1. Packages
  2. AWS
  3. API Docs
  4. sesv2
  5. DedicatedIpPool
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.sesv2.DedicatedIpPool

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

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

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.sesv2.DedicatedIpPool("example", {poolName: "my-pool"});
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.sesv2.DedicatedIpPool("example", pool_name="my-pool")
    
    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.NewDedicatedIpPool(ctx, "example", &sesv2.DedicatedIpPoolArgs{
    			PoolName: pulumi.String("my-pool"),
    		})
    		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 example = new Aws.SesV2.DedicatedIpPool("example", new()
        {
            PoolName = "my-pool",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.sesv2.DedicatedIpPool;
    import com.pulumi.aws.sesv2.DedicatedIpPoolArgs;
    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 DedicatedIpPool("example", DedicatedIpPoolArgs.builder()
                .poolName("my-pool")
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:sesv2:DedicatedIpPool
        properties:
          poolName: my-pool
    

    Managed Pool

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.sesv2.DedicatedIpPool("example", {
        poolName: "my-managed-pool",
        scalingMode: "MANAGED",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.sesv2.DedicatedIpPool("example",
        pool_name="my-managed-pool",
        scaling_mode="MANAGED")
    
    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.NewDedicatedIpPool(ctx, "example", &sesv2.DedicatedIpPoolArgs{
    			PoolName:    pulumi.String("my-managed-pool"),
    			ScalingMode: pulumi.String("MANAGED"),
    		})
    		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 example = new Aws.SesV2.DedicatedIpPool("example", new()
        {
            PoolName = "my-managed-pool",
            ScalingMode = "MANAGED",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.sesv2.DedicatedIpPool;
    import com.pulumi.aws.sesv2.DedicatedIpPoolArgs;
    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 DedicatedIpPool("example", DedicatedIpPoolArgs.builder()
                .poolName("my-managed-pool")
                .scalingMode("MANAGED")
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:sesv2:DedicatedIpPool
        properties:
          poolName: my-managed-pool
          scalingMode: MANAGED
    

    Create DedicatedIpPool Resource

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

    Constructor syntax

    new DedicatedIpPool(name: string, args: DedicatedIpPoolArgs, opts?: CustomResourceOptions);
    @overload
    def DedicatedIpPool(resource_name: str,
                        args: DedicatedIpPoolArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def DedicatedIpPool(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        pool_name: Optional[str] = None,
                        scaling_mode: Optional[str] = None,
                        tags: Optional[Mapping[str, str]] = None)
    func NewDedicatedIpPool(ctx *Context, name string, args DedicatedIpPoolArgs, opts ...ResourceOption) (*DedicatedIpPool, error)
    public DedicatedIpPool(string name, DedicatedIpPoolArgs args, CustomResourceOptions? opts = null)
    public DedicatedIpPool(String name, DedicatedIpPoolArgs args)
    public DedicatedIpPool(String name, DedicatedIpPoolArgs args, CustomResourceOptions options)
    
    type: aws:sesv2:DedicatedIpPool
    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 DedicatedIpPoolArgs
    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 DedicatedIpPoolArgs
    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 DedicatedIpPoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DedicatedIpPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DedicatedIpPoolArgs
    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 dedicatedIpPoolResource = new Aws.SesV2.DedicatedIpPool("dedicatedIpPoolResource", new()
    {
        PoolName = "string",
        ScalingMode = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := sesv2.NewDedicatedIpPool(ctx, "dedicatedIpPoolResource", &sesv2.DedicatedIpPoolArgs{
    	PoolName:    pulumi.String("string"),
    	ScalingMode: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var dedicatedIpPoolResource = new DedicatedIpPool("dedicatedIpPoolResource", DedicatedIpPoolArgs.builder()
        .poolName("string")
        .scalingMode("string")
        .tags(Map.of("string", "string"))
        .build());
    
    dedicated_ip_pool_resource = aws.sesv2.DedicatedIpPool("dedicatedIpPoolResource",
        pool_name="string",
        scaling_mode="string",
        tags={
            "string": "string",
        })
    
    const dedicatedIpPoolResource = new aws.sesv2.DedicatedIpPool("dedicatedIpPoolResource", {
        poolName: "string",
        scalingMode: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:sesv2:DedicatedIpPool
    properties:
        poolName: string
        scalingMode: string
        tags:
            string: string
    

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

    PoolName string

    Name of the dedicated IP pool.

    The following arguments are optional:

    ScalingMode string
    IP pool scaling mode. Valid values: STANDARD, MANAGED. If omitted, the AWS API will default to a standard pool.
    Tags Dictionary<string, string>
    A map of tags to assign to the pool. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    PoolName string

    Name of the dedicated IP pool.

    The following arguments are optional:

    ScalingMode string
    IP pool scaling mode. Valid values: STANDARD, MANAGED. If omitted, the AWS API will default to a standard pool.
    Tags map[string]string
    A map of tags to assign to the pool. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    poolName String

    Name of the dedicated IP pool.

    The following arguments are optional:

    scalingMode String
    IP pool scaling mode. Valid values: STANDARD, MANAGED. If omitted, the AWS API will default to a standard pool.
    tags Map<String,String>
    A map of tags to assign to the pool. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    poolName string

    Name of the dedicated IP pool.

    The following arguments are optional:

    scalingMode string
    IP pool scaling mode. Valid values: STANDARD, MANAGED. If omitted, the AWS API will default to a standard pool.
    tags {[key: string]: string}
    A map of tags to assign to the pool. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    pool_name str

    Name of the dedicated IP pool.

    The following arguments are optional:

    scaling_mode str
    IP pool scaling mode. Valid values: STANDARD, MANAGED. If omitted, the AWS API will default to a standard pool.
    tags Mapping[str, str]
    A map of tags to assign to the pool. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    poolName String

    Name of the dedicated IP pool.

    The following arguments are optional:

    scalingMode String
    IP pool scaling mode. Valid values: STANDARD, MANAGED. If omitted, the AWS API will default to a standard pool.
    tags Map<String>
    A map of tags to assign to the pool. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    ARN of the Dedicated IP Pool.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    Arn string
    ARN of the Dedicated IP Pool.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    arn String
    ARN of the Dedicated IP Pool.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    arn string
    ARN of the Dedicated IP Pool.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    arn str
    ARN of the Dedicated IP Pool.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    arn String
    ARN of the Dedicated IP Pool.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    Look up Existing DedicatedIpPool Resource

    Get an existing DedicatedIpPool 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?: DedicatedIpPoolState, opts?: CustomResourceOptions): DedicatedIpPool
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            pool_name: Optional[str] = None,
            scaling_mode: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> DedicatedIpPool
    func GetDedicatedIpPool(ctx *Context, name string, id IDInput, state *DedicatedIpPoolState, opts ...ResourceOption) (*DedicatedIpPool, error)
    public static DedicatedIpPool Get(string name, Input<string> id, DedicatedIpPoolState? state, CustomResourceOptions? opts = null)
    public static DedicatedIpPool get(String name, Output<String> id, DedicatedIpPoolState 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:
    Arn string
    ARN of the Dedicated IP Pool.
    PoolName string

    Name of the dedicated IP pool.

    The following arguments are optional:

    ScalingMode string
    IP pool scaling mode. Valid values: STANDARD, MANAGED. If omitted, the AWS API will default to a standard pool.
    Tags Dictionary<string, string>
    A map of tags to assign to the pool. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    Arn string
    ARN of the Dedicated IP Pool.
    PoolName string

    Name of the dedicated IP pool.

    The following arguments are optional:

    ScalingMode string
    IP pool scaling mode. Valid values: STANDARD, MANAGED. If omitted, the AWS API will default to a standard pool.
    Tags map[string]string
    A map of tags to assign to the pool. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    arn String
    ARN of the Dedicated IP Pool.
    poolName String

    Name of the dedicated IP pool.

    The following arguments are optional:

    scalingMode String
    IP pool scaling mode. Valid values: STANDARD, MANAGED. If omitted, the AWS API will default to a standard pool.
    tags Map<String,String>
    A map of tags to assign to the pool. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    arn string
    ARN of the Dedicated IP Pool.
    poolName string

    Name of the dedicated IP pool.

    The following arguments are optional:

    scalingMode string
    IP pool scaling mode. Valid values: STANDARD, MANAGED. If omitted, the AWS API will default to a standard pool.
    tags {[key: string]: string}
    A map of tags to assign to the pool. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    arn str
    ARN of the Dedicated IP Pool.
    pool_name str

    Name of the dedicated IP pool.

    The following arguments are optional:

    scaling_mode str
    IP pool scaling mode. Valid values: STANDARD, MANAGED. If omitted, the AWS API will default to a standard pool.
    tags Mapping[str, str]
    A map of tags to assign to the pool. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    arn String
    ARN of the Dedicated IP Pool.
    poolName String

    Name of the dedicated IP pool.

    The following arguments are optional:

    scalingMode String
    IP pool scaling mode. Valid values: STANDARD, MANAGED. If omitted, the AWS API will default to a standard pool.
    tags Map<String>
    A map of tags to assign to the pool. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    Import

    Using pulumi import, import SESv2 (Simple Email V2) Dedicated IP Pool using the pool_name. For example:

    $ pulumi import aws:sesv2/dedicatedIpPool:DedicatedIpPool example my-pool
    

    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.60.0 published on Tuesday, Nov 19, 2024 by Pulumi