This product is not supported for your selected Datadog site. ().

gcp_datamigration_connection_profile

alloydb

Type: STRUCT
Provider name: alloydb
Description: An AlloyDB cluster connection profile.

  • cluster_id
    Type: STRING
    Provider name: clusterId
    Description: Required. The AlloyDB cluster ID that this connection profile is associated with.
  • settings
    Type: STRUCT
    Provider name: settings
    Description: Immutable. Metadata used to create the destination AlloyDB cluster.
    • database_version
      Type: STRING
      Provider name: databaseVersion
      Description: Optional. The database engine major version. This is an optional field. If a database version is not supplied at cluster creation time, then a default database version will be used.
      Possible values:
      • DATABASE_VERSION_UNSPECIFIED - This is an unknown database version.
      • POSTGRES_14 - The database version is Postgres 14.
      • POSTGRES_15 - The database version is Postgres 15.
      • POSTGRES_16 - The database version is Postgres 16.
    • encryption_config
      Type: STRUCT
      Provider name: encryptionConfig
      Description: 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.
      • kms_key_name
        Type: STRING
        Provider name: kmsKeyName
        Description: 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]
    • initial_user
      Type: STRUCT
      Provider name: initialUser
      Description: Required. Input only. Initial user to setup during cluster creation. Required.
      • password
        Type: STRING
        Provider name: password
        Description: The initial password for the user.
      • password_set
        Type: BOOLEAN
        Provider name: passwordSet
        Description: Output only. Indicates if the initial_user.password field has been set.
      • user
        Type: STRING
        Provider name: user
        Description: The database username.
    • primary_instance_settings
      Type: STRUCT
      Provider name: primaryInstanceSettings
      • id
        Type: STRING
        Provider name: id
        Description: Required. The ID of the AlloyDB primary instance. The ID must satisfy the regex expression “[a-z0-9-]+”.
      • instance_network_config
        Type: STRUCT
        Provider name: instanceNetworkConfig
        Description: Optional. Metadata related to instance level network configuration.
        • authorized_external_networks
          Type: UNORDERED_LIST_STRUCT
          Provider name: authorizedExternalNetworks
          Description: Optional. A list of external network authorized to access this instance.
          • cidr_range
            Type: STRING
            Provider name: cidrRange
            Description: Optional. CIDR range for one authorzied network of the instance.
        • enable_outbound_public_ip
          Type: BOOLEAN
          Provider name: enableOutboundPublicIp
          Description: Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet.
        • enable_public_ip
          Type: BOOLEAN
          Provider name: enablePublicIp
          Description: Optional. Enabling public ip for the instance.
      • machine_config
        Type: STRUCT
        Provider name: machineConfig
        Description: Configuration for the machines that host the underlying database engine.
        • cpu_count
          Type: INT32
          Provider name: cpuCount
          Description: The number of CPU’s in the VM instance.
        • machine_type
          Type: STRING
          Provider name: machineType
          Description: Optional. Machine type of the VM instance. E.g. “n2-highmem-4”, “n2-highmem-8”, “c4a-highmem-4-lssd”. cpu_count must match the number of vCPUs in the machine type.
      • outbound_public_ip_addresses
        Type: UNORDERED_LIST_STRING
        Provider name: outboundPublicIpAddresses
        Description: Output only. All outbound public IP addresses configured for the instance.
      • private_ip
        Type: STRING
        Provider name: privateIp
        Description: Output only. The private IP address for the Instance. This is the connection endpoint for an end-user application.
    • vpc_network
      Type: STRING
      Provider name: vpcNetwork
      Description: 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.

ancestors

Type: UNORDERED_LIST_STRING

cloudsql

