Google Cloud Dms V1 Client - Class AlloyDbSettings (1.3.0)

Reference documentation and code samples for the Google Cloud Dms V1 Client class AlloyDbSettings.

Settings for creating an AlloyDB cluster.

Generated from protobuf message google.cloud.clouddms.v1.AlloyDbSettings

Namespace

Google \ Cloud \ CloudDms \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ initial_user Google\Cloud\CloudDms\V1\AlloyDbSettings\UserPassword

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

↳ vpc_network 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.

↳ labels array|Google\Protobuf\Internal\MapField

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

↳ primary_instance_settings Google\Cloud\CloudDms\V1\AlloyDbSettings\PrimaryInstanceSettings
↳ encryption_config 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.

getInitialUser

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

Required.

Returns
TypeDescription
Google\Cloud\CloudDms\V1\AlloyDbSettings\UserPassword|null

hasInitialUser

clearInitialUser

setInitialUser

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

Required.

Parameter
NameDescription
var Google\Cloud\CloudDms\V1\AlloyDbSettings\UserPassword
Returns
TypeDescription
$this

getVpcNetwork

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
TypeDescription
string

setVpcNetwork

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLabels

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

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

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

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getPrimaryInstanceSettings

Generated from protobuf field .google.cloud.clouddms.v1.AlloyDbSettings.PrimaryInstanceSettings primary_instance_settings = 4;

Returns
TypeDescription
Google\Cloud\CloudDms\V1\AlloyDbSettings\PrimaryInstanceSettings|null

hasPrimaryInstanceSettings

clearPrimaryInstanceSettings

setPrimaryInstanceSettings

Generated from protobuf field .google.cloud.clouddms.v1.AlloyDbSettings.PrimaryInstanceSettings primary_instance_settings = 4;

Parameter
NameDescription
var Google\Cloud\CloudDms\V1\AlloyDbSettings\PrimaryInstanceSettings
Returns
TypeDescription
$this

getEncryptionConfig

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
TypeDescription
Google\Cloud\CloudDms\V1\AlloyDbSettings\EncryptionConfig|null

hasEncryptionConfig

clearEncryptionConfig

setEncryptionConfig

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.

Parameter
NameDescription
var Google\Cloud\CloudDms\V1\AlloyDbSettings\EncryptionConfig
Returns
TypeDescription
$this