Package software.amazon.awscdk.services.s3

Class CfnMultiRegionAccessPoint

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:37.622Z") @Stability(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
                 .bucketAccountId("bucketAccountId")
                 .build()))
         // the properties below are optional
         .name("name")
         .publicAccessBlockConfiguration(PublicAccessBlockConfigurationProperty.builder()
                 .blockPublicAcls(false)
                 .blockPublicPolicy(false)
                 .ignorePublicAcls(false)
                 .restrictPublicBuckets(false)
                 .build())
         .build();

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

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

    • setPublicAccessBlockConfiguration

      @Stability(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 .