Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. ses
  5. IdentityNotificationTopic
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

aws.ses.IdentityNotificationTopic

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

    Resource for managing SES Identity Notification Topics

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.ses.IdentityNotificationTopic("test", {
    topicArn: exampleAwsSnsTopic.arn,
    notificationType: "Bounce",
    identity: example.domain,
    includeOriginalHeaders: true,
});

    import pulumi
import pulumi_aws as aws

test = aws.ses.IdentityNotificationTopic("test",
    topic_arn=example_aws_sns_topic["arn"],
    notification_type="Bounce",
    identity=example["domain"],
    include_original_headers=True)

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ses"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ses.NewIdentityNotificationTopic(ctx, "test", &ses.IdentityNotificationTopicArgs{
			TopicArn:               pulumi.Any(exampleAwsSnsTopic.Arn),
			NotificationType:       pulumi.String("Bounce"),
			Identity:               pulumi.Any(example.Domain),
			IncludeOriginalHeaders: pulumi.Bool(true),
		})
		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 test = new Aws.Ses.IdentityNotificationTopic("test", new()
    {
        TopicArn = exampleAwsSnsTopic.Arn,
        NotificationType = "Bounce",
        Identity = example.Domain,
        IncludeOriginalHeaders = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ses.IdentityNotificationTopic;
import com.pulumi.aws.ses.IdentityNotificationTopicArgs;
import java.util.List;
import java.util.ArrayList;
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 test = new IdentityNotificationTopic("test", IdentityNotificationTopicArgs.builder()
            .topicArn(exampleAwsSnsTopic.arn())
            .notificationType("Bounce")
            .identity(example.domain())
            .includeOriginalHeaders(true)
            .build());

    }
}

    resources:
  test:
    type: aws:ses:IdentityNotificationTopic
    properties:
      topicArn: ${exampleAwsSnsTopic.arn}
      notificationType: Bounce
      identity: ${example.domain}
      includeOriginalHeaders: true

    Create IdentityNotificationTopic Resource

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

    Constructor syntax

    new IdentityNotificationTopic(name: string, args: IdentityNotificationTopicArgs, opts?: CustomResourceOptions);
    @overload
def IdentityNotificationTopic(resource_name: str,
                              args: IdentityNotificationTopicArgs,
                              opts: Optional[ResourceOptions] = None)

@overload
def IdentityNotificationTopic(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              identity: Optional[str] = None,
                              notification_type: Optional[str] = None,
                              include_original_headers: Optional[bool] = None,
                              topic_arn: Optional[str] = None)
    func NewIdentityNotificationTopic(ctx *Context, name string, args IdentityNotificationTopicArgs, opts ...ResourceOption) (*IdentityNotificationTopic, error)
    public IdentityNotificationTopic(string name, IdentityNotificationTopicArgs args, CustomResourceOptions? opts = null)
    public IdentityNotificationTopic(String name, IdentityNotificationTopicArgs args)
public IdentityNotificationTopic(String name, IdentityNotificationTopicArgs args, CustomResourceOptions options)

    type: aws:ses:IdentityNotificationTopic
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args IdentityNotificationTopicArgs
    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 IdentityNotificationTopicArgs
    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 IdentityNotificationTopicArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IdentityNotificationTopicArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IdentityNotificationTopicArgs
    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 identityNotificationTopicResource = new Aws.Ses.IdentityNotificationTopic("identityNotificationTopicResource", new()
{
    Identity = "string",
    NotificationType = "string",
    IncludeOriginalHeaders = false,
    TopicArn = "string",
});

    example, err := ses.NewIdentityNotificationTopic(ctx, "identityNotificationTopicResource", &ses.IdentityNotificationTopicArgs{
	Identity:               pulumi.String("string"),
	NotificationType:       pulumi.String("string"),
	IncludeOriginalHeaders: pulumi.Bool(false),
	TopicArn:               pulumi.String("string"),
})

    var identityNotificationTopicResource = new IdentityNotificationTopic("identityNotificationTopicResource", IdentityNotificationTopicArgs.builder()
    .identity("string")
    .notificationType("string")
    .includeOriginalHeaders(false)
    .topicArn("string")
    .build());

    identity_notification_topic_resource = aws.ses.IdentityNotificationTopic("identityNotificationTopicResource",
    identity="string",
    notification_type="string",
    include_original_headers=False,
    topic_arn="string")

    const identityNotificationTopicResource = new aws.ses.IdentityNotificationTopic("identityNotificationTopicResource", {
    identity: "string",
    notificationType: "string",
    includeOriginalHeaders: false,
    topicArn: "string",
});

    type: aws:ses:IdentityNotificationTopic
