import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the Vault resource in Oracle Cloud Infrastructure Kms service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/key/latest/Vault * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/kms * * Creates a new vault. The type of vault you create determines key placement, pricing, and * available options. Options include storage isolation, a dedicated service endpoint instead * of a shared service endpoint for API calls, and either a dedicated hardware security module * (HSM) or a multitenant HSM. * * As a provisioning operation, this call is subject to a Key Management limit that applies to * the total number of requests across all provisioning write operations. Key Management might * throttle this call to reject an otherwise valid request when the total rate of provisioning * write operations exceeds 10 requests per second for a given tenancy. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testVault = new oci.kms.Vault("test_vault", { * compartmentId: compartmentId, * displayName: vaultDisplayName, * vaultType: vaultVaultType, * definedTags: { * "Operations.CostCenter": "42", * }, * externalKeyManagerMetadata: { * externalVaultEndpointUrl: vaultExternalKeyManagerMetadataExternalVaultEndpointUrl, * oauthMetadata: { * clientAppId: testClientApp.id, * clientAppSecret: vaultExternalKeyManagerMetadataOauthMetadataClientAppSecret, * idcsAccountNameUrl: vaultExternalKeyManagerMetadataOauthMetadataIdcsAccountNameUrl, * }, * privateEndpointId: testPrivateEndpoint.id, * }, * freeformTags: { * Department: "Finance", * }, * }); * ``` * * ## Import * * Vaults can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:Kms/vault:Vault test_vault "id" * ``` */ export declare class Vault extends pulumi.CustomResource { /** * Get an existing Vault 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, state?: VaultState, opts?: pulumi.CustomResourceOptions): Vault; /** * Returns true if the given object is an instance of Vault. 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 Vault; /** * (Updatable) The OCID of the compartment where you want to create this vault. */ readonly compartmentId: pulumi.Output; /** * The service endpoint to perform cryptographic operations against. Cryptographic operations include [Encrypt](https://docs.cloud.oracle.com/iaas/api/#/en/key/latest/EncryptedData/Encrypt), [Decrypt](https://docs.cloud.oracle.com/iaas/api/#/en/key/latest/DecryptedData/Decrypt), and [GenerateDataEncryptionKey](https://docs.cloud.oracle.com/iaas/api/#/en/key/latest/GeneratedKey/GenerateDataEncryptionKey) operations. */ readonly cryptoEndpoint: pulumi.Output; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) A user-friendly name for the vault. It does not have to be unique, and it is changeable. Avoid entering confidential information. */ readonly displayName: pulumi.Output; /** * Metadata required for accessing External Key manager */ readonly externalKeyManagerMetadata: pulumi.Output; /** * Summary about metadata of external key manager to be returned to the customer as a response. */ readonly externalKeyManagerMetadataSummaries: pulumi.Output; /** * (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ readonly freeformTags: pulumi.Output<{ [key: string]: string; }>; /** * A Boolean value that indicates whether the Vault is primary Vault or replica Vault. */ readonly isPrimary: pulumi.Output; /** * A Boolean value that indicates whether the Vault has cross region replication capability. Always true for Virtual Private Vaults. */ readonly isVaultReplicable: pulumi.Output; /** * The service endpoint to perform management operations against. Management operations include "Create," "Update," "List," "Get," and "Delete" operations. */ readonly managementEndpoint: pulumi.Output; /** * Vault replica details */ readonly replicaDetails: pulumi.Output; /** * (Updatable) Details where vault was backed up. */ readonly restoreFromFile: pulumi.Output; /** * (Updatable) Details where vault was backed up */ readonly restoreFromObjectStore: pulumi.Output; readonly restoreTrigger: pulumi.Output; /** * The OCID of the vault from which this vault was restored, if it was restored from a backup file. If you restore a vault to the same region, the vault retains the same OCID that it had when you backed up the vault. */ readonly restoredFromVaultId: pulumi.Output; /** * The vault's current lifecycle state. Example: `DELETED` */ readonly state: pulumi.Output; /** * The date and time this vault was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` */ readonly timeCreated: pulumi.Output; /** * (Updatable) An optional property for the deletion time of the vault, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ readonly timeOfDeletion: pulumi.Output; /** * The type of vault to create. Each type of vault stores the key with different degrees of isolation and has different options and pricing. */ readonly vaultType: pulumi.Output; /** * Create a Vault 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: VaultArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Vault resources. */ export interface VaultState { /** * (Updatable) The OCID of the compartment where you want to create this vault. */ compartmentId?: pulumi.Input; /** * The service endpoint to perform cryptographic operations against. Cryptographic operations include [Encrypt](https://docs.cloud.oracle.com/iaas/api/#/en/key/latest/EncryptedData/Encrypt), [Decrypt](https://docs.cloud.oracle.com/iaas/api/#/en/key/latest/DecryptedData/Decrypt), and [GenerateDataEncryptionKey](https://docs.cloud.oracle.com/iaas/api/#/en/key/latest/GeneratedKey/GenerateDataEncryptionKey) operations. */ cryptoEndpoint?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) A user-friendly name for the vault. It does not have to be unique, and it is changeable. Avoid entering confidential information. */ displayName?: pulumi.Input; /** * Metadata required for accessing External Key manager */ externalKeyManagerMetadata?: pulumi.Input; /** * Summary about metadata of external key manager to be returned to the customer as a response. */ externalKeyManagerMetadataSummaries?: pulumi.Input[] | undefined>; /** * (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * A Boolean value that indicates whether the Vault is primary Vault or replica Vault. */ isPrimary?: pulumi.Input; /** * A Boolean value that indicates whether the Vault has cross region replication capability. Always true for Virtual Private Vaults. */ isVaultReplicable?: pulumi.Input; /** * The service endpoint to perform management operations against. Management operations include "Create," "Update," "List," "Get," and "Delete" operations. */ managementEndpoint?: pulumi.Input; /** * Vault replica details */ replicaDetails?: pulumi.Input[] | undefined>; /** * (Updatable) Details where vault was backed up. */ restoreFromFile?: pulumi.Input; /** * (Updatable) Details where vault was backed up */ restoreFromObjectStore?: pulumi.Input; restoreTrigger?: pulumi.Input; /** * The OCID of the vault from which this vault was restored, if it was restored from a backup file. If you restore a vault to the same region, the vault retains the same OCID that it had when you backed up the vault. */ restoredFromVaultId?: pulumi.Input; /** * The vault's current lifecycle state. Example: `DELETED` */ state?: pulumi.Input; /** * The date and time this vault was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` */ timeCreated?: pulumi.Input; /** * (Updatable) An optional property for the deletion time of the vault, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ timeOfDeletion?: pulumi.Input; /** * The type of vault to create. Each type of vault stores the key with different degrees of isolation and has different options and pricing. */ vaultType?: pulumi.Input; } /** * The set of arguments for constructing a Vault resource. */ export interface VaultArgs { /** * (Updatable) The OCID of the compartment where you want to create this vault. */ compartmentId: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) A user-friendly name for the vault. It does not have to be unique, and it is changeable. Avoid entering confidential information. */ displayName: pulumi.Input; /** * Metadata required for accessing External Key manager */ externalKeyManagerMetadata?: pulumi.Input; /** * (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) Details where vault was backed up. */ restoreFromFile?: pulumi.Input; /** * (Updatable) Details where vault was backed up */ restoreFromObjectStore?: pulumi.Input; restoreTrigger?: pulumi.Input; /** * (Updatable) An optional property for the deletion time of the vault, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ timeOfDeletion?: pulumi.Input; /** * The type of vault to create. Each type of vault stores the key with different degrees of isolation and has different options and pricing. */ vaultType: pulumi.Input; } //# sourceMappingURL=vault.d.ts.map