Class CfnBucketPolicy

A CloudFormation AWS::S3Outposts::BucketPolicy.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnBucketPolicy
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.S3Outposts
Assembly: Amazon.CDK.AWS.S3Outposts.dll
Syntax (csharp)
public class CfnBucketPolicy : CfnResource, IConstruct, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnBucketPolicy
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable
Remarks

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

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

CloudformationResource: AWS::S3Outposts::BucketPolicy

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

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;

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

Synopsis

Constructors

CfnBucketPolicy(Construct, String, ICfnBucketPolicyProps)

Create a new AWS::S3Outposts::BucketPolicy.
CfnBucketPolicy(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnBucketPolicy(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

Properties

Bucket

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

The CloudFormation resource type name for this resource class.
CfnProperties
PolicyDocument

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

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 System.String
  • scoped id of the resource.
props ICfnBucketPolicyProps
  • resource properties.

CfnBucketPolicy(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnBucketPolicy(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnBucketPolicy(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnBucketPolicy(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

Bucket

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

public virtual string Bucket { get; set; }
Property Value

System.String

Remarks

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

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

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

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

PolicyDocument

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

public virtual object PolicyDocument { get; set; }
Property Value

System.Object

Remarks

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 .

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

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.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements

Constructs.IConstruct