software.amazon.awscdk.services.s3

Class CfnMultiRegionAccessPointPolicy

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.s3.CfnMultiRegionAccessPointPolicy

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:27.225Z")
public class CfnMultiRegionAccessPointPolicy
extends CfnResource
implements IInspectable

A CloudFormation `AWS::S3::MultiRegionAccessPointPolicy`.

Applies an Amazon S3 access policy to an Amazon S3 Multi-Region Access Point.

It is not possible to delete an access policy for a Multi-Region Access Point from the CloudFormation template. When you attempt to delete the policy, CloudFormation updates the policy using DeletionPolicy:Retain and UpdateReplacePolicy:Retain . CloudFormation updates the policy to only allow access to the account that created the bucket.

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.s3.*;
 Object policy;
 CfnMultiRegionAccessPointPolicy cfnMultiRegionAccessPointPolicy = CfnMultiRegionAccessPointPolicy.Builder.create(this, "MyCfnMultiRegionAccessPointPolicy")
         .mrapName("mrapName")
         .policy(policy)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnMultiRegionAccessPointPolicy.Builder A fluent builder for CfnMultiRegionAccessPointPolicy.
static interface	CfnMultiRegionAccessPointPolicy.PolicyStatusProperty The container element for a bucket's policy status.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnMultiRegionAccessPointPolicy(Construct scope, java.lang.String id, CfnMultiRegionAccessPointPolicyProps props) Create a new `AWS::S3::MultiRegionAccessPointPolicy`.
protected	CfnMultiRegionAccessPointPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnMultiRegionAccessPointPolicy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrPolicyStatusIsPublic()
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getMrapName() The name of the Multi-Region Access Point.
java.lang.Object	getPolicy() The access policy associated with the Multi-Region Access Point.
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	setMrapName(java.lang.String value) The name of the Multi-Region Access Point.
void	setPolicy(java.lang.Object value) The access policy associated with the Multi-Region Access Point.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnMultiRegionAccessPointPolicy

protected CfnMultiRegionAccessPointPolicy(software.amazon.jsii.JsiiObjectRef objRef)

CfnMultiRegionAccessPointPolicy

protected CfnMultiRegionAccessPointPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnMultiRegionAccessPointPolicy

public CfnMultiRegionAccessPointPolicy(Construct scope,
                                       java.lang.String id,
                                       CfnMultiRegionAccessPointPolicyProps props)

Create a new `AWS::S3::MultiRegionAccessPointPolicy`.

Parameters:

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.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrPolicyStatusIsPublic

public java.lang.String getAttrPolicyStatusIsPublic()

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getMrapName

public java.lang.String getMrapName()

The name of the Multi-Region Access Point.

setMrapName

public void setMrapName(java.lang.String value)

The name of the Multi-Region Access Point.

getPolicy

public java.lang.Object getPolicy()

The access policy associated with the Multi-Region Access Point.

setPolicy

public void setPolicy(java.lang.Object value)

The access policy associated with the Multi-Region Access Point.