1. Packages
  2. AWS Classic
  3. API Docs
  4. sesv2
  5. EmailIdentity

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.31.0 published on Monday, Apr 15, 2024 by Pulumi

aws.sesv2.EmailIdentity

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.31.0 published on Monday, Apr 15, 2024 by Pulumi

    Resource for managing an AWS SESv2 (Simple Email V2) Email Identity.

    Example Usage

    Basic Usage

    Email Address Identity

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.sesv2.EmailIdentity("example", {emailIdentity: "testing@example.com"});
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.sesv2.EmailIdentity("example", email_identity="testing@example.com")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sesv2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := sesv2.NewEmailIdentity(ctx, "example", &sesv2.EmailIdentityArgs{
    			EmailIdentity: pulumi.String("testing@example.com"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.SesV2.EmailIdentity("example", new()
        {
            EmailIdentityDetails = "testing@example.com",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.sesv2.EmailIdentity;
    import com.pulumi.aws.sesv2.EmailIdentityArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new EmailIdentity("example", EmailIdentityArgs.builder()        
                .emailIdentity("testing@example.com")
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:sesv2:EmailIdentity
        properties:
          emailIdentity: testing@example.com
    

    Domain Identity

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.sesv2.EmailIdentity("example", {emailIdentity: "example.com"});
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.sesv2.EmailIdentity("example", email_identity="example.com")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sesv2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := sesv2.NewEmailIdentity(ctx, "example", &sesv2.EmailIdentityArgs{
    			EmailIdentity: pulumi.String("example.com"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.SesV2.EmailIdentity("example", new()
        {
            EmailIdentityDetails = "example.com",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.sesv2.EmailIdentity;
    import com.pulumi.aws.sesv2.EmailIdentityArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new EmailIdentity("example", EmailIdentityArgs.builder()        
                .emailIdentity("example.com")
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:sesv2:EmailIdentity
        properties:
          emailIdentity: example.com
    

    Configuration Set

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.sesv2.ConfigurationSet("example", {configurationSetName: "example"});
    const exampleEmailIdentity = new aws.sesv2.EmailIdentity("example", {
        emailIdentity: "example.com",
        configurationSetName: example.configurationSetName,
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.sesv2.ConfigurationSet("example", configuration_set_name="example")
    example_email_identity = aws.sesv2.EmailIdentity("example",
        email_identity="example.com",
        configuration_set_name=example.configuration_set_name)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sesv2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := sesv2.NewConfigurationSet(ctx, "example", &sesv2.ConfigurationSetArgs{
    			ConfigurationSetName: pulumi.String("example"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = sesv2.NewEmailIdentity(ctx, "example", &sesv2.EmailIdentityArgs{
    			EmailIdentity:        pulumi.String("example.com"),
    			ConfigurationSetName: example.ConfigurationSetName,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.SesV2.ConfigurationSet("example", new()
        {
            ConfigurationSetName = "example",
        });
    
        var exampleEmailIdentity = new Aws.SesV2.EmailIdentity("example", new()
        {
            EmailIdentityDetails = "example.com",
            ConfigurationSetName = example.ConfigurationSetName,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.sesv2.ConfigurationSet;
    import com.pulumi.aws.sesv2.ConfigurationSetArgs;
    import com.pulumi.aws.sesv2.EmailIdentity;
    import com.pulumi.aws.sesv2.EmailIdentityArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new ConfigurationSet("example", ConfigurationSetArgs.builder()        
                .configurationSetName("example")
                .build());
    
            var exampleEmailIdentity = new EmailIdentity("exampleEmailIdentity", EmailIdentityArgs.builder()        
                .emailIdentity("example.com")
                .configurationSetName(example.configurationSetName())
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:sesv2:ConfigurationSet
        properties:
          configurationSetName: example
      exampleEmailIdentity:
        type: aws:sesv2:EmailIdentity
        name: example
        properties:
          emailIdentity: example.com
          configurationSetName: ${example.configurationSetName}
    

    DKIM Signing Attributes (BYODKIM)

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.sesv2.EmailIdentity("example", {
        emailIdentity: "example.com",
        dkimSigningAttributes: {
            domainSigningPrivateKey: "MIIJKAIBAAKCAgEA2Se7p8zvnI4yh+Gh9j2rG5e2aRXjg03Y8saiupLnadPH9xvM...",
            domainSigningSelector: "example",
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.sesv2.EmailIdentity("example",
        email_identity="example.com",
        dkim_signing_attributes=aws.sesv2.EmailIdentityDkimSigningAttributesArgs(
            domain_signing_private_key="MIIJKAIBAAKCAgEA2Se7p8zvnI4yh+Gh9j2rG5e2aRXjg03Y8saiupLnadPH9xvM...",
            domain_signing_selector="example",
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sesv2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := sesv2.NewEmailIdentity(ctx, "example", &sesv2.EmailIdentityArgs{
    			EmailIdentity: pulumi.String("example.com"),
    			DkimSigningAttributes: &sesv2.EmailIdentityDkimSigningAttributesArgs{
    				DomainSigningPrivateKey: pulumi.String("MIIJKAIBAAKCAgEA2Se7p8zvnI4yh+Gh9j2rG5e2aRXjg03Y8saiupLnadPH9xvM..."),
    				DomainSigningSelector:   pulumi.String("example"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.SesV2.EmailIdentity("example", new()
        {
            EmailIdentityDetails = "example.com",
            DkimSigningAttributes = new Aws.SesV2.Inputs.EmailIdentityDkimSigningAttributesArgs
            {
                DomainSigningPrivateKey = "MIIJKAIBAAKCAgEA2Se7p8zvnI4yh+Gh9j2rG5e2aRXjg03Y8saiupLnadPH9xvM...",
                DomainSigningSelector = "example",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.sesv2.EmailIdentity;
    import com.pulumi.aws.sesv2.EmailIdentityArgs;
    import com.pulumi.aws.sesv2.inputs.EmailIdentityDkimSigningAttributesArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new EmailIdentity("example", EmailIdentityArgs.builder()        
                .emailIdentity("example.com")
                .dkimSigningAttributes(EmailIdentityDkimSigningAttributesArgs.builder()
                    .domainSigningPrivateKey("MIIJKAIBAAKCAgEA2Se7p8zvnI4yh+Gh9j2rG5e2aRXjg03Y8saiupLnadPH9xvM...")
                    .domainSigningSelector("example")
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:sesv2:EmailIdentity
        properties:
          emailIdentity: example.com
          dkimSigningAttributes:
            domainSigningPrivateKey: MIIJKAIBAAKCAgEA2Se7p8zvnI4yh+Gh9j2rG5e2aRXjg03Y8saiupLnadPH9xvM...
            domainSigningSelector: example
    

    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_name: Optional[str] = None,
                      dkim_signing_attributes: Optional[EmailIdentityDkimSigningAttributesArgs] = None,
                      tags: Optional[Mapping[str, str]] = 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:sesv2: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.

    var awsEmailIdentityResource = new Aws.SesV2.EmailIdentity("awsEmailIdentityResource", new()
    {
        EmailIdentityDetails = "string",
        ConfigurationSetName = "string",
        DkimSigningAttributes = new Aws.SesV2.Inputs.EmailIdentityDkimSigningAttributesArgs
        {
            CurrentSigningKeyLength = "string",
            DomainSigningPrivateKey = "string",
            DomainSigningSelector = "string",
            LastKeyGenerationTimestamp = "string",
            NextSigningKeyLength = "string",
            SigningAttributesOrigin = "string",
            Status = "string",
            Tokens = new[]
            {
                "string",
            },
        },
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := sesv2.NewEmailIdentity(ctx, "awsEmailIdentityResource", &sesv2.EmailIdentityArgs{
    	EmailIdentity:        pulumi.String("string"),
    	ConfigurationSetName: pulumi.String("string"),
    	DkimSigningAttributes: &sesv2.EmailIdentityDkimSigningAttributesArgs{
    		CurrentSigningKeyLength:    pulumi.String("string"),
    		DomainSigningPrivateKey:    pulumi.String("string"),
    		DomainSigningSelector:      pulumi.String("string"),
    		LastKeyGenerationTimestamp: pulumi.String("string"),
    		NextSigningKeyLength:       pulumi.String("string"),
    		SigningAttributesOrigin:    pulumi.String("string"),
    		Status:                     pulumi.String("string"),
    		Tokens: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var awsEmailIdentityResource = new EmailIdentity("awsEmailIdentityResource", EmailIdentityArgs.builder()        
        .emailIdentity("string")
        .configurationSetName("string")
        .dkimSigningAttributes(EmailIdentityDkimSigningAttributesArgs.builder()
            .currentSigningKeyLength("string")
            .domainSigningPrivateKey("string")
            .domainSigningSelector("string")
            .lastKeyGenerationTimestamp("string")
            .nextSigningKeyLength("string")
            .signingAttributesOrigin("string")
            .status("string")
            .tokens("string")
            .build())
        .tags(Map.of("string", "string"))
        .build());
    
    aws_email_identity_resource = aws.sesv2.EmailIdentity("awsEmailIdentityResource",
        email_identity="string",
        configuration_set_name="string",
        dkim_signing_attributes=aws.sesv2.EmailIdentityDkimSigningAttributesArgs(
            current_signing_key_length="string",
            domain_signing_private_key="string",
            domain_signing_selector="string",
            last_key_generation_timestamp="string",
            next_signing_key_length="string",
            signing_attributes_origin="string",
            status="string",
            tokens=["string"],
        ),
        tags={
            "string": "string",
        })
    
    const awsEmailIdentityResource = new aws.sesv2.EmailIdentity("awsEmailIdentityResource", {
        emailIdentity: "string",
        configurationSetName: "string",
        dkimSigningAttributes: {
            currentSigningKeyLength: "string",
            domainSigningPrivateKey: "string",
            domainSigningSelector: "string",
            lastKeyGenerationTimestamp: "string",
            nextSigningKeyLength: "string",
            signingAttributesOrigin: "string",
            status: "string",
            tokens: ["string"],
        },
        tags: {
            string: "string",
        },
    });
    
    type: aws:sesv2:EmailIdentity
    properties:
        configurationSetName: string
        dkimSigningAttributes:
            currentSigningKeyLength: string
            domainSigningPrivateKey: string
            domainSigningSelector: string
            lastKeyGenerationTimestamp: string
            nextSigningKeyLength: string
            signingAttributesOrigin: string
            status: string
            tokens:
                - string
        emailIdentity: string
        tags:
            string: string
    

    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:

    EmailIdentityDetails string

    The email address or domain to verify.

    The following arguments are optional:

    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.
    DkimSigningAttributes EmailIdentityDkimSigningAttributes
    The configuration of the DKIM authentication settings for an email domain identity.
    Tags Dictionary<string, string>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    EmailIdentity string

    The email address or domain to verify.

    The following arguments are optional:

    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.
    DkimSigningAttributes EmailIdentityDkimSigningAttributesArgs
    The configuration of the DKIM authentication settings for an email domain identity.
    Tags map[string]string
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    emailIdentity String

    The email address or domain to verify.

    The following arguments are optional:

    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.
    dkimSigningAttributes EmailIdentityDkimSigningAttributes
    The configuration of the DKIM authentication settings for an email domain identity.
    tags Map<String,String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    emailIdentity string

    The email address or domain to verify.

    The following arguments are optional:

    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.
    dkimSigningAttributes EmailIdentityDkimSigningAttributes
    The configuration of the DKIM authentication settings for an email domain identity.
    tags {[key: string]: string}
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    email_identity str

    The email address or domain to verify.

    The following arguments are optional:

    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.
    dkim_signing_attributes EmailIdentityDkimSigningAttributesArgs
    The configuration of the DKIM authentication settings for an email domain identity.
    tags Mapping[str, str]
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    emailIdentity String

    The email address or domain to verify.

    The following arguments are optional:

    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.
    dkimSigningAttributes Property Map
    The configuration of the DKIM authentication settings for an email domain identity.
    tags Map<String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    ARN of the Email Identity.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityType string
    The email identity type. Valid values: EMAIL_ADDRESS, DOMAIN.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    VerifiedForSendingStatus bool
    Specifies whether or not the identity is verified.
    Arn string
    ARN of the Email Identity.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityType string
    The email identity type. Valid values: EMAIL_ADDRESS, DOMAIN.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    VerifiedForSendingStatus bool
    Specifies whether or not the identity is verified.
    arn String
    ARN of the Email Identity.
    id String
    The provider-assigned unique ID for this managed resource.
    identityType String
    The email identity type. Valid values: EMAIL_ADDRESS, DOMAIN.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    verifiedForSendingStatus Boolean
    Specifies whether or not the identity is verified.
    arn string
    ARN of the Email Identity.
    id string
    The provider-assigned unique ID for this managed resource.
    identityType string
    The email identity type. Valid values: EMAIL_ADDRESS, DOMAIN.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    verifiedForSendingStatus boolean
    Specifies whether or not the identity is verified.
    arn str
    ARN of the Email Identity.
    id str
    The provider-assigned unique ID for this managed resource.
    identity_type str
    The email identity type. Valid values: EMAIL_ADDRESS, DOMAIN.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    verified_for_sending_status bool
    Specifies whether or not the identity is verified.
    arn String
    ARN of the Email Identity.
    id String
    The provider-assigned unique ID for this managed resource.
    identityType String
    The email identity type. Valid values: EMAIL_ADDRESS, DOMAIN.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    verifiedForSendingStatus Boolean
    Specifies whether or not the identity is verified.

    Look up Existing EmailIdentity Resource

    Get an existing EmailIdentity resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: EmailIdentityState, opts?: CustomResourceOptions): EmailIdentity
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            configuration_set_name: Optional[str] = None,
            dkim_signing_attributes: Optional[EmailIdentityDkimSigningAttributesArgs] = None,
            email_identity: Optional[str] = None,
            identity_type: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            verified_for_sending_status: Optional[bool] = None) -> EmailIdentity
    func GetEmailIdentity(ctx *Context, name string, id IDInput, state *EmailIdentityState, opts ...ResourceOption) (*EmailIdentity, error)
    public static EmailIdentity Get(string name, Input<string> id, EmailIdentityState? state, CustomResourceOptions? opts = null)
    public static EmailIdentity get(String name, Output<String> id, EmailIdentityState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    ARN of the Email Identity.
    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.
    DkimSigningAttributes EmailIdentityDkimSigningAttributes
    The configuration of the DKIM authentication settings for an email domain identity.
    EmailIdentityDetails string

    The email address or domain to verify.

    The following arguments are optional:

    IdentityType string
    The email identity type. Valid values: EMAIL_ADDRESS, DOMAIN.
    Tags Dictionary<string, string>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    VerifiedForSendingStatus bool
    Specifies whether or not the identity is verified.
    Arn string
    ARN of the Email Identity.
    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.
    DkimSigningAttributes EmailIdentityDkimSigningAttributesArgs
    The configuration of the DKIM authentication settings for an email domain identity.
    EmailIdentity string

    The email address or domain to verify.

    The following arguments are optional:

    IdentityType string
    The email identity type. Valid values: EMAIL_ADDRESS, DOMAIN.
    Tags map[string]string
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    VerifiedForSendingStatus bool
    Specifies whether or not the identity is verified.
    arn String
    ARN of the Email Identity.
    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.
    dkimSigningAttributes EmailIdentityDkimSigningAttributes
    The configuration of the DKIM authentication settings for an email domain identity.
    emailIdentity String

    The email address or domain to verify.

    The following arguments are optional:

    identityType String
    The email identity type. Valid values: EMAIL_ADDRESS, DOMAIN.
    tags Map<String,String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    verifiedForSendingStatus Boolean
    Specifies whether or not the identity is verified.
    arn string
    ARN of the Email Identity.
    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.
    dkimSigningAttributes EmailIdentityDkimSigningAttributes
    The configuration of the DKIM authentication settings for an email domain identity.
    emailIdentity string

    The email address or domain to verify.

    The following arguments are optional:

    identityType string
    The email identity type. Valid values: EMAIL_ADDRESS, DOMAIN.
    tags {[key: string]: string}
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    verifiedForSendingStatus boolean
    Specifies whether or not the identity is verified.
    arn str
    ARN of the Email Identity.
    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.
    dkim_signing_attributes EmailIdentityDkimSigningAttributesArgs
    The configuration of the DKIM authentication settings for an email domain identity.
    email_identity str

    The email address or domain to verify.

    The following arguments are optional:

    identity_type str
    The email identity type. Valid values: EMAIL_ADDRESS, DOMAIN.
    tags Mapping[str, str]
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    verified_for_sending_status bool
    Specifies whether or not the identity is verified.
    arn String
    ARN of the Email Identity.
    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.
    dkimSigningAttributes Property Map
    The configuration of the DKIM authentication settings for an email domain identity.
    emailIdentity String

    The email address or domain to verify.

    The following arguments are optional:

    identityType String
    The email identity type. Valid values: EMAIL_ADDRESS, DOMAIN.
    tags Map<String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    verifiedForSendingStatus Boolean
    Specifies whether or not the identity is verified.

    Supporting Types

    EmailIdentityDkimSigningAttributes, EmailIdentityDkimSigningAttributesArgs

    CurrentSigningKeyLength string
    [Easy DKIM] The key length of the DKIM key pair in use.
    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.

    NOTE: You have to delete the first and last lines ('-----BEGIN PRIVATE KEY-----' and '-----END PRIVATE KEY-----', respectively) of the generated private key. Additionally, you have to remove the line breaks in the generated private key. The resulting value is a string of characters with no spaces or line breaks.

    DomainSigningSelector string
    [Bring Your Own DKIM] A string that's used to identify a public key in the DNS configuration for a domain.
    LastKeyGenerationTimestamp string
    [Easy DKIM] The last time a key pair was generated for this identity.
    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. Valid values: RSA_1024_BIT, RSA_2048_BIT.
    SigningAttributesOrigin string
    A string that indicates how DKIM was configured for the identity. AWS_SES indicates that DKIM was configured for the identity by using Easy DKIM. EXTERNAL indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).
    Status string
    Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. See the AWS SES API v2 Reference for supported statuses.
    Tokens List<string>
    If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key.
    CurrentSigningKeyLength string
    [Easy DKIM] The key length of the DKIM key pair in use.
    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.

    NOTE: You have to delete the first and last lines ('-----BEGIN PRIVATE KEY-----' and '-----END PRIVATE KEY-----', respectively) of the generated private key. Additionally, you have to remove the line breaks in the generated private key. The resulting value is a string of characters with no spaces or line breaks.

    DomainSigningSelector string
    [Bring Your Own DKIM] A string that's used to identify a public key in the DNS configuration for a domain.
    LastKeyGenerationTimestamp string
    [Easy DKIM] The last time a key pair was generated for this identity.
    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. Valid values: RSA_1024_BIT, RSA_2048_BIT.
    SigningAttributesOrigin string
    A string that indicates how DKIM was configured for the identity. AWS_SES indicates that DKIM was configured for the identity by using Easy DKIM. EXTERNAL indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).
    Status string
    Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. See the AWS SES API v2 Reference for supported statuses.
    Tokens []string
    If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key.
    currentSigningKeyLength String
    [Easy DKIM] The key length of the DKIM key pair in use.
    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.

    NOTE: You have to delete the first and last lines ('-----BEGIN PRIVATE KEY-----' and '-----END PRIVATE KEY-----', respectively) of the generated private key. Additionally, you have to remove the line breaks in the generated private key. The resulting value is a string of characters with no spaces or line breaks.

    domainSigningSelector String
    [Bring Your Own DKIM] A string that's used to identify a public key in the DNS configuration for a domain.
    lastKeyGenerationTimestamp String
    [Easy DKIM] The last time a key pair was generated for this identity.
    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. Valid values: RSA_1024_BIT, RSA_2048_BIT.
    signingAttributesOrigin String
    A string that indicates how DKIM was configured for the identity. AWS_SES indicates that DKIM was configured for the identity by using Easy DKIM. EXTERNAL indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).
    status String
    Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. See the AWS SES API v2 Reference for supported statuses.
    tokens List<String>
    If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key.
    currentSigningKeyLength string
    [Easy DKIM] The key length of the DKIM key pair in use.
    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.

    NOTE: You have to delete the first and last lines ('-----BEGIN PRIVATE KEY-----' and '-----END PRIVATE KEY-----', respectively) of the generated private key. Additionally, you have to remove the line breaks in the generated private key. The resulting value is a string of characters with no spaces or line breaks.

    domainSigningSelector string
    [Bring Your Own DKIM] A string that's used to identify a public key in the DNS configuration for a domain.
    lastKeyGenerationTimestamp string
    [Easy DKIM] The last time a key pair was generated for this identity.
    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. Valid values: RSA_1024_BIT, RSA_2048_BIT.
    signingAttributesOrigin string
    A string that indicates how DKIM was configured for the identity. AWS_SES indicates that DKIM was configured for the identity by using Easy DKIM. EXTERNAL indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).
    status string
    Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. See the AWS SES API v2 Reference for supported statuses.
    tokens string[]
    If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key.
    current_signing_key_length str
    [Easy DKIM] The key length of the DKIM key pair in use.
    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.

    NOTE: You have to delete the first and last lines ('-----BEGIN PRIVATE KEY-----' and '-----END PRIVATE KEY-----', respectively) of the generated private key. Additionally, you have to remove the line breaks in the generated private key. The resulting value is a string of characters with no spaces or line breaks.

    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.
    last_key_generation_timestamp str
    [Easy DKIM] The last time a key pair was generated for this identity.
    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. Valid values: RSA_1024_BIT, RSA_2048_BIT.
    signing_attributes_origin str
    A string that indicates how DKIM was configured for the identity. AWS_SES indicates that DKIM was configured for the identity by using Easy DKIM. EXTERNAL indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).
    status str
    Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. See the AWS SES API v2 Reference for supported statuses.
    tokens Sequence[str]
    If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key.
    currentSigningKeyLength String
    [Easy DKIM] The key length of the DKIM key pair in use.
    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.

    NOTE: You have to delete the first and last lines ('-----BEGIN PRIVATE KEY-----' and '-----END PRIVATE KEY-----', respectively) of the generated private key. Additionally, you have to remove the line breaks in the generated private key. The resulting value is a string of characters with no spaces or line breaks.

    domainSigningSelector String
    [Bring Your Own DKIM] A string that's used to identify a public key in the DNS configuration for a domain.
    lastKeyGenerationTimestamp String
    [Easy DKIM] The last time a key pair was generated for this identity.
    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. Valid values: RSA_1024_BIT, RSA_2048_BIT.
    signingAttributesOrigin String
    A string that indicates how DKIM was configured for the identity. AWS_SES indicates that DKIM was configured for the identity by using Easy DKIM. EXTERNAL indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).
    status String
    Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. See the AWS SES API v2 Reference for supported statuses.
    tokens List<String>
    If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key.

    Import

    Using pulumi import, import SESv2 (Simple Email V2) Email Identity using the email_identity. For example:

    $ pulumi import aws:sesv2/emailIdentity:EmailIdentity example example.com
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.31.0 published on Monday, Apr 15, 2024 by Pulumi