@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-31T18:36:55.063Z") public class CfnEmailIdentity extends CfnResource implements IInspectable
Specifies an identity for using within SES. An identity is an email address or domain that you use when you send email. Before you can use an identity to send email, you first have to verify it. By verifying an identity, you demonstrate that you're the owner of the identity, and that you've given Amazon SES API v2 permission to send email from the identity.
When you verify an email address, SES sends an email to the address. Your email address is verified as soon as you follow the link in the verification email. When you verify a domain without specifying the DkimSigningAttributes properties, OR only the NextSigningKeyLength property of DkimSigningAttributes, this resource provides a set of CNAME token names and values (DkimDNSTokenName1, DkimDNSTokenValue1, DkimDNSTokenName2, DkimDNSTokenValue2, DkimDNSTokenName3, DkimDNSTokenValue3) as outputs. You can then add these to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. This verification method is known as Easy DKIM.
Alternatively, you can perform the verification process by providing your own public-private key pair. This verification method is known as Bring Your Own DKIM (BYODKIM). To use BYODKIM, your resource must include DkimSigningAttributes properties DomainSigningSelector and DomainSigningPrivateKey. When you specify this object, you provide a selector (DomainSigningSelector) (a component of the DNS record name that identifies the public key to use for DKIM authentication) and a private key (DomainSigningPrivateKey).
Additionally, you can associate an existing configuration set with the email identity that you're verifying.
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.ses.*; CfnEmailIdentity cfnEmailIdentity = CfnEmailIdentity.Builder.create(this, "MyCfnEmailIdentity") .emailIdentity("emailIdentity") // the properties below are optional .configurationSetAttributes(ConfigurationSetAttributesProperty.builder() .configurationSetName("configurationSetName") .build()) .dkimAttributes(DkimAttributesProperty.builder() .signingEnabled(false) .build()) .dkimSigningAttributes(DkimSigningAttributesProperty.builder() .domainSigningPrivateKey("domainSigningPrivateKey") .domainSigningSelector("domainSigningSelector") .nextSigningKeyLength("nextSigningKeyLength") .build()) .feedbackAttributes(FeedbackAttributesProperty.builder() .emailForwardingEnabled(false) .build()) .mailFromAttributes(MailFromAttributesProperty.builder() .behaviorOnMxFailure("behaviorOnMxFailure") .mailFromDomain("mailFromDomain") .build()) .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnEmailIdentity.Builder
A fluent builder for
CfnEmailIdentity . |
static interface |
CfnEmailIdentity.ConfigurationSetAttributesProperty
Used to associate a configuration set with an email identity.
|
static interface |
CfnEmailIdentity.DkimAttributesProperty
Used to enable or disable DKIM authentication for an email identity.
|
static interface |
CfnEmailIdentity.DkimSigningAttributesProperty
Used to configure or change the DKIM authentication settings for an email domain identity.
|
static interface |
CfnEmailIdentity.FeedbackAttributesProperty
Used to enable or disable feedback forwarding for an identity.
|
static interface |
CfnEmailIdentity.MailFromAttributesProperty
Used to enable or disable the custom Mail-From domain configuration for an email identity.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnEmailIdentity(Construct scope,
java.lang.String id,
CfnEmailIdentityProps props)
Create a new `AWS::SES::EmailIdentity`.
|
protected |
CfnEmailIdentity(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnEmailIdentity(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrDkimDnsTokenName1()
The host name for the first token that you have to add to the DNS configuration for your domain.
|
java.lang.String |
getAttrDkimDnsTokenName2()
The host name for the second token that you have to add to the DNS configuration for your domain.
|
java.lang.String |
getAttrDkimDnsTokenName3()
The host name for the third token that you have to add to the DNS configuration for your domain.
|
java.lang.String |
getAttrDkimDnsTokenValue1()
The record value for the first token that you have to add to the DNS configuration for your domain.
|
java.lang.String |
getAttrDkimDnsTokenValue2()
The record value for the second token that you have to add to the DNS configuration for your domain.
|
java.lang.String |
getAttrDkimDnsTokenValue3()
The record value for the third token that you have to add to the DNS configuration for your domain.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getConfigurationSetAttributes()
Used to associate a configuration set with an email identity.
|
java.lang.Object |
getDkimAttributes()
An object that contains information about the DKIM attributes for the identity.
|
java.lang.Object |
getDkimSigningAttributes()
If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for [Easy DKIM](https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html) .
|
java.lang.String |
getEmailIdentity()
The email address or domain to verify.
|
java.lang.Object |
getFeedbackAttributes()
Used to enable or disable feedback forwarding for an identity.
|
java.lang.Object |
getMailFromAttributes()
Used to enable or disable the custom Mail-From domain configuration for an email identity.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setConfigurationSetAttributes(CfnEmailIdentity.ConfigurationSetAttributesProperty value)
Used to associate a configuration set with an email identity.
|
void |
setConfigurationSetAttributes(IResolvable value)
Used to associate a configuration set with an email identity.
|
void |
setDkimAttributes(CfnEmailIdentity.DkimAttributesProperty value)
An object that contains information about the DKIM attributes for the identity.
|
void |
setDkimAttributes(IResolvable value)
An object that contains information about the DKIM attributes for the identity.
|
void |
setDkimSigningAttributes(CfnEmailIdentity.DkimSigningAttributesProperty value)
If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for [Easy DKIM](https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html) .
|
void |
setDkimSigningAttributes(IResolvable value)
If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for [Easy DKIM](https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html) .
|
void |
setEmailIdentity(java.lang.String value)
The email address or domain to verify.
|
void |
setFeedbackAttributes(CfnEmailIdentity.FeedbackAttributesProperty value)
Used to enable or disable feedback forwarding for an identity.
|
void |
setFeedbackAttributes(IResolvable value)
Used to enable or disable feedback forwarding for an identity.
|
void |
setMailFromAttributes(CfnEmailIdentity.MailFromAttributesProperty value)
Used to enable or disable the custom Mail-From domain configuration for an email identity.
|
void |
setMailFromAttributes(IResolvable value)
Used to enable or disable the custom Mail-From domain configuration for an email identity.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnEmailIdentity(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnEmailIdentity(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnEmailIdentity(Construct scope, java.lang.String id, CfnEmailIdentityProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrDkimDnsTokenName1()
public java.lang.String getAttrDkimDnsTokenName2()
public java.lang.String getAttrDkimDnsTokenName3()
public java.lang.String getAttrDkimDnsTokenValue1()
public java.lang.String getAttrDkimDnsTokenValue2()
public java.lang.String getAttrDkimDnsTokenValue3()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getEmailIdentity()
public void setEmailIdentity(java.lang.String value)
public java.lang.Object getConfigurationSetAttributes()
public void setConfigurationSetAttributes(IResolvable value)
public void setConfigurationSetAttributes(CfnEmailIdentity.ConfigurationSetAttributesProperty value)
public java.lang.Object getDkimAttributes()
public void setDkimAttributes(IResolvable value)
public void setDkimAttributes(CfnEmailIdentity.DkimAttributesProperty value)
public java.lang.Object getDkimSigningAttributes()
public void setDkimSigningAttributes(IResolvable value)
public void setDkimSigningAttributes(CfnEmailIdentity.DkimSigningAttributesProperty value)
public java.lang.Object getFeedbackAttributes()
public void setFeedbackAttributes(IResolvable value)
public void setFeedbackAttributes(CfnEmailIdentity.FeedbackAttributesProperty value)
public java.lang.Object getMailFromAttributes()
public void setMailFromAttributes(IResolvable value)
public void setMailFromAttributes(CfnEmailIdentity.MailFromAttributesProperty value)