@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
date="2023-03-14T16:25:25.266Z")
public class CfnBucketPolicy
extends CfnResource
implements IInspectable
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 .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.s3outposts.*;
Object policyDocument;
CfnBucketPolicy cfnBucketPolicy = CfnBucketPolicy.Builder.create(this, "MyCfnBucketPolicy")
.bucket("bucket")
.policyDocument(policyDocument)
.build();
| Modifier and Type | Class and Description |
|---|---|
static class |
CfnBucketPolicy.Builder
A fluent builder for
CfnBucketPolicy. |
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyIConstruct.Jsii$Default| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnBucketPolicy(Construct scope,
java.lang.String id,
CfnBucketPolicyProps props)
Create a new `AWS::S3Outposts::BucketPolicy`.
|
protected |
CfnBucketPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnBucketPolicy(software.amazon.jsii.JsiiObjectRef objRef) |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getBucket()
The name of the Amazon S3 Outposts bucket to which the policy applies.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getPolicyDocument()
A policy document containing permissions to add to the specified bucket.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setBucket(java.lang.String value)
The name of the Amazon S3 Outposts bucket to which the policy applies.
|
void |
setPolicyDocument(java.lang.Object value)
A policy document containing permissions to add to the specified bucket.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdgetNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validatepublic static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnBucketPolicy(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnBucketPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnBucketPolicy(Construct scope, java.lang.String id, CfnBucketPolicyProps props)
scope - - scope in which this resource is defined. This parameter is required.id - - scoped id of the resource. This parameter is required.props - - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties in class CfnResourceprops - This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties in class CfnResourcepublic java.lang.String getBucket()
public void setBucket(java.lang.String value)
public java.lang.Object getPolicyDocument()
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 .
public void setPolicyDocument(java.lang.Object value)
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 .