Package software.amazon.awscdk.services.connect

Class CfnEmailAddress

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.connect.CfnEmailAddress
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggableV2, IEmailAddressRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:01.485Z") @Stability(Stable) public class CfnEmailAddress extends CfnResource implements IInspectable, IEmailAddressRef, ITaggableV2
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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.connect.*;
 CfnEmailAddress cfnEmailAddress = CfnEmailAddress.Builder.create(this, "MyCfnEmailAddress")
         .emailAddress("emailAddress")
         .instanceArn("instanceArn")
         // the properties below are optional
         .aliasConfigurations(List.of(AliasConfigurationProperty.builder()
                 .emailAddressArn("emailAddressArn")
                 .build()))
         .description("description")
         .displayName("displayName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnEmailAddress

      protected CfnEmailAddress(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnEmailAddress

      protected CfnEmailAddress(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnEmailAddress

      @Stability(Stable) public CfnEmailAddress(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnEmailAddressProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrEmailAddressArn

      @Stability(Stable) @NotNull public String getAttrEmailAddressArn()
      The Amazon Resource Name (ARN) of the email address.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getEmailAddressRef

      @Stability(Stable) @NotNull public EmailAddressReference getEmailAddressRef()
      A reference to a EmailAddress resource.
      Specified by:
      getEmailAddressRef in interface IEmailAddressRef

    • getEmailAddress

      @Stability(Stable) @NotNull public String getEmailAddress()
      The email address, including the domain.

    • setEmailAddress

      @Stability(Stable) public void setEmailAddress(@NotNull String value)
      The email address, including the domain.

    • getInstanceArn

      @Stability(Stable) @NotNull public String getInstanceArn()
      The Amazon Resource Name (ARN) of the instance.

    • setInstanceArn

      @Stability(Stable) public void setInstanceArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the instance.

    • getAliasConfigurations

      @Stability(Stable) @Nullable public Object getAliasConfigurations()
      A list of alias configurations for this email address, showing which email addresses forward to this primary address.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnEmailAddress.AliasConfigurationProperty>

    • setAliasConfigurations

      @Stability(Stable) public void setAliasConfigurations(@Nullable IResolvable value)
      A list of alias configurations for this email address, showing which email addresses forward to this primary address.

    • setAliasConfigurations

      @Stability(Stable) public void setAliasConfigurations(@Nullable List<Object> value)
      A list of alias configurations for this email address, showing which email addresses forward to this primary address.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the email address.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the email address.

    • getDisplayName

      @Stability(Stable) @Nullable public String getDisplayName()
      The display name of email address.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@Nullable String value)
      The display name of email address.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.