software.amazon.awscdk.services.lex

Class CfnBotVersion

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.lex.CfnBotVersion

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.621Z")
 @Stability(value=Stable)
public class CfnBotVersion
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Lex::BotVersion`.

Specifies a new version of the bot based on the DRAFT version. If the DRAFT version of this resource hasn't changed since you created the last version, Amazon Lex doesn't create a new version, it returns the last created version.

When you specify the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1.

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.lex.*;
 CfnBotVersion cfnBotVersion = CfnBotVersion.Builder.create(this, "MyCfnBotVersion")
         .botId("botId")
         .botVersionLocaleSpecification(List.of(BotVersionLocaleSpecificationProperty.builder()
                 .botVersionLocaleDetails(BotVersionLocaleDetailsProperty.builder()
                         .sourceBotVersion("sourceBotVersion")
                         .build())
                 .localeId("localeId")
                 .build()))
         // the properties below are optional
         .description("description")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnBotVersion.BotVersionLocaleDetailsProperty The version of a bot used for a bot locale.
static interface	CfnBotVersion.BotVersionLocaleSpecificationProperty Specifies the locale that Amazon Lex adds to this version.
static class	CfnBotVersion.Builder A fluent builder for CfnBotVersion.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnBotVersion(software.constructs.Construct scope, String id, CfnBotVersionProps props) Create a new `AWS::Lex::BotVersion`.
protected	CfnBotVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnBotVersion(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrBotVersion() The version of the bot.
String	getBotId() The unique identifier of the bot.
Object	getBotVersionLocaleSpecification() Specifies the locales that Amazon Lex adds to this version.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description of the version.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBotId(String value) The unique identifier of the bot.
void	setBotVersionLocaleSpecification(IResolvable value) Specifies the locales that Amazon Lex adds to this version.
void	setBotVersionLocaleSpecification(List<Object> value) Specifies the locales that Amazon Lex adds to this version.
void	setDescription(String value) The description of the version.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnBotVersion

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

CfnBotVersion

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

CfnBotVersion

@Stability(value=Stable)
public CfnBotVersion(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id,
                                              @NotNull
                                              CfnBotVersionProps props)

Create a new `AWS::Lex::BotVersion`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrBotVersion

@Stability(value=Stable)
 @NotNull
public String getAttrBotVersion()

The version of the bot.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getBotId

@Stability(value=Stable)
 @NotNull
public String getBotId()

The unique identifier of the bot.

setBotId

@Stability(value=Stable)
public void setBotId(@NotNull
                                              String value)

The unique identifier of the bot.

getBotVersionLocaleSpecification

@Stability(value=Stable)
 @NotNull
public Object getBotVersionLocaleSpecification()

Specifies the locales that Amazon Lex adds to this version.

You can choose the Draft version or any other previously published version for each locale. When you specify a source version, the locale data is copied from the source version to the new version.

setBotVersionLocaleSpecification

@Stability(value=Stable)
public void setBotVersionLocaleSpecification(@NotNull
                                                                      IResolvable value)

Specifies the locales that Amazon Lex adds to this version.

You can choose the Draft version or any other previously published version for each locale. When you specify a source version, the locale data is copied from the source version to the new version.

setBotVersionLocaleSpecification

@Stability(value=Stable)
public void setBotVersionLocaleSpecification(@NotNull
                                                                      List<Object> value)

Specifies the locales that Amazon Lex adds to this version.

You can choose the Draft version or any other previously published version for each locale. When you specify a source version, the locale data is copied from the source version to the new version.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The description of the version.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The description of the version.