1. Docs
  2. Reference
  3. API
  4. GCP
  5. kms
  6. KeyRing

KeyRing

A KeyRing is a toplevel logical grouping of CryptoKeys.

Note: KeyRings cannot be deleted from Google Cloud Platform. Destroying a provider-managed KeyRing will remove it from state but will not delete the resource on the server.

To get more information about KeyRing, see:

Create a KeyRing Resource

new KeyRing(name: string, args: KeyRingArgs, opts?: CustomResourceOptions);
def KeyRing(resource_name, opts=None, location=None, name=None, project=None, __props__=None);
func NewKeyRing(ctx *Context, name string, args KeyRingArgs, opts ...ResourceOption) (*KeyRing, error)
public KeyRing(string name, KeyRingArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args KeyRingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args KeyRingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args KeyRingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

KeyRing Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The KeyRing resource accepts the following input properties:

Location string

The location for the KeyRing. A full list of valid locations can be found by running gcloud kms locations list.

Name string

The resource name for the KeyRing.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Location string

The location for the KeyRing. A full list of valid locations can be found by running gcloud kms locations list.

Name string

The resource name for the KeyRing.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

location string

The location for the KeyRing. A full list of valid locations can be found by running gcloud kms locations list.

name string

The resource name for the KeyRing.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

location str

The location for the KeyRing. A full list of valid locations can be found by running gcloud kms locations list.

name str

The resource name for the KeyRing.

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Outputs

All input properties are implicitly available as output properties. Additionally, the KeyRing resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
SelfLink string
Id string
The provider-assigned unique ID for this managed resource.
SelfLink string
id string
The provider-assigned unique ID for this managed resource.
selfLink string
id str
The provider-assigned unique ID for this managed resource.
self_link str

Look up an Existing KeyRing Resource

Get an existing KeyRing resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: KeyRingState, opts?: CustomResourceOptions): KeyRing
static get(resource_name, id, opts=None, location=None, name=None, project=None, self_link=None, __props__=None);
func GetKeyRing(ctx *Context, name string, id IDInput, state *KeyRingState, opts ...ResourceOption) (*KeyRing, error)
public static KeyRing Get(string name, Input<string> id, KeyRingState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

Location string

The location for the KeyRing. A full list of valid locations can be found by running gcloud kms locations list.

Name string

The resource name for the KeyRing.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

SelfLink string
Location string

The location for the KeyRing. A full list of valid locations can be found by running gcloud kms locations list.

Name string

The resource name for the KeyRing.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

SelfLink string
location string

The location for the KeyRing. A full list of valid locations can be found by running gcloud kms locations list.

name string

The resource name for the KeyRing.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

selfLink string
location str

The location for the KeyRing. A full list of valid locations can be found by running gcloud kms locations list.

name str

The resource name for the KeyRing.

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

self_link str

Package Details

Repository
https://github.com/pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.