labels

Creates, updates, deletes or gets a label resource or lists labels in a region

Overview

Name	labels
Type	Resource
Description	An label for fraud detector.
Id	awscc.frauddetector.labels

Fields

get (all properties)

Name	Datatype	Description
name	string	The name of the label.
▶tags	array	Tags associated with this label.
description	string	The label description.
arn	string	The label ARN.
created_time	string	The timestamp when the label was created.
last_updated_time	string	The timestamp when the label was last updated.
region	string	AWS region.

list (identifiers only)

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

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

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual label.

SELECT
  region,
  name,
  tags,
  description,
  arn,
  created_time,
  last_updated_time
FROM awscc.frauddetector.labels
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all labels in a region.

SELECT
  region,
  arn
FROM awscc.frauddetector.labels_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.frauddetector.labels (
  Name,
  region
)
SELECT
  '{{ name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.frauddetector.labels (
  Name,
  Tags,
  Description,
  region
)
SELECT
  '{{ name }}',
  '{{ tags }}',
  '{{ description }}',
  '{{ region }}';

Manifest

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

UPDATE example

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

/*+ update */
UPDATE awscc.frauddetector.labels
SET PatchDocument = string('{{ {
    "Tags": tags,
    "Description": description
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.frauddetector.labels
WHERE
  Identifier = '{{ arn }}' AND
  region = 'us-east-1';

Permissions

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

Create

frauddetector:GetLabels,
frauddetector:PutLabel,
frauddetector:ListTagsForResource,
frauddetector:TagResource

Read

frauddetector:GetLabels,
frauddetector:ListTagsForResource

Update

frauddetector:GetLabels,
frauddetector:PutLabel,
frauddetector:ListTagsForResource,
frauddetector:TagResource,
frauddetector:UntagResource

Delete

frauddetector:GetLabels,
frauddetector:DeleteLabel

List

frauddetector:GetLabels,
frauddetector:ListTagsForResource