Class: Google::Cloud::CloudDMS::V1::AlloyDbSettings

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb

Overview

Settings for creating an AlloyDB cluster.

Defined Under Namespace

Classes: EncryptionConfig, LabelsEntry, PrimaryInstanceSettings, UserPassword

Instance Attribute Summary collapse

Instance Attribute Details

#encryption_config ⇒ ::Google::Cloud::CloudDMS::V1::AlloyDbSettings::EncryptionConfig

Returns Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.

Returns:

  • (::Google::Cloud::CloudDMS::V1::AlloyDbSettings::EncryptionConfig) —

    Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 501

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

  # The username/password for a database user. Used for specifying initial
  # users at cluster creation time.
  # @!attribute [rw] user
  #   @return [::String]
  #     The database username.
  # @!attribute [rw] password
  #   @return [::String]
  #     The initial password for the user.
  # @!attribute [r] password_set
  #   @return [::Boolean]
  #     Output only. Indicates if the initial_user.password field has been set.
  class UserPassword
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for the cluster's primary instance
  # @!attribute [rw] id
  #   @return [::String]
  #     Required. The ID of the AlloyDB primary instance. The ID must satisfy the
  #     regex expression "[a-z0-9-]+".
  # @!attribute [rw] machine_config
  #   @return [::Google::Cloud::CloudDMS::V1::AlloyDbSettings::PrimaryInstanceSettings::MachineConfig]
  #     Configuration for the machines that host the underlying
  #     database engine.
  # @!attribute [rw] database_flags
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Database flags to pass to AlloyDB when DMS is creating the AlloyDB
  #     cluster and instances. See the AlloyDB documentation for how these can be
  #     used.
  # @!attribute [rw] labels
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Labels for the AlloyDB primary instance created by DMS. An object
  #     containing a list of 'key', 'value' pairs.
  # @!attribute [r] private_ip
  #   @return [::String]
  #     Output only. The private IP address for the Instance.
  #     This is the connection endpoint for an end-user application.
  class PrimaryInstanceSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # MachineConfig describes the configuration of a machine.
    # @!attribute [rw] cpu_count
    #   @return [::Integer]
    #     The number of CPU's in the VM instance.
    class MachineConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class DatabaseFlagsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class LabelsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # EncryptionConfig describes the encryption config of a cluster that is
  # encrypted with a CMEK (customer-managed encryption key).
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     The fully-qualified resource name of the KMS key.
  #     Each Cloud KMS key is regionalized and has the following format:
  #     projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#initial_user ⇒ ::Google::Cloud::CloudDMS::V1::AlloyDbSettings::UserPassword

Returns Required. Input only. Initial user to setup during cluster creation. Required.

Returns:



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 501

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

  # The username/password for a database user. Used for specifying initial
  # users at cluster creation time.
  # @!attribute [rw] user
  #   @return [::String]
  #     The database username.
  # @!attribute [rw] password
  #   @return [::String]
  #     The initial password for the user.
  # @!attribute [r] password_set
  #   @return [::Boolean]
  #     Output only. Indicates if the initial_user.password field has been set.
  class UserPassword
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for the cluster's primary instance
  # @!attribute [rw] id
  #   @return [::String]
  #     Required. The ID of the AlloyDB primary instance. The ID must satisfy the
  #     regex expression "[a-z0-9-]+".
  # @!attribute [rw] machine_config
  #   @return [::Google::Cloud::CloudDMS::V1::AlloyDbSettings::PrimaryInstanceSettings::MachineConfig]
  #     Configuration for the machines that host the underlying
  #     database engine.
  # @!attribute [rw] database_flags
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Database flags to pass to AlloyDB when DMS is creating the AlloyDB
  #     cluster and instances. See the AlloyDB documentation for how these can be
  #     used.
  # @!attribute [rw] labels
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Labels for the AlloyDB primary instance created by DMS. An object
  #     containing a list of 'key', 'value' pairs.
  # @!attribute [r] private_ip
  #   @return [::String]
  #     Output only. The private IP address for the Instance.
  #     This is the connection endpoint for an end-user application.
  class PrimaryInstanceSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # MachineConfig describes the configuration of a machine.
    # @!attribute [rw] cpu_count
    #   @return [::Integer]
    #     The number of CPU's in the VM instance.
    class MachineConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class DatabaseFlagsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class LabelsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # EncryptionConfig describes the encryption config of a cluster that is
  # encrypted with a CMEK (customer-managed encryption key).
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     The fully-qualified resource name of the KMS key.
  #     Each Cloud KMS key is regionalized and has the following format:
  #     projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Labels for the AlloyDB cluster created by DMS. An object containing a list of 'key', 'value' pairs.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Labels for the AlloyDB cluster created by DMS. An object containing a list of 'key', 'value' pairs.



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 501

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

  # The username/password for a database user. Used for specifying initial
  # users at cluster creation time.
  # @!attribute [rw] user
  #   @return [::String]
  #     The database username.
  # @!attribute [rw] password
  #   @return [::String]
  #     The initial password for the user.
  # @!attribute [r] password_set
  #   @return [::Boolean]
  #     Output only. Indicates if the initial_user.password field has been set.
  class UserPassword
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for the cluster's primary instance
  # @!attribute [rw] id
  #   @return [::String]
  #     Required. The ID of the AlloyDB primary instance. The ID must satisfy the
  #     regex expression "[a-z0-9-]+".
  # @!attribute [rw] machine_config
  #   @return [::Google::Cloud::CloudDMS::V1::AlloyDbSettings::PrimaryInstanceSettings::MachineConfig]
  #     Configuration for the machines that host the underlying
  #     database engine.
  # @!attribute [rw] database_flags
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Database flags to pass to AlloyDB when DMS is creating the AlloyDB
  #     cluster and instances. See the AlloyDB documentation for how these can be
  #     used.
  # @!attribute [rw] labels
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Labels for the AlloyDB primary instance created by DMS. An object
  #     containing a list of 'key', 'value' pairs.
  # @!attribute [r] private_ip
  #   @return [::String]
  #     Output only. The private IP address for the Instance.
  #     This is the connection endpoint for an end-user application.
  class PrimaryInstanceSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # MachineConfig describes the configuration of a machine.
    # @!attribute [rw] cpu_count
    #   @return [::Integer]
    #     The number of CPU's in the VM instance.
    class MachineConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class DatabaseFlagsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class LabelsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # EncryptionConfig describes the encryption config of a cluster that is
  # encrypted with a CMEK (customer-managed encryption key).
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     The fully-qualified resource name of the KMS key.
  #     Each Cloud KMS key is regionalized and has the following format:
  #     projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#primary_instance_settings ⇒ ::Google::Cloud::CloudDMS::V1::AlloyDbSettings::PrimaryInstanceSettings

