aws.bedrock.AgentAgentAlias
Explore with Pulumi AI
Resource for managing an AWS Agents for Amazon Bedrock Agent Alias.
Example Usage
Basic Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
resources:
example:
type: aws:iam:Role
properties:
assumeRolePolicy: ${exampleAgentTrust.json}
namePrefix: AmazonBedrockExecutionRoleForAgents_
exampleRolePolicy:
type: aws:iam:RolePolicy
name: example
properties:
policy: ${exampleAgentPermissions.json}
role: ${example.id}
exampleAgentAgent:
type: aws:bedrock:AgentAgent
name: example
properties:
agentName: my-agent-name
agentResourceRoleArn: ${example.arn}
idleTtl: 500
foundationModel: anthropic.claude-v2
exampleAgentAgentAlias:
type: aws:bedrock:AgentAgentAlias
name: example
properties:
agentAliasName: my-agent-alias
agentId: ${exampleAgentAgent.agentId}
description: Test Alias
variables:
current:
fn::invoke:
Function: aws:getCallerIdentity
Arguments: {}
currentGetPartition:
fn::invoke:
Function: aws:getPartition
Arguments: {}
currentGetRegion:
fn::invoke:
Function: aws:getRegion
Arguments: {}
exampleAgentTrust:
fn::invoke:
Function: aws:iam:getPolicyDocument
Arguments:
statements:
- actions:
- sts:AssumeRole
principals:
- identifiers:
- bedrock.amazonaws.com
type: Service
conditions:
- test: StringEquals
values:
- ${current.accountId}
variable: aws:SourceAccount
- test: ArnLike
values:
- arn:${currentGetPartition.partition}:bedrock:${currentGetRegion.name}:${current.accountId}:agent/*
variable: AWS:SourceArn
exampleAgentPermissions:
fn::invoke:
Function: aws:iam:getPolicyDocument
Arguments:
statements:
- actions:
- bedrock:InvokeModel
resources:
- arn:${currentGetPartition.partition}:bedrock:${currentGetRegion.name}::foundation-model/anthropic.claude-v2
Create AgentAgentAlias Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AgentAgentAlias(name: string, args: AgentAgentAliasArgs, opts?: CustomResourceOptions);
@overload
def AgentAgentAlias(resource_name: str,
args: AgentAgentAliasArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AgentAgentAlias(resource_name: str,
opts: Optional[ResourceOptions] = None,
agent_alias_name: Optional[str] = None,
agent_id: Optional[str] = None,
description: Optional[str] = None,
routing_configurations: Optional[Sequence[AgentAgentAliasRoutingConfigurationArgs]] = None,
tags: Optional[Mapping[str, str]] = None,
timeouts: Optional[AgentAgentAliasTimeoutsArgs] = None)
func NewAgentAgentAlias(ctx *Context, name string, args AgentAgentAliasArgs, opts ...ResourceOption) (*AgentAgentAlias, error)
public AgentAgentAlias(string name, AgentAgentAliasArgs args, CustomResourceOptions? opts = null)
public AgentAgentAlias(String name, AgentAgentAliasArgs args)
public AgentAgentAlias(String name, AgentAgentAliasArgs args, CustomResourceOptions options)
type: aws:bedrock:AgentAgentAlias
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 AgentAgentAliasArgs
- 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 AgentAgentAliasArgs
- 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 AgentAgentAliasArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AgentAgentAliasArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AgentAgentAliasArgs
- 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 agentAgentAliasResource = new Aws.Bedrock.AgentAgentAlias("agentAgentAliasResource", new()
{
AgentAliasName = "string",
AgentId = "string",
Description = "string",
RoutingConfigurations = new[]
{
new Aws.Bedrock.Inputs.AgentAgentAliasRoutingConfigurationArgs
{
AgentVersion = "string",
ProvisionedThroughput = "string",
},
},
Tags =
{
{ "string", "string" },
},
Timeouts = new Aws.Bedrock.Inputs.AgentAgentAliasTimeoutsArgs
{
Create = "string",
Delete = "string",
Update = "string",
},
});
example, err := bedrock.NewAgentAgentAlias(ctx, "agentAgentAliasResource", &bedrock.AgentAgentAliasArgs{
AgentAliasName: pulumi.String("string"),
AgentId: pulumi.String("string"),
Description: pulumi.String("string"),
RoutingConfigurations: bedrock.AgentAgentAliasRoutingConfigurationArray{
&bedrock.AgentAgentAliasRoutingConfigurationArgs{
AgentVersion: pulumi.String("string"),
ProvisionedThroughput: pulumi.String("string"),
},
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Timeouts: &bedrock.AgentAgentAliasTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
})
var agentAgentAliasResource = new AgentAgentAlias("agentAgentAliasResource", AgentAgentAliasArgs.builder()
.agentAliasName("string")
.agentId("string")
.description("string")
.routingConfigurations(AgentAgentAliasRoutingConfigurationArgs.builder()
.agentVersion("string")
.provisionedThroughput("string")
.build())
.tags(Map.of("string", "string"))
.timeouts(AgentAgentAliasTimeoutsArgs.builder()
.create("string")
.delete("string")
.update("string")
.build())
.build());
agent_agent_alias_resource = aws.bedrock.AgentAgentAlias("agentAgentAliasResource",
agent_alias_name="string",
agent_id="string",
description="string",
routing_configurations=[{
"agent_version": "string",
"provisioned_throughput": "string",
}],
tags={
"string": "string",
},
timeouts={
"create": "string",
"delete": "string",
"update": "string",
})
const agentAgentAliasResource = new aws.bedrock.AgentAgentAlias("agentAgentAliasResource", {
agentAliasName: "string",
agentId: "string",
description: "string",
routingConfigurations: [{
agentVersion: "string",
provisionedThroughput: "string",
}],
tags: {
string: "string",
},
timeouts: {
create: "string",
"delete": "string",
update: "string",
},
});
type: aws:bedrock:AgentAgentAlias
properties:
agentAliasName: string
agentId: string
description: string
routingConfigurations:
- agentVersion: string
provisionedThroughput: string
tags:
string: string
timeouts:
create: string
delete: string
update: string
AgentAgentAlias 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 AgentAgentAlias resource accepts the following input properties:
- Agent
Alias stringName - Name of the alias.
- Agent
Id string Identifier of the agent to create an alias for.
The following arguments are optional:
- Description string
- Description of the alias.
- Routing
Configurations List<AgentAgent Alias Routing Configuration> - Details about the routing configuration of the alias. See
routing_configuration
Block for details. - Dictionary<string, string>
- Map of tags assigned to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Timeouts
Agent
Agent Alias Timeouts
- Agent
Alias stringName - Name of the alias.
- Agent
Id string Identifier of the agent to create an alias for.
The following arguments are optional:
- Description string
- Description of the alias.
- Routing
Configurations []AgentAgent Alias Routing Configuration Args - Details about the routing configuration of the alias. See
routing_configuration
Block for details. - map[string]string
- Map of tags assigned to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Timeouts
Agent
Agent Alias Timeouts Args
- agent
Alias StringName - Name of the alias.
- agent
Id String Identifier of the agent to create an alias for.
The following arguments are optional:
- description String
- Description of the alias.
- routing
Configurations List<AgentAgent Alias Routing Configuration> - Details about the routing configuration of the alias. See
routing_configuration
Block for details. - Map<String,String>
- Map of tags assigned to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - timeouts
Agent
Agent Alias Timeouts
- agent
Alias stringName - Name of the alias.
- agent
Id string Identifier of the agent to create an alias for.
The following arguments are optional:
- description string
- Description of the alias.
- routing
Configurations AgentAgent Alias Routing Configuration[] - Details about the routing configuration of the alias. See
routing_configuration
Block for details. - {[key: string]: string}
- Map of tags assigned to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - timeouts
Agent
Agent Alias Timeouts
- agent_
alias_ strname - Name of the alias.
- agent_
id str Identifier of the agent to create an alias for.
The following arguments are optional:
- description str
- Description of the alias.
- routing_
configurations Sequence[AgentAgent Alias Routing Configuration Args] - Details about the routing configuration of the alias. See
routing_configuration
Block for details. - Mapping[str, str]
- Map of tags assigned to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - timeouts
Agent
Agent Alias Timeouts Args
- agent
Alias StringName - Name of the alias.
- agent
Id String Identifier of the agent to create an alias for.
The following arguments are optional:
- description String
- Description of the alias.
- routing
Configurations List<Property Map> - Details about the routing configuration of the alias. See
routing_configuration
Block for details. - Map<String>
- Map of tags assigned to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - timeouts Property Map
Outputs
All input properties are implicitly available as output properties. Additionally, the AgentAgentAlias resource produces the following output properties:
- Agent
Alias stringArn - ARN of the alias.
- Agent
Alias stringId - Unique identifier of the alias.
- Id string
- The provider-assigned unique ID for this managed resource.
- Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Agent
Alias stringArn - ARN of the alias.
- Agent
Alias stringId - Unique identifier of the alias.
- Id string
- The provider-assigned unique ID for this managed resource.
- map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- agent
Alias StringArn - ARN of the alias.
- agent
Alias StringId - Unique identifier of the alias.
- id String
- The provider-assigned unique ID for this managed resource.
- Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- agent
Alias stringArn - ARN of the alias.
- agent
Alias stringId - Unique identifier of the alias.
- id string
- The provider-assigned unique ID for this managed resource.
- {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- agent_
alias_ strarn - ARN of the alias.
- agent_
alias_ strid - Unique identifier of the alias.
- id str
- The provider-assigned unique ID for this managed resource.
- Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- agent
Alias StringArn - ARN of the alias.
- agent
Alias StringId - Unique identifier of the alias.
- id String
- The provider-assigned unique ID for this managed resource.
- Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
Look up Existing AgentAgentAlias Resource
Get an existing AgentAgentAlias 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?: AgentAgentAliasState, opts?: CustomResourceOptions): AgentAgentAlias
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
agent_alias_arn: Optional[str] = None,
agent_alias_id: Optional[str] = None,
agent_alias_name: Optional[str] = None,
agent_id: Optional[str] = None,
description: Optional[str] = None,
routing_configurations: Optional[Sequence[AgentAgentAliasRoutingConfigurationArgs]] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
timeouts: Optional[AgentAgentAliasTimeoutsArgs] = None) -> AgentAgentAlias
func GetAgentAgentAlias(ctx *Context, name string, id IDInput, state *AgentAgentAliasState, opts ...ResourceOption) (*AgentAgentAlias, error)
public static AgentAgentAlias Get(string name, Input<string> id, AgentAgentAliasState? state, CustomResourceOptions? opts = null)
public static AgentAgentAlias get(String name, Output<String> id, AgentAgentAliasState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- Agent
Alias stringArn - ARN of the alias.
- Agent
Alias stringId - Unique identifier of the alias.
- Agent
Alias stringName - Name of the alias.
- Agent
Id string Identifier of the agent to create an alias for.
The following arguments are optional:
- Description string
- Description of the alias.
- Routing
Configurations List<AgentAgent Alias Routing Configuration> - Details about the routing configuration of the alias. See
routing_configuration
Block for details. - Dictionary<string, string>
- Map of tags assigned to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Timeouts
Agent
Agent Alias Timeouts
- Agent
Alias stringArn - ARN of the alias.
- Agent
Alias stringId - Unique identifier of the alias.
- Agent
Alias stringName - Name of the alias.
- Agent
Id string Identifier of the agent to create an alias for.
The following arguments are optional:
- Description string
- Description of the alias.
- Routing
Configurations []AgentAgent Alias Routing Configuration Args - Details about the routing configuration of the alias. See
routing_configuration
Block for details. - map[string]string
- Map of tags assigned to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Timeouts
Agent
Agent Alias Timeouts Args
- agent
Alias StringArn - ARN of the alias.
- agent
Alias StringId - Unique identifier of the alias.
- agent
Alias StringName - Name of the alias.
- agent
Id String Identifier of the agent to create an alias for.
The following arguments are optional:
- description String
- Description of the alias.
- routing
Configurations List<AgentAgent Alias Routing Configuration> - Details about the routing configuration of the alias. See
routing_configuration
Block for details. - Map<String,String>
- Map of tags assigned to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - timeouts
Agent
Agent Alias Timeouts
- agent
Alias stringArn - ARN of the alias.
- agent
Alias stringId - Unique identifier of the alias.
- agent
Alias stringName - Name of the alias.
- agent
Id string Identifier of the agent to create an alias for.
The following arguments are optional:
- description string
- Description of the alias.
- routing
Configurations AgentAgent Alias Routing Configuration[] - Details about the routing configuration of the alias. See
routing_configuration
Block for details. - {[key: string]: string}
- Map of tags assigned to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - timeouts
Agent
Agent Alias Timeouts
- agent_
alias_ strarn - ARN of the alias.
- agent_
alias_ strid - Unique identifier of the alias.
- agent_
alias_ strname - Name of the alias.
- agent_
id str Identifier of the agent to create an alias for.
The following arguments are optional:
- description str
- Description of the alias.
- routing_
configurations Sequence[AgentAgent Alias Routing Configuration Args] - Details about the routing configuration of the alias. See
routing_configuration
Block for details. - Mapping[str, str]
- Map of tags assigned to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - timeouts
Agent
Agent Alias Timeouts Args
- agent
Alias StringArn - ARN of the alias.
- agent
Alias StringId - Unique identifier of the alias.
- agent
Alias StringName - Name of the alias.
- agent
Id String Identifier of the agent to create an alias for.
The following arguments are optional:
- description String
- Description of the alias.
- routing
Configurations List<Property Map> - Details about the routing configuration of the alias. See
routing_configuration
Block for details. - Map<String>
- Map of tags assigned to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - timeouts Property Map
Supporting Types
AgentAgentAliasRoutingConfiguration, AgentAgentAliasRoutingConfigurationArgs
- Agent
Version string - Version of the agent with which the alias is associated.
- Provisioned
Throughput string - ARN of the Provisioned Throughput assigned to the agent alias.
- Agent
Version string - Version of the agent with which the alias is associated.
- Provisioned
Throughput string - ARN of the Provisioned Throughput assigned to the agent alias.
- agent
Version String - Version of the agent with which the alias is associated.
- provisioned
Throughput String - ARN of the Provisioned Throughput assigned to the agent alias.
- agent
Version string - Version of the agent with which the alias is associated.
- provisioned
Throughput string - ARN of the Provisioned Throughput assigned to the agent alias.
- agent_
version str - Version of the agent with which the alias is associated.
- provisioned_
throughput str - ARN of the Provisioned Throughput assigned to the agent alias.
- agent
Version String - Version of the agent with which the alias is associated.
- provisioned
Throughput String - ARN of the Provisioned Throughput assigned to the agent alias.
AgentAgentAliasTimeouts, AgentAgentAliasTimeoutsArgs
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- Update string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- Update string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- update String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- update string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- update str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- update String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
Import
Using pulumi import
, import Agents for Amazon Bedrock Agent Alias using the alias ID and the agent ID separated by ,
. For example:
$ pulumi import aws:bedrock/agentAgentAlias:AgentAgentAlias example 66IVY0GUTF,GGRRAED6JP
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
aws
Terraform Provider.