AWS::Connect::TrafficDistributionGroup
Information about a traffic distribution group.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::Connect::TrafficDistributionGroup", "Properties" : { "Description" :
String
, "InstanceArn" :String
, "Name" :String
, "Tags" :[ Tag, ... ]
} }
YAML
Type: AWS::Connect::TrafficDistributionGroup Properties: Description:
String
InstanceArn:String
Name:String
Tags:- Tag
Properties
Description
-
The description of the traffic distribution group.
Required: No
Type: String
Pattern:
(^[\S].*[\S]$)|(^[\S]$)
Minimum:
1
Maximum:
250
Update requires: Replacement
InstanceArn
-
The Amazon Resource Name (ARN).
Required: Yes
Type: String
Pattern:
^arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
Minimum:
1
Maximum:
250
Update requires: Replacement
Name
-
The name of the traffic distribution group.
Required: Yes
Type: String
Pattern:
(^[\S].*[\S]$)|(^[\S]$)
Minimum:
1
Maximum:
128
Update requires: Replacement
-
The tags used to organize, track, or control access for this resource. For example, {"tags": {"key1":"value1", "key2":"value2"} }.
Required: No
Type: Array of Tag
Maximum:
50
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the traffic distribution group name. For example:
{ "Ref": "myTrafficDistributionGroupName" }
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
.
IsDefault
-
Describes whether this is the default traffic distribution group.
Status
-
The status of the traffic distribution group.
TrafficDistributionGroupArn
-
The Amazon Resource Name (ARN) of the traffic distribution group.