GoogleKeyManagementServiceSecretStore
Realm Operations
Resource path:
/realm-config/secrets/stores/GoogleKeyManagementServiceSecretStore
Resource version: 2.0
create
Usage
am> create GoogleKeyManagementServiceSecretStore --realm Realm --id id --body body
Parameters
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "project" : { "title" : "Project", "description" : "The GCP project that contains the key ring", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "" }, "publicKeyCacheDuration" : { "title" : "Public key cache duration (seconds)", "description" : "The length of time to cache public keys (default is 1 hour).", "propertyOrder" : 400, "required" : true, "type" : "integer", "exampleValue" : "" }, "location" : { "title" : "Location", "description" : "The <a href=\"https://cloud.google.com/kms/docs/locations\">GCP KMS location</a>", "propertyOrder" : 200, "required" : true, "type" : "string", "exampleValue" : "" }, "keyRing" : { "title" : "Key Ring", "description" : "The KMS key ring that contains the keys you want to use", "propertyOrder" : 300, "required" : true, "type" : "string", "exampleValue" : "" }, "publicKeyCacheMaxSize" : { "title" : "Public key cache size", "description" : "The maximum number of public keys to cache. The cache is per-server.", "propertyOrder" : 500, "required" : true, "type" : "integer", "exampleValue" : "" } } }
delete
Usage
am> delete GoogleKeyManagementServiceSecretStore --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
Usage
am> action GoogleKeyManagementServiceSecretStore --realm Realm --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action GoogleKeyManagementServiceSecretStore --realm Realm --actionName getCreatableTypes
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action GoogleKeyManagementServiceSecretStore --realm Realm --actionName nextdescendents
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query GoogleKeyManagementServiceSecretStore --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read GoogleKeyManagementServiceSecretStore --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update GoogleKeyManagementServiceSecretStore --realm Realm --id id --body body
Parameters
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "project" : { "title" : "Project", "description" : "The GCP project that contains the key ring", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "" }, "publicKeyCacheDuration" : { "title" : "Public key cache duration (seconds)", "description" : "The length of time to cache public keys (default is 1 hour).", "propertyOrder" : 400, "required" : true, "type" : "integer", "exampleValue" : "" }, "location" : { "title" : "Location", "description" : "The <a href=\"https://cloud.google.com/kms/docs/locations\">GCP KMS location</a>", "propertyOrder" : 200, "required" : true, "type" : "string", "exampleValue" : "" }, "keyRing" : { "title" : "Key Ring", "description" : "The KMS key ring that contains the keys you want to use", "propertyOrder" : 300, "required" : true, "type" : "string", "exampleValue" : "" }, "publicKeyCacheMaxSize" : { "title" : "Public key cache size", "description" : "The maximum number of public keys to cache. The cache is per-server.", "propertyOrder" : 500, "required" : true, "type" : "integer", "exampleValue" : "" } } }
Global Operations
Resource path:
/global-config/secrets/stores/GoogleKeyManagementServiceSecretStore
Resource version: 1.0
create
Usage
am> create GoogleKeyManagementServiceSecretStore --global --id id --body body
Parameters
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "keyRing" : { "title" : "Key Ring", "description" : "The KMS key ring that contains the keys you want to use", "propertyOrder" : 300, "required" : true, "type" : "string", "exampleValue" : "" }, "publicKeyCacheDuration" : { "title" : "Public key cache duration (seconds)", "description" : "The length of time to cache public keys (default is 1 hour).", "propertyOrder" : 400, "required" : true, "type" : "integer", "exampleValue" : "" }, "location" : { "title" : "Location", "description" : "The <a href=\"https://cloud.google.com/kms/docs/locations\">GCP KMS location</a>", "propertyOrder" : 200, "required" : true, "type" : "string", "exampleValue" : "" }, "publicKeyCacheMaxSize" : { "title" : "Public key cache size", "description" : "The maximum number of public keys to cache. The cache is per-server.", "propertyOrder" : 500, "required" : true, "type" : "integer", "exampleValue" : "" }, "project" : { "title" : "Project", "description" : "The GCP project that contains the key ring", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "" } } }
delete
Usage
am> delete GoogleKeyManagementServiceSecretStore --global --id id
Parameters
- --id
-
The unique identifier for the resource.
getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
Usage
am> action GoogleKeyManagementServiceSecretStore --global --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action GoogleKeyManagementServiceSecretStore --global --actionName getCreatableTypes
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action GoogleKeyManagementServiceSecretStore --global --actionName nextdescendents
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query GoogleKeyManagementServiceSecretStore --global --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read GoogleKeyManagementServiceSecretStore --global --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update GoogleKeyManagementServiceSecretStore --global --id id --body body
Parameters
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "keyRing" : { "title" : "Key Ring", "description" : "The KMS key ring that contains the keys you want to use", "propertyOrder" : 300, "required" : true, "type" : "string", "exampleValue" : "" }, "publicKeyCacheDuration" : { "title" : "Public key cache duration (seconds)", "description" : "The length of time to cache public keys (default is 1 hour).", "propertyOrder" : 400, "required" : true, "type" : "integer", "exampleValue" : "" }, "location" : { "title" : "Location", "description" : "The <a href=\"https://cloud.google.com/kms/docs/locations\">GCP KMS location</a>", "propertyOrder" : 200, "required" : true, "type" : "string", "exampleValue" : "" }, "publicKeyCacheMaxSize" : { "title" : "Public key cache size", "description" : "The maximum number of public keys to cache. The cache is per-server.", "propertyOrder" : 500, "required" : true, "type" : "integer", "exampleValue" : "" }, "project" : { "title" : "Project", "description" : "The GCP project that contains the key ring", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "" } } }