Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove policy argument from s3.BucketProps #672

Closed
amitsha256 opened this issue Sep 6, 2018 · 1 comment · Fixed by #730
Closed

Remove policy argument from s3.BucketProps #672

amitsha256 opened this issue Sep 6, 2018 · 1 comment · Fixed by #730
Assignees
@rix0rrr
Labels
bug This issue is a bug.

Comments

@amitsha256
Copy link

s3.Bucket takes BucketProps which can take a policy as in the below code snippet:
The issue here is that policy requires the bucket to which it will be attached.

This seems like a bug unless I'm doing something wrong.
const s3Bucket = new s3.Bucket(this, logicalName, { versioned: true, bucketName: name, encryption: s3.BucketEncryption.KmsManaged, policy: new s3.BucketPolicy(this, "MyS3BucketPolicy", { bucket: s3Bucket }) });

@rix0rrr
Copy link
Contributor

rix0rrr commented Sep 6, 2018

You are right, that can't really work.

To get a policy onto your bucket, use the bucket.addToPolicy() method with a cdk.PolicyStatement object: https://awslabs.github.io/aws-cdk/refs/_aws-cdk_aws-s3.html?highlight=bucket#bucket-policy

We'll use this ticket to track the removal of the BucketPolicy argument.

@rix0rrr rix0rrr changed the title Circular dependency b/w s3.Bucket and s3.BucketPolicy constructs Remove policy argument from s3.BucketProps Sep 6, 2018
@rix0rrr rix0rrr added the bug This issue is a bug. label Sep 6, 2018
@rix0rrr rix0rrr self-assigned this Sep 17, 2018
rix0rrr pushed a commit that referenced this issue Sep 17, 2018
fix(aws-s3): remove policy argument
154560c 
This argument served as a red herring, and made it harder
for people to find the correct method of setting a bucket
policy, by calling `addToPolicy()`.

The provided method of providing an existing Policy object on object
creation cannot actually work, because a `BucketPolicy` object requires
the `Bucket` instance as a constructor argument, which means the
`Bucket` object cannot take a `BucketPolicy` in its constructor.