Type: STRUCT
Provider name: cloudsql
Description: A CloudSQL database connection profile.

  • additional_public_ip
    Type: STRING
    Provider name: additionalPublicIp
    Description: Output only. The Cloud SQL database instance’s additional (outgoing) public IP. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available).
  • cloud_sql_id
    Type: STRING
    Provider name: cloudSqlId
    Description: Output only. The Cloud SQL instance ID that this connection profile is associated with.
  • private_ip
    Type: STRING
    Provider name: privateIp
    Description: Output only. The Cloud SQL database instance’s private IP.
  • public_ip
    Type: STRING
    Provider name: publicIp
    Description: Output only. The Cloud SQL database instance’s public IP.
  • settings
    Type: STRUCT
    Provider name: settings
    Description: Immutable. Metadata used to create the destination Cloud SQL database.
    • activation_policy
      Type: STRING
      Provider name: activationPolicy
      Description: The activation policy specifies when the instance is activated; it is applicable only when the instance state is ‘RUNNABLE’. Valid values: ‘ALWAYS’: The instance is on, and remains so even in the absence of connection requests. NEVER: The instance is off; it is not activated, even if a connection request arrives.
      Possible values:
      • SQL_ACTIVATION_POLICY_UNSPECIFIED - unspecified policy.
      • ALWAYS - The instance is always up and running.
      • NEVER - The instance should never spin up.
    • auto_storage_increase
      Type: BOOLEAN
      Provider name: autoStorageIncrease
      Description: [default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.
    • availability_type
      Type: STRING
      Provider name: availabilityType
      Description: Optional. Availability type. Potential values: * ZONAL: The instance serves data from only one zone. Outages in that zone affect data availability. * REGIONAL: The instance can serve data from more than one zone in a region (it is highly available).
      Possible values:
      • SQL_AVAILABILITY_TYPE_UNSPECIFIED - This is an unknown Availability type.
      • ZONAL - Zonal availablility instance.
      • REGIONAL - Regional availability instance.
    • cmek_key_name
      Type: STRING
      Provider name: cmekKeyName
      Description: The KMS key name used for the csql instance.
    • collation
      Type: STRING
      Provider name: collation
      Description: The Cloud SQL default instance level collation.
    • data_cache_config
      Type: STRUCT
      Provider name: dataCacheConfig
      Description: Optional. Data cache is an optional feature available for Cloud SQL for MySQL Enterprise Plus edition only. For more information on data cache, see Data cache overview in Cloud SQL documentation.
      • data_cache_enabled
        Type: BOOLEAN
        Provider name: dataCacheEnabled
        Description: Optional. Whether data cache is enabled for the instance.
    • data_disk_provisioned_iops
      Type: INT64
      Provider name: dataDiskProvisionedIops
      Description: Optional. Provisioned number of I/O operations per second for the data disk. This field is only used for hyperdisk-balanced disk types.
    • data_disk_provisioned_throughput
      Type: INT64
      Provider name: dataDiskProvisionedThroughput
      Description: Optional. Provisioned throughput measured in MiB per second for the data disk. This field is only used for hyperdisk-balanced disk types.
    • data_disk_size_gb
      Type: INT64
      Provider name: dataDiskSizeGb
      Description: The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.
    • data_disk_type
      Type: STRING
      Provider name: dataDiskType
      Description: The type of storage: PD_SSD (default) or PD_HDD or HYPERDISK_BALANCED.
      Possible values:
      • SQL_DATA_DISK_TYPE_UNSPECIFIED - Unspecified.
      • PD_SSD - SSD disk.
      • PD_HDD - HDD disk.
      • HYPERDISK_BALANCED - A Hyperdisk Balanced data disk.
    • database_version
      Type: STRING
      Provider name: databaseVersion
      Description: The database engine type and version. Deprecated. Use database_version_name instead.
      Possible values:
      • SQL_DATABASE_VERSION_UNSPECIFIED - Unspecified version.
      • MYSQL_5_6 - MySQL 5.6.
      • MYSQL_5_7 - MySQL 5.7.
      • MYSQL_8_0 - MySQL 8.0.
      • MYSQL_8_0_18 - The database major version is MySQL 8.0 and the minor version is 18.
      • MYSQL_8_0_26 - The database major version is MySQL 8.0 and the minor version is 26.
      • MYSQL_8_0_27 - The database major version is MySQL 8.0 and the minor version is 27.
      • MYSQL_8_0_28 - The database major version is MySQL 8.0 and the minor version is 28.
      • MYSQL_8_0_30 - The database major version is MySQL 8.0 and the minor version is 30.
      • MYSQL_8_0_31 - The database major version is MySQL 8.0 and the minor version is 31.
      • MYSQL_8_0_32 - The database major version is MySQL 8.0 and the minor version is 32.
      • MYSQL_8_0_33 - The database major version is MySQL 8.0 and the minor version is 33.
      • MYSQL_8_0_34 - The database major version is MySQL 8.0 and the minor version is 34.
      • MYSQL_8_0_35 - The database major version is MySQL 8.0 and the minor version is 35.
      • MYSQL_8_0_36 - The database major version is MySQL 8.0 and the minor version is 36.
      • MYSQL_8_0_37 - The database major version is MySQL 8.0 and the minor version is 37.
      • MYSQL_8_4 - MySQL 8.4.
      • POSTGRES_9_6 - PostgreSQL 9.6.
      • POSTGRES_11 - PostgreSQL 11.
      • POSTGRES_10 - PostgreSQL 10.
      • POSTGRES_12 - PostgreSQL 12.
      • POSTGRES_13 - PostgreSQL 13.
      • POSTGRES_14 - PostgreSQL 14.
      • POSTGRES_15 - PostgreSQL 15.
      • POSTGRES_16 - PostgreSQL 16.
    • database_version_name
      Type: STRING
      Provider name: databaseVersionName
      Description: Optional. The database engine type and version name.
    • edition
      Type: STRING
      Provider name: edition
      Description: Optional. The edition of the given Cloud SQL instance.
      Possible values:
      • EDITION_UNSPECIFIED - The instance did not specify the edition.
      • ENTERPRISE - The instance is an enterprise edition.
      • ENTERPRISE_PLUS - The instance is an enterprise plus edition.
    • ip_config
      Type: STRUCT
      Provider name: ipConfig
      Description: The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.
      • allocated_ip_range
        Type: STRING
        Provider name: allocatedIpRange
        Description: Optional. The name of the allocated IP address range for the private IP Cloud SQL instance. This name refers to an already allocated IP range address. If set, the instance IP address will be created in the allocated range. Note that this IP address range can’t be modified after the instance is created. If you change the VPC when configuring connectivity settings for the migration job, this field is not relevant.
      • authorized_networks
        Type: UNORDERED_LIST_STRUCT
        Provider name: authorizedNetworks
        Description: The list of external networks that are allowed to connect to the instance using the IP. See https://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation, also known as ‘slash’ notation (e.g. 192.168.100.0/24).
        • expire_time
          Type: TIMESTAMP
          Provider name: expireTime
          Description: The time when this access control entry expires in RFC 3339 format, for example: 2012-11-15T16:19:00.094Z.
        • label
          Type: STRING
          Provider name: label
          Description: A label to identify this entry.
        • ttl
          Type: STRING
          Provider name: ttl
          Description: Input only. The time-to-leave of this access control entry.
        • value
          Type: STRING
          Provider name: value
          Description: The allowlisted value for the access control list.
      • enable_ipv4
        Type: BOOLEAN
        Provider name: enableIpv4
        Description: Whether the instance should be assigned an IPv4 address or not.
      • private_network
        Type: STRING
        Provider name: privateNetwork
        Description: The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, projects/myProject/global/networks/default. This setting can be updated, but it cannot be removed after it is set.
      • require_ssl
        Type: BOOLEAN
        Provider name: requireSsl
        Description: Whether SSL connections over IP should be enforced or not.
    • root_password
      Type: STRING
      Provider name: rootPassword
      Description: Input only. Initial root password.
    • root_password_set
      Type: BOOLEAN
      Provider name: rootPasswordSet
      Description: Output only. Indicates If this connection profile root password is stored.
    • secondary_zone
      Type: STRING
      Provider name: secondaryZone
      Description: Optional. The Google Cloud Platform zone where the failover Cloud SQL database instance is located. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available).
    • source_id
      Type: STRING
      Provider name: sourceId
      Description: The Database Migration Service source connection profile ID, in the format: projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID
    • storage_auto_resize_limit
      Type: INT64
      Provider name: storageAutoResizeLimit
      Description: The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
    • tier
      Type: STRING
      Provider name: tier
      Description: The tier (or machine type) for this instance, for example: db-n1-standard-1 (MySQL instances) or db-custom-1-3840 (PostgreSQL instances). For more information, see Cloud SQL Instance Settings.
    • user_labels
      Type: MAP_STRING_STRING
      Provider name: userLabels
      Description: The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of “key”: “value” pairs. Example: { "name": "wrench", "mass": "18kg", "count": "3" }.
    • zone
      Type: STRING
      Provider name: zone
      Description: The Google Cloud Platform zone where your Cloud SQL database instance is located.

