AWS::Connect::PredefinedAttribute - 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).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Connect::PredefinedAttribute

Textual or numeric value that describes an attribute.

Syntax

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

JSON

{
  "Type" : "AWS::Connect::PredefinedAttribute",
  "Properties" : {
      "AttributeConfiguration" : AttributeConfiguration,
      "InstanceArn" : String,
      "Name" : String,
      "Purposes" : [ String, ... ],
      "Values" : Values
    }
}

YAML

Type: AWS::Connect::PredefinedAttribute
Properties:
  AttributeConfiguration: 
    AttributeConfiguration
  InstanceArn: String
  Name: String
  Purposes: 
    - String
  Values: 
    Values

Properties

AttributeConfiguration

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

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: Replacement

Name

The name of the predefined attribute.

Required: Yes

Type: String

Minimum: 1

Maximum: 100

Update requires: Replacement

Purposes

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

Values

The values of a predefined attribute.

Required: No

Type: Values

Update requires: No interruption

Return values

Ref

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 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.

LastModifiedRegion

Last modified region.

LastModifiedTime

Last modified time.