AWS::B2BI::Transformer - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::B2BI::Transformer

Creates a transformer. AWS B2B Data Interchange currently supports two scenarios:

  • Inbound EDI: the AWS customer receives an EDI file from their trading partner. AWS B2B Data Interchange converts this EDI file into a JSON or XML file with a service-defined structure. A mapping template provided by the customer, in JSONata or XSLT format, is optionally applied to this file to produce a JSON or XML file with the structure the customer requires.

  • Outbound EDI: the AWS customer has a JSON or XML file containing data that they wish to use in an EDI file. A mapping template, provided by the customer (in either JSONata or XSLT format) is applied to this file to generate a JSON or XML file in the service-defined structure. This file is then converted to an EDI file.

Note

The following fields are provided for backwards compatibility only: fileFormat, mappingTemplate, ediType, and sampleDocument.

  • Use the mapping data type in place of mappingTemplate and fileFormat

  • Use the sampleDocuments data type in place of sampleDocument

  • Use either the inputConversion or outputConversion in place of ediType

Syntax

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

JSON

{
  "Type" : "AWS::B2BI::Transformer",
  "Properties" : {
      "InputConversion" : InputConversion,
      "Mapping" : Mapping,
      "Name" : String,
      "OutputConversion" : OutputConversion,
      "SampleDocuments" : SampleDocuments,
      "Status" : String,
      "Tags" : [ Tag, ... ]
    }
}

Properties

InputConversion

Returns a structure that contains the format options for the transformation.

Required: No

Type: InputConversion

Update requires: No interruption

Mapping

Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).

Required: No

Type: Mapping

Update requires: No interruption

Name

Returns the descriptive name for the transformer.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,512}$

Minimum: 1

Maximum: 254

Update requires: No interruption

OutputConversion

Returns the OutputConversion object, which contains the format options for the outbound transformation.

Required: No

Type: OutputConversion

Update requires: No interruption

SampleDocuments

Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.

Required: No

Type: SampleDocuments

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.