class CfnBucketPolicyPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.S3.Mixins.CfnBucketPolicyPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awss3/mixins#CfnBucketPolicyPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.s3.mixins.CfnBucketPolicyPropsMixin
Python	aws_cdk.mixins_preview.aws_s3.mixins.CfnBucketPolicyPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_s3 » mixins » CfnBucketPolicyPropsMixin

Implements IMixin

Extends Mixin

Applies an Amazon S3 bucket policy to an Amazon S3 bucket.

If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the PutBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.

If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

When using the AWS::S3::BucketPolicy resource, you can create, update, and delete bucket policies for S3 buckets located in Regions that are different from the stack's Region. However, the CloudFormation stacks should be deployed in the US East (N. Virginia) or us-east-1 Region. This cross-region bucket policy modification functionality is supported for backward compatibility with existing workflows.

If the DeletionPolicy attribute is not specified or set to Delete , the bucket policy will be removed when the stack is deleted. If set to Retain , the bucket policy will be preserved even after the stack is deleted.

For example, a CloudFormation stack in us-east-1 can use the AWS::S3::BucketPolicy resource to manage the bucket policy for an S3 bucket in us-west-2 . The retention or removal of the bucket policy during the stack deletion is determined by the DeletionPolicy attribute specified in the stack template.

For more information, see Bucket policy examples .

The following operations are related to PutBucketPolicy :

• CreateBucket
• DeleteBucket

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucketpolicy.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as s3_mixins } from '@aws-cdk/mixins-preview/aws-s3';

declare const policyDocument: any;
const cfnBucketPolicyPropsMixin = new s3_mixins.CfnBucketPolicyPropsMixin({
  bucket: 'bucket',
  policyDocument: policyDocument,
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnBucketPolicyPropsMixin(props: CfnBucketPolicyMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnBucketPolicyMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::S3::BucketPolicy.

Properties

Name	Type	Description
props	CfnBucketPolicyMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnBucketPolicyMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.