Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

Amazon S3 Bucket AccelerateConfiguration

The AccelerateConfiguration property type configures the transfer acceleration state for an Amazon S3 bucket. For more information, see Amazon S3 Transfer Acceleration in the Amazon Simple Storage Service Developer Guide.

AccelerateConfiguration is a property of the AWS::S3::Bucket resource.

Syntax

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

JSON

Copy
{ "AccelerationStatus" : String }

YAML

Copy
AccelerationStatus: String

Properties

AccelerationStatus

Sets the transfer acceleration state of the bucket.

Required: Yes

Type: String

Valid values: Enabled, Suspended

Update requires: No interruption

Example

The following example sets the transfer acceleration state of a bucket based on the AccelerateStatus parameter.

JSON

Copy
{ "AWSTemplateFormatVersion":"2010-09-09", "Parameters" : { "AccelerateStatus" : { "Type" : "String" } }, "Resources":{ "MyBucket":{ "Type":"AWS::S3::Bucket", "Properties" : { "AccelerateConfiguration" : { "AccelerationStatus" : {"Ref" : "AccelerateStatus"} } } } } }

YAML

Copy
AWSTemplateFormatVersion: 2010-09-09 Parameters: AccelerateStatus: Type: String Resources: MyBucket: Type: 'AWS::S3::Bucket' Properties: AccelerateConfiguration: AccelerationStatus: !Ref AccelerateStatus

On this page: