Package software.amazon.awscdk.services.s3

Class CfnMultiRegionAccessPointPolicy

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.s3.CfnMultiRegionAccessPointPolicy

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-02T15:58:32.853Z")
@Stability(Stable)
public class CfnMultiRegionAccessPointPolicy
extends CfnResource
implements IInspectable

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-multiregionaccesspointpolicy.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final 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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnMultiRegionAccessPointPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnMultiRegionAccessPointPolicy(software.amazon.jsii.JsiiObjectRef objRef)
	CfnMultiRegionAccessPointPolicy(software.constructs.Construct scope, String id, CfnMultiRegionAccessPointPolicyProps props)

Method Summary

Modifier and Type	Method	Description
IResolvable	getAttrPolicyStatus()	The Policy Status associated with this Multi Region Access Point.
String	getAttrPolicyStatusIsPublic()	Specifies whether the policy is public or not.
protected Map<String,Object>	getCfnProperties()
String	getMrapName()	The name of the Multi-Region Access Point.
Object	getPolicy()	The access policy associated with the Multi-Region Access Point.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setMrapName(String value)	The name of the Multi-Region Access Point.
void	setPolicy(Object value)	The access policy associated with the Multi-Region Access Point.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnMultiRegionAccessPointPolicy

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

CfnMultiRegionAccessPointPolicy

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

CfnMultiRegionAccessPointPolicy

@Stability(Stable)
public CfnMultiRegionAccessPointPolicy(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnMultiRegionAccessPointPolicyProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 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

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrPolicyStatus

@Stability(Stable)
@NotNull
public IResolvable getAttrPolicyStatus()

The Policy Status associated with this Multi Region Access Point.

getAttrPolicyStatusIsPublic

@Stability(Stable)
@NotNull
public String getAttrPolicyStatusIsPublic()

Specifies whether the policy is public or not.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getMrapName

@Stability(Stable)
@NotNull
public String getMrapName()

The name of the Multi-Region Access Point.

setMrapName

@Stability(Stable)
public void setMrapName(@NotNull
 String value)

The name of the Multi-Region Access Point.

getPolicy

@Stability(Stable)
@NotNull
public Object getPolicy()

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

setPolicy

@Stability(Stable)
public void setPolicy(@NotNull
 Object value)

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