ContactList class

Resource for managing an AWS SESv2 (Simple Email V2) Contact List.

Example Usage

Basic Usage

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

const example = new aws.sesv2.ContactList("example", {contactListName: "example"});
import pulumi
import pulumi_aws as aws

example = aws.sesv2.ContactList("example", contact_list_name="example")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.SesV2.ContactList("example", new()
    {
        ContactListName = "example",
    });

});
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.NewContactList(ctx, "example", &sesv2.ContactListArgs{
			ContactListName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_sesv2_contactlist" "example" {
  contact_list_name = "example"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sesv2.ContactList;
import com.pulumi.aws.sesv2.ContactListArgs;
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 ContactList("example", ContactListArgs.builder()
            .contactListName("example")
            .build());

    }
}
resources:
  example:
    type: aws:sesv2:ContactList
    properties:
      contactListName: example

Extended Usage

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

const example = new aws.sesv2.ContactList("example", {
    topics: [{
        defaultSubscriptionStatus: "OPT_IN",
        description: "topic description",
        displayName: "Example Topic",
        topicName: "example-topic",
    }],
    contactListName: "example",
    description: "description",
});
import pulumi
import pulumi_aws as aws

example = aws.sesv2.ContactList("example",
    topics=[{
        "default_subscription_status": "OPT_IN",
        "description": "topic description",
        "display_name": "Example Topic",
        "topic_name": "example-topic",
    }],
    contact_list_name="example",
    description="description")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.SesV2.ContactList("example", new()
    {
        Topics = new[]
        {
            new Aws.SesV2.Inputs.ContactListTopicArgs
            {
                DefaultSubscriptionStatus = "OPT_IN",
                Description = "topic description",
                DisplayName = "Example Topic",
                TopicName = "example-topic",
            },
        },
        ContactListName = "example",
        Description = "description",
    });

});
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.NewContactList(ctx, "example", &sesv2.ContactListArgs{
			Topics: sesv2.ContactListTopicArray{
				&sesv2.ContactListTopicArgs{
					DefaultSubscriptionStatus: pulumi.String("OPT_IN"),
					Description:               pulumi.String("topic description"),
					DisplayName:               pulumi.String("Example Topic"),
					TopicName:                 pulumi.String("example-topic"),
				},
			},
			ContactListName: pulumi.String("example"),
			Description:     pulumi.String("description"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_sesv2_contactlist" "example" {
  topics {
    default_subscription_status = "OPT_IN"
    description                 = "topic description"
    display_name                = "Example Topic"
    topic_name                  = "example-topic"
  }
  contact_list_name = "example"
  description       = "description"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sesv2.ContactList;
import com.pulumi.aws.sesv2.ContactListArgs;
import com.pulumi.aws.sesv2.inputs.ContactListTopicArgs;
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 ContactList("example", ContactListArgs.builder()
            .topics(ContactListTopicArgs.builder()
                .defaultSubscriptionStatus("OPT_IN")
                .description("topic description")
                .displayName("Example Topic")
                .topicName("example-topic")
                .build())
            .contactListName("example")
            .description("description")
            .build());

    }
}
resources:
  example:
    type: aws:sesv2:ContactList
    properties:
      topics:
        - defaultSubscriptionStatus: OPT_IN
          description: topic description
          displayName: Example Topic
          topicName: example-topic
      contactListName: example
      description: description

Import

Using pulumi import, import SESv2 (Simple Email V2) Contact List using the id. For example:

$ pulumi import aws:sesv2/contactList:ContactList example example

Constructors

ContactList(String name, {ContactListArgs? args, CustomResourceOptions? options})
Creates a new ContactList. name The Pulumi resource name. args Arguments used to configure this ContactList. The set of arguments for ContactList. options Resource options controlling this resource's behavior.
ContactList.reference(String urn)
Creates a typed reference to an existing ContactList resource.

Properties

arn ↔ Output<String>
ARN of the contact list.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
contactListName ↔ Output<String>
Name of the contact list.
latefinal
createdTimestamp ↔ Output<String>
Timestamp noting when the contact list was created in ISO 8601 format.
latefinal
description ↔ Output<String?>
Description of what the contact list is about.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
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
lastUpdatedTimestamp ↔ Output<String>
Timestamp noting the last time the contact list was updated in ISO 8601 format.
latefinal
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
tags ↔ Output<Map<String, String>?>
Key-value map of resource tags for the contact list. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
latefinal
topics ↔ Output<List<ContactListTopic>?>
Configuration block(s) with topic for the contact list. Detailed below.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

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, {ContactListState? state, CustomResourceOptions? options}) → ContactList
Gets an existing ContactList resource's state with the given name and id.