create_time

Type: TIMESTAMP
Provider name: createTime
Description: Output only. The timestamp when the resource was created. A timestamp in RFC3339 UTC “Zulu” format, accurate to nanoseconds. Example: “2014-10-02T15:01:23.045123456Z”.

error

Type: STRUCT
Provider name: error
Description: Output only. The error details in case of state FAILED.

  • code
    Type: INT32
    Provider name: code
    Description: The status code, which should be an enum value of google.rpc.Code.
  • message
    Type: STRING
    Provider name: message
    Description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

gcp_display_name

Type: STRING
Provider name: displayName
Description: The connection profile display name.

labels

Type: UNORDERED_LIST_STRING

mysql

Type: STRUCT
Provider name: mysql
Description: A MySQL database connection profile.

  • cloud_sql_id
    Type: STRING
    Provider name: cloudSqlId
    Description: If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.
  • host
    Type: STRING
    Provider name: host
    Description: Required. The IP or hostname of the source MySQL database.
  • password
    Type: STRING
    Provider name: password
    Description: Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.
  • password_set
    Type: BOOLEAN
    Provider name: passwordSet
    Description: Output only. Indicates If this connection profile password is stored.
  • port
    Type: INT32
    Provider name: port
    Description: Required. The network port of the source MySQL database.
  • ssl
    Type: STRUCT
    Provider name: ssl
    Description: SSL configuration for the destination to connect to the source database.
    • ca_certificate
      Type: STRING
      Provider name: caCertificate
      Description: Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server’s certificate. The replica will use this certificate to verify it’s connecting to the right host.
    • client_certificate
      Type: STRING
      Provider name: clientCertificate
      Description: Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the ‘client_key’ field is mandatory.
    • client_key
      Type: STRING
      Provider name: clientKey
      Description: Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the ‘client_certificate’ field is mandatory.
    • type
      Type: STRING
      Provider name: type
      Description: Optional. The ssl config type according to ‘client_key’, ‘client_certificate’ and ‘ca_certificate’.
      Possible values:
      • SSL_TYPE_UNSPECIFIED - Unspecified.
      • SERVER_ONLY - Only ‘ca_certificate’ specified.
      • SERVER_CLIENT - Both server (‘ca_certificate’), and client (‘client_key
      • REQUIRED - client_certificate’) specified.
      • NONE - Mandates SSL encryption for all connections. This doesn’t require certificate verification.
  • username
    Type: STRING
    Provider name: username
    Description: Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.

