AWS::Connect::Instance

Connect Instance

Resource Type definition for AWS::Connect::Instance

Properties

5 configurable properties. 2 required. Click a row to see details.

Filter:

Property	Type	Flags
`Attributes`	`Attributes`	Required
`IdentityManagementType`	`string`	RequiredCreate-only
`DirectoryId`	`string`	Create-onlyWrite-only
`InstanceAlias`	`string`	Create-only
`Tags`	`Array<Tag>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`Arn`	`string`	An instanceArn is automatically generated on creation based on instanceId.
`CreatedTime`	`string`	Timestamp of instance creation logged as part of instance creation.
`Id`	`string`	An instanceId is automatically generated on creation and assigned as the unique identifier.
`InstanceStatus`	`string`	Specifies the creation status of new instance.
`ServiceRole`	`string`	Service linked role created as part of instance creation.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Connect::Instance

Resources:
  MyResource:
    Type: AWS::Connect::Instance
    Properties:
      IdentityManagementType: "SAML"
      Attributes: "value"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

connect:CreateInstanceconnect:DescribeInstanceconnect:UpdateInstanceAttributeconnect:TagResourceds:CheckAliasds:CreateAliasds:AuthorizeApplicationds:UnauthorizeApplication

read

connect:DescribeInstanceconnect:ListInstanceAttributesds:DescribeDirectories

update

connect:ListInstanceAttributesconnect:UpdateInstanceAttributeds:DescribeDirectoriesiam:CreateServiceLinkedRoleiam:DeleteRolePolicylogs:CreateLogGroupiam:PutRolePolicyconnect:TagResource

delete

connect:DeleteInstanceconnect:DescribeInstanceconnect:UntagResourceds:DeleteDirectoryds:UnauthorizeApplicationds:DescribeDirectories

list

connect:ListInstancesconnect:ListInstanceAttributesds:DescribeDirectories

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceConnect

Properties10

Required2

TaggingSupported

Primary IDArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

DirectoryIdInstanceAliasIdentityManagementType

Related Resources

External Links

AWS Documentation