Package software.amazon.awscdk.services.s3

Interface CfnBucketPolicyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBucketPolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-04-10T22:22:34.851Z")
@Stability(Stable)
public interface CfnBucketPolicyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnBucketPolicy.

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.s3.*;
 Object policyDocument;
 CfnBucketPolicyProps cfnBucketPolicyProps = CfnBucketPolicyProps.builder()
         .bucket("bucket")
         .policyDocument(policyDocument)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucketpolicy.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnBucketPolicyProps.Builder	A builder for CfnBucketPolicyProps
static final class	CfnBucketPolicyProps.Jsii$Proxy	An implementation for CfnBucketPolicyProps

Method Summary

Modifier and Type	Method	Description
static CfnBucketPolicyProps.Builder	builder()
String	getBucket()	The name of the Amazon S3 bucket to which the policy applies.
Object	getPolicyDocument()	A policy document containing permissions to add to the specified bucket.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucket

@Stability(Stable)
@NotNull
String getBucket()

The name of the Amazon S3 bucket to which the policy applies.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucketpolicy.html#cfn-s3-bucketpolicy-bucket

getPolicyDocument

@Stability(Stable)
@NotNull
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 in the Amazon S3 User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucketpolicy.html#cfn-s3-bucketpolicy-policydocument

builder

@Stability(Stable)
static CfnBucketPolicyProps.Builder builder()

Returns:

a CfnBucketPolicyProps.Builder of CfnBucketPolicyProps