Creates a new connection profile in a given project and location.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: datamigration1 --scope <scope> projects locations-connection-profiles-create ...

Required Scalar Argument

  • <parent> (string)
    • Required. The parent which owns this collection of connection profiles.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

ConnectionProfile:
  alloydb:
    cluster-id: string
    settings:
      database-version: string
      encryption-config:
        kms-key-name: string
      initial-user:
        password: string
        password-set: boolean
        user: string
      labels: { string: string }
      primary-instance-settings:
        database-flags: { string: string }
        id: string
        labels: { string: string }
        machine-config:
          cpu-count: integer
        private-ip: string
      vpc-network: string
  cloudsql:
    additional-public-ip: string
    cloud-sql-id: string
    private-ip: string
    public-ip: string
    settings:
      activation-policy: string
      auto-storage-increase: boolean
      availability-type: string
      cmek-key-name: string
      collation: string
      data-cache-config:
        data-cache-enabled: boolean
      data-disk-size-gb: string
      data-disk-type: string
      database-flags: { string: string }
      database-version: string
      edition: string
      ip-config:
        allocated-ip-range: string
        enable-ipv4: boolean
        private-network: string
        require-ssl: boolean
      root-password: string
      root-password-set: boolean
      secondary-zone: string
      source-id: string
      storage-auto-resize-limit: string
      tier: string
      user-labels: { string: string }
      zone: string
  create-time: string
  display-name: string
  error:
    code: integer
    message: string
  labels: { string: string }
  mysql:
    cloud-sql-id: string
    host: string
    password: string
    password-set: boolean
    port: integer
    ssl:
      ca-certificate: string
      client-certificate: string
      client-key: string
      type: string
    username: string
  name: string
  oracle:
    database-service: string
    forward-ssh-connectivity:
      hostname: string
      password: string
      port: integer
      private-key: string
      username: string
    host: string
    password: string
    password-set: boolean
    port: integer
    private-connectivity:
      private-connection: string
    ssl:
      ca-certificate: string
      client-certificate: string
      client-key: string
      type: string
    username: string
  postgresql:
    alloydb-cluster-id: string
    cloud-sql-id: string
    host: string
    network-architecture: string
    password: string
    password-set: boolean
    port: integer
    private-service-connect-connectivity:
      service-attachment: string
    ssl:
      ca-certificate: string
      client-certificate: string
      client-key: string
      type: string
    username: string
  provider: string
  state: string
  update-time: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r .alloydb cluster-id=et
    • Required. The AlloyDB cluster ID that this connection profile is associated with.
  • settings database-version=magna
    • 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.

  • encryption-config kms-key-name=no

    • 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 password=ipsum

    • The initial password for the user.
  • password-set=false
    • Output only. Indicates if the initial_user.password field has been set.

  • user=amet.

    • The database username.

  • .. labels=key=takimata

    • Labels for the AlloyDB cluster created by DMS. An object containing a list of 'key', 'value' pairs.
    • the value will be associated with the given key
  • primary-instance-settings database-flags=key=amet.
    • 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.
    • the value will be associated with the given key
  • id=duo
    • Required. The ID of the AlloyDB primary instance. The ID must satisfy the regex expression "[a-z0-9-]+".
  • labels=key=ipsum
    • Labels for the AlloyDB primary instance created by DMS. An object containing a list of 'key', 'value' pairs.
    • the value will be associated with the given key

  • machine-config cpu-count=39

    • The number of CPU's in the VM instance.

  • .. private-ip=lorem

    • Output only. The private IP address for the Instance. This is the connection endpoint for an end-user application.

  • .. vpc-network=gubergren

    • 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.

  • ...cloudsql additional-public-ip=eos

    • 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=dolor
    • Output only. The Cloud SQL instance ID that this connection profile is associated with.
  • private-ip=ea
    • Output only. The Cloud SQL database instance's private IP.
  • public-ip=ipsum
    • Output only. The Cloud SQL database instance's public IP.
  • settings activation-policy=invidunt
    • 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.
  • auto-storage-increase=true
    • [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=duo
    • 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).
  • cmek-key-name=ipsum
    • The KMS key name used for the csql instance.
  • collation=sed
    • The Cloud SQL default instance level collation.

  • data-cache-config data-cache-enabled=true

    • Optional. Whether data cache is enabled for the instance.

  • .. data-disk-size-gb=ipsum

    • The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.
  • data-disk-type=ipsum
    • The type of storage: PD_SSD (default) or PD_HDD.
  • database-flags=key=est
    • The database flags passed to the Cloud SQL instance at startup. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
    • the value will be associated with the given key
  • database-version=gubergren
    • The database engine type and version.
  • edition=ea
    • Optional. The edition of the given Cloud SQL instance.
  • ip-config allocated-ip-range=dolor
    • 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.
  • enable-ipv4=true
    • Whether the instance should be assigned an IPv4 address or not.
  • private-network=eos
    • 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=false

    • Whether SSL connections over IP should be enforced or not.

  • .. root-password=sed

    • Input only. Initial root password.
  • root-password-set=false
    • Output only. Indicates If this connection profile root password is stored.
  • secondary-zone=sed
    • 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=no
    • 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=stet
    • The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
  • tier=kasd
    • 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=key=et
    • 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: { &#34;name&#34;: &#34;wrench&#34;, &#34;mass&#34;: &#34;18kg&#34;, &#34;count&#34;: &#34;3&#34; }.
    • the value will be associated with the given key

  • zone=sed

    • The Google Cloud Platform zone where your Cloud SQL database instance is located.

  • ... create-time=et

    • 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".
  • display-name=et
    • The connection profile display name.
  • error code=25
    • The status code, which should be an enum value of google.rpc.Code.

  • message=erat

    • 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.

  • .. labels=key=sed

    • The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: { &#34;name&#34;: &#34;wrench&#34;, &#34;mass&#34;: &#34;1.3kg&#34;, &#34;count&#34;: &#34;3&#34; }.
    • the value will be associated with the given key
  • mysql cloud-sql-id=duo
    • If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.
  • host=dolore
    • Required. The IP or hostname of the source MySQL database.
  • password=et
    • 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=false
    • Output only. Indicates If this connection profile password is stored.
  • port=9
    • Required. The network port of the source MySQL database.
  • ssl ca-certificate=dolor
    • 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=et
    • 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=et
    • 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=sadipscing

    • Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'.

  • .. username=stet

    • 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=dolor

    • The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}.
  • oracle database-service=duo
    • Required. Database service for the Oracle connection.
  • forward-ssh-connectivity hostname=vero
    • Required. Hostname for the SSH tunnel.
  • password=vero
    • Input only. SSH password.
  • port=13
    • Port for the SSH tunnel, default value is 22.
  • private-key=stet
    • Input only. SSH private key.

  • username=vero

    • Required. Username for the SSH tunnel.

  • .. host=elitr

    • Required. The IP or hostname of the source Oracle database.
  • password=lorem
    • 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=true
    • Output only. Indicates whether a new password is included in the request.
  • port=1
    • Required. The network port of the source Oracle database.

  • private-connectivity private-connection=accusam

    • Required. The resource name (URI) of the private connection.

  • ..ssl ca-certificate=takimata

    • 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=consetetur
    • 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=voluptua.
    • 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=et

    • Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'.

  • .. username=erat

    • Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.

  • ..postgresql alloydb-cluster-id=consetetur

    • Optional. If the destination is an AlloyDB database, use this field to provide the AlloyDB cluster ID.
  • cloud-sql-id=amet.
    • If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.
  • host=sed
    • Required. The IP or hostname of the source PostgreSQL database.
  • network-architecture=takimata
    • Output only. If the source is a Cloud SQL database, this field indicates the network architecture it's associated with.
  • password=dolores
    • 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=true
    • Output only. Indicates If this connection profile password is stored.
  • port=27
    • Required. The network port of the source PostgreSQL database.

  • private-service-connect-connectivity service-attachment=accusam

    • Required. A service attachment that exposes a database, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name}

  • ..ssl ca-certificate=voluptua.

    • 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=dolore
    • 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=dolore
    • 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=dolore

    • Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'.

  • .. username=voluptua.

    • Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.

  • .. provider=amet.

    • The database provider.
  • state=ea
    • The current connection profile state (e.g. DRAFT, READY, or FAILED).
  • update-time=sadipscing
    • 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".

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p connection-profile-id=string

    • Required. The connection profile identifier.

  • -p request-id=string

    • Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

  • -p skip-validation=boolean

    • Optional. Create the connection profile without validating it. The default is false. Only supported for Oracle connection profiles.

  • -p validate-only=boolean

    • Optional. Only validate the connection profile, but don't create any resources. The default is false. Only supported for Oracle connection profiles.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").