class CfnBucketPolicyPropsMixin

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

Implements IMixin

Extends Mixin

The AWS::S3Express::BucketPolicy resource defines an Amazon S3 bucket policy to an Amazon S3 directory bucket.

• Permissions - If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must both have the required permissions on the specified bucket and belong to the bucket owner's account in order to use this operation. For more information about directory bucket policies and permissions, see AWS Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide .

To ensure that bucket owners don't inadvertently lock themselves out of their own buckets, the root principal in a bucket owner's AWS account can perform the GetBucketPolicy , PutBucketPolicy , and DeleteBucketPolicy API actions, even if their bucket policy explicitly denies the root principal's access. Bucket owner root principals can only be blocked from performing these API actions by VPC endpoint policies and AWS Organizations policies.

The required permissions for CloudFormation to use are based on the operations that are performed on the stack.

• Create

• s3express:GetBucketPolicy

• s3express:PutBucketPolicy

• Read

• s3express:GetBucketPolicy

• Update

• s3express:GetBucketPolicy

• s3express:PutBucketPolicy

• Delete

• s3express:GetBucketPolicy

• s3express:DeleteBucketPolicy

• List

• s3express:GetBucketPolicy

• s3express:ListAllMyDirectoryBuckets

For more information about example bucket policies, see Example bucket policies for S3 Express One Zone in the Amazon S3 User Guide .

The following operations are related to AWS::S3Express::BucketPolicy :

• PutBucketPolicy
• GetBucketPolicy
• DeleteBucketPolicy
• ListDirectoryBuckets

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-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 s3express_mixins } from '@aws-cdk/mixins-preview/aws-s3express';

declare const policyDocument: any;
const cfnBucketPolicyPropsMixin = new s3express_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::S3Express::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.