Class CfnBucketPolicyPropsMixin

Create a mixin to apply properties to AWS::S3::BucketPolicy.

public CfnBucketPolicyPropsMixin(ICfnBucketPolicyMixinProps props, ICfnPropertyMixinOptions? options = null)

Parameters

props ICfnBucketPolicyMixinProps: L1 properties to apply.
options ICfnPropertyMixinOptions: Mixin options.

Remarks

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

If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

When using the AWS::S3::BucketPolicy resource, you can create, update, and delete bucket policies for S3 buckets located in Regions that are different from the stack's Region. However, the CloudFormation stacks should be deployed in the US East (N. Virginia) or us-east-1 Region. This cross-region bucket policy modification functionality is supported for backward compatibility with existing workflows.

If the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html">DeletionPolicy attribute</a> is not specified or set to <code>Delete</code> , the bucket policy will be removed when the stack is deleted. If set to <code>Retain</code> , the bucket policy will be preserved even after the stack is deleted.

For example, a CloudFormation stack in us-east-1 can use the AWS::S3::BucketPolicy resource to manage the bucket policy for an S3 bucket in us-west-2 . The retention or removal of the bucket policy during the stack deletion is determined by the DeletionPolicy attribute specified in the stack template.

For more information, see Bucket policy examples .

The following operations are related to PutBucketPolicy :

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

CloudformationResource: AWS::S3::BucketPolicy

Mixin: true

ExampleMetadata: fixture=_generated

Applies an Amazon S3 bucket policy to an Amazon S3 bucket.

protected static string[] CFN_PROPERTY_KEYS { get; }

Property Value

string[]

Remarks

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

If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

When using the AWS::S3::BucketPolicy resource, you can create, update, and delete bucket policies for S3 buckets located in Regions that are different from the stack's Region. However, the CloudFormation stacks should be deployed in the US East (N. Virginia) or us-east-1 Region. This cross-region bucket policy modification functionality is supported for backward compatibility with existing workflows.

If the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html">DeletionPolicy attribute</a> is not specified or set to <code>Delete</code> , the bucket policy will be removed when the stack is deleted. If set to <code>Retain</code> , the bucket policy will be preserved even after the stack is deleted.

For example, a CloudFormation stack in us-east-1 can use the AWS::S3::BucketPolicy resource to manage the bucket policy for an S3 bucket in us-west-2 . The retention or removal of the bucket policy during the stack deletion is determined by the DeletionPolicy attribute specified in the stack template.

For more information, see Bucket policy examples .

The following operations are related to PutBucketPolicy :

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

CloudformationResource: AWS::S3::BucketPolicy

Mixin: true

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.S3.Mixins;

             var policyDocument;

             var cfnBucketPolicyPropsMixin = new CfnBucketPolicyPropsMixin(new CfnBucketPolicyMixinProps {
                 Bucket = "bucket",
                 PolicyDocument = policyDocument
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Applies an Amazon S3 bucket policy to an Amazon S3 bucket.

protected virtual ICfnBucketPolicyMixinProps Props { get; }

Property Value

ICfnBucketPolicyMixinProps

Remarks

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

If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

When using the AWS::S3::BucketPolicy resource, you can create, update, and delete bucket policies for S3 buckets located in Regions that are different from the stack's Region. However, the CloudFormation stacks should be deployed in the US East (N. Virginia) or us-east-1 Region. This cross-region bucket policy modification functionality is supported for backward compatibility with existing workflows.

If the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html">DeletionPolicy attribute</a> is not specified or set to <code>Delete</code> , the bucket policy will be removed when the stack is deleted. If set to <code>Retain</code> , the bucket policy will be preserved even after the stack is deleted.

For example, a CloudFormation stack in us-east-1 can use the AWS::S3::BucketPolicy resource to manage the bucket policy for an S3 bucket in us-west-2 . The retention or removal of the bucket policy during the stack deletion is determined by the DeletionPolicy attribute specified in the stack template.

For more information, see Bucket policy examples .

The following operations are related to PutBucketPolicy :

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

CloudformationResource: AWS::S3::BucketPolicy

Mixin: true

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.S3.Mixins;

             var policyDocument;

             var cfnBucketPolicyPropsMixin = new CfnBucketPolicyPropsMixin(new CfnBucketPolicyMixinProps {
                 Bucket = "bucket",
                 PolicyDocument = policyDocument
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Applies an Amazon S3 bucket policy to an Amazon S3 bucket.

protected virtual PropertyMergeStrategy Strategy { get; }

Property Value

PropertyMergeStrategy

Remarks

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

If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

When using the AWS::S3::BucketPolicy resource, you can create, update, and delete bucket policies for S3 buckets located in Regions that are different from the stack's Region. However, the CloudFormation stacks should be deployed in the US East (N. Virginia) or us-east-1 Region. This cross-region bucket policy modification functionality is supported for backward compatibility with existing workflows.

If the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html">DeletionPolicy attribute</a> is not specified or set to <code>Delete</code> , the bucket policy will be removed when the stack is deleted. If set to <code>Retain</code> , the bucket policy will be preserved even after the stack is deleted.

For example, a CloudFormation stack in us-east-1 can use the AWS::S3::BucketPolicy resource to manage the bucket policy for an S3 bucket in us-west-2 . The retention or removal of the bucket policy during the stack deletion is determined by the DeletionPolicy attribute specified in the stack template.

For more information, see Bucket policy examples .

The following operations are related to PutBucketPolicy :

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

CloudformationResource: AWS::S3::BucketPolicy

Mixin: true

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.S3.Mixins;

             var policyDocument;

             var cfnBucketPolicyPropsMixin = new CfnBucketPolicyPropsMixin(new CfnBucketPolicyMixinProps {
                 Bucket = "bucket",
                 PolicyDocument = policyDocument
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Apply the mixin properties to the construct.

public override IConstruct ApplyTo(IConstruct construct)

Parameters

construct IConstruct

Returns

IConstruct

Overrides

Mixin.ApplyTo(IConstruct)

Remarks

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

If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

When using the AWS::S3::BucketPolicy resource, you can create, update, and delete bucket policies for S3 buckets located in Regions that are different from the stack's Region. However, the CloudFormation stacks should be deployed in the US East (N. Virginia) or us-east-1 Region. This cross-region bucket policy modification functionality is supported for backward compatibility with existing workflows.

If the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html">DeletionPolicy attribute</a> is not specified or set to <code>Delete</code> , the bucket policy will be removed when the stack is deleted. If set to <code>Retain</code> , the bucket policy will be preserved even after the stack is deleted.

For example, a CloudFormation stack in us-east-1 can use the AWS::S3::BucketPolicy resource to manage the bucket policy for an S3 bucket in us-west-2 . The retention or removal of the bucket policy during the stack deletion is determined by the DeletionPolicy attribute specified in the stack template.

For more information, see Bucket policy examples .

The following operations are related to PutBucketPolicy :

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

CloudformationResource: AWS::S3::BucketPolicy

Mixin: true

ExampleMetadata: fixture=_generated

Check if this mixin supports the given construct.

public override bool Supports(IConstruct construct)

Parameters

construct IConstruct

Returns

bool

Overrides

Mixin.Supports(IConstruct)

Remarks

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

If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

When using the AWS::S3::BucketPolicy resource, you can create, update, and delete bucket policies for S3 buckets located in Regions that are different from the stack's Region. However, the CloudFormation stacks should be deployed in the US East (N. Virginia) or us-east-1 Region. This cross-region bucket policy modification functionality is supported for backward compatibility with existing workflows.

If the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html">DeletionPolicy attribute</a> is not specified or set to <code>Delete</code> , the bucket policy will be removed when the stack is deleted. If set to <code>Retain</code> , the bucket policy will be preserved even after the stack is deleted.

For example, a CloudFormation stack in us-east-1 can use the AWS::S3::BucketPolicy resource to manage the bucket policy for an S3 bucket in us-west-2 . The retention or removal of the bucket policy during the stack deletion is determined by the DeletionPolicy attribute specified in the stack template.

For more information, see Bucket policy examples .

The following operations are related to PutBucketPolicy :

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

CloudformationResource: AWS::S3::BucketPolicy

Mixin: true

ExampleMetadata: fixture=_generated

CFN_PROPERTY_KEYS	Applies an Amazon S3 bucket policy to an Amazon S3 bucket.
Props	Applies an Amazon S3 bucket policy to an Amazon S3 bucket.
Strategy	Applies an Amazon S3 bucket policy to an Amazon S3 bucket.

ApplyTo(IConstruct)	Apply the mixin properties to the construct.
Supports(IConstruct)	Check if this mixin supports the given construct.

Class CfnBucketPolicyPropsMixin

Inheritance

Implements

Inherited Members

Namespace: Amazon.CDK.Mixins.Preview.AWS.S3.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

Syntax (vb)

Remarks

Examples

Synopsis

Constructors

Properties

Methods

Constructors

CfnBucketPolicyPropsMixin(ICfnBucketPolicyMixinProps, ICfnPropertyMixinOptions?)

Parameters

Remarks

Properties

CFN_PROPERTY_KEYS

Property Value

Remarks

Examples

Props

Property Value

Remarks

Examples

Strategy

Property Value

Remarks

Examples

Methods

ApplyTo(IConstruct)

Parameters

Returns

Overrides

Remarks

Supports(IConstruct)

Parameters

Returns

Overrides

Remarks

Implements