dedicated_ip_pools

Creates, updates, deletes or gets a dedicated_ip_pool resource or lists dedicated_ip_pools in a region

Overview

Name	dedicated_ip_pools
Type	Resource
Description	Resource Type definition for AWS::SES::DedicatedIpPool
Id	awscc.ses.dedicated_ip_pools

Fields

get (all properties)

Name	Datatype	Description
pool_name	string	The name of the dedicated IP pool.
scaling_mode	string	Specifies whether the dedicated IP pool is managed or not. The default value is STANDARD.
▶tags	array	The tags (keys and values) associated with the dedicated IP pool.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
pool_name	string	The name of the dedicated IP pool.
region	string	AWS region.

For more information, see AWS::SES::DedicatedIpPool.

Methods

Name	Resource	Accessible by	Required Params
create_resource	dedicated_ip_pools	INSERT	region
delete_resource	dedicated_ip_pools	DELETE	Identifier, region
update_resource	dedicated_ip_pools	UPDATE	Identifier, PatchDocument, region
list_resources	dedicated_ip_pools_list_only	SELECT	region
get_resource	dedicated_ip_pools	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual dedicated_ip_pool.

SELECT
  region,
  pool_name,
  scaling_mode,
  tags
FROM awscc.ses.dedicated_ip_pools
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ pool_name }}';

list (identifiers only)

Lists all dedicated_ip_pools in a region.

SELECT
  region,
  pool_name
FROM awscc.ses.dedicated_ip_pools_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new dedicated_ip_pool resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.ses.dedicated_ip_pools (
  PoolName,
  ScalingMode,
  Tags,
  region
)
SELECT
  '{{ pool_name }}',
  '{{ scaling_mode }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ses.dedicated_ip_pools (
  PoolName,
  ScalingMode,
  Tags,
  region
)
SELECT
  '{{ pool_name }}',
  '{{ scaling_mode }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: dedicated_ip_pool
  props:
    - name: pool_name
      value: '{{ pool_name }}'
    - name: scaling_mode
      value: '{{ scaling_mode }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a dedicated_ip_pool resource, using stack-deploy.

/*+ update */
UPDATE awscc.ses.dedicated_ip_pools
SET PatchDocument = string('{{ {
    "ScalingMode": scaling_mode,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ pool_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ses.dedicated_ip_pools
WHERE
  Identifier = '{{ pool_name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the dedicated_ip_pools resource, the following permissions are required:

Create

ses:CreateDedicatedIpPool,
ses:GetDedicatedIpPool,
ses:GetDedicatedIps,
ses:TagResource,
ses:UntagResource

Read

ses:GetDedicatedIpPool,
ses:GetDedicatedIps,
ses:ListTagsForResource

Update

ses:PutDedicatedIpPoolScalingAttributes,
ses:GetDedicatedIpPool,
ses:TagResource,
ses:UntagResource,
ses:ListTagsForResource

Delete

ses:DeleteDedicatedIpPool

List

ses:ListDedicatedIpPools