This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::Connect::AgentStatus
<a name="aws-resource-connect-agentstatus"></a>

Contains information about an agent status.

## Syntax
<a name="aws-resource-connect-agentstatus-syntax"></a>

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

### JSON
<a name="aws-resource-connect-agentstatus-syntax.json"></a>

```
{
  "Type" : "AWS::Connect::AgentStatus",
  "Properties" : {
      "[Description](#cfn-connect-agentstatus-description)" : String,
      "[DisplayOrder](#cfn-connect-agentstatus-displayorder)" : Integer,
      "[InstanceArn](#cfn-connect-agentstatus-instancearn)" : String,
      "[Name](#cfn-connect-agentstatus-name)" : String,
      "[ResetOrderNumber](#cfn-connect-agentstatus-resetordernumber)" : Boolean,
      "[State](#cfn-connect-agentstatus-state)" : String,
      "[Tags](#cfn-connect-agentstatus-tags)" : [ Tag, ... ],
      "[Type](#cfn-connect-agentstatus-type)" : String
    }
}
```

### YAML
<a name="aws-resource-connect-agentstatus-syntax.yaml"></a>

```
Type: AWS::Connect::AgentStatus
Properties:
  [Description](#cfn-connect-agentstatus-description): String
  [DisplayOrder](#cfn-connect-agentstatus-displayorder): Integer
  [InstanceArn](#cfn-connect-agentstatus-instancearn): String
  [Name](#cfn-connect-agentstatus-name): String
  [ResetOrderNumber](#cfn-connect-agentstatus-resetordernumber): Boolean
  [State](#cfn-connect-agentstatus-state): String
  [Tags](#cfn-connect-agentstatus-tags): 
    - Tag
  [Type](#cfn-connect-agentstatus-type): String
```

## Properties
<a name="aws-resource-connect-agentstatus-properties"></a>

`Description`  <a name="cfn-connect-agentstatus-description"></a>
The description of the agent status.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `250`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DisplayOrder`  <a name="cfn-connect-agentstatus-displayorder"></a>
The display order of the agent status.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InstanceArn`  <a name="cfn-connect-agentstatus-instancearn"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-connect-agentstatus-name"></a>
The name of the agent status.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `127`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ResetOrderNumber`  <a name="cfn-connect-agentstatus-resetordernumber"></a>
A number indicating the reset order of the agent status.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`State`  <a name="cfn-connect-agentstatus-state"></a>
The state of the agent status.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `ENABLED | DISABLED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-connect-agentstatus-tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "Tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-connect-agentstatus-tag.md)  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-connect-agentstatus-type"></a>
The type of agent status.  
*Required*: No  
*Type*: String  
*Allowed values*: `ROUTABLE | CUSTOM | OFFLINE`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-connect-agentstatus-return-values"></a>

### Ref
<a name="aws-resource-connect-agentstatus-return-values-ref"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-connect-agentstatus-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-connect-agentstatus-return-values-fn--getatt-fn--getatt"></a>

`AgentStatusArn`  <a name="AgentStatusArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the agent status.

`LastModifiedRegion`  <a name="LastModifiedRegion-fn::getatt"></a>
The AWS Region where this resource was last modified.

`LastModifiedTime`  <a name="LastModifiedTime-fn::getatt"></a>
The timestamp when this resource was last modified.

# AWS::Connect::AgentStatus Tag
<a name="aws-properties-connect-agentstatus-tag"></a>

A key-value pair to associate with a resource.

## Syntax
<a name="aws-properties-connect-agentstatus-tag-syntax"></a>

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

### JSON
<a name="aws-properties-connect-agentstatus-tag-syntax.json"></a>

```
{
  "[Key](#cfn-connect-agentstatus-tag-key)" : String,
  "[Value](#cfn-connect-agentstatus-tag-value)" : String
}
```

### YAML
<a name="aws-properties-connect-agentstatus-tag-syntax.yaml"></a>

```
  [Key](#cfn-connect-agentstatus-tag-key): String
  [Value](#cfn-connect-agentstatus-tag-value): String
```

## Properties
<a name="aws-properties-connect-agentstatus-tag-properties"></a>

`Key`  <a name="cfn-connect-agentstatus-tag-key"></a>
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, \$1, ., /, =, \$1, and -  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(?!aws:)[a-zA-Z+-=._:/]+$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-connect-agentstatus-tag-value"></a>
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, \$1, ., /, =, \$1, and -  
*Required*: Yes  
*Type*: String  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)