AWS::S3::MultiRegionAccessPoint - AWS CloudFormation
SyntaxPropertiesReturn valuesExamples

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.

Syntax

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

JSON

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

YAML

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

Properties

Name

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

PublicAccessBlockConfiguration

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

Regions

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

Ref

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.

Fn::GetAtt

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.

Alias

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.

CreatedAt

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

Examples

You can use AWSCloudFormation 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 AWS CloudFormation.

JSON

{
    "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"} ]
        }
      }
    }
}

YAML

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