Class CfnBotAlias
A CloudFormation AWS::Lex::BotAlias
.
Inherited Members
Namespace: Amazon.CDK.AWS.Lex
Assembly: Amazon.CDK.AWS.Lex.dll
Syntax (csharp)
public class CfnBotAlias : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnBotAlias
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Amazon Lex V2 is the only supported version in AWS CloudFormation .
Specifies an alias for the specified version of a bot. Use an alias to enable you to change the version of a bot without updating applications that use the bot.
For example, you can specify an alias called "PROD" that your applications use to call the Amazon Lex bot.
CloudformationResource: AWS::Lex::BotAlias
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lex-botalias.html
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.Lex;
var sentimentAnalysisSettings;
var cfnBotAlias = new CfnBotAlias(this, "MyCfnBotAlias", new CfnBotAliasProps {
BotAliasName = "botAliasName",
BotId = "botId",
// the properties below are optional
BotAliasLocaleSettings = new [] { new BotAliasLocaleSettingsItemProperty {
BotAliasLocaleSetting = new BotAliasLocaleSettingsProperty {
Enabled = false,
// the properties below are optional
CodeHookSpecification = new CodeHookSpecificationProperty {
LambdaCodeHook = new LambdaCodeHookProperty {
CodeHookInterfaceVersion = "codeHookInterfaceVersion",
LambdaArn = "lambdaArn"
}
}
},
LocaleId = "localeId"
} },
BotAliasTags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
BotVersion = "botVersion",
ConversationLogSettings = new ConversationLogSettingsProperty {
AudioLogSettings = new [] { new AudioLogSettingProperty {
Destination = new AudioLogDestinationProperty {
S3Bucket = new S3BucketLogDestinationProperty {
LogPrefix = "logPrefix",
S3BucketArn = "s3BucketArn",
// the properties below are optional
KmsKeyArn = "kmsKeyArn"
}
},
Enabled = false
} },
TextLogSettings = new [] { new TextLogSettingProperty {
Destination = new TextLogDestinationProperty {
CloudWatch = new CloudWatchLogGroupLogDestinationProperty {
CloudWatchLogGroupArn = "cloudWatchLogGroupArn",
LogPrefix = "logPrefix"
}
},
Enabled = false
} }
},
Description = "description",
SentimentAnalysisSettings = sentimentAnalysisSettings
});
Synopsis
Constructors
CfnBotAlias(Construct, String, ICfnBotAliasProps) | Create a new |
CfnBotAlias(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnBotAlias(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The Amazon Resource Name (ARN) of the bot alias. |
AttrBotAliasId | The unique identifier of the bot alias. |
AttrBotAliasStatus | The current status of the bot alias. |
BotAliasLocaleSettings | Specifies settings that are unique to a locale. |
BotAliasName | The name of the bot alias. |
BotAliasTags | An array of key-value pairs to apply to this resource. |
BotId | The unique identifier of the bot. |
BotVersion | The version of the bot that the bot alias references. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ConversationLogSettings | Specifies whether Amazon Lex logs text and audio for conversations with the bot. |
Description | The description of the bot alias. |
SentimentAnalysisSettings | Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnBotAlias(Construct, String, ICfnBotAliasProps)
Create a new AWS::Lex::BotAlias
.
public CfnBotAlias(Construct scope, string id, ICfnBotAliasProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnBotAliasProps
- resource properties.
CfnBotAlias(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnBotAlias(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnBotAlias(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnBotAlias(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The Amazon Resource Name (ARN) of the bot alias.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrBotAliasId
The unique identifier of the bot alias.
public virtual string AttrBotAliasId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: BotAliasId
AttrBotAliasStatus
The current status of the bot alias.
public virtual string AttrBotAliasStatus { get; }
Property Value
System.String
Remarks
When the status is Available the alias is ready for use with your bot.
CloudformationAttribute: BotAliasStatus
BotAliasLocaleSettings
Specifies settings that are unique to a locale.
public virtual object BotAliasLocaleSettings { get; set; }
Property Value
System.Object
Remarks
For example, you can use different Lambda function depending on the bot's locale.
BotAliasName
The name of the bot alias.
public virtual string BotAliasName { get; set; }
Property Value
System.String
Remarks
BotAliasTags
An array of key-value pairs to apply to this resource.
public virtual object BotAliasTags { get; set; }
Property Value
System.Object
Remarks
You can only add tags when you specify an alias.
For more information, see Tag .
BotId
The unique identifier of the bot.
public virtual string BotId { get; set; }
Property Value
System.String
Remarks
BotVersion
The version of the bot that the bot alias references.
public virtual string BotVersion { get; set; }
Property Value
System.String
Remarks
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ConversationLogSettings
Specifies whether Amazon Lex logs text and audio for conversations with the bot.
public virtual object ConversationLogSettings { get; set; }
Property Value
System.Object
Remarks
When you enable conversation logs, text logs store text input, transcripts of audio input, and associated metadata in Amazon CloudWatch logs. Audio logs store input in Amazon S3 .
Description
The description of the bot alias.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
SentimentAnalysisSettings
Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
public virtual object SentimentAnalysisSettings { get; set; }
Property Value
System.Object
Remarks
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>