1. Packages
  2. AWS
  3. API Docs
  4. ses
  5. DomainDkim
AWS v6.64.0 published on Friday, Dec 6, 2024 by Pulumi

aws.ses.DomainDkim

Explore with Pulumi AI

aws logo
AWS v6.64.0 published on Friday, Dec 6, 2024 by Pulumi

    Provides an SES domain DKIM generation resource.

    Domain ownership needs to be confirmed first using ses_domain_identity Resource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.ses.DomainIdentity("example", {domain: "example.com"});
    const exampleDomainDkim = new aws.ses.DomainDkim("example", {domain: example.domain});
    const exampleAmazonsesDkimRecord: aws.route53.Record[] = [];
    for (const range = {value: 0}; range.value < 3; range.value++) {
        exampleAmazonsesDkimRecord.push(new aws.route53.Record(`example_amazonses_dkim_record-${range.value}`, {
            zoneId: "ABCDEFGHIJ123",
            name: exampleDomainDkim.dkimTokens.apply(dkimTokens => `${dkimTokens[range.value]}._domainkey`),
            type: aws.route53.RecordType.CNAME,
            ttl: 600,
            records: [exampleDomainDkim.dkimTokens.apply(dkimTokens => `${dkimTokens[range.value]}.dkim.amazonses.com`)],
        }));
    }
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.ses.DomainIdentity("example", domain="example.com")
    example_domain_dkim = aws.ses.DomainDkim("example", domain=example.domain)
    example_amazonses_dkim_record = []
    for range in [{"value": i} for i in range(0, 3)]:
        example_amazonses_dkim_record.append(aws.route53.Record(f"example_amazonses_dkim_record-{range['value']}",
            zone_id="ABCDEFGHIJ123",
            name=example_domain_dkim.dkim_tokens.apply(lambda dkim_tokens: f"{dkim_tokens[range['value']]}._domainkey"),
            type=aws.route53.RecordType.CNAME,
            ttl=600,
            records=[example_domain_dkim.dkim_tokens.apply(lambda dkim_tokens: f"{dkim_tokens[range['value']]}.dkim.amazonses.com")]))
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/route53"
    	"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 {
    		example, err := ses.NewDomainIdentity(ctx, "example", &ses.DomainIdentityArgs{
    			Domain: pulumi.String("example.com"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleDomainDkim, err := ses.NewDomainDkim(ctx, "example", &ses.DomainDkimArgs{
    			Domain: example.Domain,
    		})
    		if err != nil {
    			return err
    		}
    		var exampleAmazonsesDkimRecord []*route53.Record
    		for index := 0; index < 3; index++ {
    			key0 := index
    			val0 := index
    			__res, err := route53.NewRecord(ctx, fmt.Sprintf("example_amazonses_dkim_record-%v", key0), &route53.RecordArgs{
    				ZoneId: pulumi.String("ABCDEFGHIJ123"),
    				Name: exampleDomainDkim.DkimTokens.ApplyT(func(dkimTokens []string) (string, error) {
    					return fmt.Sprintf("%v._domainkey", dkimTokens[val0]), nil
    				}).(pulumi.StringOutput),
    				Type: pulumi.String(route53.RecordTypeCNAME),
    				Ttl:  pulumi.Int(600),
    				Records: pulumi.StringArray{
    					exampleDomainDkim.DkimTokens.ApplyT(func(dkimTokens []string) (string, error) {
    						return fmt.Sprintf("%v.dkim.amazonses.com", dkimTokens[val0]), nil
    					}).(pulumi.StringOutput),
    				},
    			})
    			if err != nil {
    				return err
    			}
    			exampleAmazonsesDkimRecord = append(exampleAmazonsesDkimRecord, __res)
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Ses.DomainIdentity("example", new()
        {
            Domain = "example.com",
        });
    
        var exampleDomainDkim = new Aws.Ses.DomainDkim("example", new()
        {
            Domain = example.Domain,
        });
    
        var exampleAmazonsesDkimRecord = new List<Aws.Route53.Record>();
        for (var rangeIndex = 0; rangeIndex < 3; rangeIndex++)
        {
            var range = new { Value = rangeIndex };
            exampleAmazonsesDkimRecord.Add(new Aws.Route53.Record($"example_amazonses_dkim_record-{range.Value}", new()
            {
                ZoneId = "ABCDEFGHIJ123",
                Name = exampleDomainDkim.DkimTokens.Apply(dkimTokens => $"{dkimTokens[range.Value]}._domainkey"),
                Type = Aws.Route53.RecordType.CNAME,
                Ttl = 600,
                Records = new[]
                {
                    exampleDomainDkim.DkimTokens.Apply(dkimTokens => $"{dkimTokens[range.Value]}.dkim.amazonses.com"),
                },
            }));
        }
    });
    
    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.ses.DomainDkim;
    import com.pulumi.aws.ses.DomainDkimArgs;
    import com.pulumi.aws.route53.Record;
    import com.pulumi.aws.route53.RecordArgs;
    import com.pulumi.codegen.internal.KeyedValue;
    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 exampleDomainDkim = new DomainDkim("exampleDomainDkim", DomainDkimArgs.builder()
                .domain(example.domain())
                .build());
    
            for (var i = 0; i < 3; i++) {
                new Record("exampleAmazonsesDkimRecord-" + i, RecordArgs.builder()
                    .zoneId("ABCDEFGHIJ123")
                    .name(exampleDomainDkim.dkimTokens().applyValue(dkimTokens -> String.format("%s._domainkey", dkimTokens[range.value()])))
                    .type("CNAME")
                    .ttl("600")
                    .records(exampleDomainDkim.dkimTokens().applyValue(dkimTokens -> String.format("%s.dkim.amazonses.com", dkimTokens[range.value()])))
                    .build());
    
            
    }
        }
    }
    
    Coming soon!
    

    Create DomainDkim Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DomainDkim(name: string, args: DomainDkimArgs, opts?: CustomResourceOptions);
    @overload
    def DomainDkim(resource_name: str,
                   args: DomainDkimArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def DomainDkim(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   domain: Optional[str] = None)
    func NewDomainDkim(ctx *Context, name string, args DomainDkimArgs, opts ...ResourceOption) (*DomainDkim, error)
    public DomainDkim(string name, DomainDkimArgs args, CustomResourceOptions? opts = null)
    public DomainDkim(String name, DomainDkimArgs args)
    public DomainDkim(String name, DomainDkimArgs args, CustomResourceOptions options)
    
    type: aws:ses:DomainDkim
    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 DomainDkimArgs
    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 DomainDkimArgs
    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 DomainDkimArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DomainDkimArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DomainDkimArgs
    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 domainDkimResource = new Aws.Ses.DomainDkim("domainDkimResource", new()
    {
        Domain = "string",
    });
    
    example, err := ses.NewDomainDkim(ctx, "domainDkimResource", &ses.DomainDkimArgs{
    	Domain: pulumi.String("string"),
    })
    
    var domainDkimResource = new DomainDkim("domainDkimResource", DomainDkimArgs.builder()
        .domain("string")
        .build());
    
    domain_dkim_resource = aws.ses.DomainDkim("domainDkimResource", domain="string")
    
    const domainDkimResource = new aws.ses.DomainDkim("domainDkimResource", {domain: "string"});
    
    type: aws:ses:DomainDkim
    properties:
        domain: string
    

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

    Domain string
    Verified domain name to generate DKIM tokens for.
    Domain string
    Verified domain name to generate DKIM tokens for.
    domain String
    Verified domain name to generate DKIM tokens for.
    domain string
    Verified domain name to generate DKIM tokens for.
    domain str
    Verified domain name to generate DKIM tokens for.
    domain String
    Verified domain name to generate DKIM tokens for.

    Outputs

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

    DkimTokens List<string>
    DKIM tokens generated by SES. These tokens should be used to create CNAME records used to verify SES Easy DKIM. See below for an example of 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    DkimTokens []string
    DKIM tokens generated by SES. These tokens should be used to create CNAME records used to verify SES Easy DKIM. See below for an example of 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    dkimTokens List<String>
    DKIM tokens generated by SES. These tokens should be used to create CNAME records used to verify SES Easy DKIM. See below for an example of 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.
    id String
    The provider-assigned unique ID for this managed resource.
    dkimTokens string[]
    DKIM tokens generated by SES. These tokens should be used to create CNAME records used to verify SES Easy DKIM. See below for an example of 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.
    id string
    The provider-assigned unique ID for this managed resource.
    dkim_tokens Sequence[str]
    DKIM tokens generated by SES. These tokens should be used to create CNAME records used to verify SES Easy DKIM. See below for an example of 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.
    id str
    The provider-assigned unique ID for this managed resource.
    dkimTokens List<String>
    DKIM tokens generated by SES. These tokens should be used to create CNAME records used to verify SES Easy DKIM. See below for an example of 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.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DomainDkim Resource

    Get an existing DomainDkim 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?: DomainDkimState, opts?: CustomResourceOptions): DomainDkim
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            dkim_tokens: Optional[Sequence[str]] = None,
            domain: Optional[str] = None) -> DomainDkim
    func GetDomainDkim(ctx *Context, name string, id IDInput, state *DomainDkimState, opts ...ResourceOption) (*DomainDkim, error)
    public static DomainDkim Get(string name, Input<string> id, DomainDkimState? state, CustomResourceOptions? opts = null)
    public static DomainDkim get(String name, Output<String> id, DomainDkimState 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:
    DkimTokens List<string>
    DKIM tokens generated by SES. These tokens should be used to create CNAME records used to verify SES Easy DKIM. See below for an example of 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.
    Domain string
    Verified domain name to generate DKIM tokens for.
    DkimTokens []string
    DKIM tokens generated by SES. These tokens should be used to create CNAME records used to verify SES Easy DKIM. See below for an example of 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.
    Domain string
    Verified domain name to generate DKIM tokens for.
    dkimTokens List<String>
    DKIM tokens generated by SES. These tokens should be used to create CNAME records used to verify SES Easy DKIM. See below for an example of 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.
    domain String
    Verified domain name to generate DKIM tokens for.
    dkimTokens string[]
    DKIM tokens generated by SES. These tokens should be used to create CNAME records used to verify SES Easy DKIM. See below for an example of 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.
    domain string
    Verified domain name to generate DKIM tokens for.
    dkim_tokens Sequence[str]
    DKIM tokens generated by SES. These tokens should be used to create CNAME records used to verify SES Easy DKIM. See below for an example of 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.
    domain str
    Verified domain name to generate DKIM tokens for.
    dkimTokens List<String>
    DKIM tokens generated by SES. These tokens should be used to create CNAME records used to verify SES Easy DKIM. See below for an example of 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.
    domain String
    Verified domain name to generate DKIM tokens for.

    Import

    Using pulumi import, import DKIM tokens using the domain attribute. For example:

    $ pulumi import aws:ses/domainDkim:DomainDkim 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
    AWS v6.64.0 published on Friday, Dec 6, 2024 by Pulumi