@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
184 lines • 7.43 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Initializes a location-level encryption key specification.
*
* To get more information about EncryptionSpec, see:
*
* * [API documentation](https://docs.cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations.encryptionSpec)
* * How-to Guides
* * [Official Documentation](https://docs.cloud.google.com/contact-center/insights/docs/cmek)
*
* ## Example Usage
*
* ### Contact Center Insights Encryption Spec Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* import * as std from "@pulumi/std";
* import * as time from "@pulumiverse/time";
*
* const project = new gcp.organizations.Project("project", {
* projectId: "my-proj",
* name: "my-proj",
* orgId: "123456789",
* billingAccount: "000000-0000000-0000000-000000",
* deletionPolicy: "DELETE",
* });
* const cloudkms = new gcp.projects.Service("cloudkms", {
* project: project.projectId,
* service: "cloudkms.googleapis.com",
* });
* const contactcenterinsights = new gcp.projects.Service("contactcenterinsights", {
* project: project.projectId,
* service: "contactcenterinsights.googleapis.com",
* }, {
* dependsOn: [cloudkms],
* });
* const waitEnableServiceApi = new time.Sleep("wait_enable_service_api", {createDuration: "30s"}, {
* dependsOn: [
* cloudkms,
* contactcenterinsights,
* ],
* });
* const gcpSa = new gcp.projects.ServiceIdentity("gcp_sa", {
* service: "contactcenterinsights.googleapis.com",
* project: project.projectId,
* }, {
* dependsOn: [waitEnableServiceApi],
* });
* const waitCreateSa = new time.Sleep("wait_create_sa", {createDuration: "30s"}, {
* dependsOn: [gcpSa],
* });
* const keyring = new gcp.kms.KeyRing("keyring", {
* name: "my-keyring",
* location: "us-east1",
* project: project.projectId,
* }, {
* dependsOn: [waitEnableServiceApi],
* });
* const key = new gcp.kms.CryptoKey("key", {
* name: "my-key",
* keyRing: keyring.id,
* purpose: "ENCRYPT_DECRYPT",
* });
* const cryptoKey = new gcp.kms.CryptoKeyIAMMember("crypto_key", {
* cryptoKeyId: key.id,
* member: std.replaceOutput({
* text: gcpSa.member,
* search: "@gcp-sa-contactcenterinsights.iam",
* replace: "@gcp-sa-ccai-cmek.iam",
* }).apply(invoke => invoke.result),
* role: "roles/cloudkms.cryptoKeyEncrypterDecrypter",
* }, {
* dependsOn: [waitCreateSa],
* });
* const my_encryption_spec = new gcp.contactcenterinsights.EncryptionSpec("my-encryption-spec", {
* project: project.projectId,
* location: "us-east1",
* kmsKey: key.id,
* }, {
* dependsOn: [cryptoKey],
* });
* ```
*
* ## Import
*
* EncryptionSpec can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/encryptionSpec/{{name}}`
* * `{{project}}/{{location}}/{{name}}`
* * `{{location}}/{{name}}`
*
* When using the `pulumi import` command, EncryptionSpec can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:contactcenterinsights/encryptionSpec:EncryptionSpec default projects/{{project}}/locations/{{location}}/encryptionSpec/{{name}}
* $ pulumi import gcp:contactcenterinsights/encryptionSpec:EncryptionSpec default {{project}}/{{location}}/{{name}}
* $ pulumi import gcp:contactcenterinsights/encryptionSpec:EncryptionSpec default {{location}}/{{name}}
* ```
*/
export declare class EncryptionSpec extends pulumi.CustomResource {
/**
* Get an existing EncryptionSpec resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EncryptionSpecState, opts?: pulumi.CustomResourceOptions): EncryptionSpec;
/**
* Returns true if the given object is an instance of EncryptionSpec. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is EncryptionSpec;
/**
* The name of customer-managed encryption key that is used to secure a resource and its sub-resources.
* If empty, the resource is secured by the default Google encryption key.
* Only the key in the same location as this resource is allowed to be used for encryption.
* Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}
*/
readonly kmsKey: pulumi.Output<string>;
/**
* The location in which the encryptionSpec is to be initialized.
*/
readonly location: pulumi.Output<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* Create a EncryptionSpec resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: EncryptionSpecArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering EncryptionSpec resources.
*/
export interface EncryptionSpecState {
/**
* The name of customer-managed encryption key that is used to secure a resource and its sub-resources.
* If empty, the resource is secured by the default Google encryption key.
* Only the key in the same location as this resource is allowed to be used for encryption.
* Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}
*/
kmsKey?: pulumi.Input<string | undefined>;
/**
* The location in which the encryptionSpec is to be initialized.
*/
location?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a EncryptionSpec resource.
*/
export interface EncryptionSpecArgs {
/**
* The name of customer-managed encryption key that is used to secure a resource and its sub-resources.
* If empty, the resource is secured by the default Google encryption key.
* Only the key in the same location as this resource is allowed to be used for encryption.
* Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}
*/
kmsKey: pulumi.Input<string>;
/**
* The location in which the encryptionSpec is to be initialized.
*/
location: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=encryptionSpec.d.ts.map