Bucket - Amazon Lightsail

Bucket

Describes an Amazon Lightsail bucket.

Contents

ableToUpdateBundle

Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle.

You can update a bucket's bundle only one time within a monthly AWS billing cycle.

Use the UpdateBucketBundle action to change a bucket's bundle.

Type: Boolean

Required: No

accessLogConfig

An object that describes the access log configuration for the bucket.

Type: BucketAccessLogConfig object

Required: No

accessRules

An object that describes the access rules of the bucket.

Type: AccessRules object

Required: No

arn

The Amazon Resource Name (ARN) of the bucket.

Type: String

Pattern: .*\S.*

Required: No

bundleId

The ID of the bundle currently applied to the bucket.

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

Use the UpdateBucketBundle action to change the bundle of a bucket.

Type: String

Pattern: .*\S.*

Required: No

createdAt

The timestamp when the distribution was created.

Type: Timestamp

Required: No

location

Describes the resource location.

Type: ResourceLocation object

Required: No

name

The name of the bucket.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 54.

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

Required: No

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.

Type: String

Pattern: .*\S.*

Required: No

readonlyAccessAccounts

An array of strings that specify the AWS account IDs that have read-only access to the bucket.

Type: Array of strings

Array Members: Maximum number of 10 items.

Pattern: .*\S.*

Required: No

resourcesReceivingAccess

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

Use the SetResourceAccessForBucket action to update the instances that have access to a bucket.

Type: Array of ResourceReceivingAccess objects

Required: No

resourceType

The Lightsail resource type of the bucket (for example, Bucket).

Type: String

Pattern: .*\S.*

Required: No

state

An object that describes the state of the bucket.

Type: BucketState object

Required: No

supportCode

The support code for a bucket. Include this code in your email to support when you have questions about a Lightsail bucket. This code enables our support team to look up your Lightsail information more easily.

Type: String

Pattern: .*\S.*

Required: No

tags

The tag keys and optional values for the bucket. For more information, see Tags in Amazon Lightsail in the Amazon Lightsail Developer Guide.

Type: Array of Tag objects

Required: No

url

The URL of the bucket.

Type: String

Pattern: .*\S.*

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: