Package software.amazon.awscdk.cfnpropertymixins.services.s3express

Class CfnBucketPolicyPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.s3express.CfnBucketPolicyPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:20:04.806Z") @Stability(Stable) public class CfnBucketPolicyPropsMixin extends Mixin implements software.constructs.IMixin
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 :

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.s3express.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 Object policyDocument;
 CfnBucketPolicyPropsMixin cfnBucketPolicyPropsMixin = CfnBucketPolicyPropsMixin.Builder.create(CfnBucketPolicyMixinProps.builder()
         .bucket("bucket")
         .policyDocument(policyDocument)
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnBucketPolicyPropsMixin

      protected CfnBucketPolicyPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnBucketPolicyPropsMixin

      protected CfnBucketPolicyPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnBucketPolicyPropsMixin

      @Stability(Stable) public CfnBucketPolicyPropsMixin(@NotNull CfnBucketPolicyMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::S3Express::BucketPolicy.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnBucketPolicyPropsMixin

      @Stability(Stable) public CfnBucketPolicyPropsMixin(@NotNull CfnBucketPolicyMixinProps props)
      Create a mixin to apply properties to AWS::S3Express::BucketPolicy.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnBucketPolicyMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()