CfnBucketPolicyProps

class aws_cdk.aws_s3.CfnBucketPolicyProps(*, bucket, policy_document)

Bases: object

Properties for defining a CfnBucketPolicy.

Parameters
  • bucket (str) – The name of the Amazon S3 bucket to which the policy applies.

  • policy_document (Any) – 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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_s3 as s3

# policy_document: Any

cfn_bucket_policy_props = s3.CfnBucketPolicyProps(
    bucket="bucket",
    policy_document=policy_document
)

Attributes

bucket

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html#aws-properties-s3-policy-bucket

Return type

str

policy_document

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html#aws-properties-s3-policy-policydocument

Return type

Any