name

Type: STRING
Provider name: name
Description: The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}.

oracle

Type: STRUCT
Provider name: oracle
Description: An Oracle database connection profile.

  • database_service
    Type: STRING
    Provider name: databaseService
    Description: Required. Database service for the Oracle connection.

  • forward_ssh_connectivity
    Type: STRUCT
    Provider name: forwardSshConnectivity
    Description: Forward SSH tunnel connectivity.

    • hostname
      Type: STRING
      Provider name: hostname
      Description: Required. Hostname for the SSH tunnel.
    • password
      Type: STRING
      Provider name: password
      Description: Input only. SSH password.
    • port
      Type: INT32
      Provider name: port
      Description: Port for the SSH tunnel, default value is 22.
    • private_key
      Type: STRING
      Provider name: privateKey
      Description: Input only. SSH private key.
    • username
      Type: STRING
      Provider name: username
      Description: Required. Username for the SSH tunnel.

  • host
    Type: STRING
    Provider name: host
    Description: Required. The IP or hostname of the source Oracle database.

  • oracle_asm_config
    Type: STRUCT
    Provider name: oracleAsmConfig
    Description: Optional. Configuration for Oracle ASM connection.

    • asm_service
      Type: STRING
      Provider name: asmService
      Description: Required. ASM service name for the Oracle ASM connection.
    • hostname
      Type: STRING
      Provider name: hostname
      Description: Required. Hostname for the Oracle ASM connection.
    • password
      Type: STRING
      Provider name: password
      Description: Required. Input only. Password for the Oracle ASM connection.
    • password_set
      Type: BOOLEAN
      Provider name: passwordSet
      Description: Output only. Indicates whether a new password is included in the request.
    • port
      Type: INT32
      Provider name: port
      Description: Required. Port for the Oracle ASM connection.
    • ssl
      Type: STRUCT
      Provider name: ssl
      Description: Optional. SSL configuration for the Oracle connection.
      • ca_certificate
        Type: STRING
        Provider name: caCertificate
        Description: Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server’s certificate. The replica will use this certificate to verify it’s connecting to the right host.
      • client_certificate
        Type: STRING
        Provider name: clientCertificate
        Description: Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the ‘client_key’ field is mandatory.
      • client_key
        Type: STRING
        Provider name: clientKey
        Description: Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the ‘client_certificate’ field is mandatory.
      • type
        Type: STRING
        Provider name: type
        Description: Optional. The ssl config type according to ‘client_key’, ‘client_certificate’ and ‘ca_certificate’.
        Possible values:
        • SSL_TYPE_UNSPECIFIED - Unspecified.
        • SERVER_ONLY - Only ‘ca_certificate’ specified.
        • SERVER_CLIENT - Both server (‘ca_certificate’), and client (‘client_key
        • REQUIRED - client_certificate’) specified.
        • NONE - Mandates SSL encryption for all connections. This doesn’t require certificate verification.
    • username
      Type: STRING
      Provider name: username
      Description: Required. Username for the Oracle ASM connection.

  • password
    Type: STRING
    Provider name: password
    Description: Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.

  • password_set
    Type: BOOLEAN
    Provider name: passwordSet
    Description: Output only. Indicates whether a new password is included in the request.

  • port
    Type: INT32
    Provider name: port
    Description: Required. The network port of the source Oracle database.

  • private_connectivity
    Type: STRUCT
    Provider name: privateConnectivity
    Description: Private connectivity.

    • private_connection
      Type: STRING
      Provider name: privateConnection
      Description: Required. The resource name (URI) of the private connection.

  • ssl
    Type: STRUCT
    Provider name: ssl
    Description: SSL configuration for the connection to the source Oracle database. * Only SERVER_ONLY configuration is supported for Oracle SSL. * SSL is supported for Oracle versions 12 and above.

    • ca_certificate
      Type: STRING
      Provider name: caCertificate
      Description: Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server’s certificate. The replica will use this certificate to verify it’s connecting to the right host.
    • client_certificate
      Type: STRING
      Provider name: clientCertificate
      Description: Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the ‘client_key’ field is mandatory.
    • client_key
      Type: STRING
      Provider name: clientKey
      Description: Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the ‘client_certificate’ field is mandatory.
    • type
      Type: STRING
      Provider name: type
      Description: Optional. The ssl config type according to ‘client_key’, ‘client_certificate’ and ‘ca_certificate’.
      Possible values:
      • SSL_TYPE_UNSPECIFIED - Unspecified.
      • SERVER_ONLY - Only ‘ca_certificate’ specified.
      • SERVER_CLIENT - Both server (‘ca_certificate’), and client (‘client_key
      • REQUIRED - client_certificate’) specified.
      • NONE - Mandates SSL encryption for all connections. This doesn’t require certificate verification.

  • static_service_ip_connectivity
    Type: STRUCT
    Provider name: staticServiceIpConnectivity
    Description: Static Service IP connectivity.

  • username
    Type: STRING
    Provider name: username
    Description: Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.

