@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
169 lines (168 loc) • 6.32 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides an Amazon Lex Bot Alias resource. For more information see
* [Amazon Lex: How It Works](https://docs.aws.amazon.com/lex/latest/dg/how-it-works.html)
*
* ## Example Usage
*
* ```typescript
* 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
*
* Using `pulumi import`, import bot aliases using an ID with the format `bot_name:bot_alias_name`. For example:
*
* ```sh
* $ pulumi import aws:lex/botAlias:BotAlias order_flowers_prod OrderFlowers:OrderFlowersProd
* ```
*/
export declare class BotAlias extends pulumi.CustomResource {
/**
* Get an existing BotAlias resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: BotAliasState, opts?: pulumi.CustomResourceOptions): BotAlias;
/**
* Returns true if the given object is an instance of BotAlias. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is BotAlias;
/**
* The ARN of the bot alias.
*/
readonly arn: pulumi.Output<string>;
/**
* The name of the bot.
*/
readonly botName: pulumi.Output<string>;
/**
* The version of the bot.
*/
readonly botVersion: pulumi.Output<string>;
/**
* Checksum of the bot alias.
*/
readonly checksum: pulumi.Output<string>;
/**
* The settings that determine how Amazon Lex uses conversation logs for the alias. Attributes are documented under conversation_logs.
*/
readonly conversationLogs: pulumi.Output<outputs.lex.BotAliasConversationLogs | undefined>;
/**
* The date that the bot alias was created.
*/
readonly createdDate: pulumi.Output<string>;
/**
* A description of the alias. Must be less than or equal to 200 characters in length.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.
*/
readonly lastUpdatedDate: pulumi.Output<string>;
/**
* The name of the alias. The name is not case sensitive. Must be less than or equal to 100 characters in length.
*/
readonly name: pulumi.Output<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* Create a BotAlias resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: BotAliasArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering BotAlias resources.
*/
export interface BotAliasState {
/**
* The ARN of the bot alias.
*/
arn?: pulumi.Input<string>;
/**
* The name of the bot.
*/
botName?: pulumi.Input<string>;
/**
* The version of the bot.
*/
botVersion?: pulumi.Input<string>;
/**
* Checksum of the bot alias.
*/
checksum?: pulumi.Input<string>;
/**
* The settings that determine how Amazon Lex uses conversation logs for the alias. Attributes are documented under conversation_logs.
*/
conversationLogs?: pulumi.Input<inputs.lex.BotAliasConversationLogs>;
/**
* The date that the bot alias was created.
*/
createdDate?: pulumi.Input<string>;
/**
* A description of the alias. Must be less than or equal to 200 characters in length.
*/
description?: pulumi.Input<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.
*/
lastUpdatedDate?: pulumi.Input<string>;
/**
* The name of the alias. The name is not case sensitive. Must be less than or equal to 100 characters in length.
*/
name?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a BotAlias resource.
*/
export interface BotAliasArgs {
/**
* The name of the bot.
*/
botName: pulumi.Input<string>;
/**
* The version of the bot.
*/
botVersion: pulumi.Input<string>;
/**
* The settings that determine how Amazon Lex uses conversation logs for the alias. Attributes are documented under conversation_logs.
*/
conversationLogs?: pulumi.Input<inputs.lex.BotAliasConversationLogs>;
/**
* A description of the alias. Must be less than or equal to 200 characters in length.
*/
description?: pulumi.Input<string>;
/**
* The name of the alias. The name is not case sensitive. Must be less than or equal to 100 characters in length.
*/
name?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
}