vdm_attributes

Creates, updates, deletes or gets a vdm_attribute resource or lists vdm_attributes in a region

Overview

Name	vdm_attributes
Type	Resource
Description	Resource Type definition for AWS::SES::VdmAttributes
Id	awscc.ses.vdm_attributes

Fields

Name	Datatype	Description
vdm_attributes_resource_id	string	Unique identifier for this resource
▶dashboard_attributes	object	Preferences regarding the Dashboard feature.
▶guardian_attributes	object	Preferences regarding the Guardian feature.
region	string	AWS region.

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

Methods

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

SELECT examples

Gets all properties from an individual vdm_attribute.

SELECT
  region,
  vdm_attributes_resource_id,
  dashboard_attributes,
  guardian_attributes
FROM awscc.ses.vdm_attributes
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ vdm_attributes_resource_id }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ses.vdm_attributes (
  DashboardAttributes,
  GuardianAttributes,
  region
)
SELECT
  '{{ dashboard_attributes }}',
  '{{ guardian_attributes }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ses.vdm_attributes (
  DashboardAttributes,
  GuardianAttributes,
  region
)
SELECT
  '{{ dashboard_attributes }}',
  '{{ guardian_attributes }}',
  '{{ 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: vdm_attribute
  props:
    - name: dashboard_attributes
      value:
        engagement_metrics: '{{ engagement_metrics }}'
    - name: guardian_attributes
      value:
        optimized_shared_delivery: '{{ optimized_shared_delivery }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ses.vdm_attributes
SET PatchDocument = string('{{ {
    "DashboardAttributes": dashboard_attributes,
    "GuardianAttributes": guardian_attributes
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ vdm_attributes_resource_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ses.vdm_attributes
WHERE
  Identifier = '{{ vdm_attributes_resource_id }}' 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 vdm_attributes resource, the following permissions are required:

Create

ses:PutAccountVdmAttributes,
ses:GetAccount

Read

ses:GetAccount

Update

ses:PutAccountVdmAttributes,
ses:GetAccount

Delete

ses:PutAccountVdmAttributes,
ses:GetAccount