Package 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.103.1 (build bef2dea)", date="2024-10-11T15:56:05.358Z") @Stability(Stable) public class CfnMultiRegionAccessPoint extends CfnResource implements IInspectable
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
                 .bucketAccountId("bucketAccountId")
                 .build()))
         // the properties below are optional
         .name("name")
         .publicAccessBlockConfiguration(PublicAccessBlockConfigurationProperty.builder()
                 .blockPublicAcls(false)
                 .blockPublicPolicy(false)
                 .ignorePublicAcls(false)
                 .restrictPublicBuckets(false)
                 .build())
         .build();

See Also:

  • 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

    • CfnMultiRegionAccessPoint

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

    • CfnMultiRegionAccessPoint

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

    • CfnMultiRegionAccessPoint

      @Stability(Stable) public CfnMultiRegionAccessPoint(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnMultiRegionAccessPointProps 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.

    • getAttrAlias

      @Stability(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(Stable) @NotNull public String getAttrCreatedAt()
      The timestamp of when the Multi-Region Access Point is created.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getRegions

      @Stability(Stable) @NotNull public Object getRegions()
      A collection of the Regions and buckets associated with the Multi-Region Access Point.

    • setRegions

      @Stability(Stable) public void setRegions(@NotNull IResolvable value)
      A collection of the Regions and buckets associated with the Multi-Region Access Point.

    • setRegions

      @Stability(Stable) public void setRegions(@NotNull List<Object> value)
      A collection of the Regions and buckets associated with the Multi-Region Access Point.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the Multi-Region Access Point.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the Multi-Region Access Point.

    • getPublicAccessBlockConfiguration

      @Stability(Stable) @Nullable public Object getPublicAccessBlockConfiguration()
      The PublicAccessBlock configuration that you want to apply to this Multi-Region Access Point.

    • setPublicAccessBlockConfiguration

      @Stability(Stable) public void setPublicAccessBlockConfiguration(@Nullable IResolvable value)
      The PublicAccessBlock configuration that you want to apply to this Multi-Region Access Point.

    • setPublicAccessBlockConfiguration

      @Stability(Stable) public void setPublicAccessBlockConfiguration(@Nullable CfnMultiRegionAccessPoint.PublicAccessBlockConfigurationProperty value)
      The PublicAccessBlock configuration that you want to apply to this Multi-Region Access Point.