@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
147 lines • 6.37 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* `ProjectKajPolicyConfig` is a project-level singleton resource
* used to configure the default KAJ policy of newly created key.
*
* > **Note:** ProjectKajPolicyConfig cannot be deleted from Google Cloud Platform.
* Destroying a Terraform-managed ProjectKajPolicyConfig will remove it from state but
* *will not delete the resource from Google Cloud Platform.*
*
* > **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider.
* See Provider Versions for more details on beta resources.
*
* To get more information about ProjectKajPolicyConfig, see:
*
* * [API documentation](https://cloud.google.com/kms/docs/reference/rest/v1/KeyAccessJustificationsPolicyConfig)
* * How-to Guides
* * [Set default Key Access Justifications policy](https://cloud.google.com/assured-workloads/key-access-justifications/docs/set-default-policy)
*
* ## Example Usage
*
* ### Kms Project Kaj Policy Config Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* import * as time from "@pulumiverse/time";
*
* // Create a project
* const kmsProject = new gcp.organizations.Project("kms_project", {
* projectId: "my-project",
* name: "my-project",
* orgId: "123456789",
* billingAccount: "000000-0000000-0000000-000000",
* deletionPolicy: "DELETE",
* });
* // Enable the Cloud KMS API.
* const kmsApiService = new gcp.projects.Service("kms_api_service", {
* service: "cloudkms.googleapis.com",
* project: kmsProject.projectId,
* disableDependentServices: true,
* }, {
* dependsOn: [kmsProject],
* });
* const waitEnableServiceApi = new time.Sleep("wait_enable_service_api", {createDuration: "30s"}, {
* dependsOn: [kmsApiService],
* });
* const example = new gcp.kms.ProjectKajPolicyConfig("example", {
* project: kmsProject.projectId,
* defaultKeyAccessJustificationPolicy: {
* allowedAccessReasons: [
* "CUSTOMER_INITIATED_ACCESS",
* "GOOGLE_INITIATED_SYSTEM_OPERATION",
* ],
* },
* }, {
* dependsOn: [waitEnableServiceApi],
* });
* ```
*
* ## Import
*
* ProjectKajPolicyConfig can be imported using any of these accepted formats:
*
* * `projects/{{project}}/kajPolicyConfig`
* * `{{project}}`
*
* When using the `pulumi import` command, ProjectKajPolicyConfig can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:kms/projectKajPolicyConfig:ProjectKajPolicyConfig default projects/{{project}}/kajPolicyConfig
* $ pulumi import gcp:kms/projectKajPolicyConfig:ProjectKajPolicyConfig default {{project}}
* ```
*/
export declare class ProjectKajPolicyConfig extends pulumi.CustomResource {
/**
* Get an existing ProjectKajPolicyConfig 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?: ProjectKajPolicyConfigState, opts?: pulumi.CustomResourceOptions): ProjectKajPolicyConfig;
/**
* Returns true if the given object is an instance of ProjectKajPolicyConfig. 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 ProjectKajPolicyConfig;
/**
* The default key access justification policy used when a CryptoKey is
* created in this project. This is only used when a Key Access Justifications
* policy is not provided in the CreateCryptoKeyRequest.
* Structure is documented below.
*/
readonly defaultKeyAccessJustificationPolicy: pulumi.Output<outputs.kms.ProjectKajPolicyConfigDefaultKeyAccessJustificationPolicy | undefined>;
/**
* 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 ProjectKajPolicyConfig 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?: ProjectKajPolicyConfigArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ProjectKajPolicyConfig resources.
*/
export interface ProjectKajPolicyConfigState {
/**
* The default key access justification policy used when a CryptoKey is
* created in this project. This is only used when a Key Access Justifications
* policy is not provided in the CreateCryptoKeyRequest.
* Structure is documented below.
*/
defaultKeyAccessJustificationPolicy?: pulumi.Input<inputs.kms.ProjectKajPolicyConfigDefaultKeyAccessJustificationPolicy | 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 ProjectKajPolicyConfig resource.
*/
export interface ProjectKajPolicyConfigArgs {
/**
* The default key access justification policy used when a CryptoKey is
* created in this project. This is only used when a Key Access Justifications
* policy is not provided in the CreateCryptoKeyRequest.
* Structure is documented below.
*/
defaultKeyAccessJustificationPolicy?: pulumi.Input<inputs.kms.ProjectKajPolicyConfigDefaultKeyAccessJustificationPolicy | 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>;
}
//# sourceMappingURL=projectKajPolicyConfig.d.ts.map