EmailIdentity class
Resource for managing an AWS SESv2 (Simple Email V2) Email Identity.
Example Usage
Basic Usage
Email Address Identity
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.sesv2.EmailIdentity("example", {emailIdentity: "testing@example.com"});
import pulumi
import pulumi_aws as aws
example = aws.sesv2.EmailIdentity("example", email_identity="testing@example.com")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.SesV2.EmailIdentity("example", new()
{
EmailIdentityDetails = "testing@example.com",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/sesv2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := sesv2.NewEmailIdentity(ctx, "example", &sesv2.EmailIdentityArgs{
EmailIdentity: pulumi.String("testing@example.com"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_sesv2_emailidentity" "example" {
email_identity = "testing@example.com"
}
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());
}
}
resources:
example:
type: aws:sesv2:EmailIdentity
properties:
emailIdentity: testing@example.com
Domain Identity
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.sesv2.EmailIdentity("example", {emailIdentity: "example.com"});
import pulumi
import pulumi_aws as aws
example = aws.sesv2.EmailIdentity("example", email_identity="example.com")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.SesV2.EmailIdentity("example", new()
{
EmailIdentityDetails = "example.com",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/sesv2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := sesv2.NewEmailIdentity(ctx, "example", &sesv2.EmailIdentityArgs{
EmailIdentity: pulumi.String("example.com"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_sesv2_emailidentity" "example" {
email_identity = "example.com"
}
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());
}
}
resources:
example:
type: aws:sesv2:EmailIdentity
properties:
emailIdentity: example.com
Configuration Set
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.sesv2.ConfigurationSet("example", {configurationSetName: "example"});
const exampleEmailIdentity = new aws.sesv2.EmailIdentity("example", {
emailIdentity: "example.com",
configurationSetName: example.configurationSetName,
});
import pulumi
import pulumi_aws as aws
example = aws.sesv2.ConfigurationSet("example", configuration_set_name="example")
example_email_identity = aws.sesv2.EmailIdentity("example",
email_identity="example.com",
configuration_set_name=example.configuration_set_name)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.SesV2.ConfigurationSet("example", new()
{
ConfigurationSetName = "example",
});
var exampleEmailIdentity = new Aws.SesV2.EmailIdentity("example", new()
{
EmailIdentityDetails = "example.com",
ConfigurationSetName = example.ConfigurationSetName,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/sesv2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := sesv2.NewConfigurationSet(ctx, "example", &sesv2.ConfigurationSetArgs{
ConfigurationSetName: pulumi.String("example"),
})
if err != nil {
return err
}
_, err = sesv2.NewEmailIdentity(ctx, "example", &sesv2.EmailIdentityArgs{
EmailIdentity: pulumi.String("example.com"),
ConfigurationSetName: example.ConfigurationSetName,
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_sesv2_configurationset" "example" {
configuration_set_name = "example"
}
resource "aws_sesv2_emailidentity" "example" {
email_identity = "example.com"
configuration_set_name = aws_sesv2_configurationset.example.configuration_set_name
}
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());
}
}
resources:
example:
type: aws:sesv2:ConfigurationSet
properties:
configurationSetName: example
exampleEmailIdentity:
type: aws:sesv2:EmailIdentity
name: example
properties:
emailIdentity: example.com
configurationSetName: ${example.configurationSetName}
DKIM Signing Attributes (BYODKIM)
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.sesv2.EmailIdentity("example", {
dkimSigningAttributes: {
domainSigningPrivateKey: "MIIJKAIBAAKCAgEA2Se7p8zvnI4yh+Gh9j2rG5e2aRXjg03Y8saiupLnadPH9xvM...",
domainSigningSelector: "example",
},
emailIdentity: "example.com",
});
import pulumi
import pulumi_aws as aws
example = aws.sesv2.EmailIdentity("example",
dkim_signing_attributes={
"domain_signing_private_key": "MIIJKAIBAAKCAgEA2Se7p8zvnI4yh+Gh9j2rG5e2aRXjg03Y8saiupLnadPH9xvM...",
"domain_signing_selector": "example",
},
email_identity="example.com")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.SesV2.EmailIdentity("example", new()
{
DkimSigningAttributes = new Aws.SesV2.Inputs.EmailIdentityDkimSigningAttributesArgs
{
DomainSigningPrivateKey = "MIIJKAIBAAKCAgEA2Se7p8zvnI4yh+Gh9j2rG5e2aRXjg03Y8saiupLnadPH9xvM...",
DomainSigningSelector = "example",
},
EmailIdentityDetails = "example.com",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/sesv2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := sesv2.NewEmailIdentity(ctx, "example", &sesv2.EmailIdentityArgs{
DkimSigningAttributes: &sesv2.EmailIdentityDkimSigningAttributesArgs{
DomainSigningPrivateKey: pulumi.String("MIIJKAIBAAKCAgEA2Se7p8zvnI4yh+Gh9j2rG5e2aRXjg03Y8saiupLnadPH9xvM..."),
DomainSigningSelector: pulumi.String("example"),
},
EmailIdentity: pulumi.String("example.com"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_sesv2_emailidentity" "example" {
dkim_signing_attributes = {
domain_signing_private_key = "MIIJKAIBAAKCAgEA2Se7p8zvnI4yh+Gh9j2rG5e2aRXjg03Y8saiupLnadPH9xvM..."
domain_signing_selector = "example"
}
#PEM private key without headers or newline characters
email_identity = "example.com"
}
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());
}
}
resources:
example:
type: aws:sesv2:EmailIdentity
properties:
dkimSigningAttributes:
domainSigningPrivateKey: MIIJKAIBAAKCAgEA2Se7p8zvnI4yh+Gh9j2rG5e2aRXjg03Y8saiupLnadPH9xvM...
domainSigningSelector: example
emailIdentity: example.com
Import
Using pulumi import, import SESv2 (Simple Email V2) Email Identity using the emailIdentity. For example:
$ pulumi import aws:sesv2/emailIdentity:EmailIdentity example example.com
Constructors
- EmailIdentity(String name, {EmailIdentityArgs? args, CustomResourceOptions? options})
-
Creates a new EmailIdentity.
nameThe Pulumi resource name.argsArguments used to configure this EmailIdentity. The set of arguments for EmailIdentity.optionsResource options controlling this resource's behavior. - EmailIdentity.reference(String urn)
- Creates a typed reference to an existing EmailIdentity resource.
Properties
-
arn
↔ Output<
String> -
ARN of the Email Identity.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
configurationSetName
↔ Output<
String?> -
Configuration set to use by default when sending from this identity. Any configuration set defined in the email sending request takes precedence.
latefinal
-
dkimSigningAttributes
↔ Output<
EmailIdentityDkimSigningAttributes> -
Configuration block for the DKIM authentication settings for an email domain identity. See
dkimSigningAttributesBlock below.latefinal -
emailIdentity
↔ Output<
String> -
Email address or domain to verify.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
identityType
↔ Output<
String> -
Email identity type. Valid values:
EMAIL_ADDRESS,DOMAIN.latefinal - 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
-
Key-value mapping of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
verificationStatus
↔ Output<
String> -
Verification status of the identity. One of
PENDING,SUCCESS,FAILED,TEMPORARY_FAILURE, andNOT_STARTED.latefinal -
verifiedForSendingStatus
↔ Output<
bool> -
Whether the identity is verified.
latefinal
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, {EmailIdentityState? state, CustomResourceOptions? options}) → EmailIdentity -
Gets an existing EmailIdentity resource's state with the given
nameandid.