

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::PredefinedAttribute
<a name="aws-resource-connect-predefinedattribute"></a>

Textual or numeric value that describes an attribute.

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

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

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

```
{
  "Type" : "AWS::Connect::PredefinedAttribute",
  "Properties" : {
      "[AttributeConfiguration](#cfn-connect-predefinedattribute-attributeconfiguration)" : AttributeConfiguration,
      "[InstanceArn](#cfn-connect-predefinedattribute-instancearn)" : String,
      "[Name](#cfn-connect-predefinedattribute-name)" : String,
      "[Purposes](#cfn-connect-predefinedattribute-purposes)" : [ String, ... ],
      "[Values](#cfn-connect-predefinedattribute-values)" : Values
    }
}
```

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

```
Type: AWS::Connect::PredefinedAttribute
Properties:
  [AttributeConfiguration](#cfn-connect-predefinedattribute-attributeconfiguration): 
    AttributeConfiguration
  [InstanceArn](#cfn-connect-predefinedattribute-instancearn): String
  [Name](#cfn-connect-predefinedattribute-name): String
  [Purposes](#cfn-connect-predefinedattribute-purposes): 
    - String
  [Values](#cfn-connect-predefinedattribute-values): 
    Values
```

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

`AttributeConfiguration`  <a name="cfn-connect-predefinedattribute-attributeconfiguration"></a>
Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.  
*Required*: No  
*Type*: [AttributeConfiguration](aws-properties-connect-predefinedattribute-attributeconfiguration.md)  
*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-predefinedattribute-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*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Name`  <a name="cfn-connect-predefinedattribute-name"></a>
The name of the predefined attribute.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `100`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Purposes`  <a name="cfn-connect-predefinedattribute-purposes"></a>
Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `10`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Values`  <a name="cfn-connect-predefinedattribute-values"></a>
The values of a predefined attribute.  
*Required*: No  
*Type*: [Values](aws-properties-connect-predefinedattribute-values.md)  
*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-predefinedattribute-return-values"></a>

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

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the predefined attribute. For example:

 `{ "Ref": "myPredefinedAttribute" }` 

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-predefinedattribute-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-predefinedattribute-return-values-fn--getatt-fn--getatt"></a>

`LastModifiedRegion`  <a name="LastModifiedRegion-fn::getatt"></a>
Last modified region.

`LastModifiedTime`  <a name="LastModifiedTime-fn::getatt"></a>
Last modified time.

# AWS::Connect::PredefinedAttribute AttributeConfiguration
<a name="aws-properties-connect-predefinedattribute-attributeconfiguration"></a>

<a name="aws-properties-connect-predefinedattribute-attributeconfiguration-description"></a>The `AttributeConfiguration` property type specifies Property description not available. for an [AWS::Connect::PredefinedAttribute](aws-resource-connect-predefinedattribute.md).

## Syntax
<a name="aws-properties-connect-predefinedattribute-attributeconfiguration-syntax"></a>

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

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

```
{
  "[EnableValueValidationOnAssociation](#cfn-connect-predefinedattribute-attributeconfiguration-enablevaluevalidationonassociation)" : Boolean,
  "[IsReadOnly](#cfn-connect-predefinedattribute-attributeconfiguration-isreadonly)" : Boolean
}
```

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

```
  [EnableValueValidationOnAssociation](#cfn-connect-predefinedattribute-attributeconfiguration-enablevaluevalidationonassociation): Boolean
  [IsReadOnly](#cfn-connect-predefinedattribute-attributeconfiguration-isreadonly): Boolean
```

## Properties
<a name="aws-properties-connect-predefinedattribute-attributeconfiguration-properties"></a>

`EnableValueValidationOnAssociation`  <a name="cfn-connect-predefinedattribute-attributeconfiguration-enablevaluevalidationonassociation"></a>
Property description not available.  
*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)

`IsReadOnly`  <a name="cfn-connect-predefinedattribute-attributeconfiguration-isreadonly"></a>
Property description not available.  
*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)

# AWS::Connect::PredefinedAttribute Values
<a name="aws-properties-connect-predefinedattribute-values"></a>

The values of a predefined attribute.

## Syntax
<a name="aws-properties-connect-predefinedattribute-values-syntax"></a>

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

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

```
{
  "[StringList](#cfn-connect-predefinedattribute-values-stringlist)" : [ String, ... ]
}
```

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

```
  [StringList](#cfn-connect-predefinedattribute-values-stringlist): 
    - String
```

## Properties
<a name="aws-properties-connect-predefinedattribute-values-properties"></a>

`StringList`  <a name="cfn-connect-predefinedattribute-values-stringlist"></a>
Predefined attribute values of type string list.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `500`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)