Package software.amazon.awscdk.services.s3outposts

Class CfnBucketPolicy

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.s3outposts.CfnBucketPolicy
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.068Z") @Stability(Stable) public class CfnBucketPolicy extends CfnResource implements IInspectable
A CloudFormation AWS::S3Outposts::BucketPolicy.

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 .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.s3outposts.*;
 Object policyDocument;
 CfnBucketPolicy cfnBucketPolicy = CfnBucketPolicy.Builder.create(this, "MyCfnBucketPolicy")
         .bucket("bucket")
         .policyDocument(policyDocument)
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

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

  • Constructor Details

    • CfnBucketPolicy

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

    • CfnBucketPolicy

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

    • CfnBucketPolicy

      @Stability(Stable) public CfnBucketPolicy(@NotNull Construct scope, @NotNull String id, @NotNull CfnBucketPolicyProps props)
      Create a new AWS::S3Outposts::BucketPolicy.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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
      Parameters:
      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)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      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.

      In IAM, you must provide policy documents in JSON format. However, in CloudFormation, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM. For more information, see the AWS::IAM::Policy PolicyDocument resource description in this guide and Access Policy Language Overview .

    • setPolicyDocument

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

      In IAM, you must provide policy documents in JSON format. However, in CloudFormation, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM. For more information, see the AWS::IAM::Policy PolicyDocument resource description in this guide and Access Policy Language Overview .