Struct CmekSettings 

#[non_exhaustive]
pub struct CmekSettings {
    pub name: String,
    pub kms_key_name: String,
    pub kms_key_version_name: String,
    pub service_account_id: String,
    /* private fields */
}

Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.

Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.

See Enabling CMEK for Log Router for more information.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Output only. The resource name of the CMEK settings.

kms_key_name: String

The resource name for the configured Cloud KMS key.

KMS key name format:

"projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]"

For example:

"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"

To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.

The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.

To disable CMEK for the Log Router, set this field to an empty string.

See Enabling CMEK for Log Router for more information.

kms_key_version_name: String

The CryptoKeyVersion resource name for the configured Cloud KMS key.

KMS key name format:

"projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]"

For example:

"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1"

This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version.

If this field is populated, the kms_key is tied to a specific CryptoKeyVersion.

service_account_id: String

Output only. The service account that will be used by the Log Router to access your Cloud KMS key.

Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.

See Enabling CMEK for Log Router for more information.

Implementations

impl CmekSettings

pub fn new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

pub fn set_kms_key_name<T: Into<String>>(self, v: T) -> Self

Sets the value of kms_key_name.

pub fn set_kms_key_version_name<T: Into<String>>(self, v: T) -> Self

Sets the value of kms_key_version_name.

pub fn set_service_account_id<T: Into<String>>(self, v: T) -> Self

Sets the value of service_account_id.

Trait Implementations

impl Clone for CmekSettings

fn clone(&self) -> CmekSettings

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CmekSettings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CmekSettings

fn default() -> CmekSettings

Returns the “default value” for a type.

impl Message for CmekSettings

fn typename() -> &'static str

The typename of this message.

impl PartialEq for CmekSettings

fn eq(&self, other: &CmekSettings) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CmekSettings