AWS::Connect::EmailAddress - 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::EmailAddress

Create new email address in the specified Amazon Connect instance. For more information about email addresses, see Create email addresses in the Amazon Connect Administrator Guide.

Syntax

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

JSON

{
  "Type" : "AWS::Connect::EmailAddress",
  "Properties" : {
      "AliasConfigurations" : [ AliasConfiguration, ... ],
      "Description" : String,
      "DisplayName" : String,
      "EmailAddress" : String,
      "InstanceArn" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Connect::EmailAddress
Properties:
  AliasConfigurations: 
    - AliasConfiguration
  Description: String
  DisplayName: String
  EmailAddress: String
  InstanceArn: String
  Tags: 
    - Tag

Properties

AliasConfigurations

A list of alias configurations for this email address, showing which email addresses forward to this primary address. Each configuration contains the email address ID of an alias that forwards emails to this address.

Required: No

Type: Array of AliasConfiguration

Maximum: 1

Update requires: No interruption

Description

The description of the email address.

Required: No

Type: String

Pattern: (^[\S].*[\S]$)|(^[\S]$)

Minimum: 1

Maximum: 250

Update requires: No interruption

DisplayName

The display name of email address.

Required: No

Type: String

Pattern: (^[\S].*[\S]$)|(^[\S]$)

Minimum: 0

Maximum: 256

Update requires: No interruption

EmailAddress

The email address, including the domain.

Required: Yes

Type: String

Pattern: ([^\s@]+@[^\s@]+\.[^\s@]+)

Minimum: 1

Maximum: 255

Update requires: Replacement

InstanceArn

The Amazon Resource Name (ARN) of the instance.

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: No interruption

Tags

An array of key-value pairs to apply to this resource.

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 email address. For example:

{ "Ref": "myEmailAddress" }

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.

EmailAddressArn

The Amazon Resource Name (ARN) of the email address.