@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
102 lines (101 loc) • 3.32 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides access to Google Cloud Platform KMS KeyRing. For more information see
* [the official documentation](https://cloud.google.com/kms/docs/object-hierarchy#key_ring)
* and
* [API](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings).
*
* 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.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const myKeyRing = gcp.kms.getKMSKeyRing({
* name: "my-key-ring",
* location: "us-central1",
* });
* ```
*/
export declare function getKMSKeyRing(args: GetKMSKeyRingArgs, opts?: pulumi.InvokeOptions): Promise<GetKMSKeyRingResult>;
/**
* A collection of arguments for invoking getKMSKeyRing.
*/
export interface GetKMSKeyRingArgs {
/**
* The Google Cloud Platform location for the KeyRing.
* A full list of valid locations can be found by running `gcloud kms locations list`.
*
* - - -
*/
location: 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}`
*/
name: string;
/**
* The project in which the resource belongs. If it
* is not provided, the provider project is used.
*/
project?: string;
}
/**
* A collection of values returned by getKMSKeyRing.
*/
export interface GetKMSKeyRingResult {
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly location: string;
readonly name: string;
readonly project?: string;
}
/**
* Provides access to Google Cloud Platform KMS KeyRing. For more information see
* [the official documentation](https://cloud.google.com/kms/docs/object-hierarchy#key_ring)
* and
* [API](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings).
*
* 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.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const myKeyRing = gcp.kms.getKMSKeyRing({
* name: "my-key-ring",
* location: "us-central1",
* });
* ```
*/
export declare function getKMSKeyRingOutput(args: GetKMSKeyRingOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetKMSKeyRingResult>;
/**
* A collection of arguments for invoking getKMSKeyRing.
*/
export interface GetKMSKeyRingOutputArgs {
/**
* The Google Cloud Platform location for the KeyRing.
* A full list of valid locations can be found by running `gcloud kms locations list`.
*
* - - -
*/
location: pulumi.Input<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}`
*/
name: pulumi.Input<string>;
/**
* The project in which the resource belongs. If it
* is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
}