Class EmailChannel

Provides a Pinpoint Email Channel resource.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var app = new Aws.Pinpoint.App("app", new Aws.Pinpoint.AppArgs
    {
    });
    var identity = new Aws.Ses.DomainIdentity("identity", new Aws.Ses.DomainIdentityArgs
    {
        Domain = "example.com",
    });
    var role = new Aws.Iam.Role("role", new Aws.Iam.RoleArgs
    {
        AssumeRolePolicy = @"{
""Version"": ""2012-10-17"",
""Statement"": [
{
  ""Action"": ""sts:AssumeRole"",
  ""Principal"": {
    ""Service"": ""pinpoint.amazonaws.com""
  },
  ""Effect"": ""Allow"",
  ""Sid"": """"
}
]
}

",
    });
    var email = new Aws.Pinpoint.EmailChannel("email", new Aws.Pinpoint.EmailChannelArgs
    {
        ApplicationId = app.ApplicationId,
        FromAddress = "user@example.com",
        Identity = identity.Arn,
        RoleArn = role.Arn,
    });
    var rolePolicy = new Aws.Iam.RolePolicy("rolePolicy", new Aws.Iam.RolePolicyArgs
    {
        Policy = @"{
""Version"": ""2012-10-17"",
""Statement"": {
""Action"": [
  ""mobileanalytics:PutEvents"",
  ""mobileanalytics:PutItems""
],
""Effect"": ""Allow"",
""Resource"": [
  ""*""
]
}
}

",
        Role = role.Id,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

EmailChannel

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Pinpoint

Assembly: Pulumi.Aws.dll

Syntax

public class EmailChannel : CustomResource

Constructors

EmailChannel(String, EmailChannelArgs, CustomResourceOptions)

Create a EmailChannel resource with the given unique name, arguments, and options.

Declaration

public EmailChannel(string name, EmailChannelArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
EmailChannelArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ApplicationId

The application ID.

Declaration

public Output<string> ApplicationId { get; }

Property Value

Type	Description
Output<System.String>

Enabled

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

Declaration

public Output<bool?> Enabled { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

FromAddress

The email address used to send emails from.

Declaration

public Output<string> FromAddress { get; }

Property Value

Type	Description
Output<System.String>

Identity

The ARN of an identity verified with SES.

Declaration

public Output<string> Identity { get; }

Property Value

Type	Description
Output<System.String>

MessagesPerSecond

Messages per second that can be sent.

Declaration

public Output<int> MessagesPerSecond { get; }

Property Value

Type	Description
Output<System.Int32>

RoleArn

The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service.

Declaration

public Output<string> RoleArn { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, EmailChannelState, CustomResourceOptions)

Get an existing EmailChannel resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static EmailChannel Get(string name, Input<string> id, EmailChannelState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
EmailChannelState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
EmailChannel