Package software.amazon.awscdk.cfnpropertymixins.services.b2bi

Class CfnTransformerPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.b2bi.CfnTransformerPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:56.254Z")
@Stability(Stable)
public class CfnTransformerPropsMixin
extends Mixin
implements software.constructs.IMixin

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.b2bi.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnTransformerPropsMixin cfnTransformerPropsMixin = CfnTransformerPropsMixin.Builder.create(CfnTransformerMixinProps.builder()
         .ediType(EdiTypeProperty.builder()
                 .x12Details(X12DetailsProperty.builder()
                         .transactionSet("transactionSet")
                         .version("version")
                         .build())
                 .build())
         .fileFormat("fileFormat")
         .inputConversion(InputConversionProperty.builder()
                 .advancedOptions(AdvancedOptionsProperty.builder()
                         .x12(X12AdvancedOptionsProperty.builder()
                                 .splitOptions(X12SplitOptionsProperty.builder()
                                         .splitBy("splitBy")
                                         .build())
                                 .validationOptions(X12ValidationOptionsProperty.builder()
                                         .validationRules(List.of(X12ValidationRuleProperty.builder()
                                                 .codeListValidationRule(X12CodeListValidationRuleProperty.builder()
                                                         .codesToAdd(List.of("codesToAdd"))
                                                         .codesToRemove(List.of("codesToRemove"))
                                                         .elementId("elementId")
                                                         .build())
                                                 .elementLengthValidationRule(X12ElementLengthValidationRuleProperty.builder()
                                                         .elementId("elementId")
                                                         .maxLength(123)
                                                         .minLength(123)
                                                         .build())
                                                 .elementRequirementValidationRule(X12ElementRequirementValidationRuleProperty.builder()
                                                         .elementPosition("elementPosition")
                                                         .requirement("requirement")
                                                         .build())
                                                 .build()))
                                         .build())
                                 .build())
                         .build())
                 .formatOptions(FormatOptionsProperty.builder()
                         .x12(X12DetailsProperty.builder()
                                 .transactionSet("transactionSet")
                                 .version("version")
                                 .build())
                         .build())
                 .fromFormat("fromFormat")
                 .build())
         .mapping(MappingProperty.builder()
                 .template("template")
                 .templateLanguage("templateLanguage")
                 .build())
         .mappingTemplate("mappingTemplate")
         .name("name")
         .outputConversion(OutputConversionProperty.builder()
                 .advancedOptions(AdvancedOptionsProperty.builder()
                         .x12(X12AdvancedOptionsProperty.builder()
                                 .splitOptions(X12SplitOptionsProperty.builder()
                                         .splitBy("splitBy")
                                         .build())
                                 .validationOptions(X12ValidationOptionsProperty.builder()
                                         .validationRules(List.of(X12ValidationRuleProperty.builder()
                                                 .codeListValidationRule(X12CodeListValidationRuleProperty.builder()
                                                         .codesToAdd(List.of("codesToAdd"))
                                                         .codesToRemove(List.of("codesToRemove"))
                                                         .elementId("elementId")
                                                         .build())
                                                 .elementLengthValidationRule(X12ElementLengthValidationRuleProperty.builder()
                                                         .elementId("elementId")
                                                         .maxLength(123)
                                                         .minLength(123)
                                                         .build())
                                                 .elementRequirementValidationRule(X12ElementRequirementValidationRuleProperty.builder()
                                                         .elementPosition("elementPosition")
                                                         .requirement("requirement")
                                                         .build())
                                                 .build()))
                                         .build())
                                 .build())
                         .build())
                 .formatOptions(FormatOptionsProperty.builder()
                         .x12(X12DetailsProperty.builder()
                                 .transactionSet("transactionSet")
                                 .version("version")
                                 .build())
                         .build())
                 .toFormat("toFormat")
                 .build())
         .sampleDocument("sampleDocument")
         .sampleDocuments(SampleDocumentsProperty.builder()
                 .bucketName("bucketName")
                 .keys(List.of(SampleDocumentKeysProperty.builder()
                         .input("input")
                         .output("output")
                         .build()))
                 .build())
         .status("status")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnTransformerPropsMixin.AdvancedOptionsProperty	A structure that contains advanced options for EDI processing.
static final class	CfnTransformerPropsMixin.Builder	A fluent builder for CfnTransformerPropsMixin.
static interface	CfnTransformerPropsMixin.EdiTypeProperty	Example:
static interface	CfnTransformerPropsMixin.FormatOptionsProperty	A structure that contains the X12 transaction set and version.
static interface	CfnTransformerPropsMixin.InputConversionProperty	Contains the input formatting options for an inbound transformer (takes an X12-formatted EDI document as input and converts it to JSON or XML.
static interface	CfnTransformerPropsMixin.MappingProperty	Specifies the mapping template for the transformer.
static interface	CfnTransformerPropsMixin.OutputConversionProperty	Contains the formatting options for an outbound transformer (takes JSON or XML as input and converts it to an EDI document (currently only X12 format is supported).
static interface	CfnTransformerPropsMixin.SampleDocumentKeysProperty	An array of the Amazon S3 keys used to identify the location for your sample documents.
static interface	CfnTransformerPropsMixin.SampleDocumentsProperty	Describes a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
static interface	CfnTransformerPropsMixin.X12AdvancedOptionsProperty	Contains advanced options specific to X12 EDI processing, such as splitting large X12 files into smaller units.
static interface	CfnTransformerPropsMixin.X12CodeListValidationRuleProperty	Code list validation rule configuration.
static interface	CfnTransformerPropsMixin.X12DetailsProperty	A structure that contains the X12 transaction set and version.
static interface	CfnTransformerPropsMixin.X12ElementLengthValidationRuleProperty	Defines a validation rule that specifies custom length constraints for a specific X12 element.
static interface	CfnTransformerPropsMixin.X12ElementRequirementValidationRuleProperty	Defines a validation rule that modifies the requirement status of a specific X12 element within a segment.
static interface	CfnTransformerPropsMixin.X12SplitOptionsProperty	Contains options for splitting X12 EDI files into smaller units.
static interface	CfnTransformerPropsMixin.X12ValidationOptionsProperty	Contains configuration options for X12 EDI validation.
static interface	CfnTransformerPropsMixin.X12ValidationRuleProperty	Represents a single validation rule that can be applied during X12 EDI processing.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnTransformerPropsMixin(CfnTransformerMixinProps props)	Create a mixin to apply properties to AWS::B2BI::Transformer.
	CfnTransformerPropsMixin(CfnTransformerMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::B2BI::Transformer.
protected	CfnTransformerPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTransformerPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnTransformerMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnTransformerPropsMixin

protected CfnTransformerPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnTransformerPropsMixin

protected CfnTransformerPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnTransformerPropsMixin

@Stability(Stable)
public CfnTransformerPropsMixin(@NotNull
 CfnTransformerMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::B2BI::Transformer.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnTransformerPropsMixin

@Stability(Stable)
public CfnTransformerPropsMixin(@NotNull
 CfnTransformerMixinProps props)

Create a mixin to apply properties to AWS::B2BI::Transformer.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnTransformerMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()