1. Packages
  2. AWS
  3. API Docs
  4. sesv2
  5. AccountSuppressionAttributes
AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi

aws.sesv2.AccountSuppressionAttributes

Explore with Pulumi AI

Manages AWS SESv2 (Simple Email V2) account-level suppression attributes.

Example Usage

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

const example = new aws.sesv2.AccountSuppressionAttributes("example", {suppressedReasons: ["COMPLAINT"]});
Copy
import pulumi
import pulumi_aws as aws

example = aws.sesv2.AccountSuppressionAttributes("example", suppressed_reasons=["COMPLAINT"])
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sesv2.NewAccountSuppressionAttributes(ctx, "example", &sesv2.AccountSuppressionAttributesArgs{
			SuppressedReasons: pulumi.StringArray{
				pulumi.String("COMPLAINT"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.SesV2.AccountSuppressionAttributes("example", new()
    {
        SuppressedReasons = new[]
        {
            "COMPLAINT",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sesv2.AccountSuppressionAttributes;
import com.pulumi.aws.sesv2.AccountSuppressionAttributesArgs;
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 example = new AccountSuppressionAttributes("example", AccountSuppressionAttributesArgs.builder()
            .suppressedReasons("COMPLAINT")
            .build());

    }
}
Copy
resources:
  example:
    type: aws:sesv2:AccountSuppressionAttributes
    properties:
      suppressedReasons:
        - COMPLAINT
Copy

Create AccountSuppressionAttributes Resource

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

Constructor syntax

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

@overload
def AccountSuppressionAttributes(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 suppressed_reasons: Optional[Sequence[str]] = None)
func NewAccountSuppressionAttributes(ctx *Context, name string, args AccountSuppressionAttributesArgs, opts ...ResourceOption) (*AccountSuppressionAttributes, error)
public AccountSuppressionAttributes(string name, AccountSuppressionAttributesArgs args, CustomResourceOptions? opts = null)
public AccountSuppressionAttributes(String name, AccountSuppressionAttributesArgs args)
public AccountSuppressionAttributes(String name, AccountSuppressionAttributesArgs args, CustomResourceOptions options)
type: aws:sesv2:AccountSuppressionAttributes
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AccountSuppressionAttributesArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AccountSuppressionAttributesArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AccountSuppressionAttributesArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AccountSuppressionAttributesArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AccountSuppressionAttributesArgs
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 accountSuppressionAttributesResource = new Aws.SesV2.AccountSuppressionAttributes("accountSuppressionAttributesResource", new()
{
    SuppressedReasons = new[]
    {
        "string",
    },
});
Copy
example, err := sesv2.NewAccountSuppressionAttributes(ctx, "accountSuppressionAttributesResource", &sesv2.AccountSuppressionAttributesArgs{
	SuppressedReasons: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var accountSuppressionAttributesResource = new AccountSuppressionAttributes("accountSuppressionAttributesResource", AccountSuppressionAttributesArgs.builder()
    .suppressedReasons("string")
    .build());
Copy
account_suppression_attributes_resource = aws.sesv2.AccountSuppressionAttributes("accountSuppressionAttributesResource", suppressed_reasons=["string"])
Copy
const accountSuppressionAttributesResource = new aws.sesv2.AccountSuppressionAttributes("accountSuppressionAttributesResource", {suppressedReasons: ["string"]});
Copy
type: aws:sesv2:AccountSuppressionAttributes
properties:
    suppressedReasons:
        - string
Copy

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

SuppressedReasons This property is required. List<string>
A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. Valid values: COMPLAINT, BOUNCE.
SuppressedReasons This property is required. []string
A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. Valid values: COMPLAINT, BOUNCE.
suppressedReasons This property is required. List<String>
A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. Valid values: COMPLAINT, BOUNCE.
suppressedReasons This property is required. string[]
A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. Valid values: COMPLAINT, BOUNCE.
suppressed_reasons This property is required. Sequence[str]
A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. Valid values: COMPLAINT, BOUNCE.
suppressedReasons This property is required. List<String>
A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. Valid values: COMPLAINT, BOUNCE.

Outputs

All input properties are implicitly available as output properties. Additionally, the AccountSuppressionAttributes 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 AccountSuppressionAttributes Resource

Get an existing AccountSuppressionAttributes 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?: AccountSuppressionAttributesState, opts?: CustomResourceOptions): AccountSuppressionAttributes
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        suppressed_reasons: Optional[Sequence[str]] = None) -> AccountSuppressionAttributes
func GetAccountSuppressionAttributes(ctx *Context, name string, id IDInput, state *AccountSuppressionAttributesState, opts ...ResourceOption) (*AccountSuppressionAttributes, error)
public static AccountSuppressionAttributes Get(string name, Input<string> id, AccountSuppressionAttributesState? state, CustomResourceOptions? opts = null)
public static AccountSuppressionAttributes get(String name, Output<String> id, AccountSuppressionAttributesState state, CustomResourceOptions options)
resources:  _:    type: aws:sesv2:AccountSuppressionAttributes    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
SuppressedReasons List<string>
A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. Valid values: COMPLAINT, BOUNCE.
SuppressedReasons []string
A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. Valid values: COMPLAINT, BOUNCE.
suppressedReasons List<String>
A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. Valid values: COMPLAINT, BOUNCE.
suppressedReasons string[]
A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. Valid values: COMPLAINT, BOUNCE.
suppressed_reasons Sequence[str]
A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. Valid values: COMPLAINT, BOUNCE.
suppressedReasons List<String>
A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. Valid values: COMPLAINT, BOUNCE.

Import

Using pulumi import, import account-level suppression attributes using the account ID. For example:

$ pulumi import aws:sesv2/accountSuppressionAttributes:AccountSuppressionAttributes example 123456789012
Copy

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.