Skip to content

Bucket

Source code in docs_src/capo_lightsail/types/bucket.py
class Bucket(TypedDict, closed=True):
    resource_type: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>The Lightsail resource type of the bucket.</p>"""
    access_rules: NotRequired["capo_lightsail.types.access_rules.AccessRules"]
    """<p>An object that describes the access rules of the bucket.</p>"""
    arn: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>The Amazon Resource Name (ARN) of the bucket.</p>"""
    bundle_id: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>The ID of the bundle currently applied to the bucket.</p> <p>A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.</p> <p>Use the <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html">UpdateBucketBundle</a> action to change the bundle of a bucket.</p>"""
    created_at: NotRequired["capo_lightsail.types.iso_date.IsoDate"]
    """<p>The timestamp when the distribution was created.</p>"""
    url: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>The URL of the bucket.</p>"""
    location: NotRequired["capo_lightsail.types.resource_location.ResourceLocation"]
    """<p>An object that describes the location of the bucket, such as the Amazon Web Services Region and Availability Zone.</p>"""
    name: NotRequired["capo_lightsail.types.bucket_name.BucketName"]
    """<p>The name of the bucket.</p>"""
    support_code: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>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.</p>"""
    tags: NotRequired["capo_lightsail.types.tag_list.TagList"]
    """<p>The tag keys and optional values for the bucket. For more information, see <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags">Tags in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>"""
    object_versioning: NotRequired[
        "capo_lightsail.types.non_empty_string.NonEmptyString"
    ]
    """<p>Indicates whether object versioning is enabled for the bucket.</p> <p>The following options can be configured:</p> <ul> <li> <p> <code>Enabled</code> - Object versioning is enabled.</p> </li> <li> <p> <code>Suspended</code> - Object versioning was previously enabled but is currently suspended. Existing object versions are retained.</p> </li> <li> <p> <code>NeverEnabled</code> - Object versioning has never been enabled.</p> </li> </ul>"""
    able_to_update_bundle: NotRequired["capo_lightsail.types.boolean.boolean"]
    """<p>Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle.</p> <p>You can update a bucket's bundle only one time within a monthly Amazon Web Services billing cycle.</p> <p>Use the <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html">UpdateBucketBundle</a> action to change a bucket's bundle.</p>"""
    readonly_access_accounts: NotRequired[
        "capo_lightsail.types.partner_id_list.PartnerIdList"
    ]
    """<p>An array of strings that specify the Amazon Web Services account IDs that have read-only access to the bucket.</p>"""
    resources_receiving_access: NotRequired[
        "capo_lightsail.types.access_receiver_list.AccessReceiverList"
    ]
    """<p>An array of objects that describe Lightsail instances that have access to the bucket.</p> <p>Use the <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_SetResourceAccessForBucket.html">SetResourceAccessForBucket</a> action to update the instances that have access to a bucket.</p>"""
    state: NotRequired["capo_lightsail.types.bucket_state.BucketState"]
    """<p>An object that describes the state of the bucket.</p>"""
    access_log_config: NotRequired[
        "capo_lightsail.types.bucket_access_log_config.BucketAccessLogConfig"
    ]
    """<p>An object that describes the access log configuration for the bucket.</p>"""
    cors: NotRequired["capo_lightsail.types.bucket_cors_config.BucketCorsConfig"]
    """<p>An array of cross-origin resource sharing (CORS) rules that identify origins and the HTTP methods that can be executed on your bucket. This field is only included in the response when CORS configuration is requested or when updating CORS configuration. For more information, see <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/configure-cors.html">Configuring cross-origin resource sharing (CORS)</a>.</p>"""

able_to_update_bundle instance-attribute

able_to_update_bundle: NotRequired[boolean]

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 Amazon Web Services billing cycle.

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

access_log_config instance-attribute

access_log_config: NotRequired[BucketAccessLogConfig]

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

access_rules instance-attribute

access_rules: NotRequired[AccessRules]

An object that describes the access rules of the bucket.

arn instance-attribute

arn: NotRequired[NonEmptyString]

The Amazon Resource Name (ARN) of the bucket.

bundle_id instance-attribute

bundle_id: NotRequired[NonEmptyString]

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.

cors instance-attribute

cors: NotRequired[BucketCorsConfig]

An array of cross-origin resource sharing (CORS) rules that identify origins and the HTTP methods that can be executed on your bucket. This field is only included in the response when CORS configuration is requested or when updating CORS configuration. For more information, see Configuring cross-origin resource sharing (CORS).

created_at instance-attribute

created_at: NotRequired[IsoDate]

The timestamp when the distribution was created.

location instance-attribute

location: NotRequired[ResourceLocation]

An object that describes the location of the bucket, such as the Amazon Web Services Region and Availability Zone.

name instance-attribute

name: NotRequired[BucketName]

The name of the bucket.

object_versioning instance-attribute

object_versioning: NotRequired[NonEmptyString]

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.

readonly_access_accounts instance-attribute

readonly_access_accounts: NotRequired[PartnerIdList]

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

resource_type instance-attribute

resource_type: NotRequired[NonEmptyString]

The Lightsail resource type of the bucket.

resources_receiving_access instance-attribute

resources_receiving_access: NotRequired[AccessReceiverList]

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.

state instance-attribute

state: NotRequired[BucketState]

An object that describes the state of the bucket.

support_code instance-attribute

support_code: NotRequired[NonEmptyString]

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.

tags instance-attribute

tags: NotRequired[TagList]

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

url instance-attribute

url: NotRequired[NonEmptyString]

The URL of the bucket.