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:

IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:05.772Z")
@Stability(Stable)
public class CfnEmailAddress
extends CfnResource
implements IInspectable, ITaggableV2

Resource Type definition for AWS::Connect::EmailAddress.

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
         .description("description")
         .displayName("displayName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnEmailAddress.Builder	A fluent builder for CfnEmailAddress.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnEmailAddress(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEmailAddress(software.amazon.jsii.JsiiObjectRef objRef)
	CfnEmailAddress(software.constructs.Construct scope, String id, CfnEmailAddressProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrEmailAddressArn()	The identifier of the email address.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
String	getDescription()	A description for the email address.
String	getDisplayName()	The display name for the email address.
String	getEmailAddress()	Email address to be created for this instance.
String	getInstanceArn()	The identifier of the Amazon Connect instance.
List<CfnTag>	getTags()	One or more tags.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value)	A description for the email address.
void	setDisplayName(String value)	The display name for the email address.
void	setEmailAddress(String value)	Email address to be created for this instance.
void	setInstanceArn(String value)	The identifier of the Amazon Connect instance.
void	setTags(List<CfnTag> value)	One or more tags.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

getEmailAddress

@Stability(Stable)
@NotNull
public String getEmailAddress()

Email address to be created for this instance.

setEmailAddress

@Stability(Stable)
public void setEmailAddress(@NotNull
 String value)

Email address to be created for this instance.

getInstanceArn

@Stability(Stable)
@NotNull
public String getInstanceArn()

The identifier of the Amazon Connect instance.

setInstanceArn

@Stability(Stable)
public void setInstanceArn(@NotNull
 String value)

The identifier of the Amazon Connect instance.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

A description for the email address.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

A description for the email address.

getDisplayName

@Stability(Stable)
@Nullable
public String getDisplayName()

The display name for the email address.

setDisplayName

@Stability(Stable)
public void setDisplayName(@Nullable
 String value)

The display name for the email address.

getTags

@Stability(Stable)
@Nullable
public List<CfnTag> getTags()

One or more tags.

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnTag> value)

One or more tags.