Package software.amazon.awscdk.services.lex

Class CfnBotVersion

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.lex.CfnBotVersion
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:59.674Z") @Stability(Stable) public class CfnBotVersion extends CfnResource implements IInspectable
A CloudFormation AWS::Lex::BotVersion.

Amazon Lex V2 is the only supported version in AWS CloudFormation .

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();

  • 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

    • CfnBotVersion

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

    • CfnBotVersion

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

    • CfnBotVersion

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

    • getAttrBotVersion

      @Stability(Stable) @NotNull public String getAttrBotVersion()
      The version of the bot.

    • getCfnProperties

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

    • getBotId

      @Stability(Stable) @NotNull public String getBotId()
      The unique identifier of the bot.

    • setBotId

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

    • getBotVersionLocaleSpecification

      @Stability(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(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(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(Stable) @Nullable public String getDescription()
      The description of the version.

    • setDescription

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