Class 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:

• API documentation
• How-to Guides
• Creating a key ring

Example Usage - Kms Key Ring Basic

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
public MyStack()
{
    var example_keyring = new Gcp.Kms.KeyRing("example-keyring", new Gcp.Kms.KeyRingArgs
    {
        Location = "global",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

KeyRing

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Gcp.Kms

Assembly: Pulumi.Gcp.dll

Syntax

public class KeyRing : CustomResource

Constructors

KeyRing(String, KeyRingArgs, CustomResourceOptions)

Create a KeyRing resource with the given unique name, arguments, and options.

Declaration

public KeyRing(string name, KeyRingArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
KeyRingArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Location

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

Declaration

public Output<string> Location { get; }

Property Value

Type	Description
Output<System.String>

Name

The resource name for the KeyRing.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Project

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

Declaration

public Output<string> Project { get; }

Property Value

Type	Description
Output<System.String>

SelfLink

Declaration

public Output<string> SelfLink { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, KeyRingState, CustomResourceOptions)

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

Declaration

public static KeyRing Get(string name, Input<string> id, KeyRingState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
KeyRingState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
KeyRing