Fixes #672.
@rix0rrr rix0rrr mentioned this issue Sep 17, 2018
Merged
rix0rrr added a commit that referenced this issue Sep 17, 2018
@rix0rrr
fix(aws-s3): remove policy argument (#730)
a79190c 
This argument served as a red herring, and made it harder
for people to find the correct method of setting a bucket
policy, by calling `addToPolicy()`.

The provided method of providing an existing Policy object on object
creation cannot actually work, because a `BucketPolicy` object requires
the `Bucket` instance as a constructor argument, which means the
`Bucket` object cannot take a `BucketPolicy` in its constructor.

Fixes #672.
eladb pushed a commit that referenced this issue Sep 20, 2018
v0.9.2
0636316 
__NOTICE__: This release includes a framework-wide [__breaking
change__](#712) which changes the type
of all the string resource attributes across the framework. Instead of using
strong-types that extend `cdk.Token` (such as `QueueArn`, `TopicName`, etc), we
now represent all these attributes as normal `string`s, and codify the tokens
into the string (using the feature introduced in [#168](#168)).

Furthermore, the `cdk.Arn` type has been removed. In order to format/parse ARNs,
use the static methods on `cdk.ArnUtils`.

See motivation and discussion in [#695](#695).

* **cfn2ts:** use stringified tokens for resource attributes instead of strong types ([#712](#712)) ([6508f78](6508f78)), closes [#518](#518) [#695](#695) [#744](#744)
* **aws-dynamodb:** Attribute type for keys, changes the signature of the `addPartitionKey` and `addSortKey` methods to be consistent across the board. ([#720](#720)) ([e6cc189](e6cc189))
* **aws-codebuild:** fix typo "priviledged" -> "privileged

* **assets:** cab't use multiple assets in the same stack ([#725](#725)) ([bba2e5b](bba2e5b)), closes [#706](#706)
* **aws-codebuild:** typo in BuildEnvironment "priviledged" -> "privileged     ([#734](#734)) ([72fec36](72fec36))
* **aws-ecr:** fix addToResourcePolicy ([#737](#737)) ([eadbda5](eadbda5))
* **aws-events:** ruleName can now be specified ([#726](#726)) ([a7bc5ee](a7bc5ee)), closes [#708](#708)
* **aws-lambda:** jsii use no long requires 'sourceAccount' ([#728](#728)) ([9e7d311](9e7d311)), closes [#714](#714)
* **aws-s3:** remove `policy` argument ([#730](#730)) ([a79190c](a79190c)), closes [#672](#672)
* **cdk:** "cdk init" java template is broken ([#732](#732)) ([281c083](281c083)), closes [#711](#711) [aws/jsii#233](aws/jsii#233)

* **aws-apigateway:** new API Gateway Construct Library ([#665](#665)) ([b0f3857](b0f3857))
* **aws-cdk:** detect presence of EC2 credentials ([#724](#724)) ([8e8c295](8e8c295)), closes [#702](#702) [#130](#130)
* **aws-codepipeline:** make the Stage insertion API in CodePipeline more flexible ([#460](#460)) ([d182818](d182818))
* **aws-codepipeline:** new "Pipeline#addStage" convenience method ([#647](#647)) ([25c9fa0](25c9fa0))
* **aws-rds:** add support for parameter groups ([#729](#729)) ([2541508](2541508)), closes [#719](#719)
* **docs:** add documentation for CDK toolkit plugings ([#733](#733)) ([965b918](965b918))
* **dependencies:** upgrade to [jsii 0.7.6](https://github.com/awslabs/jsii/releases/tag/v0.7.6)
eladb pushed a commit that referenced this issue Sep 20, 2018
v0.9.2 (#749)
d68b6c3 
* v0.9.2

__NOTICE__: This release includes a framework-wide [__breaking
change__](#712) which changes the type
of all the string resource attributes across the framework. Instead of using
strong-types that extend `cdk.Token` (such as `QueueArn`, `TopicName`, etc), we
now represent all these attributes as normal `string`s, and codify the tokens
into the string (using the feature introduced in [#168](#168)).

Furthermore, the `cdk.Arn` type has been removed. In order to format/parse ARNs,
use the static methods on `cdk.ArnUtils`.

See motivation and discussion in [#695](#695).

* **cfn2ts:** use stringified tokens for resource attributes instead of strong types ([#712](#712)) ([6508f78](6508f78)), closes [#518](#518) [#695](#695) [#744](#744)
* **aws-dynamodb:** Attribute type for keys, changes the signature of the `addPartitionKey` and `addSortKey` methods to be consistent across the board. ([#720](#720)) ([e6cc189](e6cc189))
* **aws-codebuild:** fix typo "priviledged" -> "privileged

* **assets:** cab't use multiple assets in the same stack ([#725](#725)) ([bba2e5b](bba2e5b)), closes [#706](#706)
* **aws-codebuild:** typo in BuildEnvironment "priviledged" -> "privileged     ([#734](#734)) ([72fec36](72fec36))
* **aws-ecr:** fix addToResourcePolicy ([#737](#737)) ([eadbda5](eadbda5))
* **aws-events:** ruleName can now be specified ([#726](#726)) ([a7bc5ee](a7bc5ee)), closes [#708](#708)
* **aws-lambda:** jsii use no long requires 'sourceAccount' ([#728](#728)) ([9e7d311](9e7d311)), closes [#714](#714)
* **aws-s3:** remove `policy` argument ([#730](#730)) ([a79190c](a79190c)), closes [#672](#672)
* **cdk:** "cdk init" java template is broken ([#732](#732)) ([281c083](281c083)), closes [#711](#711) [aws/jsii#233](aws/jsii#233)

* **aws-apigateway:** new API Gateway Construct Library ([#665](#665)) ([b0f3857](b0f3857))
* **aws-cdk:** detect presence of EC2 credentials ([#724](#724)) ([8e8c295](8e8c295)), closes [#702](#702) [#130](#130)
* **aws-codepipeline:** make the Stage insertion API in CodePipeline more flexible ([#460](#460)) ([d182818](d182818))
* **aws-codepipeline:** new "Pipeline#addStage" convenience method ([#647](#647)) ([25c9fa0](25c9fa0))
* **aws-rds:** add support for parameter groups ([#729](#729)) ([2541508](2541508)), closes [#719](#719)
* **docs:** add documentation for CDK toolkit plugings ([#733](#733)) ([965b918](965b918))
* **dependencies:** upgrade to [jsii 0.7.6](https://github.com/awslabs/jsii/releases/tag/v0.7.6)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rix0rrr rix0rrr

Labels
bug This issue is a bug.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix(aws-s3): remove policy argument aws/aws-cdk
2 participants
@rix0rrr @amitsha256