AWS::Connect::Instance

This is a preview release for Amazon Connect. It is subject to change.

Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis.

Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Connect::Instance",
  "Properties" : {
      "Attributes" : Attributes,
      "DirectoryId" : String,
      "IdentityManagementType" : String,
      "InstanceAlias" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Connect::Instance
Properties:
  Attributes: 
    Attributes
  DirectoryId: String
  IdentityManagementType: String
  InstanceAlias: String
  Tags: 
    - Tag

Properties

Attributes

A toggle for an individual feature at the instance level.

Required: Yes

Type: Attributes

Update requires: No interruption

DirectoryId

The identifier for the directory.

Required: No

Type: String

Pattern: ^d-[0-9a-f]{10}$

Minimum: 12

Maximum: 12

Update requires: Replacement

IdentityManagementType

The identity management type.

Required: Yes

Type: String

Allowed values: SAML | CONNECT_MANAGED | EXISTING_DIRECTORY

Update requires: Replacement

InstanceAlias

The alias of instance. InstanceAlias is only required when IdentityManagementType is CONNECT_MANAGED or SAML. InstanceAlias is not required when IdentityManagementType is EXISTING_DIRECTORY.

Required: No

Type: String

Pattern: ^(?!d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*$

Minimum: 1

Maximum: 62

Update requires: Replacement

Tags

An array of key-value pairs to apply to this resource.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ID of the Amazon Connect instance.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) of the instance.

CreatedTime

When the instance was created.

Id

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

InstanceStatus

The state of the instance.

ServiceRole

The service role of the instance.