AWS Amazon Pinpoint Email Email Channel
This page shows how to write Terraform and CloudFormation for Amazon Pinpoint Email Email Channel and write them securely.
aws_pinpoint_email_channel (Terraform)
The Email Channel in Amazon Pinpoint Email can be configured in Terraform with the resource name aws_pinpoint_email_channel. The following sections describe 2 examples of how to use the resource and its parameters.
Example Usage from GitHub
resource "aws_pinpoint_email_channel" "this" {
application_id = var.application_id
enabled = var.enabled
from_address = var.from_address
identity = var.identity
role_arn = var.role_arn
resource "aws_pinpoint_email_channel" "email" {
provider = aws.west
application_id = aws_pinpoint_app.red_team_terraform_final.application_id
from_address = "michael.jiang@accenturefederal.com"
identity = "arn:aws-us-gov:ses:us-gov-west-1:812677824406:identity/michael.jiang@accenturefederal.com"
role_arn = aws_iam_role.role.arn
Parameters
-
application_idrequired - string -
configuration_setoptional - string -
enabledoptional - bool -
from_addressrequired - string -
idoptional computed - string -
identityrequired - string -
messages_per_secondoptional computed - number -
role_arnrequired - string
Explanation in Terraform Registry
Provides a Pinpoint Email Channel resource.
AWS::Pinpoint::EmailChannel (CloudFormation)
The EmailChannel in Pinpoint can be configured in CloudFormation with the resource name AWS::Pinpoint::EmailChannel. The following sections describe 8 examples of how to use the resource and its parameters.
Example Usage from GitHub
Type: AWS::Pinpoint::EmailChannel
Properties:
ApplicationId: !Ref PinpointApp
Enabled: True
FromAddress: ${self:custom.sesSender.address}
Identity: ${self:custom.sesSender.arn}
Type: AWS::Pinpoint::EmailChannel
Properties:
ApplicationId: !Ref PinpointApp
Enabled: True
FromAddress: ${self:custom.sesSender.address}
Identity: ${self:custom.sesSender.arn}
Type: AWS::Pinpoint::EmailChannel
Properties:
ApplicationId: !Ref pinpointApp
Enabled: true
FromAddress: getfloodwarnings@gmail.com
Identity: arn:aws:ses:eu-west-2:190133113546:identity/getfloodwarnings@gmail.com
Type: AWS::Pinpoint::EmailChannel
Properties:
ApplicationId: !Ref pinpointApp
Enabled: true
FromAddress: ${self:custom.environment.emailConfig.verifiedEmailAddress}
Identity: ${self:custom.environment.emailConfig.verifiedEmailArn}
Type: AWS::Pinpoint::EmailChannel
Description: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html
Properties:
FromAddress: !Ref 'FromAddress'
ApplicationId: !Ref 'ApplicationId'
Identity: !Ref 'Identity'
"resourceType": "AWS::Pinpoint::EmailChannel",
"filePath": null
},
{
"resourceType": "AWS::Pinpoint::App",
"filePath": null
"AWS::Pinpoint::EmailChannel": {
"Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html",
"Properties": {
"ConfigurationSet": {
"Required": false,
"Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html#cfn-pinpoint-emailchannel-configurationset",
"AWS::Pinpoint::EmailChannel": {
"Type": "AWS::Pinpoint::EmailChannel",
"Properties": {}
},
"AWS::EC2::NetworkInsightsAnalysis": {
"Type": "AWS::EC2::NetworkInsightsAnalysis",
Parameters
ApplicationId
The unique identifier for the Amazon Pinpoint application that you're specifying the email channel for.
Required: Yes
Type: String
Update requires: Replacement
ConfigurationSet
The Amazon SES configuration set that you want to apply to messages that you send through the channel.
Required: No
Type: String
Update requires: No interruption
Enabled
Specifies whether to enable the email channel for the application.
Required: No
Type: Boolean
Update requires: No interruption
FromAddress
The verified email address that you want to send email from when you send email through the channel.
Required: Yes
Type: String
Update requires: No interruption
Identity
The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.
Required: Yes
Type: String
Update requires: No interruption
RoleArn
The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.
Required: No
Type: String
Update requires: No interruption
Explanation in CloudFormation Registry
A channel is a type of platform that you can deliver messages to. You can use the email channel to send email to users. Before you can use Amazon Pinpoint to send email, you must enable the email channel for an Amazon Pinpoint application.
The EmailChannel resource represents the status, identity, and other settings of the email channel for an application
Frequently asked questions
What is AWS Amazon Pinpoint Email Email Channel?
AWS Amazon Pinpoint Email Email Channel is a resource for Amazon Pinpoint Email of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.
Where can I find the example code for the AWS Amazon Pinpoint Email Email Channel?
For Terraform, the niveklabs/aws and wimaac/red_team source code examples are useful. See the Terraform Example section for further details.
For CloudFormation, the starpolar/backend, lovelyrrg51/real-backend and DEFRA/flood-xws-subscription-api source code examples are useful. See the CloudFormation Example section for further details.
