Package com.pulumi.aws.connect

Class Instance

  • public class Instance
extends com.pulumi.resources.CustomResource
    Provides an Amazon Connect instance resource. For more information see [Amazon Connect: Getting Started](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-get-started.html) > **WARN:** Amazon Connect enforces a limit of [100 combined instance creation and deletions every 30 days](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits). For example, if you create 80 instances and delete 20 of them, you must wait 30 days to create or delete another instance. Use care when creating or deleting instances. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.connect.Instance;
 import com.pulumi.aws.connect.InstanceArgs;
 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 test = new Instance("test", InstanceArgs.builder()
             .identityManagementType("CONNECT_MANAGED")
             .inboundCallsEnabled(true)
             .instanceAlias("friendly-name-connect")
             .outboundCallsEnabled(true)
             .tags(Map.of("hello", "world"))
             .build());
 
     }
 }
    ### Example Usage with Existing Active Directory 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.connect.Instance;
 import com.pulumi.aws.connect.InstanceArgs;
 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 test = new Instance("test", InstanceArgs.builder()
             .directoryId(testAwsDirectoryServiceDirectory.id())
             .identityManagementType("EXISTING_DIRECTORY")
             .inboundCallsEnabled(true)
             .instanceAlias("friendly-name-connect")
             .outboundCallsEnabled(true)
             .build());
 
     }
 }
    ### Example Usage with SAML 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.connect.Instance;
 import com.pulumi.aws.connect.InstanceArgs;
 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 test = new Instance("test", InstanceArgs.builder()
             .identityManagementType("SAML")
             .inboundCallsEnabled(true)
             .instanceAlias("friendly-name-connect")
             .outboundCallsEnabled(true)
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `id` - (String) ID of the connect instance. #### Optional - `accountId` (String) AWS Account where this resource is managed. - `region` (String) Region where this resource is managed. Using `pulumi import`, import Connect instances using the `id`. For example: ```sh $ pulumi import aws:connect/instance:Instance example f1288a1f-6193-445a-b47e-af739b2 ```

    • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      Instance​(java.lang.String name)  
      Instance​(java.lang.String name, InstanceArgs args)  
      Instance​(java.lang.String name, InstanceArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> autoResolveBestVoicesEnabled()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> contactFlowLogsEnabled()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> contactLensEnabled()  
      com.pulumi.core.Output<java.lang.String> createdTime()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> directoryId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> earlyMediaEnabled()  
      static Instance get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, InstanceState 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> identityManagementType()  
      com.pulumi.core.Output<java.lang.Boolean> inboundCallsEnabled()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> instanceAlias()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> multiPartyConferenceEnabled()  
      com.pulumi.core.Output<java.lang.Boolean> outboundCallsEnabled()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> serviceRole()  
      com.pulumi.core.Output<java.lang.String> status()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  

      • 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

      • Instance

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

      • Instance

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

      • Instance

        public Instance​(java.lang.String name,
                InstanceArgs 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

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the instance.

      • autoResolveBestVoicesEnabled

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> autoResolveBestVoicesEnabled()
        Returns:
        Specifies whether auto resolve best voices is enabled. Defaults to `true`.

      • contactFlowLogsEnabled

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> contactFlowLogsEnabled()
        Returns:
        Specifies whether contact flow logs are enabled. Defaults to `false`.

      • contactLensEnabled

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> contactLensEnabled()
        Returns:
        Specifies whether contact lens is enabled. Defaults to `true`.

      • createdTime

        public com.pulumi.core.Output<java.lang.String> createdTime()
        Returns:
        When the instance was created.

      • directoryId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> directoryId()
        Returns:
        The identifier for the directory if identityManagementType is `EXISTING_DIRECTORY`.

      • earlyMediaEnabled

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> earlyMediaEnabled()
        Returns:
        Specifies whether early media for outbound calls is enabled . Defaults to `true` if outbound calls is enabled.

      • identityManagementType

        public com.pulumi.core.Output<java.lang.String> identityManagementType()
        Returns:
        Specifies the identity management type attached to the instance. Allowed Values are: `SAML`, `CONNECT_MANAGED`, `EXISTING_DIRECTORY`.

      • inboundCallsEnabled

        public com.pulumi.core.Output<java.lang.Boolean> inboundCallsEnabled()
        Returns:
        Specifies whether inbound calls are enabled.

      • instanceAlias

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> instanceAlias()
        Returns:
        Specifies the name of the instance. Required if `directoryId` not specified.

      • multiPartyConferenceEnabled

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> multiPartyConferenceEnabled()
        Returns:
        Specifies whether multi-party calls/conference is enabled. Defaults to `false`.

      • outboundCallsEnabled

        public com.pulumi.core.Output<java.lang.Boolean> outboundCallsEnabled()
        Returns:
        Specifies whether outbound calls are enabled.

      • 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.

      • serviceRole

        public com.pulumi.core.Output<java.lang.String> serviceRole()
        Returns:
        The service role of the instance.

      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        The state of the instance.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Tags to apply to the Instance. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. <!-- * `useCustomTtsVoices` - (Optional) Whether use custom tts voices is enabled. Defaults to `false` -->

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • get

        public static Instance get​(java.lang.String name,
                           com.pulumi.core.Output<java.lang.String> id,
                           @Nullable
                           InstanceState 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.