dedicated_ip_pools

Creates, updates, deletes, gets or lists a dedicated_ip_pools resource.

Overview

Name	dedicated_ip_pools
Type	Resource
Id	aws.sesv2.dedicated_ip_pools

Fields

The following fields are returned by SELECT queries:

get_dedicated_ip_pool

Name	Datatype	Description
pool_name	string	The name of a dedicated IP pool.
scaling_mode	string	The type of the dedicated IP pool. STANDARD – A dedicated IP pool where you can control which IPs are part of the pool. MANAGED – A dedicated IP pool where the reputation and number of IPs are automatically managed by Amazon SES. (STANDARD, MANAGED)

list_dedicated_ip_pools

Name	Datatype	Description
dedicated_ip_pool	string	A list of all of the dedicated IP pools that are associated with your Amazon Web Services account in the current Region.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_dedicated_ip_pool	select	pool_name, region		Retrieve information about the dedicated pool.
list_dedicated_ip_pools	select	region	NextToken, PageSize	List all of the dedicated IP pools that exist in your Amazon Web Services account in the current Region.
create_dedicated_ip_pool	insert	region, PoolName		Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your Amazon Web Services account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, the message is sent from one of the addresses in the associated pool.
put_dedicated_ip_pool_scaling_attributes	replace	pool_name, region, ScalingMode		Used to convert a dedicated IP pool to a different scaling mode. MANAGED pools cannot be converted to STANDARD scaling mode.
delete_dedicated_ip_pool	delete	pool_name, region		Delete a dedicated IP pool.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
pool_name	string	The name of the dedicated IP pool that you want to delete.
region	string	AWS region (default: us-east-1)
NextToken	string	A token returned from a previous call to ListDedicatedIpPools to indicate the position in the list of dedicated IP pools.
PageSize	integer	The number of results to show in a single call to ListDedicatedIpPools. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

SELECT examples

get_dedicated_ip_pool

Retrieve information about the dedicated pool.

SELECT
pool_name,
scaling_mode
FROM aws.sesv2.dedicated_ip_pools
WHERE pool_name = '{{ pool_name }}' -- required
AND region = '{{ region }}' -- required
;

list_dedicated_ip_pools

List all of the dedicated IP pools that exist in your Amazon Web Services account in the current Region.

SELECT
dedicated_ip_pool
FROM aws.sesv2.dedicated_ip_pools
WHERE region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND PageSize = '{{ PageSize }}'
;

INSERT examples

create_dedicated_ip_pool

Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your Amazon Web Services account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, the message is sent from one of the addresses in the associated pool.

INSERT INTO aws.sesv2.dedicated_ip_pools (
PoolName,
Tags,
ScalingMode,
region
)
SELECT 
'{{ PoolName }}' /* required */,
'{{ Tags }}',
'{{ ScalingMode }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: dedicated_ip_pools
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the dedicated_ip_pools resource.
  - name: PoolName
    value: "{{ PoolName }}"
    description: |
      The name of a dedicated IP pool.
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: ScalingMode
    value: "{{ ScalingMode }}"
    valid_values: ['STANDARD', 'MANAGED']

REPLACE examples

put_dedicated_ip_pool_scaling_attributes

Used to convert a dedicated IP pool to a different scaling mode. MANAGED pools cannot be converted to STANDARD scaling mode.

REPLACE aws.sesv2.dedicated_ip_pools
SET 
ScalingMode = '{{ ScalingMode }}'
WHERE 
pool_name = '{{ pool_name }}' --required
AND region = '{{ region }}' --required
AND ScalingMode = '{{ ScalingMode }}' --required;

DELETE examples

delete_dedicated_ip_pool

Delete a dedicated IP pool.

DELETE FROM aws.sesv2.dedicated_ip_pools
WHERE pool_name = '{{ pool_name }}' --required
AND region = '{{ region }}' --required
;