Package software.amazon.awscdk.cfnpropertymixins.services.s3

Class CfnBucketPolicyPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.s3.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.708Z") @Stability(Stable) public class CfnBucketPolicyPropsMixin extends Mixin implements software.constructs.IMixin
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 :

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.s3.*;
 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::S3::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::S3::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()