AWS::Connect::AgentStatus - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Connect::AgentStatus

Contains information about an agent status.

Syntax

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

JSON

{
  "Type" : "AWS::Connect::AgentStatus",
  "Properties" : {
      "Description" : String,
      "DisplayOrder" : Integer,
      "InstanceArn" : String,
      "Name" : String,
      "ResetOrderNumber" : Boolean,
      "State" : String,
      "Tags" : [ Tag, ... ],
      "Type" : String
    }
}

YAML

Type: AWS::Connect::AgentStatus
Properties:
  Description: String
  DisplayOrder: Integer
  InstanceArn: String
  Name: String
  ResetOrderNumber: Boolean
  State: String
  Tags: 
    - Tag
  Type: String

Properties

Description

The description of the agent status.

Required: No

Type: String

Minimum: 1

Maximum: 250

Update requires: No interruption

DisplayOrder

The display order of the agent status.

Required: No

Type: Integer

Minimum: 1

Maximum: 50

Update requires: No interruption

InstanceArn

The Amazon Resource Name (ARN) of the instance.

Required: Yes

Type: String

Pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$

Update requires: No interruption

Name

The name of the agent status.

Required: Yes

Type: String

Minimum: 1

Maximum: 127

Update requires: No interruption

ResetOrderNumber

A number indicating the reset order of the agent status.

Required: No

Type: Boolean

Update requires: No interruption

State

The state of the agent status.

Required: Yes

Type: String

Allowed values: ENABLED | DISABLED

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: Array of Tag

Maximum: 50

Update requires: No interruption

Type

The type of agent status.

Required: No

Type: String

Allowed values: ROUTABLE | CUSTOM | OFFLINE

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the agent status. For example:

{ "Ref": "myAgentStatus" }

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.

AgentStatusArn

The Amazon Resource Name (ARN) of the agent status.

LastModifiedRegion

The Amazon Region where this resource was last modified.

LastModifiedTime

The timestamp when this resource was last modified.