Class: Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/spanner/admin/database/v1/backup.rb

Overview

Encryption configuration for the backup to create.

Defined Under Namespace

Modules: EncryptionType

Instance Attribute Summary collapse

Instance Attribute Details

#encryption_type ⇒ ::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig::EncryptionType

Returns Required. The encryption type of the backup.

Returns:



609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 609

class CreateBackupEncryptionConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Encryption types for the backup.
  module EncryptionType
    # Unspecified. Do not use.
    ENCRYPTION_TYPE_UNSPECIFIED = 0

    # Use the same encryption configuration as the database. This is the
    # default option when
    # {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig encryption_config}
    # is empty. For example, if the database is using
    # `Customer_Managed_Encryption`, the backup will be using the same Cloud
    # KMS key as the database.
    USE_DATABASE_ENCRYPTION = 1

    # Use Google default encryption.
    GOOGLE_DEFAULT_ENCRYPTION = 2

    # Use customer managed encryption. If specified, `kms_key_name`
    # must contain a valid Cloud KMS key.
    CUSTOMER_MANAGED_ENCRYPTION = 3
  end
end

#kms_key_name ⇒ ::String

Returns Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is CUSTOMER_MANAGED_ENCRYPTION. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.

Returns:

  • (::String) —

    Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is CUSTOMER_MANAGED_ENCRYPTION. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.



609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 609

class CreateBackupEncryptionConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Encryption types for the backup.
  module EncryptionType
    # Unspecified. Do not use.
    ENCRYPTION_TYPE_UNSPECIFIED = 0

    # Use the same encryption configuration as the database. This is the
    # default option when
    # {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig encryption_config}
    # is empty. For example, if the database is using
    # `Customer_Managed_Encryption`, the backup will be using the same Cloud
    # KMS key as the database.
    USE_DATABASE_ENCRYPTION = 1

    # Use Google default encryption.
    GOOGLE_DEFAULT_ENCRYPTION = 2

    # Use customer managed encryption. If specified, `kms_key_name`
    # must contain a valid Cloud KMS key.
    CUSTOMER_MANAGED_ENCRYPTION = 3
  end
end

#kms_key_names ⇒ ::Array<::String>

Returns Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.

The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples:

  • For single region instance configs, specify a single regional location KMS key.
  • For multi-regional instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config.
  • For an instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.

Returns:

  • (::Array<::String>) —

    Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.

    The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples:

    • For single region instance configs, specify a single regional location KMS key.
    • For multi-regional instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config.
    • For an instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.


609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 609

class CreateBackupEncryptionConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Encryption types for the backup.
  module EncryptionType
    # Unspecified. Do not use.
    ENCRYPTION_TYPE_UNSPECIFIED = 0

    # Use the same encryption configuration as the database. This is the
    # default option when
    # {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig encryption_config}
    # is empty. For example, if the database is using
    # `Customer_Managed_Encryption`, the backup will be using the same Cloud
    # KMS key as the database.
    USE_DATABASE_ENCRYPTION = 1

    # Use Google default encryption.
    GOOGLE_DEFAULT_ENCRYPTION = 2

    # Use customer managed encryption. If specified, `kms_key_name`
    # must contain a valid Cloud KMS key.
    CUSTOMER_MANAGED_ENCRYPTION = 3
  end
end