1. Packages
  2. AWS
  3. API Docs
  4. sesv2
  5. DedicatedIpAssignment
AWS v6.74.0 published on Wednesday, Mar 26, 2025 by Pulumi

aws.sesv2.DedicatedIpAssignment

Explore with Pulumi AI

Resource for managing an AWS SESv2 (Simple Email V2) Dedicated IP Assignment.

This resource is used with “Standard” dedicated IP addresses. This includes addresses requested and relinquished manually via an AWS support case, or Bring Your Own IP addresses. Once no longer assigned, this resource returns the IP to the ses-default-dedicated-pool, managed by AWS.

Example Usage

Basic Usage

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

const example = new aws.sesv2.DedicatedIpAssignment("example", {
    ip: "0.0.0.0",
    destinationPoolName: "my-pool",
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.sesv2.DedicatedIpAssignment("example",
    ip="0.0.0.0",
    destination_pool_name="my-pool")
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.NewDedicatedIpAssignment(ctx, "example", &sesv2.DedicatedIpAssignmentArgs{
			Ip:                  pulumi.String("0.0.0.0"),
			DestinationPoolName: pulumi.String("my-pool"),
		})
		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.DedicatedIpAssignment("example", new()
    {
        Ip = "0.0.0.0",
        DestinationPoolName = "my-pool",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sesv2.DedicatedIpAssignment;
import com.pulumi.aws.sesv2.DedicatedIpAssignmentArgs;
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 DedicatedIpAssignment("example", DedicatedIpAssignmentArgs.builder()
            .ip("0.0.0.0")
            .destinationPoolName("my-pool")
            .build());

    }
}
Copy
resources:
  example:
    type: aws:sesv2:DedicatedIpAssignment
    properties:
      ip: 0.0.0.0
      destinationPoolName: my-pool
Copy

Create DedicatedIpAssignment Resource

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

Constructor syntax

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

@overload
def DedicatedIpAssignment(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          destination_pool_name: Optional[str] = None,
                          ip: Optional[str] = None)
func NewDedicatedIpAssignment(ctx *Context, name string, args DedicatedIpAssignmentArgs, opts ...ResourceOption) (*DedicatedIpAssignment, error)
public DedicatedIpAssignment(string name, DedicatedIpAssignmentArgs args, CustomResourceOptions? opts = null)
public DedicatedIpAssignment(String name, DedicatedIpAssignmentArgs args)
public DedicatedIpAssignment(String name, DedicatedIpAssignmentArgs args, CustomResourceOptions options)
type: aws:sesv2:DedicatedIpAssignment
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. DedicatedIpAssignmentArgs
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. DedicatedIpAssignmentArgs
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. DedicatedIpAssignmentArgs
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. DedicatedIpAssignmentArgs
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. DedicatedIpAssignmentArgs
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 dedicatedIpAssignmentResource = new Aws.SesV2.DedicatedIpAssignment("dedicatedIpAssignmentResource", new()
{
    DestinationPoolName = "string",
    Ip = "string",
});
Copy
example, err := sesv2.NewDedicatedIpAssignment(ctx, "dedicatedIpAssignmentResource", &sesv2.DedicatedIpAssignmentArgs{
	DestinationPoolName: pulumi.String("string"),
	Ip:                  pulumi.String("string"),
})
Copy
var dedicatedIpAssignmentResource = new DedicatedIpAssignment("dedicatedIpAssignmentResource", DedicatedIpAssignmentArgs.builder()
    .destinationPoolName("string")
    .ip("string")
    .build());
Copy
dedicated_ip_assignment_resource = aws.sesv2.DedicatedIpAssignment("dedicatedIpAssignmentResource",
    destination_pool_name="string",
    ip="string")
Copy
const dedicatedIpAssignmentResource = new aws.sesv2.DedicatedIpAssignment("dedicatedIpAssignmentResource", {
    destinationPoolName: "string",
    ip: "string",
});
Copy
type: aws:sesv2:DedicatedIpAssignment
properties:
    destinationPoolName: string
    ip: string
Copy

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

DestinationPoolName
This property is required.
Changes to this property will trigger replacement.
string
Dedicated IP address.
Ip
This property is required.
Changes to this property will trigger replacement.
string
Dedicated IP address.
DestinationPoolName
This property is required.
Changes to this property will trigger replacement.
string
Dedicated IP address.
Ip
This property is required.
Changes to this property will trigger replacement.
string
Dedicated IP address.
destinationPoolName
This property is required.
Changes to this property will trigger replacement.
String
Dedicated IP address.
ip
This property is required.
Changes to this property will trigger replacement.
String
Dedicated IP address.
destinationPoolName
This property is required.
Changes to this property will trigger replacement.
string
Dedicated IP address.
ip
This property is required.
Changes to this property will trigger replacement.
string
Dedicated IP address.
destination_pool_name
This property is required.
Changes to this property will trigger replacement.
str
Dedicated IP address.
ip
This property is required.
Changes to this property will trigger replacement.
str
Dedicated IP address.
destinationPoolName
This property is required.
Changes to this property will trigger replacement.
String
Dedicated IP address.
ip
This property is required.
Changes to this property will trigger replacement.
String
Dedicated IP address.

Outputs

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

Get an existing DedicatedIpAssignment 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?: DedicatedIpAssignmentState, opts?: CustomResourceOptions): DedicatedIpAssignment
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        destination_pool_name: Optional[str] = None,
        ip: Optional[str] = None) -> DedicatedIpAssignment
func GetDedicatedIpAssignment(ctx *Context, name string, id IDInput, state *DedicatedIpAssignmentState, opts ...ResourceOption) (*DedicatedIpAssignment, error)
public static DedicatedIpAssignment Get(string name, Input<string> id, DedicatedIpAssignmentState? state, CustomResourceOptions? opts = null)
public static DedicatedIpAssignment get(String name, Output<String> id, DedicatedIpAssignmentState state, CustomResourceOptions options)
resources:  _:    type: aws:sesv2:DedicatedIpAssignment    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:
DestinationPoolName Changes to this property will trigger replacement. string
Dedicated IP address.
Ip Changes to this property will trigger replacement. string
Dedicated IP address.
DestinationPoolName Changes to this property will trigger replacement. string
Dedicated IP address.
Ip Changes to this property will trigger replacement. string
Dedicated IP address.
destinationPoolName Changes to this property will trigger replacement. String
Dedicated IP address.
ip Changes to this property will trigger replacement. String
Dedicated IP address.
destinationPoolName Changes to this property will trigger replacement. string
Dedicated IP address.
ip Changes to this property will trigger replacement. string
Dedicated IP address.
destination_pool_name Changes to this property will trigger replacement. str
Dedicated IP address.
ip Changes to this property will trigger replacement. str
Dedicated IP address.
destinationPoolName Changes to this property will trigger replacement. String
Dedicated IP address.
ip Changes to this property will trigger replacement. String
Dedicated IP address.

Import

Using pulumi import, import SESv2 (Simple Email V2) Dedicated IP Assignment using the id, which is a comma-separated string made up of ip and destination_pool_name. For example:

$ pulumi import aws:sesv2/dedicatedIpAssignment:DedicatedIpAssignment example "0.0.0.0,my-pool"
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.