Package software.amazon.awscdk.services.bedrock

Class CfnAgentAlias

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.bedrock.CfnAgentAlias
All Implemented Interfaces:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-05T20:26:27.748Z") @Stability(Stable) public class CfnAgentAlias extends CfnResource implements IInspectable, ITaggableV2
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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.bedrock.*;
 CfnAgentAlias cfnAgentAlias = CfnAgentAlias.Builder.create(this, "MyCfnAgentAlias")
         .agentAliasName("agentAliasName")
         .agentId("agentId")
         // the properties below are optional
         .description("description")
         .routingConfiguration(List.of(AgentAliasRoutingConfigurationListItemProperty.builder()
                 .agentVersion("agentVersion")
                 .build()))
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAgentAlias

      protected CfnAgentAlias(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnAgentAlias

      protected CfnAgentAlias(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnAgentAlias

      @Stability(Stable) public CfnAgentAlias(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAgentAliasProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAgentAliasArn

      @Stability(Stable) @NotNull public String getAttrAgentAliasArn()
      The Amazon Resource Name (ARN) of the alias of the agent.

    • getAttrAgentAliasHistoryEvents

      @Stability(Stable) @NotNull public IResolvable getAttrAgentAliasHistoryEvents()
      Contains details about the history of the alias.

    • getAttrAgentAliasId

      @Stability(Stable) @NotNull public String getAttrAgentAliasId()
      The unique identifier of the alias of the agent.

    • getAttrAgentAliasStatus

      @Stability(Stable) @NotNull public String getAttrAgentAliasStatus()
      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.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The time at which the alias of the agent was created.

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()
      The time at which the alias was last updated.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getAgentAliasName

      @Stability(Stable) @NotNull public String getAgentAliasName()
      The name of the alias of the agent.

    • setAgentAliasName

      @Stability(Stable) public void setAgentAliasName(@NotNull String value)
      The name of the alias of the agent.

    • getAgentId

      @Stability(Stable) @NotNull public String getAgentId()
      The unique identifier of the agent.

    • setAgentId

      @Stability(Stable) public void setAgentId(@NotNull String value)
      The unique identifier of the agent.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the alias of the agent.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the alias of the agent.

    • getRoutingConfiguration

      @Stability(Stable) @Nullable public Object getRoutingConfiguration()
      Contains details about the routing configuration of the alias.

    • setRoutingConfiguration

      @Stability(Stable) public void setRoutingConfiguration(@Nullable IResolvable value)
      Contains details about the routing configuration of the alias.

    • setRoutingConfiguration

      @Stability(Stable) public void setRoutingConfiguration(@Nullable List<Object> value)
      Contains details about the routing configuration of the alias.

    • getTags

      @Stability(Stable) @Nullable public Map<String,String> getTags()
      Metadata that you can assign to a resource as key-value pairs.

      For more information, see the following resources:.

    • setTags

      @Stability(Stable) public void setTags(@Nullable Map<String,String> value)
      Metadata that you can assign to a resource as key-value pairs.

      For more information, see the following resources:.