aws.connect.BotAssociation
Explore with Pulumi AI
Allows the specified Amazon Connect instance to access the specified Amazon Lex (V1) bot. For more information see Amazon Connect: Getting Started and Add an Amazon Lex bot.
NOTE: This resource only currently supports Amazon Lex (V1) Associations.
Example Usage
Basic
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.connect.BotAssociation("example", {
instanceId: exampleAwsConnectInstance.id,
lexBot: {
lexRegion: "us-west-2",
name: "Test",
},
});
import pulumi
import pulumi_aws as aws
example = aws.connect.BotAssociation("example",
instance_id=example_aws_connect_instance["id"],
lex_bot={
"lex_region": "us-west-2",
"name": "Test",
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := connect.NewBotAssociation(ctx, "example", &connect.BotAssociationArgs{
InstanceId: pulumi.Any(exampleAwsConnectInstance.Id),
LexBot: &connect.BotAssociationLexBotArgs{
LexRegion: pulumi.String("us-west-2"),
Name: pulumi.String("Test"),
},
})
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 example = new Aws.Connect.BotAssociation("example", new()
{
InstanceId = exampleAwsConnectInstance.Id,
LexBot = new Aws.Connect.Inputs.BotAssociationLexBotArgs
{
LexRegion = "us-west-2",
Name = "Test",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.connect.BotAssociation;
import com.pulumi.aws.connect.BotAssociationArgs;
import com.pulumi.aws.connect.inputs.BotAssociationLexBotArgs;
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 example = new BotAssociation("example", BotAssociationArgs.builder()
.instanceId(exampleAwsConnectInstance.id())
.lexBot(BotAssociationLexBotArgs.builder()
.lexRegion("us-west-2")
.name("Test")
.build())
.build());
}
}
resources:
example:
type: aws:connect:BotAssociation
properties:
instanceId: ${exampleAwsConnectInstance.id}
lexBot:
lexRegion: us-west-2
name: Test
Including a sample Lex bot
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const current = aws.getRegion({});
const example = new aws.lex.Intent("example", {
createVersion: true,
name: "connect_lex_intent",
fulfillmentActivity: {
type: "ReturnIntent",
},
sampleUtterances: ["I would like to pick up flowers."],
});
const exampleBot = new aws.lex.Bot("example", {
abortStatement: {
messages: [{
content: "Sorry, I am not able to assist at this time.",
contentType: "PlainText",
}],
},
clarificationPrompt: {
maxAttempts: 2,
messages: [{
content: "I didn't understand you, what would you like to do?",
contentType: "PlainText",
}],
},
intents: [{
intentName: example.name,
intentVersion: "1",
}],
childDirected: false,
name: "connect_lex_bot",
processBehavior: "BUILD",
});
const exampleBotAssociation = new aws.connect.BotAssociation("example", {
instanceId: exampleAwsConnectInstance.id,
lexBot: {
lexRegion: current.then(current => current.name),
name: exampleBot.name,
},
});
import pulumi
import pulumi_aws as aws
current = aws.get_region()
example = aws.lex.Intent("example",
create_version=True,
name="connect_lex_intent",
fulfillment_activity={
"type": "ReturnIntent",
},
sample_utterances=["I would like to pick up flowers."])
example_bot = aws.lex.Bot("example",
abort_statement={
"messages": [{
"content": "Sorry, I am not able to assist at this time.",
"content_type": "PlainText",
}],
},
clarification_prompt={
"max_attempts": 2,
"messages": [{
"content": "I didn't understand you, what would you like to do?",
"content_type": "PlainText",
}],
},
intents=[{
"intent_name": example.name,
"intent_version": "1",
}],
child_directed=False,
name="connect_lex_bot",
process_behavior="BUILD")
example_bot_association = aws.connect.BotAssociation("example",
instance_id=example_aws_connect_instance["id"],
lex_bot={
"lex_region": current.name,
"name": example_bot.name,
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
"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 {
current, err := aws.GetRegion(ctx, &aws.GetRegionArgs{}, nil)
if err != nil {
return err
}
example, err := lex.NewIntent(ctx, "example", &lex.IntentArgs{
CreateVersion: pulumi.Bool(true),
Name: pulumi.String("connect_lex_intent"),
FulfillmentActivity: &lex.IntentFulfillmentActivityArgs{
Type: pulumi.String("ReturnIntent"),
},
SampleUtterances: pulumi.StringArray{
pulumi.String("I would like to pick up flowers."),
},
})
if err != nil {
return err
}
exampleBot, err := lex.NewBot(ctx, "example", &lex.BotArgs{
AbortStatement: &lex.BotAbortStatementArgs{
Messages: lex.BotAbortStatementMessageArray{
&lex.BotAbortStatementMessageArgs{
Content: pulumi.String("Sorry, I am not able to assist at this time."),
ContentType: pulumi.String("PlainText"),
},
},
},
ClarificationPrompt: &lex.BotClarificationPromptArgs{
MaxAttempts: pulumi.Int(2),
Messages: lex.BotClarificationPromptMessageArray{
&lex.BotClarificationPromptMessageArgs{
Content: pulumi.String("I didn't understand you, what would you like to do?"),
ContentType: pulumi.String("PlainText"),
},
},
},
Intents: lex.BotIntentArray{
&lex.BotIntentArgs{
IntentName: example.Name,
IntentVersion: pulumi.String("1"),
},
},
ChildDirected: pulumi.Bool(false),
Name: pulumi.String("connect_lex_bot"),
ProcessBehavior: pulumi.String("BUILD"),
})
if err != nil {
return err
}
_, err = connect.NewBotAssociation(ctx, "example", &connect.BotAssociationArgs{
InstanceId: pulumi.Any(exampleAwsConnectInstance.Id),
LexBot: &connect.BotAssociationLexBotArgs{
LexRegion: pulumi.String(current.Name),
Name: exampleBot.Name,
},
})
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 current = Aws.GetRegion.Invoke();
var example = new Aws.Lex.Intent("example", new()
{
CreateVersion = true,
Name = "connect_lex_intent",
FulfillmentActivity = new Aws.Lex.Inputs.IntentFulfillmentActivityArgs
{
Type = "ReturnIntent",
},
SampleUtterances = new[]
{
"I would like to pick up flowers.",
},
});
var exampleBot = new Aws.Lex.Bot("example", new()
{
AbortStatement = new Aws.Lex.Inputs.BotAbortStatementArgs
{
Messages = new[]
{
new Aws.Lex.Inputs.BotAbortStatementMessageArgs
{
Content = "Sorry, I am not able to assist at this time.",
ContentType = "PlainText",
},
},
},
ClarificationPrompt = new Aws.Lex.Inputs.BotClarificationPromptArgs
{
MaxAttempts = 2,
Messages = new[]
{
new Aws.Lex.Inputs.BotClarificationPromptMessageArgs
{
Content = "I didn't understand you, what would you like to do?",
ContentType = "PlainText",
},
},
},
Intents = new[]
{
new Aws.Lex.Inputs.BotIntentArgs
{
IntentName = example.Name,
IntentVersion = "1",
},
},
ChildDirected = false,
Name = "connect_lex_bot",
ProcessBehavior = "BUILD",
});
var exampleBotAssociation = new Aws.Connect.BotAssociation("example", new()
{
InstanceId = exampleAwsConnectInstance.Id,
LexBot = new Aws.Connect.Inputs.BotAssociationLexBotArgs
{
LexRegion = current.Apply(getRegionResult => getRegionResult.Name),
Name = exampleBot.Name,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.AwsFunctions;
import com.pulumi.aws.inputs.GetRegionArgs;
import com.pulumi.aws.lex.Intent;
import com.pulumi.aws.lex.IntentArgs;
import com.pulumi.aws.lex.inputs.IntentFulfillmentActivityArgs;
import com.pulumi.aws.lex.Bot;
import com.pulumi.aws.lex.BotArgs;
import com.pulumi.aws.lex.inputs.BotAbortStatementArgs;
import com.pulumi.aws.lex.inputs.BotClarificationPromptArgs;
import com.pulumi.aws.lex.inputs.BotIntentArgs;
import com.pulumi.aws.connect.BotAssociation;
import com.pulumi.aws.connect.BotAssociationArgs;
import com.pulumi.aws.connect.inputs.BotAssociationLexBotArgs;
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) {
final var current = AwsFunctions.getRegion();
var example = new Intent("example", IntentArgs.builder()
.createVersion(true)
.name("connect_lex_intent")
.fulfillmentActivity(IntentFulfillmentActivityArgs.builder()
.type("ReturnIntent")
.build())
.sampleUtterances("I would like to pick up flowers.")
.build());
var exampleBot = new Bot("exampleBot", BotArgs.builder()
.abortStatement(BotAbortStatementArgs.builder()
.messages(BotAbortStatementMessageArgs.builder()
.content("Sorry, I am not able to assist at this time.")
.contentType("PlainText")
.build())
.build())
.clarificationPrompt(BotClarificationPromptArgs.builder()
.maxAttempts(2)
.messages(BotClarificationPromptMessageArgs.builder()
.content("I didn't understand you, what would you like to do?")
.contentType("PlainText")
.build())
.build())
.intents(BotIntentArgs.builder()
.intentName(example.name())
.intentVersion("1")
.build())
.childDirected(false)
.name("connect_lex_bot")
.processBehavior("BUILD")
.build());
var exampleBotAssociation = new BotAssociation("exampleBotAssociation", BotAssociationArgs.builder()
.instanceId(exampleAwsConnectInstance.id())
.lexBot(BotAssociationLexBotArgs.builder()
.lexRegion(current.applyValue(getRegionResult -> getRegionResult.name()))
.name(exampleBot.name())
.build())
.build());
}
}
resources:
example:
type: aws:lex:Intent
properties:
createVersion: true
name: connect_lex_intent
fulfillmentActivity:
type: ReturnIntent
sampleUtterances:
- I would like to pick up flowers.
exampleBot:
type: aws:lex:Bot
name: example
properties:
abortStatement:
messages:
- content: Sorry, I am not able to assist at this time.
contentType: PlainText
clarificationPrompt:
maxAttempts: 2
messages:
- content: I didn't understand you, what would you like to do?
contentType: PlainText
intents:
- intentName: ${example.name}
intentVersion: '1'
childDirected: false
name: connect_lex_bot
processBehavior: BUILD
exampleBotAssociation:
type: aws:connect:BotAssociation
name: example
properties:
instanceId: ${exampleAwsConnectInstance.id}
lexBot:
lexRegion: ${current.name}
name: ${exampleBot.name}
variables:
current:
fn::invoke:
Function: aws:getRegion
Arguments: {}
Create BotAssociation Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new BotAssociation(name: string, args: BotAssociationArgs, opts?: CustomResourceOptions);
@overload
def BotAssociation(resource_name: str,
args: BotAssociationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def BotAssociation(resource_name: str,
opts: Optional[ResourceOptions] = None,
instance_id: Optional[str] = None,
lex_bot: Optional[BotAssociationLexBotArgs] = None)
func NewBotAssociation(ctx *Context, name string, args BotAssociationArgs, opts ...ResourceOption) (*BotAssociation, error)
public BotAssociation(string name, BotAssociationArgs args, CustomResourceOptions? opts = null)
public BotAssociation(String name, BotAssociationArgs args)
public BotAssociation(String name, BotAssociationArgs args, CustomResourceOptions options)
type: aws:connect:BotAssociation
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 BotAssociationArgs
- 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 BotAssociationArgs
- 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 BotAssociationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BotAssociationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BotAssociationArgs
- 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 botAssociationResource = new Aws.Connect.BotAssociation("botAssociationResource", new()
{
InstanceId = "string",
LexBot = new Aws.Connect.Inputs.BotAssociationLexBotArgs
{
Name = "string",
LexRegion = "string",
},
});
example, err := connect.NewBotAssociation(ctx, "botAssociationResource", &connect.BotAssociationArgs{
InstanceId: pulumi.String("string"),
LexBot: &connect.BotAssociationLexBotArgs{
Name: pulumi.String("string"),
LexRegion: pulumi.String("string"),
},
})
var botAssociationResource = new BotAssociation("botAssociationResource", BotAssociationArgs.builder()
.instanceId("string")
.lexBot(BotAssociationLexBotArgs.builder()
.name("string")
.lexRegion("string")
.build())
.build());
bot_association_resource = aws.connect.BotAssociation("botAssociationResource",
instance_id="string",
lex_bot={
"name": "string",
"lex_region": "string",
})
const botAssociationResource = new aws.connect.BotAssociation("botAssociationResource", {
instanceId: "string",
lexBot: {
name: "string",
lexRegion: "string",
},
});
type: aws:connect:BotAssociation
properties:
instanceId: string
lexBot:
lexRegion: string
name: string
BotAssociation 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 BotAssociation resource accepts the following input properties:
- Instance
Id string - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- Lex
Bot BotAssociation Lex Bot - Configuration information of an Amazon Lex (V1) bot. Detailed below.
- Instance
Id string - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- Lex
Bot BotAssociation Lex Bot Args - Configuration information of an Amazon Lex (V1) bot. Detailed below.
- instance
Id String - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- lex
Bot BotAssociation Lex Bot - Configuration information of an Amazon Lex (V1) bot. Detailed below.
- instance
Id string - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- lex
Bot BotAssociation Lex Bot - Configuration information of an Amazon Lex (V1) bot. Detailed below.
- instance_
id str - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- lex_
bot BotAssociation Lex Bot Args - Configuration information of an Amazon Lex (V1) bot. Detailed below.
- instance
Id String - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- lex
Bot Property Map - Configuration information of an Amazon Lex (V1) bot. Detailed below.
Outputs
All input properties are implicitly available as output properties. Additionally, the BotAssociation resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing BotAssociation Resource
Get an existing BotAssociation 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?: BotAssociationState, opts?: CustomResourceOptions): BotAssociation
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
instance_id: Optional[str] = None,
lex_bot: Optional[BotAssociationLexBotArgs] = None) -> BotAssociation
func GetBotAssociation(ctx *Context, name string, id IDInput, state *BotAssociationState, opts ...ResourceOption) (*BotAssociation, error)
public static BotAssociation Get(string name, Input<string> id, BotAssociationState? state, CustomResourceOptions? opts = null)
public static BotAssociation get(String name, Output<String> id, BotAssociationState 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.
- Instance
Id string - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- Lex
Bot BotAssociation Lex Bot - Configuration information of an Amazon Lex (V1) bot. Detailed below.
- Instance
Id string - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- Lex
Bot BotAssociation Lex Bot Args - Configuration information of an Amazon Lex (V1) bot. Detailed below.
- instance
Id String - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- lex
Bot BotAssociation Lex Bot - Configuration information of an Amazon Lex (V1) bot. Detailed below.
- instance
Id string - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- lex
Bot BotAssociation Lex Bot - Configuration information of an Amazon Lex (V1) bot. Detailed below.
- instance_
id str - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- lex_
bot BotAssociation Lex Bot Args - Configuration information of an Amazon Lex (V1) bot. Detailed below.
- instance
Id String - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- lex
Bot Property Map - Configuration information of an Amazon Lex (V1) bot. Detailed below.
Supporting Types
BotAssociationLexBot, BotAssociationLexBotArgs
- name str
- The name of the Amazon Lex (V1) bot.
- lex_
region str - The Region that the Amazon Lex (V1) bot was created in. Defaults to current region.
Import
Using pulumi import
, import aws_connect_bot_association
using the Amazon Connect instance ID, Lex (V1) bot name, and Lex (V1) bot region separated by colons (:
). For example:
$ pulumi import aws:connect/botAssociation:BotAssociation example aaaaaaaa-bbbb-cccc-dddd-111111111111:Example:us-west-2
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.