gcloud-help/gcloud/datastream/connection-profiles/update

NAME
    gcloud datastream connection-profiles update - update a Datastream
        connection profile

SYNOPSIS
    gcloud datastream connection-profiles update
        (CONNECTION_PROFILE : --location=LOCATION) --type=TYPE
        [--display-name=DISPLAY_NAME] [--force]
        [--update-labels=[KEY=VALUE,...]]
        [--bucket=BUCKET --root-path=ROOT_PATH
          | --database-service=DATABASE_SERVICE
          --oracle-hostname=ORACLE_HOSTNAME --oracle-port=ORACLE_PORT
          --oracle-username=ORACLE_USERNAME --oracle-password=ORACLE_PASSWORD
          | --oracle-prompt-for-password | --mysql-hostname=MYSQL_HOSTNAME
          --mysql-port=MYSQL_PORT --mysql-username=MYSQL_USERNAME
          --ca-certificate=CA_CERTIFICATE
          --client-certificate=CLIENT_CERTIFICATE
          --client-key=CLIENT_KEY --mysql-password=MYSQL_PASSWORD
          | --mysql-prompt-for-password]
        [--clear-labels | --remove-labels=[KEY,...]]
        [--private-connection=PRIVATE_CONNECTION : --static-ip-connectivity
          | --forward-ssh-hostname=FORWARD_SSH_HOSTNAME
          --forward-ssh-port=FORWARD_SSH_PORT; default=22
          --forward-ssh-username=FORWARD_SSH_USERNAME
          --forward-ssh-password=FORWARD_SSH_PASSWORD
          | --forward-ssh-private-key=FORWARD_SSH_PRIVATE_KEY]
        [GCLOUD_WIDE_FLAG ...]

DESCRIPTION
    Updates a Datastream connection profile

EXAMPLES
    To update a connection profile for Oracle:

        $ gcloud datastream connection-profiles update CONNECTION_PROFILE \
          --location=us-central1 --type=oracle \
          --oracle-password=fakepassword --oracle-username=fakeuser \
          --display-name=my-profile --oracle-hostname=35.188.150.50 \
          --oracle-port=1521 --database-service=ORCL \
          --static-ip-connectivity

    To update a connection profile for Mysql:

        $ gcloud datastream connection-profiles update CONNECTION_PROFILE \
          --location=us-central1 --type=mysql \
          --mysql-password=fakepassword --mysql-username=fakeuser \
          --display-name=my-profile --mysql-hostname=35.188.150.50 \
          --mysql-port=3306 --static-ip-connectivity

    To update a connection profile for Google Cloud Storage:

        $ gcloud datastream connection-profiles update CONNECTION_PROFILE \
          --location=us-central1 --type=google-cloud-storage \
          --bucket=fake-bucket --root-path=/root/path \
          --display-name=my-profile

    To update a connection profile for Google Cloud Storage:

        $ gcloud datastream connection-profiles update CONNECTION_PROFILE \
          --location=us-central1 --type=bigquery --display-name=my-profile

POSITIONAL ARGUMENTS
     Connection profile resource - The connection profile to update. The
     arguments in this group can be used to specify the attributes of this
     resource. (NOTE) Some attributes are not given arguments in this group but
     can be set in other ways. To set the project attribute:
      ◆ provide the argument connection_profile on the command line with a
        fully specified name;
      ◆ provide the argument --project on the command line;
      ◆ set the property core/project.

     This must be specified.

       CONNECTION_PROFILE
          ID of the connection_profile or fully qualified identifier for the
          connection_profile. To set the connection_profile attribute:
          ▸ provide the argument connection_profile on the command line.

          This positional must be specified if any of the other arguments in
          this group are specified.

       --location=LOCATION
          The Cloud location for the connection_profile. To set the location
          attribute:
          ▸ provide the argument connection_profile on the command line with
            a fully specified name;
          ▸ provide the argument --location on the command line.

REQUIRED FLAGS
     --type=TYPE
        Type can be MYSQL, ORACLE, GOOGLE-CLOUD-STORAGE or BIGQUERY

