Class CfnBucketPolicy

All Implemented Interfaces:
IInspectable,, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:34:09.236Z") @Stability(Stable) public class CfnBucketPolicy extends CfnResource implements IInspectable
This resource applies a bucket policy to an Amazon S3 on Outposts bucket.

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

If you don't have s3-outposts:PutBucketPolicy permissions, S3 on Outposts returns a 403 Access Denied error.

The root user of the AWS account that owns an Outposts bucket can always use this resource, even if the policy explicitly denies the root user the ability to perform actions on this resource.

For more information, see the AWS::IAM::Policy PolicyDocument resource description in this guide and Access Policy Language Overview .


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 Object policyDocument;
 CfnBucketPolicy cfnBucketPolicy = CfnBucketPolicy.Builder.create(this, "MyCfnBucketPolicy")

See Also:
  • Field Details


      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.
  • Constructor Details

    • CfnBucketPolicy

      protected CfnBucketPolicy( objRef)
    • CfnBucketPolicy

      protected CfnBucketPolicy( initializationMode)
    • CfnBucketPolicy

      @Stability(Stable) public CfnBucketPolicy(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnBucketPolicyProps props)
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.
  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      inspector - tree inspector to collect and process attributes. This parameter is required.
    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      renderProperties in class CfnResource
      props - This parameter is required.
    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      getCfnProperties in class CfnResource
    • getBucket

      @Stability(Stable) @NotNull public String getBucket()
      The name of the Amazon S3 Outposts bucket to which the policy applies.
    • setBucket

      @Stability(Stable) public void setBucket(@NotNull String value)
      The name of the Amazon S3 Outposts bucket to which the policy applies.
    • getPolicyDocument

      @Stability(Stable) @NotNull public Object getPolicyDocument()
      A policy document containing permissions to add to the specified bucket.
    • setPolicyDocument

      @Stability(Stable) public void setPolicyDocument(@NotNull Object value)
      A policy document containing permissions to add to the specified bucket.