properties:
    identity: string
    includeOriginalHeaders: false
    notificationType: string
    topicArn: string

    IdentityNotificationTopic Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The IdentityNotificationTopic resource accepts the following input properties:

    Identity string
    The identity for which the Amazon SNS topic will be set. You can specify an identity by using its name or by using its Amazon Resource Name (ARN).
    NotificationType string
    The type of notifications that will be published to the specified Amazon SNS topic. Valid Values: Bounce, Complaint or Delivery.
    IncludeOriginalHeaders bool
    Whether SES should include original email headers in SNS notifications of this type. false by default.
    TopicArn string
    The Amazon Resource Name (ARN) of the Amazon SNS topic. Can be set to "" (an empty string) to disable publishing.
    Identity string
    The identity for which the Amazon SNS topic will be set. You can specify an identity by using its name or by using its Amazon Resource Name (ARN).
    NotificationType string
    The type of notifications that will be published to the specified Amazon SNS topic. Valid Values: Bounce, Complaint or Delivery.
    IncludeOriginalHeaders bool
    Whether SES should include original email headers in SNS notifications of this type. false by default.
    TopicArn string
    The Amazon Resource Name (ARN) of the Amazon SNS topic. Can be set to "" (an empty string) to disable publishing.
    identity String
    The identity for which the Amazon SNS topic will be set. You can specify an identity by using its name or by using its Amazon Resource Name (ARN).
    notificationType String
    The type of notifications that will be published to the specified Amazon SNS topic. Valid Values: Bounce, Complaint or Delivery.
    includeOriginalHeaders Boolean
    Whether SES should include original email headers in SNS notifications of this type. false by default.
    topicArn String
    The Amazon Resource Name (ARN) of the Amazon SNS topic. Can be set to "" (an empty string) to disable publishing.
    identity string
    The identity for which the Amazon SNS topic will be set. You can specify an identity by using its name or by using its Amazon Resource Name (ARN).
    notificationType string
    The type of notifications that will be published to the specified Amazon SNS topic. Valid Values: Bounce, Complaint or Delivery.
    includeOriginalHeaders boolean
    Whether SES should include original email headers in SNS notifications of this type. false by default.
    topicArn string
    The Amazon Resource Name (ARN) of the Amazon SNS topic. Can be set to "" (an empty string) to disable publishing.
    identity str
    The identity for which the Amazon SNS topic will be set. You can specify an identity by using its name or by using its Amazon Resource Name (ARN).
    notification_type str
    The type of notifications that will be published to the specified Amazon SNS topic. Valid Values: Bounce, Complaint or Delivery.
    include_original_headers bool
    Whether SES should include original email headers in SNS notifications of this type. false by default.
    topic_arn str
    The Amazon Resource Name (ARN) of the Amazon SNS topic. Can be set to "" (an empty string) to disable publishing.
    identity String
    The identity for which the Amazon SNS topic will be set. You can specify an identity by using its name or by using its Amazon Resource Name (ARN).
    notificationType String
    The type of notifications that will be published to the specified Amazon SNS topic. Valid Values: Bounce, Complaint or Delivery.
    includeOriginalHeaders Boolean
    Whether SES should include original email headers in SNS notifications of this type. false by default.
    topicArn String
    The Amazon Resource Name (ARN) of the Amazon SNS topic. Can be set to "" (an empty string) to disable publishing.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing IdentityNotificationTopic Resource

    Get an existing IdentityNotificationTopic 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?: IdentityNotificationTopicState, opts?: CustomResourceOptions): IdentityNotificationTopic
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        identity: Optional[str] = None,
        include_original_headers: Optional[bool] = None,
        notification_type: Optional[str] = None,
        topic_arn: Optional[str] = None) -> IdentityNotificationTopic
    func GetIdentityNotificationTopic(ctx *Context, name string, id IDInput, state *IdentityNotificationTopicState, opts ...ResourceOption) (*IdentityNotificationTopic, error)
    public static IdentityNotificationTopic Get(string name, Input<string> id, IdentityNotificationTopicState? state, CustomResourceOptions? opts = null)
    public static IdentityNotificationTopic get(String name, Output<String> id, IdentityNotificationTopicState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Identity string
    The identity for which the Amazon SNS topic will be set. You can specify an identity by using its name or by using its Amazon Resource Name (ARN).
    IncludeOriginalHeaders bool
    Whether SES should include original email headers in SNS notifications of this type. false by default.
    NotificationType string
    The type of notifications that will be published to the specified Amazon SNS topic. Valid Values: Bounce, Complaint or Delivery.
    TopicArn string
    The Amazon Resource Name (ARN) of the Amazon SNS topic. Can be set to "" (an empty string) to disable publishing.
    Identity string
    The identity for which the Amazon SNS topic will be set. You can specify an identity by using its name or by using its Amazon Resource Name (ARN).
    IncludeOriginalHeaders bool
    Whether SES should include original email headers in SNS notifications of this type. false by default.
    NotificationType string
    The type of notifications that will be published to the specified Amazon SNS topic. Valid Values: Bounce, Complaint or Delivery.
    TopicArn string
    The Amazon Resource Name (ARN) of the Amazon SNS topic. Can be set to "" (an empty string) to disable publishing.
    identity String
    The identity for which the Amazon SNS topic will be set. You can specify an identity by using its name or by using its Amazon Resource Name (ARN).
    includeOriginalHeaders Boolean
    Whether SES should include original email headers in SNS notifications of this type. false by default.
    notificationType String
    The type of notifications that will be published to the specified Amazon SNS topic. Valid Values: Bounce, Complaint or Delivery.
    topicArn String
    The Amazon Resource Name (ARN) of the Amazon SNS topic. Can be set to "" (an empty string) to disable publishing.
    identity string
    The identity for which the Amazon SNS topic will be set. You can specify an identity by using its name or by using its Amazon Resource Name (ARN).
    includeOriginalHeaders boolean
    Whether SES should include original email headers in SNS notifications of this type. false by default.
    notificationType string
    The type of notifications that will be published to the specified Amazon SNS topic. Valid Values: Bounce, Complaint or Delivery.
    topicArn string
    The Amazon Resource Name (ARN) of the Amazon SNS topic. Can be set to "" (an empty string) to disable publishing.
    identity str
    The identity for which the Amazon SNS topic will be set. You can specify an identity by using its name or by using its Amazon Resource Name (ARN).
    include_original_headers bool
    Whether SES should include original email headers in SNS notifications of this type. false by default.
    notification_type str
    The type of notifications that will be published to the specified Amazon SNS topic. Valid Values: Bounce, Complaint or Delivery.
    topic_arn str
    The Amazon Resource Name (ARN) of the Amazon SNS topic. Can be set to "" (an empty string) to disable publishing.
    identity String
    The identity for which the Amazon SNS topic will be set. You can specify an identity by using its name or by using its Amazon Resource Name (ARN).
    includeOriginalHeaders Boolean
    Whether SES should include original email headers in SNS notifications of this type. false by default.
    notificationType String
    The type of notifications that will be published to the specified Amazon SNS topic. Valid Values: Bounce, Complaint or Delivery.
    topicArn String
    The Amazon Resource Name (ARN) of the Amazon SNS topic. Can be set to "" (an empty string) to disable publishing.

    Import

    Using pulumi import, import Identity Notification Topics using the ID of the record. The ID is made up as IDENTITY|TYPE where IDENTITY is the SES Identity and TYPE is the Notification Type. For example:

    $ pulumi import aws:ses/identityNotificationTopic:IdentityNotificationTopic test 'example.com|Bounce'

    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
    AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-aws