CfnBucketPolicyMixinProps
- class aws_cdk.mixins_preview.aws_s3.mixins.CfnBucketPolicyMixinProps(*, bucket=None, policy_document=None)
Bases:
objectProperties for CfnBucketPolicyPropsMixin.
- Parameters:
bucket (
Optional[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 .
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucketpolicy.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_s3 import mixins as s3_mixins # policy_document: Any cfn_bucket_policy_mixin_props = s3_mixins.CfnBucketPolicyMixinProps( bucket="bucket", policy_document=policy_document )
Attributes
- bucket
The name of the Amazon S3 bucket to which the policy applies.
- 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 .