@pulumi/gcp/kms/autokeyConfig.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * `AutokeyConfig` is a singleton resource used to configure the auto-provisioning
 * flow of CryptoKeys for CMEK.
 *
 * > **Note:** AutokeyConfigs cannot be deleted from Google Cloud Platform.
 * Destroying a Terraform-managed AutokeyConfig will remove it from state but
 * *will not delete the resource from the project.*
 *
 * To get more information about AutokeyConfig, see:
 *
 * * [API documentation](https://cloud.google.com/kms/docs/reference/rest/v1/AutokeyConfig)
 * * How-to Guides
 *     * [Cloud KMS with Autokey](https://cloud.google.com/kms/docs/kms-with-autokey)
 *
 * ## Example Usage
 *
 * ### Kms Autokey Config All
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 * import * as time from "@pulumiverse/time";
 *
 * // Create Folder in GCP Organization
 * const autokmsFolder = new gcp.organizations.Folder("autokms_folder", {
 *     displayName: "folder-cfg",
 *     parent: "organizations/123456789",
 *     deletionProtection: false,
 * });
 * // Create the key project
 * const keyProject = new gcp.organizations.Project("key_project", {
 *     projectId: "key-proj",
 *     name: "key-proj",
 *     folderId: autokmsFolder.folderId,
 *     billingAccount: "000000-0000000-0000000-000000",
 *     deletionPolicy: "DELETE",
 * }, {
 *     dependsOn: [autokmsFolder],
 * });
 * // Enable the Cloud KMS API
 * const kmsApiService = new gcp.projects.Service("kms_api_service", {
 *     service: "cloudkms.googleapis.com",
 *     project: keyProject.projectId,
 *     disableDependentServices: true,
 * }, {
 *     dependsOn: [keyProject],
 * });
 * // Wait delay after enabling APIs
 * const waitEnableServiceApi = new time.Sleep("wait_enable_service_api", {createDuration: "30s"}, {
 *     dependsOn: [kmsApiService],
 * });
 * //Create KMS Service Agent
 * const kmsServiceAgent = new gcp.projects.ServiceIdentity("kms_service_agent", {
 *     service: "cloudkms.googleapis.com",
 *     project: keyProject.number,
 * }, {
 *     dependsOn: [waitEnableServiceApi],
 * });
 * // Wait delay after creating service agent.
 * const waitServiceAgent = new time.Sleep("wait_service_agent", {createDuration: "10s"}, {
 *     dependsOn: [kmsServiceAgent],
 * });
 * //Grant the KMS Service Agent the Cloud KMS Admin role
 * const autokeyProjectAdmin = new gcp.projects.IAMMember("autokey_project_admin", {
 *     project: keyProject.projectId,
 *     role: "roles/cloudkms.admin",
 *     member: pulumi.interpolate`serviceAccount:service-${keyProject.number}@gcp-sa-cloudkms.iam.gserviceaccount.com`,
 * }, {
 *     dependsOn: [waitServiceAgent],
 * });
 * // Wait delay after granting IAM permissions
 * const waitSrvAccPermissions = new time.Sleep("wait_srv_acc_permissions", {createDuration: "10s"}, {
 *     dependsOn: [autokeyProjectAdmin],
 * });
 * const example_autokeyconfig = new gcp.kms.AutokeyConfig("example-autokeyconfig", {
 *     folder: autokmsFolder.id,
 *     keyProject: pulumi.interpolate`projects/${keyProject.projectId}`,
 *     keyProjectResolutionMode: "DEDICATED_KEY_PROJECT",
 * }, {
 *     dependsOn: [waitSrvAccPermissions],
 * });
 * // Wait delay after setting AutokeyConfig, to prevent diffs on reapply,
 * // because setting the config takes a little to fully propagate.
 * const waitAutokeyPropagation = new time.Sleep("wait_autokey_propagation", {createDuration: "30s"}, {
 *     dependsOn: [example_autokeyconfig],
 * });
 * ```
 *
 * ## Import
 *
 * AutokeyConfig can be imported using any of these accepted formats:
 *
 * * `folders/{{folder}}/autokeyConfig`
 * * `{{folder}}`
 *
 * When using the `pulumi import` command, AutokeyConfig can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:kms/autokeyConfig:AutokeyConfig default folders/{{folder}}/autokeyConfig
 * $ pulumi import gcp:kms/autokeyConfig:AutokeyConfig default {{folder}}
 * ```
 */
export declare class AutokeyConfig extends pulumi.CustomResource {
    /**
     * Get an existing AutokeyConfig 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?: AutokeyConfigState, opts?: pulumi.CustomResourceOptions): AutokeyConfig;
    /**
     * Returns true if the given object is an instance of AutokeyConfig.  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 AutokeyConfig;
    /**
     * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
     * When a 'terraform destroy' or 'pulumi up' would delete the resource,
     * the command will fail if this field is set to "PREVENT" in Terraform state.
     * When set to "ABANDON", the command will remove the resource from Terraform
     * management without updating or deleting the resource in the API.
     * When set to "DELETE", deleting the resource is allowed.
     */
    readonly deletionPolicy: pulumi.Output<string>;
    /**
     * The etag of the AutokeyConfig for optimistic concurrency control.
     */
    readonly etag: pulumi.Output<string>;
    /**
     * The folder for which to retrieve config.
     */
    readonly folder: pulumi.Output<string>;
    /**
     * The target key project for a given folder where KMS Autokey will provision a
     * CryptoKey for any new KeyHandle the Developer creates. Should have the form
     * `projects/<project_id_or_number>`.
     */
    readonly keyProject: pulumi.Output<string | undefined>;
    /**
     * How Autokey determines which project to use when provisioning CMEK keys.
     * Possible values are: `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, `DISABLED`.
     */
    readonly keyProjectResolutionMode: pulumi.Output<string | undefined>;
    /**
     * Create a AutokeyConfig 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: AutokeyConfigArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering AutokeyConfig resources.
 */
export interface AutokeyConfigState {
    /**
     * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
     * When a 'terraform destroy' or 'pulumi up' would delete the resource,
     * the command will fail if this field is set to "PREVENT" in Terraform state.
     * When set to "ABANDON", the command will remove the resource from Terraform
     * management without updating or deleting the resource in the API.
     * When set to "DELETE", deleting the resource is allowed.
     */
    deletionPolicy?: pulumi.Input<string | undefined>;
    /**
     * The etag of the AutokeyConfig for optimistic concurrency control.
     */
    etag?: pulumi.Input<string | undefined>;
    /**
     * The folder for which to retrieve config.
     */
    folder?: pulumi.Input<string | undefined>;
    /**
     * The target key project for a given folder where KMS Autokey will provision a
     * CryptoKey for any new KeyHandle the Developer creates. Should have the form
     * `projects/<project_id_or_number>`.
     */
    keyProject?: pulumi.Input<string | undefined>;
    /**
     * How Autokey determines which project to use when provisioning CMEK keys.
     * Possible values are: `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, `DISABLED`.
     */
    keyProjectResolutionMode?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a AutokeyConfig resource.
 */
export interface AutokeyConfigArgs {
    /**
     * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
     * When a 'terraform destroy' or 'pulumi up' would delete the resource,
     * the command will fail if this field is set to "PREVENT" in Terraform state.
     * When set to "ABANDON", the command will remove the resource from Terraform
     * management without updating or deleting the resource in the API.
     * When set to "DELETE", deleting the resource is allowed.
     */
    deletionPolicy?: pulumi.Input<string | undefined>;
    /**
     * The folder for which to retrieve config.
     */
    folder: pulumi.Input<string>;
    /**
     * The target key project for a given folder where KMS Autokey will provision a
     * CryptoKey for any new KeyHandle the Developer creates. Should have the form
     * `projects/<project_id_or_number>`.
     */
    keyProject?: pulumi.Input<string | undefined>;
    /**
     * How Autokey determines which project to use when provisioning CMEK keys.
     * Possible values are: `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, `DISABLED`.
     */
    keyProjectResolutionMode?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=autokeyConfig.d.ts.map