software.amazon.awscdk.services.s3

Class CfnMultiRegionAccessPoint

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

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-02T20:25:29.234Z")
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 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
	CfnMultiRegionAccessPoint(Construct scope, java.lang.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
java.lang.String	getAttrAlias() The alias for the Multi-Region Access Point.
java.lang.String	getAttrCreatedAt() The timestamp of when the Multi-Region Access Point is created.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getName() The name of the Multi-Region Access Point.
java.lang.Object	getPublicAccessBlockConfiguration() The PublicAccessBlock configuration that you want to apply to this Multi-Region Access Point.
java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setName(java.lang.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(java.util.List<java.lang.Object> value) A collection of the Regions and buckets 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

CfnMultiRegionAccessPoint

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

CfnMultiRegionAccessPoint

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

CfnMultiRegionAccessPoint

public CfnMultiRegionAccessPoint(Construct scope,
                                 java.lang.String id,
                                 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

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.

getAttrAlias

public java.lang.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

public java.lang.String getAttrCreatedAt()

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getRegions

public java.lang.Object getRegions()

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

setRegions

public void setRegions(IResolvable value)

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

setRegions

public void setRegions(java.util.List<java.lang.Object> value)

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

getName

public java.lang.String getName()

The name of the Multi-Region Access Point.

setName

public void setName(java.lang.String value)

The name of the Multi-Region Access Point.

getPublicAccessBlockConfiguration

public java.lang.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

public void setPublicAccessBlockConfiguration(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 .

setPublicAccessBlockConfiguration

public void setPublicAccessBlockConfiguration(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 .