Returns:



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 501

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

  # The username/password for a database user. Used for specifying initial
  # users at cluster creation time.
  # @!attribute [rw] user
  #   @return [::String]
  #     The database username.
  # @!attribute [rw] password
  #   @return [::String]
  #     The initial password for the user.
  # @!attribute [r] password_set
  #   @return [::Boolean]
  #     Output only. Indicates if the initial_user.password field has been set.
  class UserPassword
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for the cluster's primary instance
  # @!attribute [rw] id
  #   @return [::String]
  #     Required. The ID of the AlloyDB primary instance. The ID must satisfy the
  #     regex expression "[a-z0-9-]+".
  # @!attribute [rw] machine_config
  #   @return [::Google::Cloud::CloudDMS::V1::AlloyDbSettings::PrimaryInstanceSettings::MachineConfig]
  #     Configuration for the machines that host the underlying
  #     database engine.
  # @!attribute [rw] database_flags
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Database flags to pass to AlloyDB when DMS is creating the AlloyDB
  #     cluster and instances. See the AlloyDB documentation for how these can be
  #     used.
  # @!attribute [rw] labels
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Labels for the AlloyDB primary instance created by DMS. An object
  #     containing a list of 'key', 'value' pairs.
  # @!attribute [r] private_ip
  #   @return [::String]
  #     Output only. The private IP address for the Instance.
  #     This is the connection endpoint for an end-user application.
  class PrimaryInstanceSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # MachineConfig describes the configuration of a machine.
    # @!attribute [rw] cpu_count
    #   @return [::Integer]
    #     The number of CPU's in the VM instance.
    class MachineConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class DatabaseFlagsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class LabelsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # EncryptionConfig describes the encryption config of a cluster that is
  # encrypted with a CMEK (customer-managed encryption key).
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     The fully-qualified resource name of the KMS key.
  #     Each Cloud KMS key is regionalized and has the following format:
  #     projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#vpc_network ⇒ ::String

Returns Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number}/global/networks/{network_id}". This is required to create a cluster.

Returns:

  • (::String) —

    Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number}/global/networks/{network_id}". This is required to create a cluster.



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 501

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

  # The username/password for a database user. Used for specifying initial
  # users at cluster creation time.
  # @!attribute [rw] user
  #   @return [::String]
  #     The database username.
  # @!attribute [rw] password
  #   @return [::String]
  #     The initial password for the user.
  # @!attribute [r] password_set
  #   @return [::Boolean]
  #     Output only. Indicates if the initial_user.password field has been set.
  class UserPassword
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for the cluster's primary instance
  # @!attribute [rw] id
  #   @return [::String]
  #     Required. The ID of the AlloyDB primary instance. The ID must satisfy the
  #     regex expression "[a-z0-9-]+".
  # @!attribute [rw] machine_config
  #   @return [::Google::Cloud::CloudDMS::V1::AlloyDbSettings::PrimaryInstanceSettings::MachineConfig]
  #     Configuration for the machines that host the underlying
  #     database engine.
  # @!attribute [rw] database_flags
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Database flags to pass to AlloyDB when DMS is creating the AlloyDB
  #     cluster and instances. See the AlloyDB documentation for how these can be
  #     used.
  # @!attribute [rw] labels
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Labels for the AlloyDB primary instance created by DMS. An object
  #     containing a list of 'key', 'value' pairs.
  # @!attribute [r] private_ip
  #   @return [::String]
  #     Output only. The private IP address for the Instance.
  #     This is the connection endpoint for an end-user application.
  class PrimaryInstanceSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # MachineConfig describes the configuration of a machine.
    # @!attribute [rw] cpu_count
    #   @return [::Integer]
    #     The number of CPU's in the VM instance.
    class MachineConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class DatabaseFlagsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class LabelsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # EncryptionConfig describes the encryption config of a cluster that is
  # encrypted with a CMEK (customer-managed encryption key).
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     The fully-qualified resource name of the KMS key.
  #     Each Cloud KMS key is regionalized and has the following format:
  #     projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end