software.amazon.awscdk.services.s3

Class CfnMultiRegionAccessPoint

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

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.787Z")
 @Stability(value=Stable)
public class CfnMultiRegionAccessPoint
extends CfnResource
implements IInspectable

A CloudFormation `AWS::S3::MultiRegionAccessPoint`.

The AWS::S3::MultiRegionAccessPoint resource creates an Amazon S3 Multi-Region Access Point. To learn more about Multi-Region Access Points, see Multi-Region Access Points in Amazon S3 in the in the Amazon S3 User Guide .

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.*;
 CfnMultiRegionAccessPoint cfnMultiRegionAccessPoint = CfnMultiRegionAccessPoint.Builder.create(this, "MyCfnMultiRegionAccessPoint")
         .regions(List.of(RegionProperty.builder()
                 .bucket("bucket")
                 // the properties below are optional
                 .accountId("accountId")
                 .build()))
         // the properties below are optional
         .name("name")
         .publicAccessBlockConfiguration(PublicAccessBlockConfigurationProperty.builder()
                 .blockPublicAcls(false)
                 .blockPublicPolicy(false)
                 .ignorePublicAcls(false)
                 .restrictPublicBuckets(false)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnMultiRegionAccessPoint.Builder A fluent builder for CfnMultiRegionAccessPoint.
static interface	CfnMultiRegionAccessPoint.PublicAccessBlockConfigurationProperty The PublicAccessBlock configuration that you want to apply to this Amazon S3 Multi-Region Access Point.
static interface	CfnMultiRegionAccessPoint.RegionProperty A bucket associated with a specific Region when creating Multi-Region Access Points.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnMultiRegionAccessPoint(software.constructs.Construct scope, String id, CfnMultiRegionAccessPointProps props) Create a new `AWS::S3::MultiRegionAccessPoint`.
protected	CfnMultiRegionAccessPoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnMultiRegionAccessPoint(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrAlias() The alias for the Multi-Region Access Point.
String	getAttrCreatedAt() The timestamp of when the Multi-Region Access Point is created.
protected Map<String,Object>	getCfnProperties()
String	getName() The name of the Multi-Region Access Point.
Object	getPublicAccessBlockConfiguration() The PublicAccessBlock configuration that you want to apply to this Multi-Region Access Point.
Object	getRegions() A collection of the Regions and buckets 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	setName(String value) The name of the Multi-Region Access Point.
void	setPublicAccessBlockConfiguration(CfnMultiRegionAccessPoint.PublicAccessBlockConfigurationProperty value) The PublicAccessBlock configuration that you want to apply to this Multi-Region Access Point.
void	setPublicAccessBlockConfiguration(IResolvable value) The PublicAccessBlock configuration that you want to apply to this Multi-Region Access Point.
void	setRegions(IResolvable value) A collection of the Regions and buckets associated with the Multi-Region Access Point.
void	setRegions(List<Object> value) A collection of the Regions and buckets associated with the Multi-Region Access Point.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnMultiRegionAccessPoint

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

CfnMultiRegionAccessPoint

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

CfnMultiRegionAccessPoint

@Stability(value=Stable)
public CfnMultiRegionAccessPoint(@NotNull
                                                          software.constructs.Construct scope,
                                                          @NotNull
                                                          String id,
                                                          @NotNull
                                                          CfnMultiRegionAccessPointProps props)

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

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

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAlias

@Stability(value=Stable)
 @NotNull
public String getAttrAlias()

The alias for the Multi-Region Access Point.

For more information about the distinction between the name and the alias of an Multi-Region Access Point, see Managing Multi-Region Access Points in the Amazon S3 User Guide .

getAttrCreatedAt

@Stability(value=Stable)
 @NotNull
public String getAttrCreatedAt()

The timestamp of when the Multi-Region Access Point is created.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getRegions

@Stability(value=Stable)
 @NotNull
public Object getRegions()

A collection of the Regions and buckets associated with the Multi-Region Access Point.

setRegions

@Stability(value=Stable)
public void setRegions(@NotNull
                                                IResolvable value)

A collection of the Regions and buckets associated with the Multi-Region Access Point.

setRegions

@Stability(value=Stable)
public void setRegions(@NotNull
                                                List<Object> value)

A collection of the Regions and buckets associated with the Multi-Region Access Point.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

The name of the Multi-Region Access Point.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The name of the Multi-Region Access Point.

getPublicAccessBlockConfiguration

@Stability(value=Stable)
 @Nullable
public Object getPublicAccessBlockConfiguration()

The PublicAccessBlock configuration that you want to apply to this Multi-Region Access Point.

You can enable the configuration options in any combination. For more information about when Amazon S3 considers an object public, see The Meaning of "Public" in the Amazon S3 User Guide .

setPublicAccessBlockConfiguration

@Stability(value=Stable)
public void setPublicAccessBlockConfiguration(@Nullable
                                                                       CfnMultiRegionAccessPoint.PublicAccessBlockConfigurationProperty value)

The PublicAccessBlock configuration that you want to apply to this Multi-Region Access Point.

You can enable the configuration options in any combination. For more information about when Amazon S3 considers an object public, see The Meaning of "Public" in the Amazon S3 User Guide .

setPublicAccessBlockConfiguration

@Stability(value=Stable)
public void setPublicAccessBlockConfiguration(@Nullable
                                                                       IResolvable value)

The PublicAccessBlock configuration that you want to apply to this Multi-Region Access Point.

You can enable the configuration options in any combination. For more information about when Amazon S3 considers an object public, see The Meaning of "Public" in the Amazon S3 User Guide .