GoogleKmsMappings
Realm Operations
Resource path:
/realm-config/secrets/stores/GoogleKeyManagementServiceSecretStore/{GoogleKeyManagementServiceSecretStore}/mappings
Resource version: 1.0
create
Usage
am> create GoogleKmsMappings --realm Realm --GoogleKeyManagementServiceSecretStore GoogleKeyManagementServiceSecretStore --id id --body body
Parameters
- --GoogleKeyManagementServiceSecretStore
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "secretId" : { "title" : "Secret ID", "description" : "The secret ID that is to be associated with an alias.", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "" }, "aliases" : { "title" : "Key Name", "description" : "The name of the KMS key to use for this purpose. The key must exist in the configured key ring.", "propertyOrder" : 200, "required" : true, "items" : { "type" : "string", "minLength" : 1 }, "minItems" : 1, "uniqueItems" : true, "type" : "array", "exampleValue" : "" } } }
delete
Usage
am> delete GoogleKmsMappings --realm Realm --GoogleKeyManagementServiceSecretStore GoogleKeyManagementServiceSecretStore --id id
Parameters
- --GoogleKeyManagementServiceSecretStore
- --id
-
The unique identifier for the resource.
getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
Usage
am> action GoogleKmsMappings --realm Realm --GoogleKeyManagementServiceSecretStore GoogleKeyManagementServiceSecretStore --actionName getAllTypes
Parameters
- --GoogleKeyManagementServiceSecretStore
-
=== getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action GoogleKmsMappings --realm Realm --GoogleKeyManagementServiceSecretStore GoogleKeyManagementServiceSecretStore --actionName getCreatableTypes
Parameters
- --GoogleKeyManagementServiceSecretStore
-
=== nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action GoogleKmsMappings --realm Realm --GoogleKeyManagementServiceSecretStore GoogleKeyManagementServiceSecretStore --actionName nextdescendents
Parameters
- --GoogleKeyManagementServiceSecretStore
-
=== query
Get the full list of instances of this collection. This query only supports _queryFilter=true
filter.
Usage
am> query GoogleKmsMappings --realm Realm --filter filter --GoogleKeyManagementServiceSecretStore GoogleKeyManagementServiceSecretStore
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
- --GoogleKeyManagementServiceSecretStore
-
=== read
Usage
am> read GoogleKmsMappings --realm Realm --GoogleKeyManagementServiceSecretStore GoogleKeyManagementServiceSecretStore --id id
Parameters
- --GoogleKeyManagementServiceSecretStore
- --id
-
The unique identifier for the resource.
update
Usage
am> update GoogleKmsMappings --realm Realm --GoogleKeyManagementServiceSecretStore GoogleKeyManagementServiceSecretStore --id id --body body
Parameters
- --GoogleKeyManagementServiceSecretStore
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "secretId" : { "title" : "Secret ID", "description" : "The secret ID that is to be associated with an alias.", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "" }, "aliases" : { "title" : "Key Name", "description" : "The name of the KMS key to use for this purpose. The key must exist in the configured key ring.", "propertyOrder" : 200, "required" : true, "items" : { "type" : "string", "minLength" : 1 }, "minItems" : 1, "uniqueItems" : true, "type" : "array", "exampleValue" : "" } } }
Global Operations
Resource path:
/global-config/secrets/stores/GoogleKeyManagementServiceSecretStore/{GoogleKeyManagementServiceSecretStore}/mappings
Resource version: 1.0
create
Usage
am> create GoogleKmsMappings --global --GoogleKeyManagementServiceSecretStore GoogleKeyManagementServiceSecretStore --id id --body body
Parameters
- --GoogleKeyManagementServiceSecretStore
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "secretId" : { "title" : "Secret ID", "description" : "The secret ID that is to be associated with an alias.", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "" }, "aliases" : { "title" : "Key Name", "description" : "The name of the KMS key to use for this purpose. The key must exist in the configured key ring.", "propertyOrder" : 200, "required" : true, "items" : { "type" : "string", "minLength" : 1 }, "minItems" : 1, "uniqueItems" : true, "type" : "array", "exampleValue" : "" } } }
delete
Usage
am> delete GoogleKmsMappings --global --GoogleKeyManagementServiceSecretStore GoogleKeyManagementServiceSecretStore --id id
Parameters
- --GoogleKeyManagementServiceSecretStore
- --id
-
The unique identifier for the resource.
getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
Usage
am> action GoogleKmsMappings --global --GoogleKeyManagementServiceSecretStore GoogleKeyManagementServiceSecretStore --actionName getAllTypes
Parameters
- --GoogleKeyManagementServiceSecretStore
-
=== getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action GoogleKmsMappings --global --GoogleKeyManagementServiceSecretStore GoogleKeyManagementServiceSecretStore --actionName getCreatableTypes
Parameters
- --GoogleKeyManagementServiceSecretStore
-
=== nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action GoogleKmsMappings --global --GoogleKeyManagementServiceSecretStore GoogleKeyManagementServiceSecretStore --actionName nextdescendents
Parameters
- --GoogleKeyManagementServiceSecretStore
-
=== query
Get the full list of instances of this collection. This query only supports _queryFilter=true
filter.
Usage
am> query GoogleKmsMappings --global --filter filter --GoogleKeyManagementServiceSecretStore GoogleKeyManagementServiceSecretStore
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
- --GoogleKeyManagementServiceSecretStore
-
=== read
Usage
am> read GoogleKmsMappings --global --GoogleKeyManagementServiceSecretStore GoogleKeyManagementServiceSecretStore --id id
Parameters
- --GoogleKeyManagementServiceSecretStore
- --id
-
The unique identifier for the resource.
update
Usage
am> update GoogleKmsMappings --global --GoogleKeyManagementServiceSecretStore GoogleKeyManagementServiceSecretStore --id id --body body
Parameters
- --GoogleKeyManagementServiceSecretStore
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "secretId" : { "title" : "Secret ID", "description" : "The secret ID that is to be associated with an alias.", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "" }, "aliases" : { "title" : "Key Name", "description" : "The name of the KMS key to use for this purpose. The key must exist in the configured key ring.", "propertyOrder" : 200, "required" : true, "items" : { "type" : "string", "minLength" : 1 }, "minItems" : 1, "uniqueItems" : true, "type" : "array", "exampleValue" : "" } } }