AWS::Lightsail::Bucket - Amazon CloudFormation
SyntaxPropertiesReturn values
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).

AWS::Lightsail::Bucket

The AWS::Lightsail::Bucket resource specifies a bucket.

Syntax

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

JSON

{
  "Type" : "AWS::Lightsail::Bucket",
  "Properties" : {
      "AccessRules" : AccessRules,
      "BucketName" : String,
      "BundleId" : String,
      "ObjectVersioning" : Boolean,
      "ReadOnlyAccessAccounts" : [ String, ... ],
      "ResourcesReceivingAccess" : [ String, ... ],
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Lightsail::Bucket
Properties:
  AccessRules: 
    AccessRules
  BucketName: String
  BundleId: String
  ObjectVersioning: Boolean
  ReadOnlyAccessAccounts: 
    - String
  ResourcesReceivingAccess: 
    - String
  Tags: 
    - Tag

Properties

AccessRules

An object that describes the access rules for the bucket.

Required: No

Type: AccessRules

Update requires: No interruption

BucketName

The name of the bucket.

Required: Yes

Type: String

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

Minimum: 3

Maximum: 54

Update requires: Replacement

BundleId

The bundle ID for the bucket (for example, small_1_0).

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.

Required: Yes

Type: String

Pattern: .*\S.*

Update requires: No interruption

ObjectVersioning

Indicates whether object versioning is enabled for the bucket.

The following options can be configured:

  • Enabled - Object versioning is enabled.

  • Suspended - Object versioning was previously enabled but is currently suspended. Existing object versions are retained.

  • NeverEnabled - Object versioning has never been enabled.

Required: No

Type: Boolean

Pattern: .*\S.*

Update requires: No interruption

ReadOnlyAccessAccounts

An array of Amazon account IDs that have read-only access to the bucket.

Required: No

Type: Array of String

Maximum: 10

Update requires: No interruption

ResourcesReceivingAccess

An array of Lightsail instances that have access to the bucket.

Required: No

Type: Array of String

Update requires: No interruption

Tags

An array of key-value pairs to apply to this resource.

For more information, see Tag in the Amazon CloudFormation User Guide.

Note

The Value of Tags is optional for Lightsail resources.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns a unique identifier for this resource.

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.

AbleToUpdateBundle

A Boolean value indicating whether the bundle that is currently applied to your distribution can be changed to another bundle.

BucketArn

The Amazon Resource Name (ARN) of the bucket.

Url

The URL of the bucket.