aws.bedrock.AgentcoreTokenVaultCmk
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
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 pulumi
import pulumi_aws as aws
example = aws.bedrock.AgentcoreTokenVaultCmk("example", kms_configuration={
"key_type": "CustomerManagedKey",
"kms_key_arn": example_aws_kms_key["arn"],
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/bedrock"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := bedrock.NewAgentcoreTokenVaultCmk(ctx, "example", &bedrock.AgentcoreTokenVaultCmkArgs{
KmsConfiguration: &bedrock.AgentcoreTokenVaultCmkKmsConfigurationArgs{
KeyType: pulumi.String("CustomerManagedKey"),
KmsKeyArn: pulumi.Any(exampleAwsKmsKey.Arn),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Bedrock.AgentcoreTokenVaultCmk("example", new()
{
KmsConfiguration = new Aws.Bedrock.Inputs.AgentcoreTokenVaultCmkKmsConfigurationArgs
{
KeyType = "CustomerManagedKey",
KmsKeyArn = exampleAwsKmsKey.Arn,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.bedrock.AgentcoreTokenVaultCmk;
import com.pulumi.aws.bedrock.AgentcoreTokenVaultCmkArgs;
import com.pulumi.aws.bedrock.inputs.AgentcoreTokenVaultCmkKmsConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new AgentcoreTokenVaultCmk("example", AgentcoreTokenVaultCmkArgs.builder()
.kmsConfiguration(AgentcoreTokenVaultCmkKmsConfigurationArgs.builder()
.keyType("CustomerManagedKey")
.kmsKeyArn(exampleAwsKmsKey.arn())
.build())
.build());
}
}
resources:
example:
type: aws:bedrock:AgentcoreTokenVaultCmk
properties:
kmsConfiguration:
keyType: CustomerManagedKey
kmsKeyArn: ${exampleAwsKmsKey.arn}
Create AgentcoreTokenVaultCmk Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AgentcoreTokenVaultCmk(name: string, args?: AgentcoreTokenVaultCmkArgs, opts?: CustomResourceOptions);@overload
def AgentcoreTokenVaultCmk(resource_name: str,
args: Optional[AgentcoreTokenVaultCmkArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def AgentcoreTokenVaultCmk(resource_name: str,
opts: Optional[ResourceOptions] = None,
kms_configuration: Optional[AgentcoreTokenVaultCmkKmsConfigurationArgs] = None,
region: Optional[str] = None,
token_vault_id: Optional[str] = None)func NewAgentcoreTokenVaultCmk(ctx *Context, name string, args *AgentcoreTokenVaultCmkArgs, opts ...ResourceOption) (*AgentcoreTokenVaultCmk, error)public AgentcoreTokenVaultCmk(string name, AgentcoreTokenVaultCmkArgs? args = null, CustomResourceOptions? opts = null)
public AgentcoreTokenVaultCmk(String name, AgentcoreTokenVaultCmkArgs args)
public AgentcoreTokenVaultCmk(String name, AgentcoreTokenVaultCmkArgs args, CustomResourceOptions options)
type: aws:bedrock:AgentcoreTokenVaultCmk
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args AgentcoreTokenVaultCmkArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AgentcoreTokenVaultCmkArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AgentcoreTokenVaultCmkArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AgentcoreTokenVaultCmkArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AgentcoreTokenVaultCmkArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var agentcoreTokenVaultCmkResource = new Aws.Bedrock.AgentcoreTokenVaultCmk("agentcoreTokenVaultCmkResource", new()
{
KmsConfiguration = new Aws.Bedrock.Inputs.AgentcoreTokenVaultCmkKmsConfigurationArgs
{
KeyType = "string",
KmsKeyArn = "string",
},
Region = "string",
TokenVaultId = "string",
});
example, err := bedrock.NewAgentcoreTokenVaultCmk(ctx, "agentcoreTokenVaultCmkResource", &bedrock.AgentcoreTokenVaultCmkArgs{
KmsConfiguration: &bedrock.AgentcoreTokenVaultCmkKmsConfigurationArgs{
KeyType: pulumi.String("string"),
KmsKeyArn: pulumi.String("string"),
},
Region: pulumi.String("string"),
TokenVaultId: pulumi.String("string"),
})
var agentcoreTokenVaultCmkResource = new AgentcoreTokenVaultCmk("agentcoreTokenVaultCmkResource", AgentcoreTokenVaultCmkArgs.builder()
.kmsConfiguration(AgentcoreTokenVaultCmkKmsConfigurationArgs.builder()
.keyType("string")
.kmsKeyArn("string")
.build())
.region("string")
.tokenVaultId("string")
.build());
agentcore_token_vault_cmk_resource = aws.bedrock.AgentcoreTokenVaultCmk("agentcoreTokenVaultCmkResource",
kms_configuration={
"key_type": "string",
"kms_key_arn": "string",
},
region="string",
token_vault_id="string")
const agentcoreTokenVaultCmkResource = new aws.bedrock.AgentcoreTokenVaultCmk("agentcoreTokenVaultCmkResource", {
kmsConfiguration: {
keyType: "string",
kmsKeyArn: "string",
},
region: "string",
tokenVaultId: "string",
});
type: aws:bedrock:AgentcoreTokenVaultCmk
properties:
kmsConfiguration:
keyType: string
kmsKeyArn: string
region: string
tokenVaultId: string
AgentcoreTokenVaultCmk Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The AgentcoreTokenVaultCmk resource accepts the following input properties:
- Kms
Configuration AgentcoreToken Vault Cmk Kms Configuration - KMS configuration for the token vault. See
kms_configurationbelow. - Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Token
Vault stringId - Token vault ID. Defaults to
default.
- Kms
Configuration AgentcoreToken Vault Cmk Kms Configuration Args - KMS configuration for the token vault. See
kms_configurationbelow. - Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Token
Vault stringId - Token vault ID. Defaults to
default.
- kms
Configuration AgentcoreToken Vault Cmk Kms Configuration - KMS configuration for the token vault. See
kms_configurationbelow. - region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- token
Vault StringId - Token vault ID. Defaults to
default.
- kms
Configuration AgentcoreToken Vault Cmk Kms Configuration - KMS configuration for the token vault. See
kms_configurationbelow. - region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- token
Vault stringId - Token vault ID. Defaults to
default.
- kms_
configuration AgentcoreToken Vault Cmk Kms Configuration Args - KMS configuration for the token vault. See
kms_configurationbelow. - region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- token_
vault_ strid - Token vault ID. Defaults to
default.
- kms
Configuration Property Map - KMS configuration for the token vault. See
kms_configurationbelow. - region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- token
Vault StringId - Token vault ID. Defaults to
default.
Outputs
All input properties are implicitly available as output properties. Additionally, the AgentcoreTokenVaultCmk resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing AgentcoreTokenVaultCmk Resource
Get an existing AgentcoreTokenVaultCmk resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: AgentcoreTokenVaultCmkState, opts?: CustomResourceOptions): AgentcoreTokenVaultCmk@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
kms_configuration: Optional[AgentcoreTokenVaultCmkKmsConfigurationArgs] = None,
region: Optional[str] = None,
token_vault_id: Optional[str] = None) -> AgentcoreTokenVaultCmkfunc GetAgentcoreTokenVaultCmk(ctx *Context, name string, id IDInput, state *AgentcoreTokenVaultCmkState, opts ...ResourceOption) (*AgentcoreTokenVaultCmk, error)public static AgentcoreTokenVaultCmk Get(string name, Input<string> id, AgentcoreTokenVaultCmkState? state, CustomResourceOptions? opts = null)public static AgentcoreTokenVaultCmk get(String name, Output<String> id, AgentcoreTokenVaultCmkState state, CustomResourceOptions options)resources: _: type: aws:bedrock:AgentcoreTokenVaultCmk get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Kms
Configuration AgentcoreToken Vault Cmk Kms Configuration - KMS configuration for the token vault. See
kms_configurationbelow. - Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Token
Vault stringId - Token vault ID. Defaults to
default.
- Kms
Configuration AgentcoreToken Vault Cmk Kms Configuration Args - KMS configuration for the token vault. See
kms_configurationbelow. - Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Token
Vault stringId - Token vault ID. Defaults to
default.
- kms
Configuration AgentcoreToken Vault Cmk Kms Configuration - KMS configuration for the token vault. See
kms_configurationbelow. - region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- token
Vault StringId - Token vault ID. Defaults to
default.
- kms
Configuration AgentcoreToken Vault Cmk Kms Configuration - KMS configuration for the token vault. See
kms_configurationbelow. - region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- token
Vault stringId - Token vault ID. Defaults to
default.
- kms_
configuration AgentcoreToken Vault Cmk Kms Configuration Args - KMS configuration for the token vault. See
kms_configurationbelow. - region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- token_
vault_ strid - Token vault ID. Defaults to
default.
- kms
Configuration Property Map - KMS configuration for the token vault. See
kms_configurationbelow. - region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- token
Vault StringId - Token vault ID. Defaults to
default.
Supporting Types
AgentcoreTokenVaultCmkKmsConfiguration, AgentcoreTokenVaultCmkKmsConfigurationArgs
- key_
type str - Type of KMS key. Valid values:
CustomerManagedKey,ServiceManagedKey. - kms_
key_ strarn - ARN of the KMS key.
Import
Using pulumi import, import token vault CMKs using the token vault ID. For example:
$ pulumi import aws:bedrock/agentcoreTokenVaultCmk:AgentcoreTokenVaultCmk example "default"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.
