1. Packages
  2. AWS Classic
  3. API Docs
  4. lex
  5. BotAlias

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.10.0 published on Tuesday, Nov 21, 2023 by Pulumi

aws.lex.BotAlias

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.10.0 published on Tuesday, Nov 21, 2023 by Pulumi

    Provides an Amazon Lex Bot Alias resource. For more information see Amazon Lex: How It Works

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var orderFlowersProd = new Aws.Lex.BotAlias("orderFlowersProd", new()
        {
            BotName = "OrderFlowers",
            BotVersion = "1",
            Description = "Production Version of the OrderFlowers Bot.",
            Name = "OrderFlowersProd",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/lex"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := lex.NewBotAlias(ctx, "orderFlowersProd", &lex.BotAliasArgs{
    			BotName:     pulumi.String("OrderFlowers"),
    			BotVersion:  pulumi.String("1"),
    			Description: pulumi.String("Production Version of the OrderFlowers Bot."),
    			Name:        pulumi.String("OrderFlowersProd"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.lex.BotAlias;
    import com.pulumi.aws.lex.BotAliasArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var orderFlowersProd = new BotAlias("orderFlowersProd", BotAliasArgs.builder()        
                .botName("OrderFlowers")
                .botVersion("1")
                .description("Production Version of the OrderFlowers Bot.")
                .name("OrderFlowersProd")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aws as aws
    
    order_flowers_prod = aws.lex.BotAlias("orderFlowersProd",
        bot_name="OrderFlowers",
        bot_version="1",
        description="Production Version of the OrderFlowers Bot.",
        name="OrderFlowersProd")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const orderFlowersProd = new aws.lex.BotAlias("orderFlowersProd", {
        botName: "OrderFlowers",
        botVersion: "1",
        description: "Production Version of the OrderFlowers Bot.",
        name: "OrderFlowersProd",
    });
    
    resources:
      orderFlowersProd:
        type: aws:lex:BotAlias
        properties:
          botName: OrderFlowers
          botVersion: '1'
          description: Production Version of the OrderFlowers Bot.
          name: OrderFlowersProd
    

    Create BotAlias Resource

    new BotAlias(name: string, args: BotAliasArgs, opts?: CustomResourceOptions);
    @overload
    def BotAlias(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 bot_name: Optional[str] = None,
                 bot_version: Optional[str] = None,
                 conversation_logs: Optional[BotAliasConversationLogsArgs] = None,
                 description: Optional[str] = None,
                 name: Optional[str] = None)
    @overload
    def BotAlias(resource_name: str,
                 args: BotAliasArgs,
                 opts: Optional[ResourceOptions] = None)
    func NewBotAlias(ctx *Context, name string, args BotAliasArgs, opts ...ResourceOption) (*BotAlias, error)
    public BotAlias(string name, BotAliasArgs args, CustomResourceOptions? opts = null)
    public BotAlias(String name, BotAliasArgs args)
    public BotAlias(String name, BotAliasArgs args, CustomResourceOptions options)
    
    type: aws:lex:BotAlias
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args BotAliasArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BotAliasArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BotAliasArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BotAliasArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BotAliasArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    BotAlias Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The BotAlias resource accepts the following input properties:

    BotName string

    The name of the bot.

    BotVersion string

    The version of the bot.

    ConversationLogs BotAliasConversationLogs

    The settings that determine how Amazon Lex uses conversation logs for the alias. Attributes are documented under conversation_logs.

    Description string

    A description of the alias. Must be less than or equal to 200 characters in length.

    Name string

    The name of the alias. The name is not case sensitive. Must be less than or equal to 100 characters in length.

    BotName string

    The name of the bot.

    BotVersion string

    The version of the bot.

    ConversationLogs BotAliasConversationLogsArgs

    The settings that determine how Amazon Lex uses conversation logs for the alias. Attributes are documented under conversation_logs.

    Description string

    A description of the alias. Must be less than or equal to 200 characters in length.

    Name string

    The name of the alias. The name is not case sensitive. Must be less than or equal to 100 characters in length.

    botName String

    The name of the bot.

    botVersion String

    The version of the bot.

    conversationLogs BotAliasConversationLogs

    The settings that determine how Amazon Lex uses conversation logs for the alias. Attributes are documented under conversation_logs.

    description String

    A description of the alias. Must be less than or equal to 200 characters in length.

    name String

    The name of the alias. The name is not case sensitive. Must be less than or equal to 100 characters in length.

    botName string

    The name of the bot.

    botVersion string

    The version of the bot.

    conversationLogs BotAliasConversationLogs

    The settings that determine how Amazon Lex uses conversation logs for the alias. Attributes are documented under conversation_logs.

    description string

    A description of the alias. Must be less than or equal to 200 characters in length.

    name string

    The name of the alias. The name is not case sensitive. Must be less than or equal to 100 characters in length.

    bot_name str

    The name of the bot.

    bot_version str

    The version of the bot.

    conversation_logs BotAliasConversationLogsArgs

    The settings that determine how Amazon Lex uses conversation logs for the alias. Attributes are documented under conversation_logs.

    description str

    A description of the alias. Must be less than or equal to 200 characters in length.

    name str

    The name of the alias. The name is not case sensitive. Must be less than or equal to 100 characters in length.

    botName String

    The name of the bot.

    botVersion String

    The version of the bot.

    conversationLogs Property Map

    The settings that determine how Amazon Lex uses conversation logs for the alias. Attributes are documented under conversation_logs.

    description String

    A description of the alias. Must be less than or equal to 200 characters in length.

    name String

    The name of the alias. The name is not case sensitive. Must be less than or equal to 100 characters in length.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the BotAlias resource produces the following output properties:

    Arn string

    The ARN of the bot alias.

    Checksum string

    Checksum of the bot alias.

    CreatedDate string

    The date that the bot alias was created.

    Id string

    The provider-assigned unique ID for this managed resource.

    LastUpdatedDate string

    The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.

    Arn string

    The ARN of the bot alias.

    Checksum string

    Checksum of the bot alias.

    CreatedDate string

    The date that the bot alias was created.

    Id string

    The provider-assigned unique ID for this managed resource.

    LastUpdatedDate string

    The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.

    arn String

    The ARN of the bot alias.

    checksum String

    Checksum of the bot alias.

    createdDate String

    The date that the bot alias was created.

    id String

    The provider-assigned unique ID for this managed resource.

    lastUpdatedDate String

    The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.

    arn string

    The ARN of the bot alias.

    checksum string

    Checksum of the bot alias.

    createdDate string

    The date that the bot alias was created.

    id string

    The provider-assigned unique ID for this managed resource.

    lastUpdatedDate string

    The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.

    arn str

    The ARN of the bot alias.

    checksum str

    Checksum of the bot alias.

    created_date str

    The date that the bot alias was created.

    id str

    The provider-assigned unique ID for this managed resource.

    last_updated_date str

    The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.

    arn String

    The ARN of the bot alias.

    checksum String

    Checksum of the bot alias.

    createdDate String

    The date that the bot alias was created.

    id String

    The provider-assigned unique ID for this managed resource.

    lastUpdatedDate String

    The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.

    Look up Existing BotAlias Resource

    Get an existing BotAlias resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: BotAliasState, opts?: CustomResourceOptions): BotAlias
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            bot_name: Optional[str] = None,
            bot_version: Optional[str] = None,
            checksum: Optional[str] = None,
            conversation_logs: Optional[BotAliasConversationLogsArgs] = None,
            created_date: Optional[str] = None,
            description: Optional[str] = None,
            last_updated_date: Optional[str] = None,
            name: Optional[str] = None) -> BotAlias
    func GetBotAlias(ctx *Context, name string, id IDInput, state *BotAliasState, opts ...ResourceOption) (*BotAlias, error)
    public static BotAlias Get(string name, Input<string> id, BotAliasState? state, CustomResourceOptions? opts = null)
    public static BotAlias get(String name, Output<String> id, BotAliasState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string

    The ARN of the bot alias.

    BotName string

    The name of the bot.

    BotVersion string

    The version of the bot.

    Checksum string

    Checksum of the bot alias.

    ConversationLogs BotAliasConversationLogs

    The settings that determine how Amazon Lex uses conversation logs for the alias. Attributes are documented under conversation_logs.

    CreatedDate string

    The date that the bot alias was created.

    Description string

    A description of the alias. Must be less than or equal to 200 characters in length.

    LastUpdatedDate string

    The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.

    Name string

    The name of the alias. The name is not case sensitive. Must be less than or equal to 100 characters in length.

    Arn string

    The ARN of the bot alias.

    BotName string

    The name of the bot.

    BotVersion string

    The version of the bot.

    Checksum string

    Checksum of the bot alias.

    ConversationLogs BotAliasConversationLogsArgs

    The settings that determine how Amazon Lex uses conversation logs for the alias. Attributes are documented under conversation_logs.

    CreatedDate string

    The date that the bot alias was created.

    Description string

    A description of the alias. Must be less than or equal to 200 characters in length.

    LastUpdatedDate string

    The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.

    Name string

    The name of the alias. The name is not case sensitive. Must be less than or equal to 100 characters in length.

    arn String

    The ARN of the bot alias.

    botName String

    The name of the bot.

    botVersion String

    The version of the bot.

    checksum String

    Checksum of the bot alias.

    conversationLogs BotAliasConversationLogs

    The settings that determine how Amazon Lex uses conversation logs for the alias. Attributes are documented under conversation_logs.

    createdDate String

    The date that the bot alias was created.

    description String

    A description of the alias. Must be less than or equal to 200 characters in length.

    lastUpdatedDate String

    The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.

    name String

    The name of the alias. The name is not case sensitive. Must be less than or equal to 100 characters in length.

    arn string

    The ARN of the bot alias.

    botName string

    The name of the bot.

    botVersion string

    The version of the bot.

    checksum string

    Checksum of the bot alias.

    conversationLogs BotAliasConversationLogs

    The settings that determine how Amazon Lex uses conversation logs for the alias. Attributes are documented under conversation_logs.

    createdDate string

    The date that the bot alias was created.

    description string

    A description of the alias. Must be less than or equal to 200 characters in length.

    lastUpdatedDate string

    The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.

    name string

    The name of the alias. The name is not case sensitive. Must be less than or equal to 100 characters in length.

    arn str

    The ARN of the bot alias.

    bot_name str

    The name of the bot.

    bot_version str

    The version of the bot.

    checksum str

    Checksum of the bot alias.

    conversation_logs BotAliasConversationLogsArgs

    The settings that determine how Amazon Lex uses conversation logs for the alias. Attributes are documented under conversation_logs.

    created_date str

    The date that the bot alias was created.

    description str

    A description of the alias. Must be less than or equal to 200 characters in length.

    last_updated_date str

    The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.

    name str

    The name of the alias. The name is not case sensitive. Must be less than or equal to 100 characters in length.

    arn String

    The ARN of the bot alias.

    botName String

    The name of the bot.

    botVersion String

    The version of the bot.

    checksum String

    Checksum of the bot alias.

    conversationLogs Property Map

    The settings that determine how Amazon Lex uses conversation logs for the alias. Attributes are documented under conversation_logs.

    createdDate String

    The date that the bot alias was created.

    description String

    A description of the alias. Must be less than or equal to 200 characters in length.

    lastUpdatedDate String

    The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.

    name String

    The name of the alias. The name is not case sensitive. Must be less than or equal to 100 characters in length.

    Supporting Types

    BotAliasConversationLogs, BotAliasConversationLogsArgs

    IamRoleArn string

    The Amazon Resource Name (ARN) of the IAM role used to write your logs to CloudWatch Logs or an S3 bucket. Must be between 20 and 2048 characters in length.

    LogSettings List<BotAliasConversationLogsLogSetting>

    The settings for your conversation logs. You can log text, audio, or both. Attributes are documented under log_settings.

    IamRoleArn string

    The Amazon Resource Name (ARN) of the IAM role used to write your logs to CloudWatch Logs or an S3 bucket. Must be between 20 and 2048 characters in length.

    LogSettings []BotAliasConversationLogsLogSetting

    The settings for your conversation logs. You can log text, audio, or both. Attributes are documented under log_settings.

    iamRoleArn String

    The Amazon Resource Name (ARN) of the IAM role used to write your logs to CloudWatch Logs or an S3 bucket. Must be between 20 and 2048 characters in length.

    logSettings List<BotAliasConversationLogsLogSetting>

    The settings for your conversation logs. You can log text, audio, or both. Attributes are documented under log_settings.

    iamRoleArn string

    The Amazon Resource Name (ARN) of the IAM role used to write your logs to CloudWatch Logs or an S3 bucket. Must be between 20 and 2048 characters in length.

    logSettings BotAliasConversationLogsLogSetting[]

    The settings for your conversation logs. You can log text, audio, or both. Attributes are documented under log_settings.

    iam_role_arn str

    The Amazon Resource Name (ARN) of the IAM role used to write your logs to CloudWatch Logs or an S3 bucket. Must be between 20 and 2048 characters in length.

    log_settings Sequence[BotAliasConversationLogsLogSetting]

    The settings for your conversation logs. You can log text, audio, or both. Attributes are documented under log_settings.

    iamRoleArn String

    The Amazon Resource Name (ARN) of the IAM role used to write your logs to CloudWatch Logs or an S3 bucket. Must be between 20 and 2048 characters in length.

    logSettings List<Property Map>

    The settings for your conversation logs. You can log text, audio, or both. Attributes are documented under log_settings.

    BotAliasConversationLogsLogSetting, BotAliasConversationLogsLogSettingArgs

    Destination string

    The destination where logs are delivered. Options are CLOUDWATCH_LOGS or S3.

    LogType string

    The type of logging that is enabled. Options are AUDIO or TEXT.

    ResourceArn string

    The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket where the logs are delivered. Must be less than or equal to 2048 characters in length.

    KmsKeyArn string

    The Amazon Resource Name (ARN) of the key used to encrypt audio logs in an S3 bucket. This can only be specified when destination is set to S3. Must be between 20 and 2048 characters in length.

    ResourcePrefix string

    The prefix of the S3 object key for AUDIO logs or the log stream name for TEXT logs.

    Destination string

    The destination where logs are delivered. Options are CLOUDWATCH_LOGS or S3.

    LogType string

    The type of logging that is enabled. Options are AUDIO or TEXT.

    ResourceArn string

    The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket where the logs are delivered. Must be less than or equal to 2048 characters in length.

    KmsKeyArn string

    The Amazon Resource Name (ARN) of the key used to encrypt audio logs in an S3 bucket. This can only be specified when destination is set to S3. Must be between 20 and 2048 characters in length.

    ResourcePrefix string

    The prefix of the S3 object key for AUDIO logs or the log stream name for TEXT logs.

    destination String

    The destination where logs are delivered. Options are CLOUDWATCH_LOGS or S3.

    logType String

    The type of logging that is enabled. Options are AUDIO or TEXT.

    resourceArn String

    The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket where the logs are delivered. Must be less than or equal to 2048 characters in length.

    kmsKeyArn String

    The Amazon Resource Name (ARN) of the key used to encrypt audio logs in an S3 bucket. This can only be specified when destination is set to S3. Must be between 20 and 2048 characters in length.

    resourcePrefix String

    The prefix of the S3 object key for AUDIO logs or the log stream name for TEXT logs.

    destination string

    The destination where logs are delivered. Options are CLOUDWATCH_LOGS or S3.

    logType string

    The type of logging that is enabled. Options are AUDIO or TEXT.

    resourceArn string

    The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket where the logs are delivered. Must be less than or equal to 2048 characters in length.

    kmsKeyArn string

    The Amazon Resource Name (ARN) of the key used to encrypt audio logs in an S3 bucket. This can only be specified when destination is set to S3. Must be between 20 and 2048 characters in length.

    resourcePrefix string

    The prefix of the S3 object key for AUDIO logs or the log stream name for TEXT logs.

    destination str

    The destination where logs are delivered. Options are CLOUDWATCH_LOGS or S3.

    log_type str

    The type of logging that is enabled. Options are AUDIO or TEXT.

    resource_arn str

    The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket where the logs are delivered. Must be less than or equal to 2048 characters in length.

    kms_key_arn str

    The Amazon Resource Name (ARN) of the key used to encrypt audio logs in an S3 bucket. This can only be specified when destination is set to S3. Must be between 20 and 2048 characters in length.

    resource_prefix str

    The prefix of the S3 object key for AUDIO logs or the log stream name for TEXT logs.

    destination String

    The destination where logs are delivered. Options are CLOUDWATCH_LOGS or S3.

    logType String

    The type of logging that is enabled. Options are AUDIO or TEXT.

    resourceArn String

    The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket where the logs are delivered. Must be less than or equal to 2048 characters in length.

    kmsKeyArn String

    The Amazon Resource Name (ARN) of the key used to encrypt audio logs in an S3 bucket. This can only be specified when destination is set to S3. Must be between 20 and 2048 characters in length.

    resourcePrefix String

    The prefix of the S3 object key for AUDIO logs or the log stream name for TEXT logs.

    Import

    Using pulumi import, import bot aliases using an ID with the format bot_name:bot_alias_name. For example:

     $ pulumi import aws:lex/botAlias:BotAlias order_flowers_prod OrderFlowers:OrderFlowersProd
    

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the aws Terraform Provider.

    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.10.0 published on Tuesday, Nov 21, 2023 by Pulumi