organization_id

Type: STRING

parent

Type: STRING

postgresql

Type: STRUCT
Provider name: postgresql
Description: A PostgreSQL database connection profile.

  • alloydb_cluster_id
    Type: STRING
    Provider name: alloydbClusterId
    Description: Optional. If the destination is an AlloyDB database, use this field to provide the AlloyDB cluster ID.

  • cloud_sql_id
    Type: STRING
    Provider name: cloudSqlId
    Description: If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.

  • database
    Type: STRING
    Provider name: database
    Description: Optional. The name of the specific database within the host.

  • host
    Type: STRING
    Provider name: host
    Description: Required. The IP or hostname of the source PostgreSQL database.

  • network_architecture
    Type: STRING
    Provider name: networkArchitecture
    Description: Output only. If the source is a Cloud SQL database, this field indicates the network architecture it’s associated with.
    Possible values:

    • NETWORK_ARCHITECTURE_UNSPECIFIED
    • NETWORK_ARCHITECTURE_OLD_CSQL_PRODUCER - Instance is in Cloud SQL’s old producer network architecture.
    • NETWORK_ARCHITECTURE_NEW_CSQL_PRODUCER - Instance is in Cloud SQL’s new producer network architecture.

  • password
    Type: STRING
    Provider name: password
    Description: Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.

  • password_set
    Type: BOOLEAN
    Provider name: passwordSet
    Description: Output only. Indicates If this connection profile password is stored.

  • port
    Type: INT32
    Provider name: port
    Description: Required. The network port of the source PostgreSQL database.

  • private_service_connect_connectivity
    Type: STRUCT
    Provider name: privateServiceConnectConnectivity
    Description: Private service connect connectivity.

    • service_attachment
      Type: STRING
      Provider name: serviceAttachment
      Description: Required. A service attachment that exposes a database, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name}

  • ssl
    Type: STRUCT
    Provider name: ssl
    Description: SSL configuration for the destination to connect to the source database.

    • ca_certificate
      Type: STRING
      Provider name: caCertificate
      Description: Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server’s certificate. The replica will use this certificate to verify it’s connecting to the right host.
    • client_certificate
      Type: STRING
      Provider name: clientCertificate
      Description: Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the ‘client_key’ field is mandatory.
    • client_key
      Type: STRING
      Provider name: clientKey
      Description: Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the ‘client_certificate’ field is mandatory.
    • type
      Type: STRING
      Provider name: type
      Description: Optional. The ssl config type according to ‘client_key’, ‘client_certificate’ and ‘ca_certificate’.
      Possible values:
      • SSL_TYPE_UNSPECIFIED - Unspecified.
      • SERVER_ONLY - Only ‘ca_certificate’ specified.
      • SERVER_CLIENT - Both server (‘ca_certificate’), and client (‘client_key
      • REQUIRED - client_certificate’) specified.
      • NONE - Mandates SSL encryption for all connections. This doesn’t require certificate verification.

  • static_ip_connectivity
    Type: STRUCT
    Provider name: staticIpConnectivity
    Description: Static ip connectivity data (default, no additional details needed).

  • username
    Type: STRING
    Provider name: username
    Description: Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.

