Package software.amazon.awscdk.services.ses

Interface CfnEmailIdentityProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEmailIdentityProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:14.028Z")
@Stability(Stable)
public interface CfnEmailIdentityProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnEmailIdentity.

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.*;
 CfnEmailIdentityProps cfnEmailIdentityProps = CfnEmailIdentityProps.builder()
         .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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEmailIdentityProps.Builder	A builder for CfnEmailIdentityProps
static final class	CfnEmailIdentityProps.Jsii$Proxy	An implementation for CfnEmailIdentityProps

Method Summary

Modifier and Type	Method	Description
static CfnEmailIdentityProps.Builder	builder()
default Object	getConfigurationSetAttributes()	Used to associate a configuration set with an email identity.
default Object	getDkimAttributes()	An object that contains information about the DKIM attributes for the identity.
default 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 .
String	getEmailIdentity()	The email address or domain to verify.
default Object	getFeedbackAttributes()	Used to enable or disable feedback forwarding for an identity.
default Object	getMailFromAttributes()	Used to enable or disable the custom Mail-From domain configuration for an email identity.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEmailIdentity

@Stability(Stable)
@NotNull
String getEmailIdentity()

The email address or domain to verify.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#cfn-ses-emailidentity-emailidentity

getConfigurationSetAttributes

@Stability(Stable)
@Nullable
default Object getConfigurationSetAttributes()

Used to associate a configuration set with an email identity.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#cfn-ses-emailidentity-configurationsetattributes

getDkimAttributes

@Stability(Stable)
@Nullable
default Object getDkimAttributes()

An object that contains information about the DKIM attributes for the identity.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#cfn-ses-emailidentity-dkimattributes

getDkimSigningAttributes

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#cfn-ses-emailidentity-dkimsigningattributes

getFeedbackAttributes

@Stability(Stable)
@Nullable
default Object getFeedbackAttributes()

Used to enable or disable feedback forwarding for an identity.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#cfn-ses-emailidentity-feedbackattributes

getMailFromAttributes

@Stability(Stable)
@Nullable
default Object getMailFromAttributes()

Used to enable or disable the custom Mail-From domain configuration for an email identity.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#cfn-ses-emailidentity-mailfromattributes

builder

@Stability(Stable)
static CfnEmailIdentityProps.Builder builder()

Returns:

a CfnEmailIdentityProps.Builder of CfnEmailIdentityProps