AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.4.0 published on Wednesday, May 4, 2022 by Pulumi

BotAssociation

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

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.Connect.BotAssociation("example", new Aws.Connect.BotAssociationArgs
        {
            InstanceId = aws_connect_instance.Example.Id,
            LexBot = new Aws.Connect.Inputs.BotAssociationLexBotArgs
            {
                LexRegion = "us-west-2",
                Name = "Test",
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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(aws_connect_instance.Example.Id),
			LexBot: &connect.BotAssociationLexBotArgs{
				LexRegion: pulumi.String("us-west-2"),
				Name:      pulumi.String("Test"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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(aws_connect_instance.getExample().getId())
            .lexBot(BotAssociationLexBot.builder()
                .lexRegion("us-west-2")
                .name("Test")
                .build())
            .build());

        }
}
import pulumi
import pulumi_aws as aws

example = aws.connect.BotAssociation("example",
    instance_id=aws_connect_instance["example"]["id"],
    lex_bot=aws.connect.BotAssociationLexBotArgs(
        lex_region="us-west-2",
        name="Test",
    ))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.connect.BotAssociation("example", {
    instanceId: aws_connect_instance.example.id,
    lexBot: {
        lexRegion: "us-west-2",
        name: "Test",
    },
});
resources:
  example:
    type: aws:connect:BotAssociation
    properties:
      instanceId: ${aws_connect_instance.example.id}
      lexBot:
        lexRegion: us-west-2
        name: Test

Including a sample Lex bot

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var current = Output.Create(Aws.GetRegion.InvokeAsync());
        var exampleIntent = new Aws.Lex.Intent("exampleIntent", new Aws.Lex.IntentArgs
        {
            CreateVersion = true,
            Name = "connect_lex_intent",
            FulfillmentActivity = new Aws.Lex.Inputs.IntentFulfillmentActivityArgs
            {
                Type = "ReturnIntent",
            },
            SampleUtterances = 
            {
                "I would like to pick up flowers.",
            },
        });
        var exampleBot = new Aws.Lex.Bot("exampleBot", new Aws.Lex.BotArgs
        {
            AbortStatement = new Aws.Lex.Inputs.BotAbortStatementArgs
            {
                Messages = 
                {
                    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 Aws.Lex.Inputs.BotClarificationPromptMessageArgs
                    {
                        Content = "I didn't understand you, what would you like to do?",
                        ContentType = "PlainText",
                    },
                },
            },
            Intents = 
            {
                new Aws.Lex.Inputs.BotIntentArgs
                {
                    IntentName = exampleIntent.Name,
                    IntentVersion = "1",
                },
            },
            ChildDirected = false,
            Name = "connect_lex_bot",
            ProcessBehavior = "BUILD",
        });
        var exampleBotAssociation = new Aws.Connect.BotAssociation("exampleBotAssociation", new Aws.Connect.BotAssociationArgs
        {
            InstanceId = aws_connect_instance.Example.Id,
            LexBot = new Aws.Connect.Inputs.BotAssociationLexBotArgs
            {
                LexRegion = current.Apply(current => current.Name),
                Name = exampleBot.Name,
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws"
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/connect"
	"github.com/pulumi/pulumi-aws/sdk/v5/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, nil, nil)
		if err != nil {
			return err
		}
		exampleIntent, err := lex.NewIntent(ctx, "exampleIntent", &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, "exampleBot", &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:    exampleIntent.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, "exampleBotAssociation", &connect.BotAssociationArgs{
			InstanceId: pulumi.Any(aws_connect_instance.Example.Id),
			LexBot: &connect.BotAssociationLexBotArgs{
				LexRegion: pulumi.String(current.Name),
				Name:      exampleBot.Name,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var current = Output.of(AwsFunctions.getRegion());

        var exampleIntent = new Intent("exampleIntent", IntentArgs.builder()        
            .createVersion(true)
            .name("connect_lex_intent")
            .fulfillmentActivity(IntentFulfillmentActivity.builder()
                .type("ReturnIntent")
                .build())
            .sampleUtterances("I would like to pick up flowers.")
            .build());

        var exampleBot = new Bot("exampleBot", BotArgs.builder()        
            .abortStatement(BotAbortStatement.builder()
                .messages(BotAbortStatementMessage.builder()
                    .content("Sorry, I am not able to assist at this time.")
                    .contentType("PlainText")
                    .build())
                .build())
            .clarificationPrompt(BotClarificationPrompt.builder()
                .maxAttempts(2)
                .messages(BotClarificationPromptMessage.builder()
                    .content("I didn't understand you, what would you like to do?")
                    .contentType("PlainText")
                    .build())
                .build())
            .intents(BotIntent.builder()
                .intentName(exampleIntent.getName())
                .intentVersion("1")
                .build())
            .childDirected(false)
            .name("connect_lex_bot")
            .processBehavior("BUILD")
            .build());

        var exampleBotAssociation = new BotAssociation("exampleBotAssociation", BotAssociationArgs.builder()        
            .instanceId(aws_connect_instance.getExample().getId())
            .lexBot(BotAssociationLexBot.builder()
                .lexRegion(current.apply(getRegionResult -> getRegionResult.getName()))
                .name(exampleBot.getName())
                .build())
            .build());

        }
}
import pulumi
import pulumi_aws as aws

current = aws.get_region()
example_intent = aws.lex.Intent("exampleIntent",
    create_version=True,
    name="connect_lex_intent",
    fulfillment_activity=aws.lex.IntentFulfillmentActivityArgs(
        type="ReturnIntent",
    ),
    sample_utterances=["I would like to pick up flowers."])
example_bot = aws.lex.Bot("exampleBot",
    abort_statement=aws.lex.BotAbortStatementArgs(
        messages=[aws.lex.BotAbortStatementMessageArgs(
            content="Sorry, I am not able to assist at this time.",
            content_type="PlainText",
        )],
    ),
    clarification_prompt=aws.lex.BotClarificationPromptArgs(
        max_attempts=2,
        messages=[aws.lex.BotClarificationPromptMessageArgs(
            content="I didn't understand you, what would you like to do?",
            content_type="PlainText",
        )],
    ),
    intents=[aws.lex.BotIntentArgs(
        intent_name=example_intent.name,
        intent_version="1",
    )],
    child_directed=False,
    name="connect_lex_bot",
    process_behavior="BUILD")
example_bot_association = aws.connect.BotAssociation("exampleBotAssociation",
    instance_id=aws_connect_instance["example"]["id"],
    lex_bot=aws.connect.BotAssociationLexBotArgs(
        lex_region=current.name,
        name=example_bot.name,
    ))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const current = aws.getRegion({});
const exampleIntent = new aws.lex.Intent("exampleIntent", {
    createVersion: true,
    name: "connect_lex_intent",
    fulfillmentActivity: {
        type: "ReturnIntent",
    },
    sampleUtterances: ["I would like to pick up flowers."],
});
const exampleBot = new aws.lex.Bot("exampleBot", {
    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: exampleIntent.name,
        intentVersion: "1",
    }],
    childDirected: false,
    name: "connect_lex_bot",
    processBehavior: "BUILD",
});
const exampleBotAssociation = new aws.connect.BotAssociation("exampleBotAssociation", {
    instanceId: aws_connect_instance.example.id,
    lexBot: {
        lexRegion: current.then(current => current.name),
        name: exampleBot.name,
    },
});
resources:
  exampleIntent:
    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
    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: ${exampleIntent.name}
          intentVersion: 1
      childDirected: false
      name: connect_lex_bot
      processBehavior: BUILD
  exampleBotAssociation:
    type: aws:connect:BotAssociation
    properties:
      instanceId: ${aws_connect_instance.example.id}
      lexBot:
        lexRegion: ${current.name}
        name: ${exampleBot.name}
variables:
  current:
    Fn::Invoke:
      Function: aws:getRegion
      Arguments: {}

Create a BotAssociation Resource

new BotAssociation(name: string, args: BotAssociationArgs, opts?: CustomResourceOptions);
@overload
def BotAssociation(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   instance_id: Optional[str] = None,
                   lex_bot: Optional[BotAssociationLexBotArgs] = None)
@overload
def BotAssociation(resource_name: str,
                   args: BotAssociationArgs,
                   opts: Optional[ResourceOptions] = 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.

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.

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

The BotAssociation resource accepts the following input properties:

InstanceId string

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

LexBot BotAssociationLexBotArgs

Configuration information of an Amazon Lex (V1) bot. Detailed below.

InstanceId string

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

LexBot BotAssociationLexBotArgs

Configuration information of an Amazon Lex (V1) bot. Detailed below.

instanceId String

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

lexBot BotAssociationLexBotArgs

Configuration information of an Amazon Lex (V1) bot. Detailed below.

instanceId string

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

lexBot BotAssociationLexBotArgs

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 BotAssociationLexBotArgs

Configuration information of an Amazon Lex (V1) bot. Detailed below.

instanceId String

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

lexBot 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 an 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.
The following state arguments are supported:
InstanceId string

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

LexBot BotAssociationLexBotArgs

Configuration information of an Amazon Lex (V1) bot. Detailed below.

InstanceId string

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

LexBot BotAssociationLexBotArgs

Configuration information of an Amazon Lex (V1) bot. Detailed below.

instanceId String

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

lexBot BotAssociationLexBotArgs

Configuration information of an Amazon Lex (V1) bot. Detailed below.

instanceId string

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

lexBot BotAssociationLexBotArgs

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 BotAssociationLexBotArgs

Configuration information of an Amazon Lex (V1) bot. Detailed below.

instanceId String

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

lexBot Property Map

Configuration information of an Amazon Lex (V1) bot. Detailed below.

Supporting Types

BotAssociationLexBot

Name string

The name of the Amazon Lex (V1) bot.

LexRegion string

The Region that the Amazon Lex (V1) bot was created in. Defaults to current region.

Name string

The name of the Amazon Lex (V1) bot.

LexRegion string

The Region that the Amazon Lex (V1) bot was created in. Defaults to current region.

name String

The name of the Amazon Lex (V1) bot.

lexRegion String

The Region that the Amazon Lex (V1) bot was created in. Defaults to current region.

name string

The name of the Amazon Lex (V1) bot.

lexRegion string

The Region that the Amazon Lex (V1) bot was created in. Defaults to current region.

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.

name String

The name of the Amazon Lex (V1) bot.

lexRegion String

The Region that the Amazon Lex (V1) bot was created in. Defaults to current region.

Import

aws_connect_bot_association can be imported by using the Amazon Connect instance ID, Lex (V1) bot name, and Lex (V1) bot region separated by colons (:), e.g.

 $ pulumi import aws:connect/botAssociation:BotAssociation example aaaaaaaa-bbbb-cccc-dddd-111111111111:Example:us-west-2

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.