aws.lex.BotAlias
Explore with Pulumi AI
Provides an Amazon Lex Bot Alias resource. For more information see Amazon Lex: How It Works
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const orderFlowersProd = new aws.lex.BotAlias("order_flowers_prod", {
botName: "OrderFlowers",
botVersion: "1",
description: "Production Version of the OrderFlowers Bot.",
name: "OrderFlowersProd",
});
import pulumi
import pulumi_aws as aws
order_flowers_prod = aws.lex.BotAlias("order_flowers_prod",
bot_name="OrderFlowers",
bot_version="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, "order_flowers_prod", &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
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var orderFlowersProd = new Aws.Lex.BotAlias("order_flowers_prod", new()
{
BotName = "OrderFlowers",
BotVersion = "1",
Description = "Production Version of the OrderFlowers Bot.",
Name = "OrderFlowersProd",
});
});
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());
}
}
resources:
orderFlowersProd:
type: aws:lex:BotAlias
name: order_flowers_prod
properties:
botName: OrderFlowers
botVersion: '1'
description: Production Version of the OrderFlowers Bot.
name: OrderFlowersProd
Create BotAlias Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new BotAlias(name: string, args: BotAliasArgs, opts?: CustomResourceOptions);
@overload
def BotAlias(resource_name: str,
args: BotAliasArgs,
opts: Optional[ResourceOptions] = None)
@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)
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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var botAliasResource = new Aws.Lex.BotAlias("botAliasResource", new()
{
BotName = "string",
BotVersion = "string",
ConversationLogs = new Aws.Lex.Inputs.BotAliasConversationLogsArgs
{
IamRoleArn = "string",
LogSettings = new[]
{
new Aws.Lex.Inputs.BotAliasConversationLogsLogSettingArgs
{
Destination = "string",
LogType = "string",
ResourceArn = "string",
KmsKeyArn = "string",
ResourcePrefix = "string",
},
},
},
Description = "string",
Name = "string",
});
example, err := lex.NewBotAlias(ctx, "botAliasResource", &lex.BotAliasArgs{
BotName: pulumi.String("string"),
BotVersion: pulumi.String("string"),
ConversationLogs: &lex.BotAliasConversationLogsArgs{
IamRoleArn: pulumi.String("string"),
LogSettings: lex.BotAliasConversationLogsLogSettingArray{
&lex.BotAliasConversationLogsLogSettingArgs{
Destination: pulumi.String("string"),
LogType: pulumi.String("string"),
ResourceArn: pulumi.String("string"),
KmsKeyArn: pulumi.String("string"),
ResourcePrefix: pulumi.String("string"),
},
},
},
Description: pulumi.String("string"),
Name: pulumi.String("string"),
})
var botAliasResource = new BotAlias("botAliasResource", BotAliasArgs.builder()
.botName("string")
.botVersion("string")
.conversationLogs(BotAliasConversationLogsArgs.builder()
.iamRoleArn("string")
.logSettings(BotAliasConversationLogsLogSettingArgs.builder()
.destination("string")
.logType("string")
.resourceArn("string")
.kmsKeyArn("string")
.resourcePrefix("string")
.build())
.build())
.description("string")
.name("string")
.build());
bot_alias_resource = aws.lex.BotAlias("botAliasResource",
bot_name="string",
bot_version="string",
conversation_logs={
"iam_role_arn": "string",
"log_settings": [{
"destination": "string",
"log_type": "string",
"resource_arn": "string",
"kms_key_arn": "string",
"resource_prefix": "string",
}],
},
description="string",
name="string")
const botAliasResource = new aws.lex.BotAlias("botAliasResource", {
botName: "string",
botVersion: "string",
conversationLogs: {
iamRoleArn: "string",
logSettings: [{
destination: "string",
logType: "string",
resourceArn: "string",
kmsKeyArn: "string",
resourcePrefix: "string",
}],
},
description: "string",
name: "string",
});
type: aws:lex:BotAlias
properties:
botName: string
botVersion: string
conversationLogs:
iamRoleArn: string
logSettings:
- destination: string
kmsKeyArn: string
logType: string
resourceArn: string
resourcePrefix: string
description: string
name: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The BotAlias resource accepts the following input properties:
- Bot
Name string - The name of the bot.
- Bot
Version string - The version of the bot.
- Conversation
Logs BotAlias Conversation Logs - 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 string - The name of the bot.
- Bot
Version string - The version of the bot.
- Conversation
Logs BotAlias Conversation Logs Args - 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 String - The name of the bot.
- bot
Version String - The version of the bot.
- conversation
Logs BotAlias Conversation Logs - 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 string - The name of the bot.
- bot
Version string - The version of the bot.
- conversation
Logs BotAlias Conversation Logs - 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 BotAlias Conversation Logs Args - 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.
- bot
Name String - The name of the bot.
- bot
Version String - The version of the bot.
- conversation
Logs 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.
- Created
Date string - The date that the bot alias was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Updated stringDate - 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.
- Created
Date string - The date that the bot alias was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Updated stringDate - 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.
- created
Date String - The date that the bot alias was created.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Updated StringDate - 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.
- created
Date string - The date that the bot alias was created.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Updated stringDate - 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_ strdate - 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.
- created
Date String - The date that the bot alias was created.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Updated StringDate - 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.
- Arn string
- The ARN of the bot alias.
- Bot
Name string - The name of the bot.
- Bot
Version string - The version of the bot.
- Checksum string
- Checksum of the bot alias.
- Conversation
Logs BotAlias Conversation Logs - The settings that determine how Amazon Lex uses conversation logs for the alias. Attributes are documented under conversation_logs.
- Created
Date 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.
- Last
Updated stringDate - 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.
- Bot
Name string - The name of the bot.
- Bot
Version string - The version of the bot.
- Checksum string
- Checksum of the bot alias.
- Conversation
Logs BotAlias Conversation Logs Args - The settings that determine how Amazon Lex uses conversation logs for the alias. Attributes are documented under conversation_logs.
- Created
Date 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.
- Last
Updated stringDate - 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.
- bot
Name String - The name of the bot.
- bot
Version String - The version of the bot.
- checksum String
- Checksum of the bot alias.
- conversation
Logs BotAlias Conversation Logs - The settings that determine how Amazon Lex uses conversation logs for the alias. Attributes are documented under conversation_logs.
- created
Date 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.
- last
Updated StringDate - 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.
- bot
Name string - The name of the bot.
- bot
Version string - The version of the bot.
- checksum string
- Checksum of the bot alias.
- conversation
Logs BotAlias Conversation Logs - The settings that determine how Amazon Lex uses conversation logs for the alias. Attributes are documented under conversation_logs.
- created
Date 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.
- last
Updated stringDate - 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 BotAlias Conversation Logs Args - 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_ strdate - 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.
- bot
Name String - The name of the bot.
- bot
Version String - The version of the bot.
- checksum String
- Checksum of the bot alias.
- conversation
Logs Property Map - The settings that determine how Amazon Lex uses conversation logs for the alias. Attributes are documented under conversation_logs.
- created
Date 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.
- last
Updated StringDate - 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
- Iam
Role stringArn - 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 List<BotAlias Conversation Logs Log Setting> - The settings for your conversation logs. You can log text, audio, or both. Attributes are documented under log_settings.
- Iam
Role stringArn - 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 []BotAlias Conversation Logs Log Setting - The settings for your conversation logs. You can log text, audio, or both. Attributes are documented under log_settings.
- iam
Role StringArn - 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 List<BotAlias Conversation Logs Log Setting> - The settings for your conversation logs. You can log text, audio, or both. Attributes are documented under log_settings.
- iam
Role stringArn - 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 BotAlias Conversation Logs Log Setting[] - The settings for your conversation logs. You can log text, audio, or both. Attributes are documented under log_settings.
- iam_
role_ strarn - 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[BotAlias Conversation Logs Log Setting] - The settings for your conversation logs. You can log text, audio, or both. Attributes are documented under log_settings.
- iam
Role StringArn - 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 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
orS3
. - Log
Type string - The type of logging that is enabled. Options are
AUDIO
orTEXT
. - Resource
Arn 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.
- Kms
Key stringArn - 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 toS3
. Must be between 20 and 2048 characters in length. - Resource
Prefix string - The prefix of the S3 object key for
AUDIO
logs or the log stream name forTEXT
logs.
- Destination string
- The destination where logs are delivered. Options are
CLOUDWATCH_LOGS
orS3
. - Log
Type string - The type of logging that is enabled. Options are
AUDIO
orTEXT
. - Resource
Arn 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.
- Kms
Key stringArn - 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 toS3
. Must be between 20 and 2048 characters in length. - Resource
Prefix string - The prefix of the S3 object key for
AUDIO
logs or the log stream name forTEXT
logs.
- destination String
- The destination where logs are delivered. Options are
CLOUDWATCH_LOGS
orS3
. - log
Type String - The type of logging that is enabled. Options are
AUDIO
orTEXT
. - resource
Arn 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.
- kms
Key StringArn - 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 toS3
. Must be between 20 and 2048 characters in length. - resource
Prefix String - The prefix of the S3 object key for
AUDIO
logs or the log stream name forTEXT
logs.
- destination string
- The destination where logs are delivered. Options are
CLOUDWATCH_LOGS
orS3
. - log
Type string - The type of logging that is enabled. Options are
AUDIO
orTEXT
. - resource
Arn 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.
- kms
Key stringArn - 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 toS3
. Must be between 20 and 2048 characters in length. - resource
Prefix string - The prefix of the S3 object key for
AUDIO
logs or the log stream name forTEXT
logs.
- destination str
- The destination where logs are delivered. Options are
CLOUDWATCH_LOGS
orS3
. - log_
type str - The type of logging that is enabled. Options are
AUDIO
orTEXT
. - 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_ strarn - 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 toS3
. 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 forTEXT
logs.
- destination String
- The destination where logs are delivered. Options are
CLOUDWATCH_LOGS
orS3
. - log
Type String - The type of logging that is enabled. Options are
AUDIO
orTEXT
. - resource
Arn 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.
- kms
Key StringArn - 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 toS3
. Must be between 20 and 2048 characters in length. - resource
Prefix String - The prefix of the S3 object key for
AUDIO
logs or the log stream name forTEXT
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
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.