Skip to content

Resource: awsConnectInstance

Provides an Amazon Connect instance resource. For more information see Amazon Connect: Getting Started

!> WARN: Amazon Connect enforces a limit of 100 combined instance creation and deletions every 30 days. 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

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.connectInstance.ConnectInstance(this, "test", {
  identityManagementType: "CONNECT_MANAGED",
  inboundCallsEnabled: true,
  instanceAlias: "friendly-name-connect",
  outboundCallsEnabled: true,
});

Example Usage with Existing Active Directory

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.connectInstance.ConnectInstance(this, "test", {
  directoryId: "${aws_directory_service_directory.test.id}",
  identityManagementType: "EXISTING_DIRECTORY",
  inboundCallsEnabled: true,
  instanceAlias: "friendly-name-connect",
  outboundCallsEnabled: true,
});

Example Usage with SAML

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.connectInstance.ConnectInstance(this, "test", {
  identityManagementType: "SAML",
  inboundCallsEnabled: true,
  instanceAlias: "friendly-name-connect",
  outboundCallsEnabled: true,
});

Argument Reference

The following arguments are supported:

  • autoResolveBestVoicesEnabled - (Optional) Specifies whether auto resolve best voices is enabled. Defaults to true.
  • contactFlowLogsEnabled - (Optional) Specifies whether contact flow logs are enabled. Defaults to false.
  • contactLensEnabled - (Optional) Specifies whether contact lens is enabled. Defaults to true.
  • directoryId - (Optional) The identifier for the directory if identity_management_type is EXISTING_DIRECTORY.
  • earlyMediaEnabled - (Optional) Specifies whether early media for outbound calls is enabled . Defaults to true if outbound calls is enabled.
  • identityManagementType - (Required) Specifies the identity management type attached to the instance. Allowed Values are: saml, CONNECT_MANAGED, EXISTING_DIRECTORY.
  • inboundCallsEnabled - (Required) Specifies whether inbound calls are enabled.
  • instanceAlias - (Optional) Specifies the name of the instance. Required if directoryId not specified.
  • multiPartyConferenceEnabled - (Optional) Specifies whether multi-party calls/conference is enabled. Defaults to false.
  • outboundCallsEnabled - (Required) Specifies whether outbound calls are enabled.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • id - The identifier of the instance.
  • arn - Amazon Resource Name (ARN) of the instance.
  • createdTime - When the instance was created.
  • serviceRole - The service role of the instance.
  • status - The state of the instance.

Timeouts

Configuration options:

  • create - (Default 5M)
  • delete - (Default 5M)

Import

Connect instances can be imported using the id, e.g.,

$ terraform import aws_connect_instance.example f1288a1f-6193-445a-b47e-af739b2