AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::B2BI::Transformer

CfnTransformer

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. > 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`

Import

import { CfnTransformer } from 'aws-cdk-lib/aws-b2bi';

Or use the module namespace:

import * as b2bi from 'aws-cdk-lib/aws-b2bi';
// b2bi.CfnTransformer

Properties

Configuration passed to the constructor as CfnTransformerProps.

nameRequired
string

Returns the descriptive name for the transformer.

statusRequired
string

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` .

ediTypeOptionalDeprecated
IResolvable | EdiTypeProperty

Deprecated: this property has been deprecated

fileFormatOptionalDeprecated
string

Deprecated: this property has been deprecated

inputConversionOptional
IResolvable | InputConversionProperty

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

mappingOptional
IResolvable | MappingProperty

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

mappingTemplateOptionalDeprecated
string

This shape is deprecated: This is a legacy trait. Please use input-conversion or output-conversion.

Deprecated: this property has been deprecated

outputConversionOptional
IResolvable | OutputConversionProperty

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

sampleDocumentOptionalDeprecated
string

This shape is deprecated: This is a legacy trait. Please use input-conversion or output-conversion.

Deprecated: this property has been deprecated

sampleDocumentsOptional
IResolvable | SampleDocumentsProperty

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.

tagsOptional
CfnTag[]

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

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::B2BI::TransformerView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-b2bi
CFN TypeAWS::B2BI::Transformer
Properties11

Related Constructs

Explore This Service

External Links