1. Packages
  2. AWS Native
  3. API Docs
  4. ses
  5. EmailIdentity

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

aws-native.ses.EmailIdentity

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

    Resource Type definition for AWS::SES::EmailIdentity

    Create EmailIdentity Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new EmailIdentity(name: string, args: EmailIdentityArgs, opts?: CustomResourceOptions);
    @overload
    def EmailIdentity(resource_name: str,
                      args: EmailIdentityArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def EmailIdentity(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      email_identity: Optional[str] = None,
                      configuration_set_attributes: Optional[EmailIdentityConfigurationSetAttributesArgs] = None,
                      dkim_attributes: Optional[EmailIdentityDkimAttributesArgs] = None,
                      dkim_signing_attributes: Optional[EmailIdentityDkimSigningAttributesArgs] = None,
                      feedback_attributes: Optional[EmailIdentityFeedbackAttributesArgs] = None,
                      mail_from_attributes: Optional[EmailIdentityMailFromAttributesArgs] = None)
    func NewEmailIdentity(ctx *Context, name string, args EmailIdentityArgs, opts ...ResourceOption) (*EmailIdentity, error)
    public EmailIdentity(string name, EmailIdentityArgs args, CustomResourceOptions? opts = null)
    public EmailIdentity(String name, EmailIdentityArgs args)
    public EmailIdentity(String name, EmailIdentityArgs args, CustomResourceOptions options)
    
    type: aws-native:ses:EmailIdentity
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args EmailIdentityArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EmailIdentityArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EmailIdentityArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EmailIdentityArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EmailIdentityArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const emailIdentityResource = new aws_native.ses.EmailIdentity("emailIdentityResource", {
        emailIdentity: "string",
        configurationSetAttributes: {
            configurationSetName: "string",
        },
        dkimAttributes: {
            signingEnabled: false,
        },
        dkimSigningAttributes: {
            domainSigningPrivateKey: "string",
            domainSigningSelector: "string",
            nextSigningKeyLength: "string",
        },
        feedbackAttributes: {
            emailForwardingEnabled: false,
        },
        mailFromAttributes: {
            behaviorOnMxFailure: "string",
            mailFromDomain: "string",
        },
    });
    
    Coming soon!
    

    EmailIdentity Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The EmailIdentity resource accepts the following input properties:

    EmailIdentityValue string
    The email address or domain to verify.
    ConfigurationSetAttributes Pulumi.AwsNative.Ses.Inputs.EmailIdentityConfigurationSetAttributes
    Used to associate a configuration set with an email identity.
    DkimAttributes Pulumi.AwsNative.Ses.Inputs.EmailIdentityDkimAttributes
    An object that contains information about the DKIM attributes for the identity.
    DkimSigningAttributes Pulumi.AwsNative.Ses.Inputs.EmailIdentityDkimSigningAttributes
    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 .
    FeedbackAttributes Pulumi.AwsNative.Ses.Inputs.EmailIdentityFeedbackAttributes
    Used to enable or disable feedback forwarding for an identity.
    MailFromAttributes Pulumi.AwsNative.Ses.Inputs.EmailIdentityMailFromAttributes
    Used to enable or disable the custom Mail-From domain configuration for an email identity.
    EmailIdentity string
    The email address or domain to verify.
    ConfigurationSetAttributes EmailIdentityConfigurationSetAttributesArgs
    Used to associate a configuration set with an email identity.
    DkimAttributes EmailIdentityDkimAttributesArgs
    An object that contains information about the DKIM attributes for the identity.
    DkimSigningAttributes EmailIdentityDkimSigningAttributesArgs
    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 .
    FeedbackAttributes EmailIdentityFeedbackAttributesArgs
    Used to enable or disable feedback forwarding for an identity.
    MailFromAttributes EmailIdentityMailFromAttributesArgs
    Used to enable or disable the custom Mail-From domain configuration for an email identity.
    emailIdentity String
    The email address or domain to verify.
    configurationSetAttributes EmailIdentityConfigurationSetAttributes
    Used to associate a configuration set with an email identity.
    dkimAttributes EmailIdentityDkimAttributes
    An object that contains information about the DKIM attributes for the identity.
    dkimSigningAttributes EmailIdentityDkimSigningAttributes
    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 .
    feedbackAttributes EmailIdentityFeedbackAttributes
    Used to enable or disable feedback forwarding for an identity.
    mailFromAttributes EmailIdentityMailFromAttributes
    Used to enable or disable the custom Mail-From domain configuration for an email identity.
    emailIdentity string
    The email address or domain to verify.
    configurationSetAttributes EmailIdentityConfigurationSetAttributes
    Used to associate a configuration set with an email identity.
    dkimAttributes EmailIdentityDkimAttributes
    An object that contains information about the DKIM attributes for the identity.
    dkimSigningAttributes EmailIdentityDkimSigningAttributes
    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 .
    feedbackAttributes EmailIdentityFeedbackAttributes
    Used to enable or disable feedback forwarding for an identity.
    mailFromAttributes EmailIdentityMailFromAttributes
    Used to enable or disable the custom Mail-From domain configuration for an email identity.
    email_identity str
    The email address or domain to verify.
    configuration_set_attributes EmailIdentityConfigurationSetAttributesArgs
    Used to associate a configuration set with an email identity.
    dkim_attributes EmailIdentityDkimAttributesArgs
    An object that contains information about the DKIM attributes for the identity.
    dkim_signing_attributes EmailIdentityDkimSigningAttributesArgs
    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 .
    feedback_attributes EmailIdentityFeedbackAttributesArgs
    Used to enable or disable feedback forwarding for an identity.
    mail_from_attributes EmailIdentityMailFromAttributesArgs
    Used to enable or disable the custom Mail-From domain configuration for an email identity.
    emailIdentity String
    The email address or domain to verify.
    configurationSetAttributes Property Map
    Used to associate a configuration set with an email identity.
    dkimAttributes Property Map
    An object that contains information about the DKIM attributes for the identity.
    dkimSigningAttributes Property Map
    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 .
    feedbackAttributes Property Map
    Used to enable or disable feedback forwarding for an identity.
    mailFromAttributes Property Map
    Used to enable or disable the custom Mail-From domain configuration for an email identity.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EmailIdentity resource produces the following output properties:

    DkimDnsTokenName1 string
    The host name for the first token that you have to add to the DNS configuration for your domain.
    DkimDnsTokenName2 string
    The host name for the second token that you have to add to the DNS configuration for your domain.
    DkimDnsTokenName3 string
    The host name for the third token that you have to add to the DNS configuration for your domain.
    DkimDnsTokenValue1 string
    The record value for the first token that you have to add to the DNS configuration for your domain.
    DkimDnsTokenValue2 string
    The record value for the second token that you have to add to the DNS configuration for your domain.
    DkimDnsTokenValue3 string
    The record value for the third token that you have to add to the DNS configuration for your domain.
    Id string
    The provider-assigned unique ID for this managed resource.
    DkimDnsTokenName1 string
    The host name for the first token that you have to add to the DNS configuration for your domain.
    DkimDnsTokenName2 string
    The host name for the second token that you have to add to the DNS configuration for your domain.
    DkimDnsTokenName3 string
    The host name for the third token that you have to add to the DNS configuration for your domain.
    DkimDnsTokenValue1 string
    The record value for the first token that you have to add to the DNS configuration for your domain.
    DkimDnsTokenValue2 string
    The record value for the second token that you have to add to the DNS configuration for your domain.
    DkimDnsTokenValue3 string
    The record value for the third token that you have to add to the DNS configuration for your domain.
    Id string
    The provider-assigned unique ID for this managed resource.
    dkimDnsTokenName1 String
    The host name for the first token that you have to add to the DNS configuration for your domain.
    dkimDnsTokenName2 String
    The host name for the second token that you have to add to the DNS configuration for your domain.
    dkimDnsTokenName3 String
    The host name for the third token that you have to add to the DNS configuration for your domain.
    dkimDnsTokenValue1 String
    The record value for the first token that you have to add to the DNS configuration for your domain.
    dkimDnsTokenValue2 String
    The record value for the second token that you have to add to the DNS configuration for your domain.
    dkimDnsTokenValue3 String
    The record value for the third token that you have to add to the DNS configuration for your domain.
    id String
    The provider-assigned unique ID for this managed resource.
    dkimDnsTokenName1 string
    The host name for the first token that you have to add to the DNS configuration for your domain.
    dkimDnsTokenName2 string
    The host name for the second token that you have to add to the DNS configuration for your domain.
    dkimDnsTokenName3 string
    The host name for the third token that you have to add to the DNS configuration for your domain.
    dkimDnsTokenValue1 string
    The record value for the first token that you have to add to the DNS configuration for your domain.
    dkimDnsTokenValue2 string
    The record value for the second token that you have to add to the DNS configuration for your domain.
    dkimDnsTokenValue3 string
    The record value for the third token that you have to add to the DNS configuration for your domain.
    id string
    The provider-assigned unique ID for this managed resource.
    dkim_dns_token_name1 str
    The host name for the first token that you have to add to the DNS configuration for your domain.
    dkim_dns_token_name2 str
    The host name for the second token that you have to add to the DNS configuration for your domain.
    dkim_dns_token_name3 str
    The host name for the third token that you have to add to the DNS configuration for your domain.
    dkim_dns_token_value1 str
    The record value for the first token that you have to add to the DNS configuration for your domain.
    dkim_dns_token_value2 str
    The record value for the second token that you have to add to the DNS configuration for your domain.
    dkim_dns_token_value3 str
    The record value for the third token that you have to add to the DNS configuration for your domain.
    id str
    The provider-assigned unique ID for this managed resource.
    dkimDnsTokenName1 String
    The host name for the first token that you have to add to the DNS configuration for your domain.
    dkimDnsTokenName2 String
    The host name for the second token that you have to add to the DNS configuration for your domain.
    dkimDnsTokenName3 String
    The host name for the third token that you have to add to the DNS configuration for your domain.
    dkimDnsTokenValue1 String
    The record value for the first token that you have to add to the DNS configuration for your domain.
    dkimDnsTokenValue2 String
    The record value for the second token that you have to add to the DNS configuration for your domain.
    dkimDnsTokenValue3 String
    The record value for the third token that you have to add to the DNS configuration for your domain.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    EmailIdentityConfigurationSetAttributes, EmailIdentityConfigurationSetAttributesArgs

    ConfigurationSetName string
    The configuration set to use by default when sending from this identity. Note that any configuration set defined in the email sending request takes precedence.
    ConfigurationSetName string
    The configuration set to use by default when sending from this identity. Note that any configuration set defined in the email sending request takes precedence.
    configurationSetName String
    The configuration set to use by default when sending from this identity. Note that any configuration set defined in the email sending request takes precedence.
    configurationSetName string
    The configuration set to use by default when sending from this identity. Note that any configuration set defined in the email sending request takes precedence.
    configuration_set_name str
    The configuration set to use by default when sending from this identity. Note that any configuration set defined in the email sending request takes precedence.
    configurationSetName String
    The configuration set to use by default when sending from this identity. Note that any configuration set defined in the email sending request takes precedence.

    EmailIdentityDkimAttributes, EmailIdentityDkimAttributesArgs

    SigningEnabled bool
    Sets the DKIM signing configuration for the identity. When you set this value true, then the messages that are sent from the identity are signed using DKIM. If you set this value to false, your messages are sent without DKIM signing.
    SigningEnabled bool
    Sets the DKIM signing configuration for the identity. When you set this value true, then the messages that are sent from the identity are signed using DKIM. If you set this value to false, your messages are sent without DKIM signing.
    signingEnabled Boolean
    Sets the DKIM signing configuration for the identity. When you set this value true, then the messages that are sent from the identity are signed using DKIM. If you set this value to false, your messages are sent without DKIM signing.
    signingEnabled boolean
    Sets the DKIM signing configuration for the identity. When you set this value true, then the messages that are sent from the identity are signed using DKIM. If you set this value to false, your messages are sent without DKIM signing.
    signing_enabled bool
    Sets the DKIM signing configuration for the identity. When you set this value true, then the messages that are sent from the identity are signed using DKIM. If you set this value to false, your messages are sent without DKIM signing.
    signingEnabled Boolean
    Sets the DKIM signing configuration for the identity. When you set this value true, then the messages that are sent from the identity are signed using DKIM. If you set this value to false, your messages are sent without DKIM signing.

    EmailIdentityDkimSigningAttributes, EmailIdentityDkimSigningAttributesArgs

    DomainSigningPrivateKey string
    [Bring Your Own DKIM] A private key that's used to generate a DKIM signature. The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using base64 encoding.
    DomainSigningSelector string
    [Bring Your Own DKIM] A string that's used to identify a public key in the DNS configuration for a domain.
    NextSigningKeyLength string
    [Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.
    DomainSigningPrivateKey string
    [Bring Your Own DKIM] A private key that's used to generate a DKIM signature. The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using base64 encoding.
    DomainSigningSelector string
    [Bring Your Own DKIM] A string that's used to identify a public key in the DNS configuration for a domain.
    NextSigningKeyLength string
    [Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.
    domainSigningPrivateKey String
    [Bring Your Own DKIM] A private key that's used to generate a DKIM signature. The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using base64 encoding.
    domainSigningSelector String
    [Bring Your Own DKIM] A string that's used to identify a public key in the DNS configuration for a domain.
    nextSigningKeyLength String
    [Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.
    domainSigningPrivateKey string
    [Bring Your Own DKIM] A private key that's used to generate a DKIM signature. The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using base64 encoding.
    domainSigningSelector string
    [Bring Your Own DKIM] A string that's used to identify a public key in the DNS configuration for a domain.
    nextSigningKeyLength string
    [Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.
    domain_signing_private_key str
    [Bring Your Own DKIM] A private key that's used to generate a DKIM signature. The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using base64 encoding.
    domain_signing_selector str
    [Bring Your Own DKIM] A string that's used to identify a public key in the DNS configuration for a domain.
    next_signing_key_length str
    [Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.
    domainSigningPrivateKey String
    [Bring Your Own DKIM] A private key that's used to generate a DKIM signature. The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using base64 encoding.
    domainSigningSelector String
    [Bring Your Own DKIM] A string that's used to identify a public key in the DNS configuration for a domain.
    nextSigningKeyLength String
    [Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.

    EmailIdentityFeedbackAttributes, EmailIdentityFeedbackAttributesArgs

    EmailForwardingEnabled bool
    If the value is true, you receive email notifications when bounce or complaint events occur
    EmailForwardingEnabled bool
    If the value is true, you receive email notifications when bounce or complaint events occur
    emailForwardingEnabled Boolean
    If the value is true, you receive email notifications when bounce or complaint events occur
    emailForwardingEnabled boolean
    If the value is true, you receive email notifications when bounce or complaint events occur
    email_forwarding_enabled bool
    If the value is true, you receive email notifications when bounce or complaint events occur
    emailForwardingEnabled Boolean
    If the value is true, you receive email notifications when bounce or complaint events occur

    EmailIdentityMailFromAttributes, EmailIdentityMailFromAttributesArgs

    BehaviorOnMxFailure string
    The action to take if the required MX record isn't found when you send an email. When you set this value to UseDefaultValue , the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage , the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.
    MailFromDomain string
    The custom MAIL FROM domain that you want the verified identity to use
    BehaviorOnMxFailure string
    The action to take if the required MX record isn't found when you send an email. When you set this value to UseDefaultValue , the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage , the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.
    MailFromDomain string
    The custom MAIL FROM domain that you want the verified identity to use
    behaviorOnMxFailure String
    The action to take if the required MX record isn't found when you send an email. When you set this value to UseDefaultValue , the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage , the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.
    mailFromDomain String
    The custom MAIL FROM domain that you want the verified identity to use
    behaviorOnMxFailure string
    The action to take if the required MX record isn't found when you send an email. When you set this value to UseDefaultValue , the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage , the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.
    mailFromDomain string
    The custom MAIL FROM domain that you want the verified identity to use
    behavior_on_mx_failure str
    The action to take if the required MX record isn't found when you send an email. When you set this value to UseDefaultValue , the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage , the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.
    mail_from_domain str
    The custom MAIL FROM domain that you want the verified identity to use
    behaviorOnMxFailure String
    The action to take if the required MX record isn't found when you send an email. When you set this value to UseDefaultValue , the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage , the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.
    mailFromDomain String
    The custom MAIL FROM domain that you want the verified identity to use

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi