AWS::Connect::QuickConnect

Specifies a quick connect for an Amazon Connect instance.

Syntax

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

JSON

{
  "Type" : "AWS::Connect::QuickConnect",
  "Properties" : {
      "Description" : String,
      "InstanceArn" : String,
      "Name" : String,
      "QuickConnectConfig" : QuickConnectConfig,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Connect::QuickConnect
Properties: 
  Description: String
  InstanceArn: String
  Name: String
  QuickConnectConfig: 
    QuickConnectConfig
  Tags: 
    - Tag

Properties

Description

The description of the quick connect.

Required: No

Type: String

Minimum: 1

Maximum: 250

Update requires: No interruption

InstanceArn

The Amazon Resource Name (ARN) of the instance.

Required: Yes

Type: String

Update requires: No interruption

Name

The name of the quick connect.

Required: Yes

Type: String

Minimum: 1

Maximum: 127

Update requires: No interruption

QuickConnectConfig

Contains information about the quick connect.

Required: Yes

Type: QuickConnectConfig

Update requires: No interruption

Tags

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Required: No

Type: List 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 quick connect name. For example:

{ "Ref": "myQuickConnectName" }

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.

QuickConnectArn

The Amazon Resource Name (ARN) of the quick connect.