entity_types

Creates, updates, deletes or gets an entity_type resource or lists entity_types in a region

Overview

Name	entity_types
Type	Resource
Description	An entity type for fraud detector.
Id	awscc.frauddetector.entity_types

Fields

get (all properties)

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

list (identifiers only)

Name	Datatype	Description
arn	string	The entity type ARN.
region	string	AWS region.

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

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual entity_type.

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

list (identifiers only)

Lists all entity_types in a region.

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

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.frauddetector.entity_types (
  Name,
  Tags,
  Description,
  region
)
SELECT
  '{{ name }}',
  '{{ tags }}',
  '{{ description }}',
  '{{ 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: entity_type
  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 entity_type resource, using stack-deploy.

/*+ update */
UPDATE awscc.frauddetector.entity_types
SET PatchDocument = string('{{ {
    "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.entity_types
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 entity_types resource, the following permissions are required:

Create

frauddetector:GetEntityTypes,
frauddetector:PutEntityType,
frauddetector:ListTagsForResource,
frauddetector:TagResource

Read

frauddetector:GetEntityTypes,
frauddetector:ListTagsForResource

Update

frauddetector:GetEntityTypes,
frauddetector:PutEntityType,
frauddetector:ListTagsForResource,
frauddetector:TagResource,
frauddetector:UntagResource

Delete

frauddetector:GetEntityTypes,
frauddetector:DeleteEntityType

List

frauddetector:GetEntityTypes,
frauddetector:ListTagsForResource