DomainIdentityVerification class
Represents a successful verification of an SES domain identity.
Most commonly, this resource is used together with aws.route53.Record and
aws.ses.DomainIdentity to request an SES domain identity,
deploy the required DNS verification records, and wait for verification to complete.
> WARNING: This resource implements a part of the verification workflow. It does not represent a real-world entity in AWS, therefore changing or deleting this resource on its own has no immediate effect.
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 exampleAmazonsesVerificationRecord = new aws.route53.Record("example_amazonses_verification_record", {
zoneId: exampleAwsRoute53Zone.zoneId,
name: pulumi.interpolate`_amazonses.${example.domain}`,
type: aws.route53.RecordType.TXT,
ttl: 600,
records: [example.verificationToken],
});
const exampleVerification = new aws.ses.DomainIdentityVerification("example_verification", {domain: example.domain}, {
dependsOn: [exampleAmazonsesVerificationRecord],
});
import pulumi
import pulumi_aws as aws
example = aws.ses.DomainIdentity("example", domain="example.com")
example_amazonses_verification_record = aws.route53.Record("example_amazonses_verification_record",
zone_id=example_aws_route53_zone["zoneId"],
name=example.domain.apply(lambda domain: f"_amazonses.{domain}"),
type=aws.route53.RecordType.TXT,
ttl=600,
records=[example.verification_token])
example_verification = aws.ses.DomainIdentityVerification("example_verification", domain=example.domain,
opts = pulumi.ResourceOptions(depends_on=[example_amazonses_verification_record]))
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 exampleAmazonsesVerificationRecord = new Aws.Route53.Record("example_amazonses_verification_record", new()
{
ZoneId = exampleAwsRoute53Zone.ZoneId,
Name = example.Domain.Apply(domain => $"_amazonses.{domain}"),
Type = Aws.Route53.RecordType.TXT,
Ttl = 600,
Records = new[]
{
example.VerificationToken,
},
});
var exampleVerification = new Aws.Ses.DomainIdentityVerification("example_verification", new()
{
Domain = example.Domain,
}, new CustomResourceOptions
{
DependsOn =
{
exampleAmazonsesVerificationRecord,
},
});
});
package main
import (
"fmt"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/route53"
"github.com/pulumi/pulumi-aws/sdk/v7/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
}
exampleAmazonsesVerificationRecord, err := route53.NewRecord(ctx, "example_amazonses_verification_record", &route53.RecordArgs{
ZoneId: pulumi.Any(exampleAwsRoute53Zone.ZoneId),
Name: example.Domain.ApplyT(func(domain string) (string, error) {
return fmt.Sprintf("_amazonses.%v", domain), nil
}).(pulumi.StringOutput),
Type: pulumi.String(route53.RecordTypeTXT),
Ttl: pulumi.Int(600),
Records: pulumi.StringArray{
example.VerificationToken,
},
})
if err != nil {
return err
}
_, err = ses.NewDomainIdentityVerification(ctx, "example_verification", &ses.DomainIdentityVerificationArgs{
Domain: example.Domain,
}, pulumi.DependsOn([]pulumi.Resource{
exampleAmazonsesVerificationRecord,
}))
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_ses_domainidentity" "example" {
domain = "example.com"
}
resource "aws_route53_record" "example_amazonses_verification_record" {
zone_id = exampleAwsRoute53Zone.zoneId
name ="_amazonses.${aws_ses_domainidentity.example.domain}"
type = "TXT"
ttl = "600"
records = [aws_ses_domainidentity.example.verification_token]
}
resource "aws_ses_domainidentityverification" "example_verification" {
depends_on = [aws_route53_record.example_amazonses_verification_record]
domain = aws_ses_domainidentity.example.domain
}
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 com.pulumi.aws.ses.DomainIdentityVerification;
import com.pulumi.aws.ses.DomainIdentityVerificationArgs;
import com.pulumi.resources.CustomResourceOptions;
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 DomainIdentity("example", DomainIdentityArgs.builder()
.domain("example.com")
.build());
var exampleAmazonsesVerificationRecord = new Record("exampleAmazonsesVerificationRecord", RecordArgs.builder()
.zoneId(exampleAwsRoute53Zone.zoneId())
.name(example.domain().applyValue(_domain -> String.format("_amazonses.%s", _domain)))
.type("TXT")
.ttl(600)
.records(example.verificationToken())
.build());
var exampleVerification = new DomainIdentityVerification("exampleVerification", DomainIdentityVerificationArgs.builder()
.domain(example.domain())
.build(), CustomResourceOptions.builder()
.dependsOn(exampleAmazonsesVerificationRecord)
.build());
}
}
resources:
example:
type: aws:ses:DomainIdentity
properties:
domain: example.com
exampleAmazonsesVerificationRecord:
type: aws:route53:Record
name: example_amazonses_verification_record
properties:
zoneId: ${exampleAwsRoute53Zone.zoneId}
name: _amazonses.${example.domain}
type: TXT
ttl: '600'
records:
- ${example.verificationToken}
exampleVerification:
type: aws:ses:DomainIdentityVerification
name: example_verification
properties:
domain: ${example.domain}
options:
dependsOn:
- ${exampleAmazonsesVerificationRecord}
Constructors
- DomainIdentityVerification(String name, {DomainIdentityVerificationArgs? args, CustomResourceOptions? options})
-
Creates a new DomainIdentityVerification.
nameThe Pulumi resource name.argsArguments used to configure this DomainIdentityVerification. The set of arguments for DomainIdentityVerification.optionsResource options controlling this resource's behavior. - DomainIdentityVerification.reference(String urn)
- Creates a typed reference to an existing DomainIdentityVerification resource.
Properties
-
arn
↔ Output<
String> -
ARN of the domain identity.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
domain
↔ Output<
String> -
Domain name of the SES domain identity to verify.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {DomainIdentityVerificationState? state, CustomResourceOptions? options}) → DomainIdentityVerification -
Gets an existing DomainIdentityVerification resource's state with the given
nameandid.