Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. bedrock
  5. AgentAlias

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.bedrock.AgentAlias

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Definition of AWS::Bedrock::AgentAlias Resource Type

Create AgentAlias Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new AgentAlias(name: string, args: AgentAliasArgs, opts?: CustomResourceOptions);
@overload
def AgentAlias(resource_name: str,
               args: AgentAliasArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def AgentAlias(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               agent_id: Optional[str] = None,
               agent_alias_name: Optional[str] = None,
               description: Optional[str] = None,
               routing_configuration: Optional[Sequence[AgentAliasRoutingConfigurationListItemArgs]] = None,
               tags: Optional[Mapping[str, str]] = None)
func NewAgentAlias(ctx *Context, name string, args AgentAliasArgs, opts ...ResourceOption) (*AgentAlias, error)
public AgentAlias(string name, AgentAliasArgs args, CustomResourceOptions? opts = null)
public AgentAlias(String name, AgentAliasArgs args)
public AgentAlias(String name, AgentAliasArgs args, CustomResourceOptions options)

type: aws-native:bedrock:AgentAlias
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AgentAliasArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AgentAliasArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AgentAliasArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AgentAliasArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AgentAliasArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

AgentAlias 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 AgentAlias resource accepts the following input properties:

AgentId This property is required. string
Identifier for a resource.
AgentAliasName string
Name for a resource.
Description string
Description of the Resource.
RoutingConfiguration List<Pulumi.AwsNative.Bedrock.Inputs.AgentAliasRoutingConfigurationListItem>
Routing configuration for an Agent alias.
Tags Dictionary<string, string>
Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

AgentId This property is required. string
Identifier for a resource.
AgentAliasName string
Name for a resource.
Description string
Description of the Resource.
RoutingConfiguration []AgentAliasRoutingConfigurationListItemArgs
Routing configuration for an Agent alias.
Tags map[string]string
Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

agentId This property is required. String
Identifier for a resource.
agentAliasName String
Name for a resource.
description String
Description of the Resource.
routingConfiguration List<AgentAliasRoutingConfigurationListItem>
Routing configuration for an Agent alias.
tags Map<String,String>
Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

agentId This property is required. string
Identifier for a resource.
agentAliasName string
Name for a resource.
description string
Description of the Resource.
routingConfiguration AgentAliasRoutingConfigurationListItem[]
Routing configuration for an Agent alias.
tags {[key: string]: string}
Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

agent_id This property is required. str
Identifier for a resource.
agent_alias_name str
Name for a resource.
description str
Description of the Resource.
routing_configuration Sequence[AgentAliasRoutingConfigurationListItemArgs]
Routing configuration for an Agent alias.
tags Mapping[str, str]
Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

agentId This property is required. String
Identifier for a resource.
agentAliasName String
Name for a resource.
description String
Description of the Resource.
routingConfiguration List<Property Map>
Routing configuration for an Agent alias.
tags Map<String>
Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

Outputs

All input properties are implicitly available as output properties. Additionally, the AgentAlias resource produces the following output properties:

AgentAliasArn string
Arn representation of the Agent Alias.
AgentAliasHistoryEvents List<Pulumi.AwsNative.Bedrock.Outputs.AgentAliasHistoryEvent>
The list of history events for an alias for an Agent.
AgentAliasId string
Id for an Agent Alias generated at the server side.
AgentAliasStatus Pulumi.AwsNative.Bedrock.AgentAliasStatus
The status of the alias of the agent and whether it is ready for use. The following statuses are possible:

  • CREATING – The agent alias is being created.
  • PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
  • FAILED – The agent alias API operation failed.
  • UPDATING – The agent alias is being updated.
  • DELETING – The agent alias is being deleted.
  • DISSOCIATED - The agent alias has no version associated with it.
CreatedAt string
Time Stamp.
Id string
The provider-assigned unique ID for this managed resource.
UpdatedAt string
Time Stamp.
AgentAliasArn string
Arn representation of the Agent Alias.
AgentAliasHistoryEvents []AgentAliasHistoryEvent
The list of history events for an alias for an Agent.
AgentAliasId string
Id for an Agent Alias generated at the server side.
AgentAliasStatus AgentAliasStatus
The status of the alias of the agent and whether it is ready for use. The following statuses are possible:

  • CREATING – The agent alias is being created.
  • PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
  • FAILED – The agent alias API operation failed.
  • UPDATING – The agent alias is being updated.
  • DELETING – The agent alias is being deleted.
  • DISSOCIATED - The agent alias has no version associated with it.
CreatedAt string
Time Stamp.
Id string
The provider-assigned unique ID for this managed resource.
UpdatedAt string
Time Stamp.
agentAliasArn String
Arn representation of the Agent Alias.
agentAliasHistoryEvents List<AgentAliasHistoryEvent>
The list of history events for an alias for an Agent.
agentAliasId String
Id for an Agent Alias generated at the server side.
agentAliasStatus AgentAliasStatus
The status of the alias of the agent and whether it is ready for use. The following statuses are possible:

  • CREATING – The agent alias is being created.
  • PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
  • FAILED – The agent alias API operation failed.
  • UPDATING – The agent alias is being updated.
  • DELETING – The agent alias is being deleted.
  • DISSOCIATED - The agent alias has no version associated with it.
createdAt String
Time Stamp.
id String
The provider-assigned unique ID for this managed resource.
updatedAt String
Time Stamp.
agentAliasArn string
Arn representation of the Agent Alias.
agentAliasHistoryEvents AgentAliasHistoryEvent[]
The list of history events for an alias for an Agent.
agentAliasId string
Id for an Agent Alias generated at the server side.
agentAliasStatus AgentAliasStatus
The status of the alias of the agent and whether it is ready for use. The following statuses are possible:

  • CREATING – The agent alias is being created.
  • PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
  • FAILED – The agent alias API operation failed.
  • UPDATING – The agent alias is being updated.
  • DELETING – The agent alias is being deleted.
  • DISSOCIATED - The agent alias has no version associated with it.
createdAt string
Time Stamp.
id string
The provider-assigned unique ID for this managed resource.
updatedAt string
Time Stamp.
agent_alias_arn str
Arn representation of the Agent Alias.
agent_alias_history_events Sequence[AgentAliasHistoryEvent]
The list of history events for an alias for an Agent.
agent_alias_id str
Id for an Agent Alias generated at the server side.
agent_alias_status AgentAliasStatus
The status of the alias of the agent and whether it is ready for use. The following statuses are possible:

  • CREATING – The agent alias is being created.
  • PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
  • FAILED – The agent alias API operation failed.
  • UPDATING – The agent alias is being updated.
  • DELETING – The agent alias is being deleted.
  • DISSOCIATED - The agent alias has no version associated with it.
created_at str
Time Stamp.
id str
The provider-assigned unique ID for this managed resource.
updated_at str
Time Stamp.
agentAliasArn String
Arn representation of the Agent Alias.
agentAliasHistoryEvents List<Property Map>
The list of history events for an alias for an Agent.
agentAliasId String
Id for an Agent Alias generated at the server side.
agentAliasStatus "CREATING" | "PREPARED" | "FAILED" | "UPDATING" | "DELETING"
The status of the alias of the agent and whether it is ready for use. The following statuses are possible:

  • CREATING – The agent alias is being created.
  • PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
  • FAILED – The agent alias API operation failed.
  • UPDATING – The agent alias is being updated.
  • DELETING – The agent alias is being deleted.
  • DISSOCIATED - The agent alias has no version associated with it.
createdAt String
Time Stamp.
id String
The provider-assigned unique ID for this managed resource.
updatedAt String
Time Stamp.

Supporting Types

AgentAliasHistoryEvent
, AgentAliasHistoryEventArgs

EndDate string
Time Stamp.
RoutingConfiguration List<Pulumi.AwsNative.Bedrock.Inputs.AgentAliasRoutingConfigurationListItem>
Routing configuration for an Agent alias.
StartDate string
Time Stamp.
EndDate string
Time Stamp.
RoutingConfiguration []AgentAliasRoutingConfigurationListItem
Routing configuration for an Agent alias.
StartDate string
Time Stamp.
endDate String
Time Stamp.
routingConfiguration List<AgentAliasRoutingConfigurationListItem>
Routing configuration for an Agent alias.
startDate String
Time Stamp.
endDate string
Time Stamp.
routingConfiguration AgentAliasRoutingConfigurationListItem[]
Routing configuration for an Agent alias.
startDate string
Time Stamp.
end_date str
Time Stamp.
routing_configuration Sequence[AgentAliasRoutingConfigurationListItem]
Routing configuration for an Agent alias.
start_date str
Time Stamp.
endDate String
Time Stamp.
routingConfiguration List<Property Map>
Routing configuration for an Agent alias.
startDate String
Time Stamp.

AgentAliasRoutingConfigurationListItem
, AgentAliasRoutingConfigurationListItemArgs

AgentVersion This property is required. string
Agent Version.
AgentVersion This property is required. string
Agent Version.
agentVersion This property is required. String
Agent Version.
agentVersion This property is required. string
Agent Version.
agent_version This property is required. str
Agent Version.
agentVersion This property is required. String
Agent Version.

AgentAliasStatus
, AgentAliasStatusArgs

Creating
CREATING
Prepared
PREPARED
Failed
FAILED
Updating
UPDATING
Deleting
DELETING
AgentAliasStatusCreating
CREATING
AgentAliasStatusPrepared
PREPARED
AgentAliasStatusFailed
FAILED
AgentAliasStatusUpdating
UPDATING
AgentAliasStatusDeleting
DELETING
Creating
CREATING
Prepared
PREPARED
Failed
FAILED
Updating
UPDATING
Deleting
DELETING
Creating
CREATING
Prepared
PREPARED
Failed
FAILED
Updating
UPDATING
Deleting
DELETING
CREATING
CREATING
PREPARED
PREPARED
FAILED
FAILED
UPDATING
UPDATING
DELETING
DELETING
"CREATING"
CREATING
"PREPARED"
PREPARED
"FAILED"
FAILED
"UPDATING"
UPDATING
"DELETING"
DELETING

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native