Class BucketEncryption (3.10.0)

BucketEncryption(
    bucket,
    default_kms_key_name=None,
    google_managed_encryption_enforcement_config=None,
    customer_managed_encryption_enforcement_config=None,
    customer_supplied_encryption_enforcement_config=None,
)

Map a bucket's encryption configuration.

Parameters
Name	Description
`bucket`	`Bucket` Bucket for which this instance is the policy.
`default_kms_key_name`	`str` (Optional) Resource name of KMS key used to encrypt bucket's content.
`google_managed_encryption_enforcement_config`	`EncryptionEnforcementConfig` (Optional) Encryption enforcement configuration for Google managed encryption.
`customer_managed_encryption_enforcement_config`	`EncryptionEnforcementConfig` (Optional) Encryption enforcement configuration for Customer managed encryption.
`customer_supplied_encryption_enforcement_config`	`EncryptionEnforcementConfig` (Optional) Encryption enforcement configuration for Customer supplied encryption.

Properties

bucket

Bucket for which this instance is the policy.

Returns
Type	Description
`Bucket`	the instance's bucket.

customer_managed_encryption_enforcement_config

Retrieve the encryption enforcement configuration for Customer managed encryption.

Returns
Type	Description
`EncryptionEnforcementConfig`	The configuration instance.

customer_supplied_encryption_enforcement_config

Retrieve the encryption enforcement configuration for Customer supplied encryption.

Returns
Type	Description
`EncryptionEnforcementConfig`	The configuration instance.

default_kms_key_name

Retrieve default KMS encryption key for objects in the bucket.

Returns
Type	Description
`str or NoneType`	Default KMS encryption key, or `None` if not set.

google_managed_encryption_enforcement_config

Retrieve the encryption enforcement configuration for Google managed encryption.

Returns
Type	Description
`EncryptionEnforcementConfig`	The configuration instance.

Methods

clear

clear()

API documentation for storage.bucket.BucketEncryption.clear method.

copy

copy()

API documentation for storage.bucket.BucketEncryption.copy method.

from_api_repr

from_api_repr(resource, bucket)

Factory: construct instance from resource.

Parameter
Name	Description
`resource`	`dict` mapping as returned from API call.

Returns
Type	Description
`BucketEncryption`	Instance created from resource.

fromkeys

fromkeys(value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items

items()

API documentation for storage.bucket.BucketEncryption.items method.

keys

keys()

API documentation for storage.bucket.BucketEncryption.keys method.

pop

pop(k[,d])

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.