AWS::B2BI::Transformer - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::B2BI::Transformer

Creates a transformer. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::B2BI::Transformer",
  "Properties" : {
      "EdiType" : EdiType,
      "FileFormat" : String,
      "MappingTemplate" : String,
      "Name" : String,
      "SampleDocument" : String,
      "Status" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::B2BI::Transformer
Properties:
  EdiType: 
    EdiType
  FileFormat: String
  MappingTemplate: String
  Name: String
  SampleDocument: String
  Status: String
  Tags: 
    - Tag

Properties

EdiType

Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

Required: Yes

Type: EdiType

Update requires: No interruption

FileFormat

Returns that the currently supported file formats for EDI transformations are JSON and XML.

Required: Yes

Type: String

Allowed values: XML | JSON

Update requires: No interruption

MappingTemplate

Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

Required: Yes

Type: String

Minimum: 0

Maximum: 350000

Update requires: No interruption

Name

Returns the descriptive name for the transformer.

Required: Yes

Type: String

Minimum: 1

Maximum: 254

Update requires: No interruption

SampleDocument

Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

Required: No

Type: String

Minimum: 0

Maximum: 1024

Update requires: No interruption

Status

Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.

Required: Yes

Type: String

Allowed values: active | inactive

Update requires: No interruption

Tags

A key-value pair for a specific transformer. Tags are metadata that you can use to search for and group capabilities for various purposes.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: No interruption

Return values

Ref

Fn::GetAtt

CreatedAt

Returns a timestamp indicating when the transformer was created. For example, 2023-07-20T19:58:44.624Z.

ModifiedAt

Returns a timestamp representing the date and time for the most recent change for the transformer object.

TransformerArn

Returns an Amazon Resource Name (ARN) for a specific transformer.

TransformerId

The system-assigned unique identifier for the transformer.