Class CfnAgentAlias

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

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnAgentAlias

Implements

IInspectable

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AwsBedrock

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnAgentAlias : CfnResource, IInspectable, ITaggableV2

Syntax (vb)

Public Class CfnAgentAlias Inherits CfnResource Implements IInspectable, ITaggableV2

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Aws_bedrock;

             var cfnAgentAlias = new CfnAgentAlias(this, "MyCfnAgentAlias", new CfnAgentAliasProps {
                 AgentAliasName = "agentAliasName",
                 AgentId = "agentId",

                 // the properties below are optional
                 Description = "description",
                 RoutingConfiguration = new [] { new AgentAliasRoutingConfigurationListItemProperty {
                     AgentVersion = "agentVersion"
                 } },
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 }
             });

Synopsis

Constructors

CfnAgentAlias(Construct, string, ICfnAgentAliasProps)

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

Properties

AgentAliasName	The name of the alias of the agent.
AgentId	The unique identifier of the agent.
AttrAgentAliasArn	The Amazon Resource Name (ARN) of the alias of the agent.
AttrAgentAliasHistoryEvents	Contains details about the history of the alias.
AttrAgentAliasId	The unique identifier of the alias of the agent.
AttrAgentAliasStatus	The status of the alias of the agent and whether it is ready for use.
AttrCreatedAt	The time at which the alias of the agent was created.
AttrUpdatedAt	The time at which the alias was last updated.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	Specifies an agent alias as a resource in a top-level template. Minimally, you must specify the following properties:.
Description	The description of the alias of the agent.
RoutingConfiguration	Contains details about the routing configuration of the alias.
Tags	Metadata that you can assign to a resource as key-value pairs.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	Specifies an agent alias as a resource in a top-level template. Minimally, you must specify the following properties:.

Constructors

CfnAgentAlias(Construct, string, ICfnAgentAliasProps)

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

public CfnAgentAlias(Construct scope, string id, ICfnAgentAliasProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnAgentAliasProps

Resource properties.

Remarks

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

ExampleMetadata: fixture=_generated

Properties

AgentAliasName

The name of the alias of the agent.

public virtual string AgentAliasName { get; set; }

Property Value

string

Remarks

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

ExampleMetadata: fixture=_generated

AgentId

The unique identifier of the agent.

public virtual string AgentId { get; set; }

Property Value

string

Remarks

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

ExampleMetadata: fixture=_generated

AttrAgentAliasArn

The Amazon Resource Name (ARN) of the alias of the agent.

public virtual string AttrAgentAliasArn { get; }

Property Value

string

Remarks

CloudformationAttribute: AgentAliasArn

AttrAgentAliasHistoryEvents

Contains details about the history of the alias.

public virtual IResolvable AttrAgentAliasHistoryEvents { get; }

Property Value

IResolvable

Remarks

CloudformationAttribute: AgentAliasHistoryEvents

AttrAgentAliasId

The unique identifier of the alias of the agent.

public virtual string AttrAgentAliasId { get; }

Property Value

string

Remarks

CloudformationAttribute: AgentAliasId

AttrAgentAliasStatus

The status of the alias of the agent and whether it is ready for use.

public virtual string AttrAgentAliasStatus { get; }

Property Value

string

Remarks

The following statuses are possible:

CloudformationAttribute: AgentAliasStatus

AttrCreatedAt

The time at which the alias of the agent was created.

public virtual string AttrCreatedAt { get; }

Property Value

string

Remarks

CloudformationAttribute: CreatedAt

AttrUpdatedAt

The time at which the alias was last updated.

public virtual string AttrUpdatedAt { get; }

Property Value

string

Remarks

CloudformationAttribute: UpdatedAt

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

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

ExampleMetadata: fixture=_generated

CfnProperties

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

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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

ExampleMetadata: fixture=_generated

Description

The description of the alias of the agent.

public virtual string? Description { get; set; }

Property Value

string

Remarks

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

ExampleMetadata: fixture=_generated

RoutingConfiguration

Contains details about the routing configuration of the alias.

public virtual object? RoutingConfiguration { get; set; }

Property Value

object

Remarks

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

ExampleMetadata: fixture=_generated

Tags

Metadata that you can assign to a resource as key-value pairs.

public virtual IDictionary<string, string>? Tags { get; set; }

Property Value

IDictionary<string, string>

Remarks

For more information, see the following resources:.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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

ExampleMetadata: fixture=_generated

Implements

IInspectable

ITaggableV2