CfnAgentAliasPropsMixin

class aws_cdk.mixins_preview.aws_bedrock.mixins.CfnAgentAliasPropsMixin(props, *, strategy=None)

Bases: Mixin

Specifies an agent alias as a resource in a top-level template. Minimally, you must specify the following properties:.

AgentAliasName – Specify a name for the alias.

For more information about creating aliases for an agent in Amazon Bedrock , see Deploy an Amazon Bedrock agent .

See the Properties section below for descriptions of both the required and optional properties.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agentalias.html
CloudformationResource:: AWS::Bedrock::AgentAlias
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_bedrock import mixins as bedrock_mixins

cfn_agent_alias_props_mixin = bedrock_mixins.CfnAgentAliasPropsMixin(bedrock_mixins.CfnAgentAliasMixinProps(
    agent_alias_name="agentAliasName",
    agent_id="agentId",
    description="description",
    routing_configuration=[bedrock_mixins.CfnAgentAliasPropsMixin.AgentAliasRoutingConfigurationListItemProperty(
        agent_version="agentVersion"
    )],
    tags={
        "tags_key": "tags"
    }
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Bedrock::AgentAlias.

Parameters:

props (Union[CfnAgentAliasMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['agentAliasName', 'agentId', 'description', 'routingConfiguration', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AgentAliasHistoryEventProperty

class CfnAgentAliasPropsMixin.AgentAliasHistoryEventProperty(*, end_date=None, routing_configuration=None, start_date=None)

Bases: object

Contains details about the history of the alias.

Parameters:

end_date (Optional[str]) – The date that the alias stopped being associated to the version in the routingConfiguration object.
routing_configuration (Union[IResolvable, Sequence[Union[IResolvable, AgentAliasRoutingConfigurationListItemProperty, Dict[str, Any]]], None]) – Contains details about the version of the agent with which the alias is associated.
start_date (Optional[str]) – The date that the alias began being associated to the version in the routingConfiguration object.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agentalias-agentaliashistoryevent.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_bedrock import mixins as bedrock_mixins

agent_alias_history_event_property = bedrock_mixins.CfnAgentAliasPropsMixin.AgentAliasHistoryEventProperty(
    end_date="endDate",
    routing_configuration=[bedrock_mixins.CfnAgentAliasPropsMixin.AgentAliasRoutingConfigurationListItemProperty(
        agent_version="agentVersion"
    )],
    start_date="startDate"
)

Attributes

end_date

The date that the alias stopped being associated to the version in the routingConfiguration object.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agentalias-agentaliashistoryevent.html#cfn-bedrock-agentalias-agentaliashistoryevent-enddate

routing_configuration

Contains details about the version of the agent with which the alias is associated.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agentalias-agentaliashistoryevent.html#cfn-bedrock-agentalias-agentaliashistoryevent-routingconfiguration

start_date

The date that the alias began being associated to the version in the routingConfiguration object.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agentalias-agentaliashistoryevent.html#cfn-bedrock-agentalias-agentaliashistoryevent-startdate

AgentAliasRoutingConfigurationListItemProperty

class CfnAgentAliasPropsMixin.AgentAliasRoutingConfigurationListItemProperty(*, agent_version=None)

Bases: object

Contains details about the routing configuration of the alias.

Parameters:: agent_version (Optional[str]) – The version of the agent with which the alias is associated.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agentalias-agentaliasroutingconfigurationlistitem.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_bedrock import mixins as bedrock_mixins

agent_alias_routing_configuration_list_item_property = bedrock_mixins.CfnAgentAliasPropsMixin.AgentAliasRoutingConfigurationListItemProperty(
    agent_version="agentVersion"
)

Attributes

agent_version

The version of the agent with which the alias is associated.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agentalias-agentaliasroutingconfigurationlistitem.html#cfn-bedrock-agentalias-agentaliasroutingconfigurationlistitem-agentversion