detectors

Creates, updates, deletes or gets a detector resource or lists detectors in a region

Overview

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

Fields

get (all properties)

Name	Datatype	Description
detector_id	string	The ID of the detector
detector_version_status	string	The desired detector version status for the detector
detector_version_id	string	The active version ID of the detector
rule_execution_mode	string
▶tags	array	Tags associated with this detector.
description	string	The description of the detector.
▶rules	array
▶event_type	object	The event type to associate this detector with.
arn	string	The ARN of the detector.
created_time	string	The time when the detector was created.
last_updated_time	string	The time when the detector was last updated.
▶associated_models	array	The models to associate with this detector.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string	The ARN of the detector.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	detectors	INSERT	DetectorId, EventType, Rules, region
delete_resource	detectors	DELETE	Identifier, region
update_resource	detectors	UPDATE	Identifier, PatchDocument, region
list_resources	detectors_list_only	SELECT	region
get_resource	detectors	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual detector.

SELECT
  region,
  detector_id,
  detector_version_status,
  detector_version_id,
  rule_execution_mode,
  tags,
  description,
  rules,
  event_type,
  arn,
  created_time,
  last_updated_time,
  associated_models
FROM awscc.frauddetector.detectors
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all detectors in a region.

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

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.frauddetector.detectors (
  DetectorId,
  Rules,
  EventType,
  region
)
SELECT
  '{{ detector_id }}',
  '{{ rules }}',
  '{{ event_type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.frauddetector.detectors (
  DetectorId,
  DetectorVersionStatus,
  RuleExecutionMode,
  Tags,
  Description,
  Rules,
  EventType,
  AssociatedModels,
  region
)
SELECT
  '{{ detector_id }}',
  '{{ detector_version_status }}',
  '{{ rule_execution_mode }}',
  '{{ tags }}',
  '{{ description }}',
  '{{ rules }}',
  '{{ event_type }}',
  '{{ associated_models }}',
  '{{ 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: detector
  props:
    - name: detector_id
      value: '{{ detector_id }}'
    - name: detector_version_status
      value: '{{ detector_version_status }}'
    - name: rule_execution_mode
      value: '{{ rule_execution_mode }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: description
      value: '{{ description }}'
    - name: rules
      value:
        - rule_id: '{{ rule_id }}'
          rule_version: '{{ rule_version }}'
          detector_id: '{{ detector_id }}'
          expression: '{{ expression }}'
          language: '{{ language }}'
          outcomes:
            - name: '{{ name }}'
              tags:
                - null
              description: '{{ description }}'
          arn: '{{ arn }}'
          description: '{{ description }}'
          tags:
            - null
          created_time: '{{ created_time }}'
          last_updated_time: '{{ last_updated_time }}'
    - name: event_type
      value:
        name: '{{ name }}'
        tags:
          - null
        description: '{{ description }}'
        event_variables:
          - arn: '{{ arn }}'
            inline: '{{ inline }}'
            name: '{{ name }}'
            data_source: '{{ data_source }}'
            data_type: '{{ data_type }}'
            default_value: '{{ default_value }}'
            variable_type: '{{ variable_type }}'
            description: '{{ description }}'
            tags:
              - null
            created_time: '{{ created_time }}'
            last_updated_time: '{{ last_updated_time }}'
        labels:
          - name: '{{ name }}'
            tags:
              - null
            description: '{{ description }}'
        entity_types:
          - arn: '{{ arn }}'
            inline: '{{ inline }}'
            name: '{{ name }}'
            description: '{{ description }}'
            tags:
              - null
            created_time: '{{ created_time }}'
            last_updated_time: '{{ last_updated_time }}'
    - name: associated_models
      value:
        - arn: '{{ arn }}'

UPDATE example

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

/*+ update */
UPDATE awscc.frauddetector.detectors
SET PatchDocument = string('{{ {
    "DetectorVersionStatus": detector_version_status,
    "RuleExecutionMode": rule_execution_mode,
    "Tags": tags,
    "Description": description
} | 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.detectors
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 detectors resource, the following permissions are required:

Create

frauddetector:PutDetector,
frauddetector:CreateDetectorVersion,
frauddetector:UpdateDetectorVersionStatus,
frauddetector:CreateRule,
frauddetector:CreateVariable,
frauddetector:PutLabel,
frauddetector:PutOutcome,
frauddetector:PutEntityType,
frauddetector:PutEventType,
frauddetector:DescribeDetector,
frauddetector:GetDetectors,
frauddetector:GetDetectorVersion,
frauddetector:GetRules,
frauddetector:GetVariables,
frauddetector:GetEventTypes,
frauddetector:GetExternalModels,
frauddetector:GetModelVersion,
frauddetector:GetLabels,
frauddetector:GetOutcomes,
frauddetector:GetEntityTypes,
frauddetector:ListTagsForResource

Update

frauddetector:GetDetectors,
frauddetector:GetDetectorVersion,
frauddetector:PutDetector,
frauddetector:UpdateDetectorVersion,
frauddetector:UpdateDetectorVersionStatus,
frauddetector:UpdateDetectorVersionMetadata,
frauddetector:UpdateRuleVersion,
frauddetector:UpdateRuleMetadata,
frauddetector:CreateRule,
frauddetector:CreateVariable,
frauddetector:UpdateVariable,
frauddetector:GetVariables,
frauddetector:PutLabel,
frauddetector:PutOutcome,
frauddetector:PutEntityType,
frauddetector:PutEventType,
frauddetector:GetRules,
frauddetector:GetEventTypes,
frauddetector:GetLabels,
frauddetector:GetOutcomes,
frauddetector:GetEntityTypes,
frauddetector:GetExternalModels,
frauddetector:GetModelVersion,
frauddetector:DeleteEventType,
frauddetector:DeleteVariable,
frauddetector:DeleteLabel,
frauddetector:DeleteEntityType,
frauddetector:ListTagsForResource,
frauddetector:TagResource,
frauddetector:UntagResource

Delete

frauddetector:GetDetectors,
frauddetector:GetDetectorVersion,
frauddetector:DescribeDetector,
frauddetector:GetRules,
frauddetector:GetVariables,
frauddetector:GetEventTypes,
frauddetector:GetLabels,
frauddetector:GetOutcomes,
frauddetector:GetEntityTypes,
frauddetector:DeleteDetector,
frauddetector:DeleteDetectorVersion,
frauddetector:DeleteRule,
frauddetector:DeleteEventType,
frauddetector:DeleteVariable,
frauddetector:DeleteLabel,
frauddetector:DeleteOutcome,
frauddetector:DeleteEntityType,
frauddetector:ListTagsForResource

Read

frauddetector:GetDetectors,
frauddetector:GetDetectorVersion,
frauddetector:DescribeDetector,
frauddetector:GetRules,
frauddetector:GetVariables,
frauddetector:GetEventTypes,
frauddetector:GetExternalModels,
frauddetector:GetModelVersion,
frauddetector:GetLabels,
frauddetector:GetOutcomes,
frauddetector:GetEntityTypes,
frauddetector:ListTagsForResource

List

frauddetector:GetDetectors,
frauddetector:GetDetectorVersion,
frauddetector:DescribeDetector,
frauddetector:GetRules,
frauddetector:GetVariables,
frauddetector:GetEventTypes,
frauddetector:GetExternalModels,
frauddetector:GetModelVersion,
frauddetector:GetLabels,
frauddetector:GetOutcomes,
frauddetector:GetEntityTypes,
frauddetector:ListTagsForResource