@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
122 lines • 5.59 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* `OrganizationKajPolicyConfig` is a organization-level singleton resource
* used to configure the default KAJ policy of newly created key.
*
* > **Note:** OrganizationKajPolicyConfig cannot be deleted from Google Cloud Platform.
* Destroying a Terraform-managed OrganizationKajPolicyConfig 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 OrganizationKajPolicyConfig, 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 Organization Kaj Policy Config Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = new gcp.kms.OrganizationKajPolicyConfig("example", {
* organization: "123456789",
* defaultKeyAccessJustificationPolicy: {
* allowedAccessReasons: [
* "CUSTOMER_INITIATED_ACCESS",
* "GOOGLE_INITIATED_SYSTEM_OPERATION",
* ],
* },
* });
* ```
*
* ## Import
*
* OrganizationKajPolicyConfig can be imported using any of these accepted formats:
*
* * `organizations/{{organization}}/kajPolicyConfig`
* * `{{organization}}`
*
* When using the `pulumi import` command, OrganizationKajPolicyConfig can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:kms/organizationKajPolicyConfig:OrganizationKajPolicyConfig default organizations/{{organization}}/kajPolicyConfig
* $ pulumi import gcp:kms/organizationKajPolicyConfig:OrganizationKajPolicyConfig default {{organization}}
* ```
*/
export declare class OrganizationKajPolicyConfig extends pulumi.CustomResource {
/**
* Get an existing OrganizationKajPolicyConfig 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?: OrganizationKajPolicyConfigState, opts?: pulumi.CustomResourceOptions): OrganizationKajPolicyConfig;
/**
* Returns true if the given object is an instance of OrganizationKajPolicyConfig. 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 OrganizationKajPolicyConfig;
/**
* The default key access justification policy used when a CryptoKey is
* created in this organization. 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.OrganizationKajPolicyConfigDefaultKeyAccessJustificationPolicy | undefined>;
/**
* The organization number for which to retrieve config.
*/
readonly organization: pulumi.Output<string>;
/**
* Create a OrganizationKajPolicyConfig 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: OrganizationKajPolicyConfigArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering OrganizationKajPolicyConfig resources.
*/
export interface OrganizationKajPolicyConfigState {
/**
* The default key access justification policy used when a CryptoKey is
* created in this organization. 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.OrganizationKajPolicyConfigDefaultKeyAccessJustificationPolicy | undefined>;
/**
* The organization number for which to retrieve config.
*/
organization?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a OrganizationKajPolicyConfig resource.
*/
export interface OrganizationKajPolicyConfigArgs {
/**
* The default key access justification policy used when a CryptoKey is
* created in this organization. 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.OrganizationKajPolicyConfigDefaultKeyAccessJustificationPolicy | undefined>;
/**
* The organization number for which to retrieve config.
*/
organization: pulumi.Input<string>;
}
//# sourceMappingURL=organizationKajPolicyConfig.d.ts.map