AWS Classic v5.34.0, Mar 30 23

aws.ses.DomainIdentity

Provides an SES domain identity resource

Example Usage

Basic Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Ses.DomainIdentity("example", new()
    {
        Domain = "example.com",
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/ses"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ses.NewDomainIdentity(ctx, "example", &ses.DomainIdentityArgs{
			Domain: pulumi.String("example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ses.DomainIdentity;
import com.pulumi.aws.ses.DomainIdentityArgs;
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 DomainIdentity("example", DomainIdentityArgs.builder()        
            .domain("example.com")
            .build());

    }
}

import pulumi
import pulumi_aws as aws

example = aws.ses.DomainIdentity("example", domain="example.com")

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ses.DomainIdentity("example", {domain: "example.com"});

resources:
  example:
    type: aws:ses:DomainIdentity
    properties:
      domain: example.com

With Route53 Record

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Ses.DomainIdentity("example", new()
    {
        Domain = "example.com",
    });

    var exampleAmazonsesVerificationRecord = new Aws.Route53.Record("exampleAmazonsesVerificationRecord", new()
    {
        ZoneId = "ABCDEFGHIJ123",
        Name = "_amazonses.example.com",
        Type = "TXT",
        Ttl = 600,
        Records = new[]
        {
            example.VerificationToken,
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/route53"
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/ses"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := ses.NewDomainIdentity(ctx, "example", &ses.DomainIdentityArgs{
			Domain: pulumi.String("example.com"),
		})
		if err != nil {
			return err
		}
		_, err = route53.NewRecord(ctx, "exampleAmazonsesVerificationRecord", &route53.RecordArgs{
			ZoneId: pulumi.String("ABCDEFGHIJ123"),
			Name:   pulumi.String("_amazonses.example.com"),
			Type:   pulumi.String("TXT"),
			Ttl:    pulumi.Int(600),
			Records: pulumi.StringArray{
				example.VerificationToken,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ses.DomainIdentity;
import com.pulumi.aws.ses.DomainIdentityArgs;
import com.pulumi.aws.route53.Record;
import com.pulumi.aws.route53.RecordArgs;
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 DomainIdentity("example", DomainIdentityArgs.builder()        
            .domain("example.com")
            .build());

        var exampleAmazonsesVerificationRecord = new Record("exampleAmazonsesVerificationRecord", RecordArgs.builder()        
            .zoneId("ABCDEFGHIJ123")
            .name("_amazonses.example.com")
            .type("TXT")
            .ttl("600")
            .records(example.verificationToken())
            .build());

    }
}

import pulumi
import pulumi_aws as aws

example = aws.ses.DomainIdentity("example", domain="example.com")
example_amazonses_verification_record = aws.route53.Record("exampleAmazonsesVerificationRecord",
    zone_id="ABCDEFGHIJ123",
    name="_amazonses.example.com",
    type="TXT",
    ttl=600,
    records=[example.verification_token])

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ses.DomainIdentity("example", {domain: "example.com"});
const exampleAmazonsesVerificationRecord = new aws.route53.Record("exampleAmazonsesVerificationRecord", {
    zoneId: "ABCDEFGHIJ123",
    name: "_amazonses.example.com",
    type: "TXT",
    ttl: 600,
    records: [example.verificationToken],
});

resources:
  example:
    type: aws:ses:DomainIdentity
    properties:
      domain: example.com
  exampleAmazonsesVerificationRecord:
    type: aws:route53:Record
    properties:
      zoneId: ABCDEFGHIJ123
      name: _amazonses.example.com
      type: TXT
      ttl: '600'
      records:
        - ${example.verificationToken}

Create DomainIdentity Resource

new DomainIdentity(name: string, args: DomainIdentityArgs, opts?: CustomResourceOptions);

@overload
def DomainIdentity(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   domain: Optional[str] = None)
@overload
def DomainIdentity(resource_name: str,
                   args: DomainIdentityArgs,
                   opts: Optional[ResourceOptions] = None)

func NewDomainIdentity(ctx *Context, name string, args DomainIdentityArgs, opts ...ResourceOption) (*DomainIdentity, error)

public DomainIdentity(string name, DomainIdentityArgs args, CustomResourceOptions? opts = null)

public DomainIdentity(String name, DomainIdentityArgs args)
public DomainIdentity(String name, DomainIdentityArgs args, CustomResourceOptions options)

type: aws:ses:DomainIdentity
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DomainIdentityArgs: 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 DomainIdentityArgs: 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 DomainIdentityArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DomainIdentityArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DomainIdentityArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

DomainIdentity 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 DomainIdentity resource accepts the following input properties:

Domain string: The domain name to assign to SES

Domain string: The domain name to assign to SES

domain String: The domain name to assign to SES

domain string: The domain name to assign to SES

domain str: The domain name to assign to SES

domain String: The domain name to assign to SES

Outputs

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

Arn string: The ARN of the domain identity.
Id string: The provider-assigned unique ID for this managed resource.
VerificationToken string: A code which when added to the domain as a TXT record will signal to SES that the owner of the domain has authorised SES to act on their behalf. The domain identity will be in state "verification pending" until this is done. See the With Route53 Record example for how this might be achieved when the domain is hosted in Route 53 and managed by this provider. Find out more about verifying domains in Amazon SES in the AWS SES docs.

Arn string: The ARN of the domain identity.
Id string: The provider-assigned unique ID for this managed resource.
VerificationToken string: A code which when added to the domain as a TXT record will signal to SES that the owner of the domain has authorised SES to act on their behalf. The domain identity will be in state "verification pending" until this is done. See the With Route53 Record example for how this might be achieved when the domain is hosted in Route 53 and managed by this provider. Find out more about verifying domains in Amazon SES in the AWS SES docs.

arn String: The ARN of the domain identity.
id String: The provider-assigned unique ID for this managed resource.
verificationToken String: A code which when added to the domain as a TXT record will signal to SES that the owner of the domain has authorised SES to act on their behalf. The domain identity will be in state "verification pending" until this is done. See the With Route53 Record example for how this might be achieved when the domain is hosted in Route 53 and managed by this provider. Find out more about verifying domains in Amazon SES in the AWS SES docs.

arn string: The ARN of the domain identity.
id string: The provider-assigned unique ID for this managed resource.
verificationToken string: A code which when added to the domain as a TXT record will signal to SES that the owner of the domain has authorised SES to act on their behalf. The domain identity will be in state "verification pending" until this is done. See the With Route53 Record example for how this might be achieved when the domain is hosted in Route 53 and managed by this provider. Find out more about verifying domains in Amazon SES in the AWS SES docs.

arn str: The ARN of the domain identity.
id str: The provider-assigned unique ID for this managed resource.
verification_token str: A code which when added to the domain as a TXT record will signal to SES that the owner of the domain has authorised SES to act on their behalf. The domain identity will be in state "verification pending" until this is done. See the With Route53 Record example for how this might be achieved when the domain is hosted in Route 53 and managed by this provider. Find out more about verifying domains in Amazon SES in the AWS SES docs.

arn String: The ARN of the domain identity.
id String: The provider-assigned unique ID for this managed resource.
verificationToken String: A code which when added to the domain as a TXT record will signal to SES that the owner of the domain has authorised SES to act on their behalf. The domain identity will be in state "verification pending" until this is done. See the With Route53 Record example for how this might be achieved when the domain is hosted in Route 53 and managed by this provider. Find out more about verifying domains in Amazon SES in the AWS SES docs.

Look up Existing DomainIdentity Resource

Get an existing DomainIdentity 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?: DomainIdentityState, opts?: CustomResourceOptions): DomainIdentity

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        domain: Optional[str] = None,
        verification_token: Optional[str] = None) -> DomainIdentity

func GetDomainIdentity(ctx *Context, name string, id IDInput, state *DomainIdentityState, opts ...ResourceOption) (*DomainIdentity, error)

public static DomainIdentity Get(string name, Input<string> id, DomainIdentityState? state, CustomResourceOptions? opts = null)

public static DomainIdentity get(String name, Output<String> id, DomainIdentityState 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 domain identity.
Domain string: The domain name to assign to SES
VerificationToken string: A code which when added to the domain as a TXT record will signal to SES that the owner of the domain has authorised SES to act on their behalf. The domain identity will be in state "verification pending" until this is done. See the With Route53 Record example for how this might be achieved when the domain is hosted in Route 53 and managed by this provider. Find out more about verifying domains in Amazon SES in the AWS SES docs.

Arn string: The ARN of the domain identity.
Domain string: The domain name to assign to SES
VerificationToken string: A code which when added to the domain as a TXT record will signal to SES that the owner of the domain has authorised SES to act on their behalf. The domain identity will be in state "verification pending" until this is done. See the With Route53 Record example for how this might be achieved when the domain is hosted in Route 53 and managed by this provider. Find out more about verifying domains in Amazon SES in the AWS SES docs.

arn String: The ARN of the domain identity.
domain String: The domain name to assign to SES
verificationToken String: A code which when added to the domain as a TXT record will signal to SES that the owner of the domain has authorised SES to act on their behalf. The domain identity will be in state "verification pending" until this is done. See the With Route53 Record example for how this might be achieved when the domain is hosted in Route 53 and managed by this provider. Find out more about verifying domains in Amazon SES in the AWS SES docs.

arn string: The ARN of the domain identity.
domain string: The domain name to assign to SES
verificationToken string: A code which when added to the domain as a TXT record will signal to SES that the owner of the domain has authorised SES to act on their behalf. The domain identity will be in state "verification pending" until this is done. See the With Route53 Record example for how this might be achieved when the domain is hosted in Route 53 and managed by this provider. Find out more about verifying domains in Amazon SES in the AWS SES docs.

arn str: The ARN of the domain identity.
domain str: The domain name to assign to SES
verification_token str: A code which when added to the domain as a TXT record will signal to SES that the owner of the domain has authorised SES to act on their behalf. The domain identity will be in state "verification pending" until this is done. See the With Route53 Record example for how this might be achieved when the domain is hosted in Route 53 and managed by this provider. Find out more about verifying domains in Amazon SES in the AWS SES docs.

arn String: The ARN of the domain identity.
domain String: The domain name to assign to SES
verificationToken String: A code which when added to the domain as a TXT record will signal to SES that the owner of the domain has authorised SES to act on their behalf. The domain identity will be in state "verification pending" until this is done. See the With Route53 Record example for how this might be achieved when the domain is hosted in Route 53 and managed by this provider. Find out more about verifying domains in Amazon SES in the AWS SES docs.

Import

SES domain identities can be imported using the domain name.

 $ pulumi import aws:ses/domainIdentity:DomainIdentity example example.com

Package Details

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