Class CfnBucketPolicy

This resource applies a bucket policy to an Amazon S3 on Outposts bucket.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnBucketPolicy

Implements

IInspectable

IBucketPolicyRef

IConstruct

IDependable

IEnvironmentAware

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.S3Outposts

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnBucketPolicy : CfnResource, IInspectable, IBucketPolicyRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class CfnBucketPolicy Inherits CfnResource Implements IInspectable, IBucketPolicyRef, IConstruct, IDependable, IEnvironmentAware

Remarks

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 <em>always</em> 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 .

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

CloudformationResource: AWS::S3Outposts::BucketPolicy

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.AWS.S3Outposts;

             var policyDocument;

             var cfnBucketPolicy = new CfnBucketPolicy(this, "MyCfnBucketPolicy", new CfnBucketPolicyProps {
                 Bucket = "bucket",
                 PolicyDocument = policyDocument
             });

Synopsis

Constructors

CfnBucketPolicy(Construct, string, ICfnBucketPolicyProps)

Create a new AWS::S3Outposts::BucketPolicy.

Properties

Bucket	The name of the Amazon S3 Outposts bucket to which the policy applies.
BucketPolicyRef	A reference to a BucketPolicy resource.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	This resource applies a bucket policy to an Amazon S3 on Outposts bucket.
PolicyDocument	A policy document containing permissions to add to the specified bucket.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnBucketPolicy(object)	Checks whether the given object is a CfnBucketPolicy.
RenderProperties(IDictionary<string, object>)	This resource applies a bucket policy to an Amazon S3 on Outposts bucket.

Constructors

CfnBucketPolicy(Construct, string, ICfnBucketPolicyProps)

Create a new AWS::S3Outposts::BucketPolicy.

public CfnBucketPolicy(Construct scope, string id, ICfnBucketPolicyProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnBucketPolicyProps: Resource properties.

Remarks

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 <em>always</em> 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 .

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

CloudformationResource: AWS::S3Outposts::BucketPolicy

ExampleMetadata: fixture=_generated

Properties

Bucket

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

public virtual string Bucket { get; set; }

Property Value

string

Remarks

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 <em>always</em> 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 .

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

CloudformationResource: AWS::S3Outposts::BucketPolicy

ExampleMetadata: fixture=_generated

BucketPolicyRef

A reference to a BucketPolicy resource.

public virtual IBucketPolicyReference BucketPolicyRef { get; }

Property Value

IBucketPolicyReference

Remarks

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 <em>always</em> 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 .

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

CloudformationResource: AWS::S3Outposts::BucketPolicy

ExampleMetadata: fixture=_generated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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 <em>always</em> 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 .

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

CloudformationResource: AWS::S3Outposts::BucketPolicy

ExampleMetadata: fixture=_generated

CfnProperties

This resource applies a bucket policy to an Amazon S3 on Outposts bucket.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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 <em>always</em> 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 .

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

CloudformationResource: AWS::S3Outposts::BucketPolicy

ExampleMetadata: fixture=_generated

PolicyDocument

A policy document containing permissions to add to the specified bucket.

public virtual object PolicyDocument { get; set; }

Property Value

object

Remarks

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 <em>always</em> 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 .

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

CloudformationResource: AWS::S3Outposts::BucketPolicy

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector: tree inspector to collect and process attributes.

Remarks

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 <em>always</em> 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 .

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

CloudformationResource: AWS::S3Outposts::BucketPolicy

ExampleMetadata: fixture=_generated

IsCfnBucketPolicy(object)

Checks whether the given object is a CfnBucketPolicy.

public static bool IsCfnBucketPolicy(object x)

Parameters

x object

Returns

bool

Remarks

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 <em>always</em> 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 .

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

CloudformationResource: AWS::S3Outposts::BucketPolicy

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

This resource applies a bucket policy to an Amazon S3 on Outposts bucket.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Remarks

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 <em>always</em> 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 .

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

CloudformationResource: AWS::S3Outposts::BucketPolicy

ExampleMetadata: fixture=_generated

Implements

IInspectable

IBucketPolicyRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware