Class EmailIdentity


  • public class EmailIdentity
    extends com.pulumi.resources.CustomResource
    Resource for managing an AWS SESv2 (Simple Email V2) Email Identity. ## Example Usage ### Basic Usage ### Email Address Identity
     
     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.ArrayList;
     import java.util.Arrays;
     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());
     
         }
     }
     
     
    ### Domain Identity
     
     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.ArrayList;
     import java.util.Arrays;
     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());
     
         }
     }
     
     
    ### Configuration Set
     
     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.ArrayList;
     import java.util.Arrays;
     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());
     
         }
     }
     
     
    ### DKIM Signing Attributes (BYODKIM)
     
     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.ArrayList;
     import java.util.Arrays;
     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()
                 .dkimSigningAttributes(EmailIdentityDkimSigningAttributesArgs.builder()
                     .domainSigningPrivateKey("MIIJKAIBAAKCAgEA2Se7p8zvnI4yh+Gh9j2rG5e2aRXjg03Y8saiupLnadPH9xvM...")
                     .domainSigningSelector("example")
                     .build())
                 .emailIdentity("example.com")
                 .build());
     
         }
     }
     
     
    ## Import Using `pulumi import`, import SESv2 (Simple Email V2) Email Identity using the `emailIdentity`. For example: ```sh $ pulumi import aws:sesv2/emailIdentity:EmailIdentity example example.com ```
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> configurationSetName()  
      com.pulumi.core.Output<EmailIdentityDkimSigningAttributes> dkimSigningAttributes()  
      com.pulumi.core.Output<java.lang.String> emailIdentity()  
      static EmailIdentity get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, EmailIdentityState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> identityType()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.String> verificationStatus()  
      com.pulumi.core.Output<java.lang.Boolean> verifiedForSendingStatus()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • EmailIdentity

        public EmailIdentity​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • EmailIdentity

        public EmailIdentity​(java.lang.String name,
                             EmailIdentityArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • EmailIdentity

        public EmailIdentity​(java.lang.String name,
                             EmailIdentityArgs args,
                             @Nullable
                             com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the Email Identity.
      • configurationSetName

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> configurationSetName()
        Returns:
        Configuration set to use by default when sending from this identity. Any configuration set defined in the email sending request takes precedence.
      • dkimSigningAttributes

        public com.pulumi.core.Output<EmailIdentityDkimSigningAttributes> dkimSigningAttributes()
        Returns:
        Configuration block for the DKIM authentication settings for an email domain identity. See `dkimSigningAttributes` Block below.
      • emailIdentity

        public com.pulumi.core.Output<java.lang.String> emailIdentity()
        Returns:
        Email address or domain to verify. The following arguments are optional:
      • identityType

        public com.pulumi.core.Output<java.lang.String> identityType()
        Returns:
        Email identity type. Valid values: `EMAIL_ADDRESS`, `DOMAIN`.
      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
      • verificationStatus

        public com.pulumi.core.Output<java.lang.String> verificationStatus()
        Returns:
        Verification status of the identity. One of `PENDING`, `SUCCESS`, `FAILED`, `TEMPORARY_FAILURE`, and `NOT_STARTED`.
      • verifiedForSendingStatus

        public com.pulumi.core.Output<java.lang.Boolean> verifiedForSendingStatus()
        Returns:
        Whether the identity is verified.
      • get

        public static EmailIdentity get​(java.lang.String name,
                                        com.pulumi.core.Output<java.lang.String> id,
                                        @Nullable
                                        EmailIdentityState state,
                                        @Nullable
                                        com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.