Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. ses
  5. getEmailIdentity

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.ses.getEmailIdentity

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::SES::EmailIdentity

    Using getEmailIdentity

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEmailIdentity(args: GetEmailIdentityArgs, opts?: InvokeOptions): Promise<GetEmailIdentityResult>
function getEmailIdentityOutput(args: GetEmailIdentityOutputArgs, opts?: InvokeOptions): Output<GetEmailIdentityResult>
    def get_email_identity(email_identity: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetEmailIdentityResult
def get_email_identity_output(email_identity: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetEmailIdentityResult]
    func LookupEmailIdentity(ctx *Context, args *LookupEmailIdentityArgs, opts ...InvokeOption) (*LookupEmailIdentityResult, error)
func LookupEmailIdentityOutput(ctx *Context, args *LookupEmailIdentityOutputArgs, opts ...InvokeOption) LookupEmailIdentityResultOutput

    > Note: This function is named LookupEmailIdentity in the Go SDK.

    public static class GetEmailIdentity 
{
    public static Task<GetEmailIdentityResult> InvokeAsync(GetEmailIdentityArgs args, InvokeOptions? opts = null)
    public static Output<GetEmailIdentityResult> Invoke(GetEmailIdentityInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEmailIdentityResult> getEmailIdentity(GetEmailIdentityArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:ses:getEmailIdentity
  arguments:
    # arguments dictionary

    The following arguments are supported:

    EmailIdentityValue string
    The email address or domain to verify.
    EmailIdentity string
    The email address or domain to verify.
    emailIdentity String
    The email address or domain to verify.
    emailIdentity string
    The email address or domain to verify.
    email_identity str
    The email address or domain to verify.
    emailIdentity String
    The email address or domain to verify.

    getEmailIdentity Result

    The following output properties are available:

    ConfigurationSetAttributes Pulumi.AwsNative.Ses.Outputs.EmailIdentityConfigurationSetAttributes
    Used to associate a configuration set with an email identity.
    DkimAttributes Pulumi.AwsNative.Ses.Outputs.EmailIdentityDkimAttributes
    An object that contains information about the DKIM attributes for the identity.
    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.
    DkimSigningAttributes Pulumi.AwsNative.Ses.Outputs.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 .

    You can only specify this object if the email identity is a domain, as opposed to an address.

    FeedbackAttributes Pulumi.AwsNative.Ses.Outputs.EmailIdentityFeedbackAttributes
    Used to enable or disable feedback forwarding for an identity.
    MailFromAttributes Pulumi.AwsNative.Ses.Outputs.EmailIdentityMailFromAttributes
    Used to enable or disable the custom Mail-From domain configuration for an email identity.
    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.
    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.
    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 .

    You can only specify this object if the email identity is a domain, as opposed to an address.

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

    You can only specify this object if the email identity is a domain, as opposed to an address.

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

    You can only specify this object if the email identity is a domain, as opposed to an address.

    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.
    configuration_set_attributes EmailIdentityConfigurationSetAttributes
    Used to associate a configuration set with an email identity.
    dkim_attributes EmailIdentityDkimAttributes
    An object that contains information about the DKIM attributes for the identity.
    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.
    dkim_signing_attributes 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 .

    You can only specify this object if the email identity is a domain, as opposed to an address.

    feedback_attributes EmailIdentityFeedbackAttributes
    Used to enable or disable feedback forwarding for an identity.
    mail_from_attributes EmailIdentityMailFromAttributes
    Used to enable or disable the custom Mail-From domain configuration for an email identity.
    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.
    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.
    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 .

    You can only specify this object if the email identity is a domain, as opposed to an address.

    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.

    Supporting Types

    EmailIdentityConfigurationSetAttributes

    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

    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

    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

    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

    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

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native