AWS Classic v5.32.0, Mar 17 23

aws.sesv2.getDedicatedIpPool

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

Example Usage

Basic Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.SesV2.GetDedicatedIpPool.Invoke(new()
    {
        PoolName = "my-pool",
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sesv2.LookupDedicatedIpPool(ctx, &sesv2.LookupDedicatedIpPoolArgs{
			PoolName: "my-pool",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sesv2.Sesv2Functions;
import com.pulumi.aws.sesv2.inputs.GetDedicatedIpPoolArgs;
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) {
        final var example = Sesv2Functions.getDedicatedIpPool(GetDedicatedIpPoolArgs.builder()
            .poolName("my-pool")
            .build());

    }
}

import pulumi
import pulumi_aws as aws

example = aws.sesv2.get_dedicated_ip_pool(pool_name="my-pool")

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

const example = aws.sesv2.getDedicatedIpPool({
    poolName: "my-pool",
});

variables:
  example:
    fn::invoke:
      Function: aws:sesv2:getDedicatedIpPool
      Arguments:
        poolName: my-pool

Using getDedicatedIpPool

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDedicatedIpPool(args: GetDedicatedIpPoolArgs, opts?: InvokeOptions): Promise<GetDedicatedIpPoolResult>
function getDedicatedIpPoolOutput(args: GetDedicatedIpPoolOutputArgs, opts?: InvokeOptions): Output<GetDedicatedIpPoolResult>

def get_dedicated_ip_pool(pool_name: Optional[str] = None,
                          tags: Optional[Mapping[str, str]] = None,
                          opts: Optional[InvokeOptions] = None) -> GetDedicatedIpPoolResult
def get_dedicated_ip_pool_output(pool_name: Optional[pulumi.Input[str]] = None,
                          tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetDedicatedIpPoolResult]

func LookupDedicatedIpPool(ctx *Context, args *LookupDedicatedIpPoolArgs, opts ...InvokeOption) (*LookupDedicatedIpPoolResult, error)
func LookupDedicatedIpPoolOutput(ctx *Context, args *LookupDedicatedIpPoolOutputArgs, opts ...InvokeOption) LookupDedicatedIpPoolResultOutput

> Note: This function is named LookupDedicatedIpPool in the Go SDK.

public static class GetDedicatedIpPool 
{
    public static Task<GetDedicatedIpPoolResult> InvokeAsync(GetDedicatedIpPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetDedicatedIpPoolResult> Invoke(GetDedicatedIpPoolInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDedicatedIpPoolResult> getDedicatedIpPool(GetDedicatedIpPoolArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws:sesv2/getDedicatedIpPool:getDedicatedIpPool
  arguments:
    # arguments dictionary

The following arguments are supported:

PoolName string: Name of the dedicated IP pool.
Tags Dictionary<string, string>: A map of tags attached to the pool.

PoolName string: Name of the dedicated IP pool.
Tags map[string]string: A map of tags attached to the pool.

poolName String: Name of the dedicated IP pool.
tags Map<String,String>: A map of tags attached to the pool.

poolName string: Name of the dedicated IP pool.
tags {[key: string]: string}: A map of tags attached to the pool.

pool_name str: Name of the dedicated IP pool.
tags Mapping[str, str]: A map of tags attached to the pool.

poolName String: Name of the dedicated IP pool.
tags Map<String>: A map of tags attached to the pool.

getDedicatedIpPool Result

The following output properties are available:

Arn string: ARN of the Dedicated IP Pool.
DedicatedIps List<GetDedicatedIpPoolDedicatedIp>: A list of objects describing the pool's dedicated IP's. See dedicated_ips.
Id string: The provider-assigned unique ID for this managed resource.
PoolName string
ScalingMode string: (Optional) IP pool scaling mode. Valid values: STANDARD, MANAGED.
Tags Dictionary<string, string>: A map of tags attached to the pool.

Arn string: ARN of the Dedicated IP Pool.
DedicatedIps []GetDedicatedIpPoolDedicatedIp: A list of objects describing the pool's dedicated IP's. See dedicated_ips.
Id string: The provider-assigned unique ID for this managed resource.
PoolName string
ScalingMode string: (Optional) IP pool scaling mode. Valid values: STANDARD, MANAGED.
Tags map[string]string: A map of tags attached to the pool.

arn String: ARN of the Dedicated IP Pool.
dedicatedIps List<GetDedicatedIpPoolDedicatedIp>: A list of objects describing the pool's dedicated IP's. See dedicated_ips.
id String: The provider-assigned unique ID for this managed resource.
poolName String
scalingMode String: (Optional) IP pool scaling mode. Valid values: STANDARD, MANAGED.
tags Map<String,String>: A map of tags attached to the pool.

arn string: ARN of the Dedicated IP Pool.
dedicatedIps GetDedicatedIpPoolDedicatedIp[]: A list of objects describing the pool's dedicated IP's. See dedicated_ips.
id string: The provider-assigned unique ID for this managed resource.
poolName string
scalingMode string: (Optional) IP pool scaling mode. Valid values: STANDARD, MANAGED.
tags {[key: string]: string}: A map of tags attached to the pool.

arn str: ARN of the Dedicated IP Pool.
dedicated_ips Sequence[GetDedicatedIpPoolDedicatedIp]: A list of objects describing the pool's dedicated IP's. See dedicated_ips.
id str: The provider-assigned unique ID for this managed resource.
pool_name str
scaling_mode str: (Optional) IP pool scaling mode. Valid values: STANDARD, MANAGED.
tags Mapping[str, str]: A map of tags attached to the pool.

arn String: ARN of the Dedicated IP Pool.
dedicatedIps List<Property Map>: A list of objects describing the pool's dedicated IP's. See dedicated_ips.
id String: The provider-assigned unique ID for this managed resource.
poolName String
scalingMode String: (Optional) IP pool scaling mode. Valid values: STANDARD, MANAGED.
tags Map<String>: A map of tags attached to the pool.

Supporting Types

GetDedicatedIpPoolDedicatedIp

Ip string: IPv4 address.
WarmupPercentage int: Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.
WarmupStatus string: The warm-up status of a dedicated IP address. Valid values: IN_PROGRESS, DONE.

Ip string: IPv4 address.
WarmupPercentage int: Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.
WarmupStatus string: The warm-up status of a dedicated IP address. Valid values: IN_PROGRESS, DONE.

ip String: IPv4 address.
warmupPercentage Integer: Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.
warmupStatus String: The warm-up status of a dedicated IP address. Valid values: IN_PROGRESS, DONE.

ip string: IPv4 address.
warmupPercentage number: Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.
warmupStatus string: The warm-up status of a dedicated IP address. Valid values: IN_PROGRESS, DONE.

ip str: IPv4 address.
warmup_percentage int: Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.
warmup_status str: The warm-up status of a dedicated IP address. Valid values: IN_PROGRESS, DONE.

ip String: IPv4 address.
warmupPercentage Number: Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.
warmupStatus String: The warm-up status of a dedicated IP address. Valid values: IN_PROGRESS, DONE.

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.