AWS::S3::MultiRegionAccessPoint - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


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.


To declare this entity in your Amazon CloudFormation template, use the following syntax:


{ "Type" : "AWS::S3::MultiRegionAccessPoint", "Properties" : { "Name" : String, "PublicAccessBlockConfiguration" : PublicAccessBlockConfiguration, "Regions" : [ Region, ... ] } }


Type: AWS::S3::MultiRegionAccessPoint Properties: Name: String PublicAccessBlockConfiguration: PublicAccessBlockConfiguration Regions: - Region



The name of the Multi-Region Access Point.

Required: No

Type: String

Pattern: ^[a-z0-9][-a-z0-9]{1,48}[a-z0-9]$

Minimum: 3

Maximum: 50

Update requires: Replacement


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.

Required: No

Type: PublicAccessBlockConfiguration

Update requires: Replacement


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

Required: Yes

Type: Array of Region

Minimum: 1

Update requires: Replacement

Return values


When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the name of the Multi-Region Access Point.

For more information about using the Ref function, see Ref.


The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.


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.


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


You can use AmazonCloudFormation to create a Multi-Region Access Point. When you create the Multi-Region Access Point, you must provide all the S3 buckets that it supports. Be aware that you can't add any S3 buckets to the Multi-Region Access Point after it's been created.

Multi-Region Access Point with two Regions

The following template can be used to create a Multi-Region Access Point (with two Regions) through Amazon CloudFormation.


{ "AWSTemplateFormatVersion": "2010-09-09", "Resources": { "DOC-EXAMPLE-MULTI-REGION-ACCESS-POINT": { "Type" : "AWS::S3::MultiRegionAccessPoint", "Properties" : { "PublicAccessBlockConfiguration" : { "BlockPublicAcls" : "True", "BlockPublicPolicy" : "True", "IgnorePublicAcls" : "True", "RestrictPublicBuckets" : "True" }, "Regions" : [ {"Bucket":"DOC-EXAMPLE-BUCKET1"}, {"Bucket": "DOC-EXAMPLE-BUCKET2"} ] } } } }


AWSTemplateFormatVersion: "2010-09-09" Resources: DOC-EXAMPLE-MULTI-REGION-ACCESS-POINT: Type: AWS::S3::MultiRegionAccessPoint Properties: PublicAccessBlockConfiguration: BlockPublicAcls: "True" BlockPublicPolicy: "True" IgnorePublicAcls: "True" RestrictPublicBuckets: "True" Regions: - Bucket: DOC-EXAMPLE-BUCKET1 - Bucket: DOC-EXAMPLE-BUCKET2