OPTIONAL FLAGS
     --display-name=DISPLAY_NAME
        Friendly name for the connection profile.

     --force
        Update the connection profile without validating it.

     --update-labels=[KEY=VALUE,...]
        List of label KEY=VALUE pairs to update. If a label exists, its value
        is modified. Otherwise, a new label is created.

        Keys must start with a lowercase character and contain only hyphens
        (-), underscores (_), lowercase characters, and numbers. Values must
        contain only hyphens (-), underscores (_), lowercase characters, and
        numbers.

     At most one of these can be specified:

       --bucket=BUCKET
          The full project and resource path for Cloud Storage bucket including
          the name.

       --root-path=ROOT_PATH
          The root path inside the Cloud Storage bucket.

       --database-service=DATABASE_SERVICE
          Database service for the Oracle connection.

       --oracle-hostname=ORACLE_HOSTNAME
          IP or hostname of the oracle source database.

       --oracle-port=ORACLE_PORT
          Network port of the oracle source database.

       --oracle-username=ORACLE_USERNAME
          Username Datastream will use to connect to the database.

       At most one of these can be specified:

         --oracle-password=ORACLE_PASSWORD
            Password for the user that Datastream will be using to connect to
            the database. This field is not returned on request, and the value
            is encrypted when stored in Datastream.

         --oracle-prompt-for-password
            Prompt for the password used to connect to the database.

       --mysql-hostname=MYSQL_HOSTNAME
          IP or hostname of the mysql source database.

       --mysql-port=MYSQL_PORT
          Network port of the mysql source database.

       --mysql-username=MYSQL_USERNAME
          Username Datastream will use to connect to the database.

       --ca-certificate=CA_CERTIFICATE
          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=CLIENT_CERTIFICATE
          x509 PEM-encoded certificate that will be used by the replica to
          authenticate against the source database server.

       --client-key=CLIENT_KEY
          Unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with
          the Client Certificate.

       At most one of these can be specified:

         --mysql-password=MYSQL_PASSWORD
            Password for the user that Datastream will be using to connect to
            the database. This field is not returned on request, and the value
            is encrypted when stored in Datastream.

         --mysql-prompt-for-password
            Prompt for the password used to connect to the database.

     At most one of these can be specified:

       --clear-labels
          Remove all labels. If --update-labels is also specified then
          --clear-labels is applied first.

          For example, to remove all labels:

              $ gcloud datastream connection-profiles update --clear-labels

          To remove all existing labels and create two new labels, foo and baz:

              $ gcloud datastream connection-profiles update --clear-labels \
                --update-labels foo=bar,baz=qux

       --remove-labels=[KEY,...]
          List of label keys to remove. If a label does not exist it is
          silently ignored. If --update-labels is also specified then
          --update-labels is applied first.

     At most one of these can be specified:

       Private connection resource - Resource ID of the private connection.
       This represents a Cloud resource. (NOTE) Some attributes are not given
       arguments in this group but can be set in other ways. To set the project
       attribute:
        ▸ provide the argument --private-connection on the command line with
          a fully specified name;
        ▸ provide the argument --project on the command line;
        ▸ set the property core/project. To set the location attribute:
        ▸ provide the argument --private-connection on the command line with
          a fully specified name;
        ▸ provide the argument --location on the command line.

         --private-connection=PRIVATE_CONNECTION
            ID of the private_connection or fully qualified identifier for the
            private_connection. To set the private_connection attribute:
            ▫ provide the argument --private-connection on the command line.

       --static-ip-connectivity
          use static ip connectivity

       --forward-ssh-hostname=FORWARD_SSH_HOSTNAME
          Hostname for the SSH tunnel.

       --forward-ssh-port=FORWARD_SSH_PORT; default=22
          Port for the SSH tunnel, default value is 22.

       --forward-ssh-username=FORWARD_SSH_USERNAME
          Username for the SSH tunnel.

       At most one of these can be specified:

         --forward-ssh-password=FORWARD_SSH_PASSWORD
            SSH password.

         --forward-ssh-private-key=FORWARD_SSH_PRIVATE_KEY
            SSH private key..

GCLOUD WIDE FLAGS
    These flags are available to all commands: --access-token-file, --account,
    --billing-project, --configuration, --flags-file, --flatten, --format,
    --help, --impersonate-service-account, --log-http, --project, --quiet,
    --trace-token, --user-output-enabled, --verbosity.

    Run $ gcloud help for details.

NOTES
    This variant is also available:

        $ gcloud beta datastream connection-profiles update