transformers

Creates, updates, deletes or gets a transformer resource or lists transformers in a region

Overview

Name	transformers
Type	Resource
Description	Definition of AWS::B2BI::Transformer Resource Type
Id	aws.b2bi.transformers

Fields

Name	Datatype	Description
created_at	string
edi_type	undefined
file_format	string
mapping_template	string
modified_at	string
name	string
sample_document	string
status	string
tags	array
transformer_arn	string
transformer_id	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	EdiType, FileFormat, MappingTemplate, Name, Status, 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 transformers in a region.

SELECT
region,
created_at,
edi_type,
file_format,
mapping_template,
modified_at,
name,
sample_document,
status,
tags,
transformer_arn,
transformer_id
FROM aws.b2bi.transformers
WHERE region = 'us-east-1';

Gets all properties from an individual transformer.

SELECT
region,
created_at,
edi_type,
file_format,
mapping_template,
modified_at,
name,
sample_document,
status,
tags,
transformer_arn,
transformer_id
FROM aws.b2bi.transformers
WHERE region = 'us-east-1' AND data__Identifier = '<TransformerId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.b2bi.transformers (
 EdiType,
 FileFormat,
 MappingTemplate,
 Name,
 Status,
 region
)
SELECT 
'{{ EdiType }}',
 '{{ FileFormat }}',
 '{{ MappingTemplate }}',
 '{{ Name }}',
 '{{ Status }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.b2bi.transformers (
 EdiType,
 FileFormat,
 MappingTemplate,
 Name,
 SampleDocument,
 Status,
 Tags,
 region
)
SELECT 
 '{{ EdiType }}',
 '{{ FileFormat }}',
 '{{ MappingTemplate }}',
 '{{ Name }}',
 '{{ SampleDocument }}',
 '{{ Status }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: transformer
    props:
      - name: EdiType
        value: null
      - name: FileFormat
        value: '{{ FileFormat }}'
      - name: MappingTemplate
        value: '{{ MappingTemplate }}'
      - name: Name
        value: '{{ Name }}'
      - name: SampleDocument
        value: '{{ SampleDocument }}'
      - name: Status
        value: '{{ Status }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.b2bi.transformers
WHERE data__Identifier = '<TransformerId>'
AND region = 'us-east-1';

Permissions

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

Create

b2bi:CreateTransformer,
b2bi:TagResource,
b2bi:UpdateTransformer,
logs:CreateLogDelivery,
logs:CreateLogGroup,
logs:CreateLogStream,
logs:DescribeLogGroups,
logs:DescribeLogStreams,
logs:DescribeResourcePolicies,
logs:ListLogDeliveries,
logs:PutLogEvents,
logs:PutResourcePolicy

Read

b2bi:GetTransformer,
b2bi:ListTagsForResource

Update

b2bi:TagResource,
b2bi:UntagResource,
b2bi:UpdateTransformer

Delete

b2bi:DeleteTransformer,
logs:DeleteLogDelivery,
logs:ListLogDeliveries

List

b2bi:ListTransformers