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	aws.frauddetector.lists

Fields

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.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all lists in a region.

SELECT
region,
arn,
name,
description,
variable_type,
created_time,
last_updated_time,
tags,
elements
FROM aws.frauddetector.lists
WHERE region = 'us-east-1';

Gets all properties from an individual list.

SELECT
region,
arn,
name,
description,
variable_type,
created_time,
last_updated_time,
tags,
elements
FROM aws.frauddetector.lists
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.frauddetector.lists (
 Name,
 region
)
SELECT 
'{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.frauddetector.lists (
 Name,
 Description,
 VariableType,
 Tags,
 Elements,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Description }}',
 '{{ VariableType }}',
 '{{ Tags }}',
 '{{ Elements }}',
 '{{ region }}';

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: VariableType
        value: '{{ VariableType }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: Elements
        value:
          - '{{ Elements[0] }}'

DELETE example

/*+ delete */
DELETE FROM aws.frauddetector.lists
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

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