gcloud alpha kms ekm-connections update Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud alpha kms ekm-connections update - update an ekmconnection
- SYNOPSIS
gcloud alpha kms ekm-connections update(EKM_CONNECTION:--location=LOCATION)[--endpoint-filter=ENDPOINT_FILTER][--hostname=HOSTNAME][--server-certificates-files=[SERVER_CERTIFICATES,…]][--service-directory-service=SERVICE_DIRECTORY_SERVICE][--crypto-space-path=CRYPTO_SPACE_PATH--key-management-mode=KEY_MANAGEMENT_MODE][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(ALPHA)gcloud alpha kms ekm-connections update can be used toupdate the ekmconnection. Updates can be made to the ekmconnection's serviceresolver's fields.- EXAMPLES
- The following command updates an ekm-connection named
laplaceservice resolver's hostname within locationus-east1:gcloudalphakmsekm-connectionsupdatelaplace--location=us-east1--hostname=newhostname.fooThe following command updates an ekm-connection named
laplaceservice resolver's service_directory_service, endpoint_filter, hostname, andserver_certificates within locationus-east1:gcloudalphakmsekm-connectionsupdatelaplace--location=us-east1--service-directory-service="foo"--endpoint-filter="foo > bar"--hostname="newhostname.foo"--server-certificates-files=foo.pem,bar.pemThe following command updates an ekm-connection named
laplacekey_management_mode within locationus-east1:gcloudalphakmsekm-connectionsupdatelaplace--location=us-east1--key-management-mode=manual - POSITIONAL ARGUMENTS
- Ekmconnection resource - The KMS ekm connection resource. The arguments in thisgroup can be used to specify the attributes of this resource. (NOTE) Someattributes are not given arguments in this group but can be set in other ways.
To set the
projectattribute:- provide the argument
ekm_connectionon the command line with afully specified name; - set the property
core/project.
This must be specified.
EKM_CONNECTION- ID of the ekmconnection or fully qualified identifier for the ekmconnection.
To set the
ekmconnectionattribute:- provide the argument
ekm_connectionon the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--location=LOCATION- The Google Cloud location for the ekmconnection.
To set the
locationattribute:- provide the argument
ekm_connectionon the command line with afully specified name; - provide the argument
--locationon the command line.
- provide the argument
- provide the argument
- Ekmconnection resource - The KMS ekm connection resource. The arguments in thisgroup can be used to specify the attributes of this resource. (NOTE) Someattributes are not given arguments in this group but can be set in other ways.
- FLAGS
--endpoint-filter=ENDPOINT_FILTER- The filter applied to the endpoints of the resolved service. If no filter isspecified, all endpoints will be considered.
--hostname=HOSTNAME- The hostname of the EKM replica used at TLS and HTTP layers.
--server-certificates-files=[SERVER_CERTIFICATES,…]- A list of filenames of leaf server certificates used to authenticate HTTPSconnections to the EKM replica in PEM format. If files are not in PEM, theassumed format will be DER.
--service-directory-service=SERVICE_DIRECTORY_SERVICE- The resource name of the Service Directory service pointing to an EKM replica.
- Specifies the key management mode for the EkmConnection and associated fields.
--crypto-space-path=CRYPTO_SPACE_PATH- Crypto space path for the EkmConnection. Required during EkmConnection creationif
--key-management-mode=cloud-kms. --key-management-mode=KEY_MANAGEMENT_MODE- Key management mode of the ekm connection. An EkmConnection in
cloud-kmsmode means Cloud KMS will attempt to create and managethe key material that resides on the EKM for crypto keys created with thisEkmConnection. An EkmConnection inmanualmode means the externalkey material will not be managed by Cloud KMS. Omitting the flag defaults tomanual.KEY_MANAGEMENT_MODEmust be one of:manual,cloud-kms.
- 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 helpfor details. - NOTES
- This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. These variants are also available:
gcloudkmsekm-connectionsupdategcloudbetakmsekm-connectionsupdate
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-01-21 UTC.