project_id

Type: STRING

project_number

Type: STRING

provider

Type: STRING
Provider name: provider
Description: The database provider.
Possible values:

  • DATABASE_PROVIDER_UNSPECIFIED - Use this value for on-premise source database instances and ORACLE.
  • CLOUDSQL - Cloud SQL is the source instance provider.
  • RDS - Amazon RDS is the source instance provider.
  • AURORA - Amazon Aurora is the source instance provider.
  • ALLOYDB - AlloyDB for PostgreSQL is the source instance provider.
  • AZURE_DATABASE - Microsoft Azure Database for MySQL/PostgreSQL.

resource_name

Type: STRING

role

Type: STRING
Provider name: role
Description: Optional. The connection profile role.
Possible values:

  • ROLE_UNSPECIFIED - The role is unspecified.
  • SOURCE - The role is source.
  • DESTINATION - The role is destination.

satisfies_pzi

Type: BOOLEAN
Provider name: satisfiesPzi
Description: Output only. Reserved for future use.

satisfies_pzs

Type: BOOLEAN
Provider name: satisfiesPzs
Description: Output only. Reserved for future use.

sqlserver

Type: STRUCT
Provider name: sqlserver
Description: Connection profile for a SQL Server data source.

  • backups
    Type: STRUCT
    Provider name: backups
    Description: The backup details in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server.

    • gcs_bucket
      Type: STRING
      Provider name: gcsBucket
      Description: Required. The Cloud Storage bucket that stores backups for all replicated databases.
    • gcs_prefix
      Type: STRING
      Provider name: gcsPrefix
      Description: Optional. Cloud Storage path inside the bucket that stores backups.

  • cloud_sql_id
    Type: STRING
    Provider name: cloudSqlId
    Description: If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.

  • database
    Type: STRING
    Provider name: database
    Description: Required. The name of the specific database within the host.

  • forward_ssh_connectivity
    Type: STRUCT
    Provider name: forwardSshConnectivity
    Description: Forward SSH tunnel connectivity.

    • hostname
      Type: STRING
      Provider name: hostname
      Description: Required. Hostname for the SSH tunnel.
    • password
      Type: STRING
      Provider name: password
      Description: Input only. SSH password.
    • port
      Type: INT32
      Provider name: port
      Description: Port for the SSH tunnel, default value is 22.
    • private_key
      Type: STRING
      Provider name: privateKey
      Description: Input only. SSH private key.
    • username
      Type: STRING
      Provider name: username
      Description: Required. Username for the SSH tunnel.

  • host
    Type: STRING
    Provider name: host
    Description: Required. The IP or hostname of the source SQL Server database.

  • password
    Type: STRING
    Provider name: password
    Description: Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.

  • password_set
    Type: BOOLEAN
    Provider name: passwordSet
    Description: Output only. Indicates whether a new password is included in the request.

  • port
    Type: INT32
    Provider name: port
    Description: Required. The network port of the source SQL Server database.

  • private_connectivity
    Type: STRUCT
    Provider name: privateConnectivity
    Description: Private connectivity.

    • private_connection
      Type: STRING
      Provider name: privateConnection
      Description: Required. The resource name (URI) of the private connection.

  • private_service_connect_connectivity
    Type: STRUCT
    Provider name: privateServiceConnectConnectivity
    Description: Private Service Connect connectivity.

    • service_attachment
      Type: STRING
      Provider name: serviceAttachment
      Description: Required. A service attachment that exposes a database, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name}

  • ssl
    Type: STRUCT
    Provider name: ssl
    Description: SSL configuration for the destination to connect to the source database.

    • ca_certificate
      Type: STRING
      Provider name: caCertificate
      Description: Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server’s certificate. The replica will use this certificate to verify it’s connecting to the right host.
    • client_certificate
      Type: STRING
      Provider name: clientCertificate
      Description: Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the ‘client_key’ field is mandatory.
    • client_key
      Type: STRING
      Provider name: clientKey
      Description: Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the ‘client_certificate’ field is mandatory.
    • type
      Type: STRING
      Provider name: type
      Description: Optional. The ssl config type according to ‘client_key’, ‘client_certificate’ and ‘ca_certificate’.
      Possible values:
      • SSL_TYPE_UNSPECIFIED - Unspecified.
      • SERVER_ONLY - Only ‘ca_certificate’ specified.
      • SERVER_CLIENT - Both server (‘ca_certificate’), and client (‘client_key
      • REQUIRED - client_certificate’) specified.
      • NONE - Mandates SSL encryption for all connections. This doesn’t require certificate verification.

  • static_ip_connectivity
    Type: STRUCT
    Provider name: staticIpConnectivity
    Description: Static IP connectivity data (default, no additional details needed).

  • username
    Type: STRING
    Provider name: username
    Description: Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.

state

Type: STRING
Provider name: state
Description: The current connection profile state (e.g. DRAFT, READY, or FAILED).
Possible values:

  • STATE_UNSPECIFIED - The state of the connection profile is unknown.
  • DRAFT - The connection profile is in draft mode and fully editable.
  • CREATING - The connection profile is being created.
  • READY - The connection profile is ready.
  • UPDATING - The connection profile is being updated.
  • DELETING - The connection profile is being deleted.
  • DELETED - The connection profile has been deleted.
  • FAILED - The last action on the connection profile failed.

tags

Type: UNORDERED_LIST_STRING

update_time

Type: TIMESTAMP
Provider name: updateTime
Description: Output only. The timestamp when the resource was last updated. A timestamp in RFC3339 UTC “Zulu” format, accurate to nanoseconds. Example: “2014-10-02T15:01:23.045123456Z”.