Class BotAssociation


  • public class BotAssociation
    extends com.pulumi.resources.CustomResource
    Allows the specified Amazon Connect instance to access the specified Amazon Lex (V1) bot. For more information see [Amazon Connect: Getting Started](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-get-started.html) and [Add an Amazon Lex bot](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-lex.html). > **NOTE:** This resource only currently supports Amazon Lex (V1) Associations. ## Example Usage ### Basic
     
     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.ArrayList;
     import java.util.Arrays;
     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()
                 .lexBot(BotAssociationLexBotArgs.builder()
                     .lexRegion("us-west-2")
                     .name("Test")
                     .build())
                 .instanceId(exampleAwsConnectInstance.id())
                 .build());
     
         }
     }
     
     
    ### Including a sample Lex bot
     
     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.BotAbortStatementMessageArgs;
     import com.pulumi.aws.lex.inputs.BotClarificationPromptArgs;
     import com.pulumi.aws.lex.inputs.BotClarificationPromptMessageArgs;
     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.ArrayList;
     import java.util.Arrays;
     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(GetRegionArgs.builder()
                 .build());
     
             var example = new Intent("example", IntentArgs.builder()
                 .fulfillmentActivity(IntentFulfillmentActivityArgs.builder()
                     .type("ReturnIntent")
                     .build())
                 .createVersion(true)
                 .name("connect_lex_intent")
                 .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()
                     .messages(BotClarificationPromptMessageArgs.builder()
                         .content("I didn't understand you, what would you like to do?")
                         .contentType("PlainText")
                         .build())
                     .maxAttempts(2)
                     .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()
                 .lexBot(BotAssociationLexBotArgs.builder()
                     .lexRegion(current.region())
                     .name(exampleBot.name())
                     .build())
                 .instanceId(exampleAwsConnectInstance.id())
                 .build());
     
         }
     }
     
     
    ## Import Using `pulumi import`, import `aws.connect.BotAssociation` using the Amazon Connect instance ID, Lex (V1) bot name, and Lex (V1) bot region separated by colons (`:`). For example: ```sh $ pulumi import aws:connect/botAssociation:BotAssociation example aaaaaaaa-bbbb-cccc-dddd-111111111111:Example:us-west-2 ```
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static BotAssociation get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, BotAssociationState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> instanceId()  
      com.pulumi.core.Output<BotAssociationLexBot> lexBot()  
      com.pulumi.core.Output<java.lang.String> region()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • BotAssociation

        public BotAssociation​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • BotAssociation

        public BotAssociation​(java.lang.String name,
                              BotAssociationArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • BotAssociation

        public BotAssociation​(java.lang.String name,
                              BotAssociationArgs args,
                              @Nullable
                              com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • instanceId

        public com.pulumi.core.Output<java.lang.String> instanceId()
        Returns:
        The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
      • lexBot

        public com.pulumi.core.Output<BotAssociationLexBot> lexBot()
        Returns:
        Configuration information of an Amazon Lex (V1) bot. Detailed below.
      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        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.
      • get

        public static BotAssociation get​(java.lang.String name,
                                         com.pulumi.core.Output<java.lang.String> id,
                                         @Nullable
                                         BotAssociationState state,
                                         @Nullable
                                         com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.