1. Packages
  2. Packages
  3. AWS
  4. API Docs
  5. pinpoint
  6. EmailChannel
Viewing docs for AWS v7.32.0
published on Friday, May 29, 2026 by Pulumi
aws logo
Viewing docs for AWS v7.32.0
published on Friday, May 29, 2026 by Pulumi

    NOTE: This resource is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES using aws.ses.DomainIdentity, aws.sesv2.EmailIdentity, and related SES/SESv2 resources. See the AWS End User Messaging migration guide for details.

    Provides an End User Messaging Email Channel resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const app = new aws.pinpoint.App("app", {});
    const assumeRole = aws.iam.getPolicyDocument({
        statements: [{
            effect: "Allow",
            principals: [{
                type: "Service",
                identifiers: ["pinpoint.amazonaws.com"],
            }],
            actions: ["sts:AssumeRole"],
        }],
    });
    const role = new aws.iam.Role("role", {assumeRolePolicy: assumeRole.then(assumeRole => assumeRole.json)});
    const email = new aws.pinpoint.EmailChannel("email", {
        applicationId: app.applicationId,
        fromAddress: "user@example.com",
        roleArn: role.arn,
    });
    const identity = new aws.ses.DomainIdentity("identity", {domain: "example.com"});
    const rolePolicy = aws.iam.getPolicyDocument({
        statements: [{
            effect: "Allow",
            actions: [
                "mobileanalytics:PutEvents",
                "mobileanalytics:PutItems",
            ],
            resources: ["*"],
        }],
    });
    const rolePolicyRolePolicy = new aws.iam.RolePolicy("role_policy", {
        name: "role_policy",
        role: role.id,
        policy: rolePolicy.then(rolePolicy => rolePolicy.json),
    });
    
    import pulumi
    import pulumi_aws as aws
    
    app = aws.pinpoint.App("app")
    assume_role = aws.iam.get_policy_document(statements=[{
        "effect": "Allow",
        "principals": [{
            "type": "Service",
            "identifiers": ["pinpoint.amazonaws.com"],
        }],
        "actions": ["sts:AssumeRole"],
    }])
    role = aws.iam.Role("role", assume_role_policy=assume_role.json)
    email = aws.pinpoint.EmailChannel("email",
        application_id=app.application_id,
        from_address="user@example.com",
        role_arn=role.arn)
    identity = aws.ses.DomainIdentity("identity", domain="example.com")
    role_policy = aws.iam.get_policy_document(statements=[{
        "effect": "Allow",
        "actions": [
            "mobileanalytics:PutEvents",
            "mobileanalytics:PutItems",
        ],
        "resources": ["*"],
    }])
    role_policy_role_policy = aws.iam.RolePolicy("role_policy",
        name="role_policy",
        role=role.id,
        policy=role_policy.json)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/iam"
    	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/pinpoint"
    	"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 {
    		app, err := pinpoint.NewApp(ctx, "app", nil)
    		if err != nil {
    			return err
    		}
    		assumeRole, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
    			Statements: []iam.GetPolicyDocumentStatement{
    				{
    					Effect: pulumi.StringRef("Allow"),
    					Principals: []iam.GetPolicyDocumentStatementPrincipal{
    						{
    							Type: "Service",
    							Identifiers: []string{
    								"pinpoint.amazonaws.com",
    							},
    						},
    					},
    					Actions: []string{
    						"sts:AssumeRole",
    					},
    				},
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		role, err := iam.NewRole(ctx, "role", &iam.RoleArgs{
    			AssumeRolePolicy: pulumi.String(pulumi.String(assumeRole.Json)),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = pinpoint.NewEmailChannel(ctx, "email", &pinpoint.EmailChannelArgs{
    			ApplicationId: app.ApplicationId,
    			FromAddress:   pulumi.String("user@example.com"),
    			RoleArn:       role.Arn,
    		})
    		if err != nil {
    			return err
    		}
    		_, err = ses.NewDomainIdentity(ctx, "identity", &ses.DomainIdentityArgs{
    			Domain: pulumi.String("example.com"),
    		})
    		if err != nil {
    			return err
    		}
    		rolePolicy, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
    			Statements: []iam.GetPolicyDocumentStatement{
    				{
    					Effect: pulumi.StringRef("Allow"),
    					Actions: []string{
    						"mobileanalytics:PutEvents",
    						"mobileanalytics:PutItems",
    					},
    					Resources: []string{
    						"*",
    					},
    				},
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = iam.NewRolePolicy(ctx, "role_policy", &iam.RolePolicyArgs{
    			Name:   pulumi.String("role_policy"),
    			Role:   role.ID(),
    			Policy: pulumi.String(pulumi.String(rolePolicy.Json)),
    		})
    		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 app = new Aws.Pinpoint.App("app");
    
        var assumeRole = Aws.Iam.GetPolicyDocument.Invoke(new()
        {
            Statements = new[]
            {
                new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
                {
                    Effect = "Allow",
                    Principals = new[]
                    {
                        new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalInputArgs
                        {
                            Type = "Service",
                            Identifiers = new[]
                            {
                                "pinpoint.amazonaws.com",
                            },
                        },
                    },
                    Actions = new[]
                    {
                        "sts:AssumeRole",
                    },
                },
            },
        });
    
        var role = new Aws.Iam.Role("role", new()
        {
            AssumeRolePolicy = assumeRole.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json),
        });
    
        var email = new Aws.Pinpoint.EmailChannel("email", new()
        {
            ApplicationId = app.ApplicationId,
            FromAddress = "user@example.com",
            RoleArn = role.Arn,
        });
    
        var identity = new Aws.Ses.DomainIdentity("identity", new()
        {
            Domain = "example.com",
        });
    
        var rolePolicy = Aws.Iam.GetPolicyDocument.Invoke(new()
        {
            Statements = new[]
            {
                new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
                {
                    Effect = "Allow",
                    Actions = new[]
                    {
                        "mobileanalytics:PutEvents",
                        "mobileanalytics:PutItems",
                    },
                    Resources = new[]
                    {
                        "*",
                    },
                },
            },
        });
    
        var rolePolicyRolePolicy = new Aws.Iam.RolePolicy("role_policy", new()
        {
            Name = "role_policy",
            Role = role.Id,
            Policy = rolePolicy.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json),
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.pinpoint.App;
    import com.pulumi.aws.iam.IamFunctions;
    import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
    import com.pulumi.aws.iam.Role;
    import com.pulumi.aws.iam.RoleArgs;
    import com.pulumi.aws.pinpoint.EmailChannel;
    import com.pulumi.aws.pinpoint.EmailChannelArgs;
    import com.pulumi.aws.ses.DomainIdentity;
    import com.pulumi.aws.ses.DomainIdentityArgs;
    import com.pulumi.aws.iam.RolePolicy;
    import com.pulumi.aws.iam.RolePolicyArgs;
    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 app = new App("app");
    
            final var assumeRole = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
                .statements(GetPolicyDocumentStatementArgs.builder()
                    .effect("Allow")
                    .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                        .type("Service")
                        .identifiers("pinpoint.amazonaws.com")
                        .build())
                    .actions("sts:AssumeRole")
                    .build())
                .build());
    
            var role = new Role("role", RoleArgs.builder()
                .assumeRolePolicy(assumeRole.json())
                .build());
    
            var email = new EmailChannel("email", EmailChannelArgs.builder()
                .applicationId(app.applicationId())
                .fromAddress("user@example.com")
                .roleArn(role.arn())
                .build());
    
            var identity = new DomainIdentity("identity", DomainIdentityArgs.builder()
                .domain("example.com")
                .build());
    
            final var rolePolicy = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
                .statements(GetPolicyDocumentStatementArgs.builder()
                    .effect("Allow")
                    .actions(                
                        "mobileanalytics:PutEvents",
                        "mobileanalytics:PutItems")
                    .resources("*")
                    .build())
                .build());
    
            var rolePolicyRolePolicy = new RolePolicy("rolePolicyRolePolicy", RolePolicyArgs.builder()
                .name("role_policy")
                .role(role.id())
                .policy(rolePolicy.json())
                .build());
    
        }
    }
    
    resources:
      email:
        type: aws:pinpoint:EmailChannel
        properties:
          applicationId: ${app.applicationId}
          fromAddress: user@example.com
          roleArn: ${role.arn}
      app:
        type: aws:pinpoint:App
      identity:
        type: aws:ses:DomainIdentity
        properties:
          domain: example.com
      role:
        type: aws:iam:Role
        properties:
          assumeRolePolicy: ${assumeRole.json}
      rolePolicyRolePolicy:
        type: aws:iam:RolePolicy
        name: role_policy
        properties:
          name: role_policy
          role: ${role.id}
          policy: ${rolePolicy.json}
    variables:
      assumeRole:
        fn::invoke:
          function: aws:iam:getPolicyDocument
          arguments:
            statements:
              - effect: Allow
                principals:
                  - type: Service
                    identifiers:
                      - pinpoint.amazonaws.com
                actions:
                  - sts:AssumeRole
      rolePolicy:
        fn::invoke:
          function: aws:iam:getPolicyDocument
          arguments:
            statements:
              - effect: Allow
                actions:
                  - mobileanalytics:PutEvents
                  - mobileanalytics:PutItems
                resources:
                  - '*'
    
    pulumi {
      required_providers {
        aws = {
          source = "pulumi/aws"
        }
      }
    }
    
    data "aws_iam_getpolicydocument" "assumeRole" {
      statements {
        effect = "Allow"
        principals {
          type        = "Service"
          identifiers = ["pinpoint.amazonaws.com"]
        }
        actions = ["sts:AssumeRole"]
      }
    }
    data "aws_iam_getpolicydocument" "rolePolicy" {
      statements {
        effect    = "Allow"
        actions   = ["mobileanalytics:PutEvents", "mobileanalytics:PutItems"]
        resources = ["*"]
      }
    }
    
    resource "aws_pinpoint_emailchannel" "email" {
      application_id = aws_pinpoint_app.app.application_id
      from_address   = "user@example.com"
      role_arn       = aws_iam_role.role.arn
    }
    resource "aws_pinpoint_app" "app" {
    }
    resource "aws_ses_domainidentity" "identity" {
      domain = "example.com"
    }
    resource "aws_iam_role" "role" {
      assume_role_policy = data.aws_iam_getpolicydocument.assumeRole.json
    }
    resource "aws_iam_rolepolicy" "role_policy" {
      name   = "role_policy"
      role   = aws_iam_role.role.id
      policy = data.aws_iam_getpolicydocument.rolePolicy.json
    }
    

    Create EmailChannel Resource

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

    Constructor syntax

    new EmailChannel(name: string, args: EmailChannelArgs, opts?: CustomResourceOptions);
    @overload
    def EmailChannel(resource_name: str,
                     args: EmailChannelArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def EmailChannel(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     application_id: Optional[str] = None,
                     from_address: Optional[str] = None,
                     identity: Optional[str] = None,
                     configuration_set: Optional[str] = None,
                     enabled: Optional[bool] = None,
                     orchestration_sending_role_arn: Optional[str] = None,
                     region: Optional[str] = None,
                     role_arn: Optional[str] = None)
    func NewEmailChannel(ctx *Context, name string, args EmailChannelArgs, opts ...ResourceOption) (*EmailChannel, error)
    public EmailChannel(string name, EmailChannelArgs args, CustomResourceOptions? opts = null)
    public EmailChannel(String name, EmailChannelArgs args)
    public EmailChannel(String name, EmailChannelArgs args, CustomResourceOptions options)
    
    type: aws:pinpoint:EmailChannel
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws_pinpoint_emailchannel" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args EmailChannelArgs
    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 EmailChannelArgs
    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 EmailChannelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EmailChannelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EmailChannelArgs
    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 emailChannelResource = new Aws.Pinpoint.EmailChannel("emailChannelResource", new()
    {
        Region = "string",
    });
    
    example, err := pinpoint.NewEmailChannel(ctx, "emailChannelResource", &pinpoint.EmailChannelArgs{
    	Region: pulumi.String("string"),
    })
    
    resource "aws_pinpoint_emailchannel" "emailChannelResource" {
      region = "string"
    }
    
    var emailChannelResource = new EmailChannel("emailChannelResource", EmailChannelArgs.builder()
        .region("string")
        .build());
    
    email_channel_resource = aws.pinpoint.EmailChannel("emailChannelResource", region="string")
    
    const emailChannelResource = new aws.pinpoint.EmailChannel("emailChannelResource", {region: "string"});
    
    type: aws:pinpoint:EmailChannel
    properties:
        region: string
    

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

    ApplicationId string
    Application ID.

    Deprecated: application_id is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    FromAddress string
    Email address used to send emails from. You can use email only (user@example.com) or friendly address (User <user@example.com>). This field comply with RFC 5322.

    Deprecated: from_address is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    Identity string
    ARN of an identity verified with SES.

    Deprecated: identity is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    ConfigurationSet string
    ARN of the Amazon SES configuration set that you want to apply to messages that you send through the channel.

    Deprecated: configuration_set is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    Enabled bool
    Whether the channel is enabled or disabled. Defaults to true.

    Deprecated: enabled is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    OrchestrationSendingRoleArn string
    ARN of an IAM role for AWS End User Messaging to use to send email from your campaigns or journeys through Amazon SES.

    Deprecated: orchestration_sending_role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    RoleArn string
    ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service.

    Deprecated: role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    ApplicationId string
    Application ID.

    Deprecated: application_id is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    FromAddress string
    Email address used to send emails from. You can use email only (user@example.com) or friendly address (User <user@example.com>). This field comply with RFC 5322.

    Deprecated: from_address is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    Identity string
    ARN of an identity verified with SES.

    Deprecated: identity is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    ConfigurationSet string
    ARN of the Amazon SES configuration set that you want to apply to messages that you send through the channel.

    Deprecated: configuration_set is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    Enabled bool
    Whether the channel is enabled or disabled. Defaults to true.

    Deprecated: enabled is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    OrchestrationSendingRoleArn string
    ARN of an IAM role for AWS End User Messaging to use to send email from your campaigns or journeys through Amazon SES.

    Deprecated: orchestration_sending_role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    RoleArn string
    ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service.

    Deprecated: role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    application_id string
    Application ID.

    Deprecated: application_id is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    from_address string
    Email address used to send emails from. You can use email only (user@example.com) or friendly address (User <user@example.com>). This field comply with RFC 5322.

    Deprecated: from_address is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    identity string
    ARN of an identity verified with SES.

    Deprecated: identity is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    configuration_set string
    ARN of the Amazon SES configuration set that you want to apply to messages that you send through the channel.

    Deprecated: configuration_set is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    enabled bool
    Whether the channel is enabled or disabled. Defaults to true.

    Deprecated: enabled is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    orchestration_sending_role_arn string
    ARN of an IAM role for AWS End User Messaging to use to send email from your campaigns or journeys through Amazon SES.

    Deprecated: orchestration_sending_role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    role_arn string
    ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service.

    Deprecated: role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    applicationId String
    Application ID.

    Deprecated: application_id is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    fromAddress String
    Email address used to send emails from. You can use email only (user@example.com) or friendly address (User <user@example.com>). This field comply with RFC 5322.

    Deprecated: from_address is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    identity String
    ARN of an identity verified with SES.

    Deprecated: identity is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    configurationSet String
    ARN of the Amazon SES configuration set that you want to apply to messages that you send through the channel.

    Deprecated: configuration_set is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    enabled Boolean
    Whether the channel is enabled or disabled. Defaults to true.

    Deprecated: enabled is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    orchestrationSendingRoleArn String
    ARN of an IAM role for AWS End User Messaging to use to send email from your campaigns or journeys through Amazon SES.

    Deprecated: orchestration_sending_role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    roleArn String
    ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service.

    Deprecated: role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    applicationId string
    Application ID.

    Deprecated: application_id is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    fromAddress string
    Email address used to send emails from. You can use email only (user@example.com) or friendly address (User <user@example.com>). This field comply with RFC 5322.

    Deprecated: from_address is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    identity string
    ARN of an identity verified with SES.

    Deprecated: identity is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    configurationSet string
    ARN of the Amazon SES configuration set that you want to apply to messages that you send through the channel.

    Deprecated: configuration_set is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    enabled boolean
    Whether the channel is enabled or disabled. Defaults to true.

    Deprecated: enabled is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    orchestrationSendingRoleArn string
    ARN of an IAM role for AWS End User Messaging to use to send email from your campaigns or journeys through Amazon SES.

    Deprecated: orchestration_sending_role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    roleArn string
    ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service.

    Deprecated: role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    application_id str
    Application ID.

    Deprecated: application_id is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    from_address str
    Email address used to send emails from. You can use email only (user@example.com) or friendly address (User <user@example.com>). This field comply with RFC 5322.

    Deprecated: from_address is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    identity str
    ARN of an identity verified with SES.

    Deprecated: identity is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    configuration_set str
    ARN of the Amazon SES configuration set that you want to apply to messages that you send through the channel.

    Deprecated: configuration_set is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    enabled bool
    Whether the channel is enabled or disabled. Defaults to true.

    Deprecated: enabled is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    orchestration_sending_role_arn str
    ARN of an IAM role for AWS End User Messaging to use to send email from your campaigns or journeys through Amazon SES.

    Deprecated: orchestration_sending_role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    role_arn str
    ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service.

    Deprecated: role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    applicationId String
    Application ID.

    Deprecated: application_id is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    fromAddress String
    Email address used to send emails from. You can use email only (user@example.com) or friendly address (User <user@example.com>). This field comply with RFC 5322.

    Deprecated: from_address is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    identity String
    ARN of an identity verified with SES.

    Deprecated: identity is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    configurationSet String
    ARN of the Amazon SES configuration set that you want to apply to messages that you send through the channel.

    Deprecated: configuration_set is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    enabled Boolean
    Whether the channel is enabled or disabled. Defaults to true.

    Deprecated: enabled is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    orchestrationSendingRoleArn String
    ARN of an IAM role for AWS End User Messaging to use to send email from your campaigns or journeys through Amazon SES.

    Deprecated: orchestration_sending_role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    roleArn String
    ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service.

    Deprecated: role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    MessagesPerSecond int
    (Deprecated) Messages per second that can be sent.

    Deprecated: messages_per_second is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    Id string
    The provider-assigned unique ID for this managed resource.
    MessagesPerSecond int
    (Deprecated) Messages per second that can be sent.

    Deprecated: messages_per_second is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    id string
    The provider-assigned unique ID for this managed resource.
    messages_per_second number
    (Deprecated) Messages per second that can be sent.

    Deprecated: messages_per_second is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    id String
    The provider-assigned unique ID for this managed resource.
    messagesPerSecond Integer
    (Deprecated) Messages per second that can be sent.

    Deprecated: messages_per_second is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    id string
    The provider-assigned unique ID for this managed resource.
    messagesPerSecond number
    (Deprecated) Messages per second that can be sent.

    Deprecated: messages_per_second is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    id str
    The provider-assigned unique ID for this managed resource.
    messages_per_second int
    (Deprecated) Messages per second that can be sent.

    Deprecated: messages_per_second is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    id String
    The provider-assigned unique ID for this managed resource.
    messagesPerSecond Number
    (Deprecated) Messages per second that can be sent.

    Deprecated: messages_per_second is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    Look up Existing EmailChannel Resource

    Get an existing EmailChannel 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?: EmailChannelState, opts?: CustomResourceOptions): EmailChannel
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            application_id: Optional[str] = None,
            configuration_set: Optional[str] = None,
            enabled: Optional[bool] = None,
            from_address: Optional[str] = None,
            identity: Optional[str] = None,
            messages_per_second: Optional[int] = None,
            orchestration_sending_role_arn: Optional[str] = None,
            region: Optional[str] = None,
            role_arn: Optional[str] = None) -> EmailChannel
    func GetEmailChannel(ctx *Context, name string, id IDInput, state *EmailChannelState, opts ...ResourceOption) (*EmailChannel, error)
    public static EmailChannel Get(string name, Input<string> id, EmailChannelState? state, CustomResourceOptions? opts = null)
    public static EmailChannel get(String name, Output<String> id, EmailChannelState state, CustomResourceOptions options)
    resources:  _:    type: aws:pinpoint:EmailChannel    get:      id: ${id}
    import {
      to = aws_pinpoint_emailchannel.example
      id = "${id}"
    }
    
    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:
    ApplicationId string
    Application ID.

    Deprecated: application_id is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    ConfigurationSet string
    ARN of the Amazon SES configuration set that you want to apply to messages that you send through the channel.

    Deprecated: configuration_set is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    Enabled bool
    Whether the channel is enabled or disabled. Defaults to true.

    Deprecated: enabled is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    FromAddress string
    Email address used to send emails from. You can use email only (user@example.com) or friendly address (User <user@example.com>). This field comply with RFC 5322.

    Deprecated: from_address is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    Identity string
    ARN of an identity verified with SES.

    Deprecated: identity is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    MessagesPerSecond int
    (Deprecated) Messages per second that can be sent.

    Deprecated: messages_per_second is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    OrchestrationSendingRoleArn string
    ARN of an IAM role for AWS End User Messaging to use to send email from your campaigns or journeys through Amazon SES.

    Deprecated: orchestration_sending_role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    RoleArn string
    ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service.

    Deprecated: role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    ApplicationId string
    Application ID.

    Deprecated: application_id is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    ConfigurationSet string
    ARN of the Amazon SES configuration set that you want to apply to messages that you send through the channel.

    Deprecated: configuration_set is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    Enabled bool
    Whether the channel is enabled or disabled. Defaults to true.

    Deprecated: enabled is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    FromAddress string
    Email address used to send emails from. You can use email only (user@example.com) or friendly address (User <user@example.com>). This field comply with RFC 5322.

    Deprecated: from_address is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    Identity string
    ARN of an identity verified with SES.

    Deprecated: identity is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    MessagesPerSecond int
    (Deprecated) Messages per second that can be sent.

    Deprecated: messages_per_second is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    OrchestrationSendingRoleArn string
    ARN of an IAM role for AWS End User Messaging to use to send email from your campaigns or journeys through Amazon SES.

    Deprecated: orchestration_sending_role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    RoleArn string
    ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service.

    Deprecated: role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    application_id string
    Application ID.

    Deprecated: application_id is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    configuration_set string
    ARN of the Amazon SES configuration set that you want to apply to messages that you send through the channel.

    Deprecated: configuration_set is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    enabled bool
    Whether the channel is enabled or disabled. Defaults to true.

    Deprecated: enabled is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    from_address string
    Email address used to send emails from. You can use email only (user@example.com) or friendly address (User <user@example.com>). This field comply with RFC 5322.

    Deprecated: from_address is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    identity string
    ARN of an identity verified with SES.

    Deprecated: identity is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    messages_per_second number
    (Deprecated) Messages per second that can be sent.

    Deprecated: messages_per_second is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    orchestration_sending_role_arn string
    ARN of an IAM role for AWS End User Messaging to use to send email from your campaigns or journeys through Amazon SES.

    Deprecated: orchestration_sending_role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    role_arn string
    ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service.

    Deprecated: role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    applicationId String
    Application ID.

    Deprecated: application_id is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    configurationSet String
    ARN of the Amazon SES configuration set that you want to apply to messages that you send through the channel.

    Deprecated: configuration_set is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    enabled Boolean
    Whether the channel is enabled or disabled. Defaults to true.

    Deprecated: enabled is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    fromAddress String
    Email address used to send emails from. You can use email only (user@example.com) or friendly address (User <user@example.com>). This field comply with RFC 5322.

    Deprecated: from_address is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    identity String
    ARN of an identity verified with SES.

    Deprecated: identity is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    messagesPerSecond Integer
    (Deprecated) Messages per second that can be sent.

    Deprecated: messages_per_second is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    orchestrationSendingRoleArn String
    ARN of an IAM role for AWS End User Messaging to use to send email from your campaigns or journeys through Amazon SES.

    Deprecated: orchestration_sending_role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    roleArn String
    ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service.

    Deprecated: role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    applicationId string
    Application ID.

    Deprecated: application_id is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    configurationSet string
    ARN of the Amazon SES configuration set that you want to apply to messages that you send through the channel.

    Deprecated: configuration_set is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    enabled boolean
    Whether the channel is enabled or disabled. Defaults to true.

    Deprecated: enabled is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    fromAddress string
    Email address used to send emails from. You can use email only (user@example.com) or friendly address (User <user@example.com>). This field comply with RFC 5322.

    Deprecated: from_address is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    identity string
    ARN of an identity verified with SES.

    Deprecated: identity is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    messagesPerSecond number
    (Deprecated) Messages per second that can be sent.

    Deprecated: messages_per_second is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    orchestrationSendingRoleArn string
    ARN of an IAM role for AWS End User Messaging to use to send email from your campaigns or journeys through Amazon SES.

    Deprecated: orchestration_sending_role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    roleArn string
    ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service.

    Deprecated: role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    application_id str
    Application ID.

    Deprecated: application_id is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    configuration_set str
    ARN of the Amazon SES configuration set that you want to apply to messages that you send through the channel.

    Deprecated: configuration_set is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    enabled bool
    Whether the channel is enabled or disabled. Defaults to true.

    Deprecated: enabled is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    from_address str
    Email address used to send emails from. You can use email only (user@example.com) or friendly address (User <user@example.com>). This field comply with RFC 5322.

    Deprecated: from_address is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    identity str
    ARN of an identity verified with SES.

    Deprecated: identity is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    messages_per_second int
    (Deprecated) Messages per second that can be sent.

    Deprecated: messages_per_second is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    orchestration_sending_role_arn str
    ARN of an IAM role for AWS End User Messaging to use to send email from your campaigns or journeys through Amazon SES.

    Deprecated: orchestration_sending_role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    role_arn str
    ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service.

    Deprecated: role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    applicationId String
    Application ID.

    Deprecated: application_id is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    configurationSet String
    ARN of the Amazon SES configuration set that you want to apply to messages that you send through the channel.

    Deprecated: configuration_set is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    enabled Boolean
    Whether the channel is enabled or disabled. Defaults to true.

    Deprecated: enabled is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    fromAddress String
    Email address used to send emails from. You can use email only (user@example.com) or friendly address (User <user@example.com>). This field comply with RFC 5322.

    Deprecated: from_address is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    identity String
    ARN of an identity verified with SES.

    Deprecated: identity is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    messagesPerSecond Number
    (Deprecated) Messages per second that can be sent.

    Deprecated: messages_per_second is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    orchestrationSendingRoleArn String
    ARN of an IAM role for AWS End User Messaging to use to send email from your campaigns or journeys through Amazon SES.

    Deprecated: orchestration_sending_role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    roleArn String
    ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service.

    Deprecated: role_arn is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES.

    Import

    Using pulumi import, import End User Messaging Email Channel using the application-id. For example:

    $ pulumi import aws:pinpoint/emailChannel:EmailChannel email application-id
    

    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
    Viewing docs for AWS v7.32.0
    published on Friday, May 29, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial