CfnEmailAddressProps

class aws_cdk.aws_connect.CfnEmailAddressProps(*, email_address, instance_arn, alias_configurations=None, description=None, display_name=None, tags=None)

Bases: object

Properties for defining a CfnEmailAddress.

Parameters:
  • email_address (str) – The email address, including the domain.

  • instance_arn (str) – The Amazon Resource Name (ARN) of the instance.

  • alias_configurations (Union[IResolvable, Sequence[Union[IResolvable, AliasConfigurationProperty, Dict[str, Any]]], None]) – 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.

  • description (Optional[str]) – The description of the email address.

  • display_name (Optional[str]) – The display name of email address.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-emailaddress.html

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_connect as connect

cfn_email_address_props = connect.CfnEmailAddressProps(
    email_address="emailAddress",
    instance_arn="instanceArn",

    # the properties below are optional
    alias_configurations=[connect.CfnEmailAddress.AliasConfigurationProperty(
        email_address_arn="emailAddressArn"
    )],
    description="description",
    display_name="displayName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

alias_configurations

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-emailaddress.html#cfn-connect-emailaddress-aliasconfigurations

description

The description of the email address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-emailaddress.html#cfn-connect-emailaddress-description

display_name

The display name of email address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-emailaddress.html#cfn-connect-emailaddress-displayname

email_address

The email address, including the domain.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-emailaddress.html#cfn-connect-emailaddress-emailaddress

instance_arn

The Amazon Resource Name (ARN) of the instance.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-emailaddress.html#cfn-connect-emailaddress-instancearn

tags

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-emailaddress.html#cfn-connect-emailaddress-tags