Skip to content

UpdateBucketRequest

Source code in docs_src/capo_lightsail/types/update_bucket_request.py
class UpdateBucketRequest(TypedDict, closed=True):
    bucket_name: "capo_lightsail.types.bucket_name.BucketName"
    """<p>The name of the bucket to update.</p>"""
    access_rules: NotRequired["capo_lightsail.types.access_rules.AccessRules"]
    """<p>An object that sets the public accessibility of objects in the specified bucket.</p>"""
    versioning: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>Specifies whether to enable or suspend versioning of objects in the bucket.</p> <p>The following options can be specified:</p> <ul> <li> <p> <code>Enabled</code> - Enables versioning of objects in the specified bucket.</p> </li> <li> <p> <code>Suspended</code> - Suspends versioning of objects in the specified bucket. Existing object versions are retained.</p> </li> </ul>"""
    readonly_access_accounts: NotRequired[
        "capo_lightsail.types.partner_id_list.PartnerIdList"
    ]
    """<p>An array of strings to specify the Amazon Web Services account IDs that can access the bucket.</p> <p>You can give a maximum of 10 Amazon Web Services accounts access to a 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>Sets the cross-origin resource sharing (CORS) configuration for your bucket. If a CORS configuration exists, it is replaced with the specified configuration. For AWS CLI operations, this parameter can also be passed as a file. 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> <note> <p>CORS information is only returned in a response when you update the CORS policy.</p> </note>"""

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 sets the public accessibility of objects in the specified bucket.

bucket_name instance-attribute

bucket_name: BucketName

The name of the bucket to update.

cors instance-attribute

cors: NotRequired[BucketCorsConfig]

Sets the cross-origin resource sharing (CORS) configuration for your bucket. If a CORS configuration exists, it is replaced with the specified configuration. For AWS CLI operations, this parameter can also be passed as a file. For more information, see Configuring cross-origin resource sharing (CORS).

CORS information is only returned in a response when you update the CORS policy.

readonly_access_accounts instance-attribute

readonly_access_accounts: NotRequired[PartnerIdList]

An array of strings to specify the Amazon Web Services account IDs that can access the bucket.

You can give a maximum of 10 Amazon Web Services accounts access to a bucket.

versioning instance-attribute

versioning: NotRequired[NonEmptyString]

Specifies whether to enable or suspend versioning of objects in the bucket.

The following options can be specified:

  • Enabled - Enables versioning of objects in the specified bucket.

  • Suspended - Suspends versioning of objects in the specified bucket. Existing object versions are retained.