lists

Creates, updates, deletes or gets a list resource or lists lists in a region

Overview

Name	lists
Type	Resource
Description	A resource schema for a List in Amazon Fraud Detector.
Id	awscc.frauddetector.lists

Fields

get (all properties)

Name	Datatype	Description
arn	string	The list ARN.
name	string	The name of the list.
description	string	The description of the list.
variable_type	string	The variable type of the list.
created_time	string	The time when the list was created.
last_updated_time	string	The time when the list was last updated.
▶tags	array	Tags associated with this list.
elements	array	The elements in this list.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string	The list ARN.
region	string	AWS region.

For more information, see AWS::FraudDetector::List.

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual list.

SELECT
  region,
  arn,
  name,
  description,
  variable_type,
  created_time,
  last_updated_time,
  tags,
  elements
FROM awscc.frauddetector.lists
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all lists in a region.

SELECT
  region,
  arn
FROM awscc.frauddetector.lists_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.frauddetector.lists (
  Name,
  region
)
SELECT
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.frauddetector.lists (
  Name,
  Description,
  VariableType,
  Tags,
  Elements,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ variable_type }}',
  '{{ tags }}',
  '{{ elements }}',
  '{{ 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: list
  props:
    - name: name
      value: '{{ name }}'
    - name: description
      value: '{{ description }}'
    - name: variable_type
      value: '{{ variable_type }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: elements
      value:
        - '{{ elements[0] }}'

UPDATE example

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

/*+ update */
UPDATE awscc.frauddetector.lists
SET PatchDocument = string('{{ {
    "Description": description,
    "VariableType": variable_type,
    "Tags": tags,
    "Elements": elements
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

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

Create

frauddetector:CreateList,
frauddetector:GetListElements,
frauddetector:GetListsMetadata,
frauddetector:ListTagsForResource,
frauddetector:TagResource,
frauddetector:UpdateList

Read

frauddetector:GetListElements,
frauddetector:GetListsMetadata,
frauddetector:ListTagsForResource

Update

frauddetector:GetListElements,
frauddetector:GetListsMetadata,
frauddetector:ListTagsForResource,
frauddetector:UntagResource,
frauddetector:UpdateList,
frauddetector:TagResource

Delete

frauddetector:DeleteList,
frauddetector:GetListsMetadata

List

frauddetector:GetListElements,
frauddetector:GetListsMetadata,
frauddetector:ListTagsForResource