GetKMSKeyRing

Provides access to Google Cloud Platform KMS KeyRing. For more information see the official documentation and API.

A KeyRing is a grouping of CryptoKeys for organizational purposes. A KeyRing belongs to a Google Cloud Platform Project and resides in a specific location.

Using GetKMSKeyRing

function getKMSKeyRing(args: GetKMSKeyRingArgs, opts?: InvokeOptions): Promise<GetKMSKeyRingResult>
function  get_kms_key_ring(location=None, name=None, project=None, opts=None)
func GetKMSKeyRing(ctx *Context, args *GetKMSKeyRingArgs, opts ...InvokeOption) (*GetKMSKeyRingResult, error)
public static class GetKMSKeyRing {
    public static Task<GetKMSKeyRingResult> InvokeAsync(GetKMSKeyRingArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Location string

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

Name string

The KeyRing’s name. A KeyRing name must exist within the provided location and match the regular expression [a-zA-Z0-9_-]{1,63}

Project string

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

Location string

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

Name string

The KeyRing’s name. A KeyRing name must exist within the provided location and match the regular expression [a-zA-Z0-9_-]{1,63}

Project string

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

location string

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

name string

The KeyRing’s name. A KeyRing name must exist within the provided location and match the regular expression [a-zA-Z0-9_-]{1,63}

project string

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

location str

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

name str

The KeyRing’s name. A KeyRing name must exist within the provided location and match the regular expression [a-zA-Z0-9_-]{1,63}

project str

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

GetKMSKeyRing Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

Location string
Name string
SelfLink string

The self link of the created KeyRing. Its format is projects/{projectId}/locations/{location}/keyRings/{keyRingName}.

Project string
Id string

The provider-assigned unique ID for this managed resource.

Location string
Name string
SelfLink string

The self link of the created KeyRing. Its format is projects/{projectId}/locations/{location}/keyRings/{keyRingName}.

Project string
id string

The provider-assigned unique ID for this managed resource.

location string
name string
selfLink string

The self link of the created KeyRing. Its format is projects/{projectId}/locations/{location}/keyRings/{keyRingName}.

project string
id str

The provider-assigned unique ID for this managed resource.

location str
name str
self_link str

The self link of the created KeyRing. Its format is projects/{projectId}/locations/{location}/keyRings/{keyRingName}.

project 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.