@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
100 lines (99 loc) • 4.14 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Manages the AWS KMS customer master key (CMK) for a token vault.
*
* > Deletion of this resource will not modify the CMK, only remove the resource from state.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.bedrock.AgentcoreTokenVaultCmk("example", {kmsConfiguration: {
* keyType: "CustomerManagedKey",
* kmsKeyArn: exampleAwsKmsKey.arn,
* }});
* ```
*
* ## Import
*
* Using `pulumi import`, import token vault CMKs using the token vault ID. For example:
*
* ```sh
* $ pulumi import aws:bedrock/agentcoreTokenVaultCmk:AgentcoreTokenVaultCmk example "default"
* ```
*/
export declare class AgentcoreTokenVaultCmk extends pulumi.CustomResource {
/**
* Get an existing AgentcoreTokenVaultCmk 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?: AgentcoreTokenVaultCmkState, opts?: pulumi.CustomResourceOptions): AgentcoreTokenVaultCmk;
/**
* Returns true if the given object is an instance of AgentcoreTokenVaultCmk. 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 AgentcoreTokenVaultCmk;
/**
* KMS configuration for the token vault. See `kmsConfiguration` below.
*/
readonly kmsConfiguration: pulumi.Output<outputs.bedrock.AgentcoreTokenVaultCmkKmsConfiguration | undefined>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* Token vault ID. Defaults to `default`.
*/
readonly tokenVaultId: pulumi.Output<string>;
/**
* Create a AgentcoreTokenVaultCmk 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?: AgentcoreTokenVaultCmkArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AgentcoreTokenVaultCmk resources.
*/
export interface AgentcoreTokenVaultCmkState {
/**
* KMS configuration for the token vault. See `kmsConfiguration` below.
*/
kmsConfiguration?: pulumi.Input<inputs.bedrock.AgentcoreTokenVaultCmkKmsConfiguration>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Token vault ID. Defaults to `default`.
*/
tokenVaultId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a AgentcoreTokenVaultCmk resource.
*/
export interface AgentcoreTokenVaultCmkArgs {
/**
* KMS configuration for the token vault. See `kmsConfiguration` below.
*/
kmsConfiguration?: pulumi.Input<inputs.bedrock.AgentcoreTokenVaultCmkKmsConfiguration>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Token vault ID. Defaults to `default`.
*/
tokenVaultId?: pulumi.Input<string>;
}