1. Packages
  2. AWS
  3. API Docs
  4. ses
  5. EmailIdentity
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.ses.EmailIdentity

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Provides an SES email identity resource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.ses.EmailIdentity("example", {email: "email@example.com"});
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.ses.EmailIdentity("example", email="email@example.com")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ses"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ses.NewEmailIdentity(ctx, "example", &ses.EmailIdentityArgs{
    			Email: pulumi.String("email@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.Ses.EmailIdentity("example", new()
        {
            Email = "email@example.com",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.ses.EmailIdentity;
    import com.pulumi.aws.ses.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()
                .email("email@example.com")
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:ses:EmailIdentity
        properties:
          email: email@example.com
    

    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: Optional[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: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.

    Constructor example

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

    var emailIdentityResource = new Aws.Ses.EmailIdentity("emailIdentityResource", new()
    {
        Email = "string",
    });
    
    example, err := ses.NewEmailIdentity(ctx, "emailIdentityResource", &ses.EmailIdentityArgs{
    	Email: pulumi.String("string"),
    })
    
    var emailIdentityResource = new EmailIdentity("emailIdentityResource", EmailIdentityArgs.builder()
        .email("string")
        .build());
    
    email_identity_resource = aws.ses.EmailIdentity("emailIdentityResource", email="string")
    
    const emailIdentityResource = new aws.ses.EmailIdentity("emailIdentityResource", {email: "string"});
    
    type: aws:ses:EmailIdentity
    properties:
        email: 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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The EmailIdentity resource accepts the following input properties:

    Email string
    The email address to assign to SES.
    Email string
    The email address to assign to SES.
    email String
    The email address to assign to SES.
    email string
    The email address to assign to SES.
    email str
    The email address to assign to SES.
    email String
    The email address to assign to SES.

    Outputs

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

    Arn string
    The ARN of the email identity.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The ARN of the email identity.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The ARN of the email identity.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The ARN of the email identity.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The ARN of the email identity.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The ARN of the email identity.
    id String
    The provider-assigned unique ID for this managed resource.

    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,
            email: Optional[str] = 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
    The ARN of the email identity.
    Email string
    The email address to assign to SES.
    Arn string
    The ARN of the email identity.
    Email string
    The email address to assign to SES.
    arn String
    The ARN of the email identity.
    email String
    The email address to assign to SES.
    arn string
    The ARN of the email identity.
    email string
    The email address to assign to SES.
    arn str
    The ARN of the email identity.
    email str
    The email address to assign to SES.
    arn String
    The ARN of the email identity.
    email String
    The email address to assign to SES.

    Import

    Using pulumi import, import SES email identities using the email address. For example:

    $ pulumi import aws:ses/emailIdentity:EmailIdentity example email@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
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi