Package software.amazon.awscdk.services.b2bi

Class CfnTransformer

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.b2bi.CfnTransformer

All Implemented Interfaces:

IEnvironmentAware, IInspectable, ITaggableV2, ITransformerRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-10T13:39:58.960Z")
@Stability(Stable)
public class CfnTransformer
extends CfnResource
implements IInspectable, ITransformerRef, ITaggableV2

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.services.b2bi.*;
 CfnTransformer cfnTransformer = CfnTransformer.Builder.create(this, "MyCfnTransformer")
         .name("name")
         .status("status")
         // the properties below are optional
         .ediType(EdiTypeProperty.builder()
                 .x12Details(X12DetailsProperty.builder()
                         .transactionSet("transactionSet")
                         .version("version")
                         .build())
                 .build())
         .fileFormat("fileFormat")
         .inputConversion(InputConversionProperty.builder()
                 .fromFormat("fromFormat")
                 // the properties below are optional
                 .advancedOptions(AdvancedOptionsProperty.builder()
                         .x12(X12AdvancedOptionsProperty.builder()
                                 .splitOptions(X12SplitOptionsProperty.builder()
                                         .splitBy("splitBy")
                                         .build())
                                 .validationOptions(X12ValidationOptionsProperty.builder()
                                         .validationRules(List.of(X12ValidationRuleProperty.builder()
                                                 .codeListValidationRule(X12CodeListValidationRuleProperty.builder()
                                                         .elementId("elementId")
                                                         // the properties below are optional
                                                         .codesToAdd(List.of("codesToAdd"))
                                                         .codesToRemove(List.of("codesToRemove"))
                                                         .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())
                 .build())
         .mapping(MappingProperty.builder()
                 .templateLanguage("templateLanguage")
                 // the properties below are optional
                 .template("template")
                 .build())
         .mappingTemplate("mappingTemplate")
         .outputConversion(OutputConversionProperty.builder()
                 .toFormat("toFormat")
                 // the properties below are optional
                 .advancedOptions(AdvancedOptionsProperty.builder()
                         .x12(X12AdvancedOptionsProperty.builder()
                                 .splitOptions(X12SplitOptionsProperty.builder()
                                         .splitBy("splitBy")
                                         .build())
                                 .validationOptions(X12ValidationOptionsProperty.builder()
                                         .validationRules(List.of(X12ValidationRuleProperty.builder()
                                                 .codeListValidationRule(X12CodeListValidationRuleProperty.builder()
                                                         .elementId("elementId")
                                                         // the properties below are optional
                                                         .codesToAdd(List.of("codesToAdd"))
                                                         .codesToRemove(List.of("codesToRemove"))
                                                         .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())
                 .build())
         .sampleDocument("sampleDocument")
         .sampleDocuments(SampleDocumentsProperty.builder()
                 .bucketName("bucketName")
                 .keys(List.of(SampleDocumentKeysProperty.builder()
                         .input("input")
                         .output("output")
                         .build()))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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	CfnTransformer.AdvancedOptionsProperty	A structure that contains advanced options for EDI processing.
static final class	CfnTransformer.Builder	A fluent builder for CfnTransformer.
static interface	CfnTransformer.EdiTypeProperty	Example:
static interface	CfnTransformer.FormatOptionsProperty	A structure that contains the X12 transaction set and version.
static interface	CfnTransformer.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	CfnTransformer.MappingProperty	Specifies the mapping template for the transformer.
static interface	CfnTransformer.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	CfnTransformer.SampleDocumentKeysProperty	An array of the Amazon S3 keys used to identify the location for your sample documents.
static interface	CfnTransformer.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	CfnTransformer.X12AdvancedOptionsProperty	Contains advanced options specific to X12 EDI processing, such as splitting large X12 files into smaller units.
static interface	CfnTransformer.X12CodeListValidationRuleProperty	Code list validation rule configuration.
static interface	CfnTransformer.X12DetailsProperty	A structure that contains the X12 transaction set and version.
static interface	CfnTransformer.X12ElementLengthValidationRuleProperty	Defines a validation rule that specifies custom length constraints for a specific X12 element.
static interface	CfnTransformer.X12ElementRequirementValidationRuleProperty	Defines a validation rule that modifies the requirement status of a specific X12 element within a segment.
static interface	CfnTransformer.X12SplitOptionsProperty	Contains options for splitting X12 EDI files into smaller units.
static interface	CfnTransformer.X12ValidationOptionsProperty	Contains configuration options for X12 EDI validation.
static interface	CfnTransformer.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.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.b2bi.ITransformerRef

ITransformerRef.Jsii$Default, ITransformerRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnTransformer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTransformer(software.amazon.jsii.JsiiObjectRef objRef)
	CfnTransformer(software.constructs.Construct scope, String id, CfnTransformerProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrCreatedAt()	Returns a timestamp indicating when the transformer was created.
String	getAttrModifiedAt()	Returns a timestamp representing the date and time for the most recent change for the transformer object.
String	getAttrTransformerArn()	Returns an Amazon Resource Name (ARN) for a specific transformer.
String	getAttrTransformerId()	The system-assigned unique identifier for the transformer.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
Object	getEdiType()	Deprecated. this property has been deprecated
String	getFileFormat()	Deprecated. this property has been deprecated
Object	getInputConversion()	Returns a structure that contains the format options for the transformation.
Object	getMapping()	Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
String	getMappingTemplate()	Deprecated. this property has been deprecated
String	getName()	Returns the descriptive name for the transformer.
Object	getOutputConversion()	Returns the OutputConversion object, which contains the format options for the outbound transformation.
String	getSampleDocument()	Deprecated. this property has been deprecated
Object	getSampleDocuments()	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.
String	getStatus()	Returns the state of the newly created transformer.
List<CfnTag>	getTags()	A key-value pair for a specific transformer.
TransformerReference	getTransformerRef()	A reference to a Transformer resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setEdiType(IResolvable value)	Deprecated. this property has been deprecated
void	setEdiType(CfnTransformer.EdiTypeProperty value)	Deprecated. this property has been deprecated
void	setFileFormat(String value)	Deprecated. this property has been deprecated
void	setInputConversion(IResolvable value)	Returns a structure that contains the format options for the transformation.
void	setInputConversion(CfnTransformer.InputConversionProperty value)	Returns a structure that contains the format options for the transformation.
void	setMapping(IResolvable value)	Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
void	setMapping(CfnTransformer.MappingProperty value)	Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
void	setMappingTemplate(String value)	Deprecated. this property has been deprecated
void	setName(String value)	Returns the descriptive name for the transformer.
void	setOutputConversion(IResolvable value)	Returns the OutputConversion object, which contains the format options for the outbound transformation.
void	setOutputConversion(CfnTransformer.OutputConversionProperty value)	Returns the OutputConversion object, which contains the format options for the outbound transformation.
void	setSampleDocument(String value)	Deprecated. this property has been deprecated
void	setSampleDocuments(IResolvable value)	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.
void	setSampleDocuments(CfnTransformer.SampleDocumentsProperty value)	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.
void	setStatus(String value)	Returns the state of the newly created transformer.
void	setTags(List<CfnTag> value)	A key-value pair for a specific transformer.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnTransformer

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

CfnTransformer

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

CfnTransformer

@Stability(Stable)
public CfnTransformer(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnTransformerProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCreatedAt

@Stability(Stable)
@NotNull
public String getAttrCreatedAt()

Returns a timestamp indicating when the transformer was created.

For example, 2023-07-20T19:58:44.624Z .

getAttrModifiedAt

@Stability(Stable)
@NotNull
public String getAttrModifiedAt()

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

getAttrTransformerArn

@Stability(Stable)
@NotNull
public String getAttrTransformerArn()

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

getAttrTransformerId

@Stability(Stable)
@NotNull
public String getAttrTransformerId()

The system-assigned unique identifier for the transformer.

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTransformerRef

@Stability(Stable)
@NotNull
public TransformerReference getTransformerRef()

A reference to a Transformer resource.

Specified by:

getTransformerRef in interface ITransformerRef

getName

@Stability(Stable)
@NotNull
public String getName()

Returns the descriptive name for the transformer.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

Returns the descriptive name for the transformer.

getStatus

@Stability(Stable)
@NotNull
public String getStatus()

Returns the state of the newly created transformer.

setStatus

@Stability(Stable)
public void setStatus(@NotNull
 String value)

Returns the state of the newly created transformer.

getEdiType

@Stability(Deprecated)
@Deprecated
@Nullable
public Object getEdiType()

Deprecated.

this property has been deprecated

Returns union: either IResolvable or CfnTransformer.EdiTypeProperty

setEdiType

@Stability(Deprecated)
@Deprecated
public void setEdiType(@Nullable
 IResolvable value)

Deprecated.

this property has been deprecated

setEdiType

@Stability(Deprecated)
@Deprecated
public void setEdiType(@Nullable
 CfnTransformer.EdiTypeProperty value)

Deprecated.

this property has been deprecated

getFileFormat

@Stability(Deprecated)
@Deprecated
@Nullable
public String getFileFormat()

Deprecated.

this property has been deprecated

setFileFormat

@Stability(Deprecated)
@Deprecated
public void setFileFormat(@Nullable
 String value)

Deprecated.

this property has been deprecated

getInputConversion

@Stability(Stable)
@Nullable
public Object getInputConversion()

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

Returns union: either IResolvable or CfnTransformer.InputConversionProperty

setInputConversion

@Stability(Stable)
public void setInputConversion(@Nullable
 IResolvable value)

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

setInputConversion

@Stability(Stable)
public void setInputConversion(@Nullable
 CfnTransformer.InputConversionProperty value)

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

getMapping

@Stability(Stable)
@Nullable
public Object getMapping()

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

Returns union: either IResolvable or CfnTransformer.MappingProperty

setMapping

@Stability(Stable)
public void setMapping(@Nullable
 IResolvable value)

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

setMapping

@Stability(Stable)
public void setMapping(@Nullable
 CfnTransformer.MappingProperty value)

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

getMappingTemplate

@Stability(Deprecated)
@Deprecated
@Nullable
public String getMappingTemplate()

Deprecated.

this property has been deprecated

(deprecated) This shape is deprecated: This is a legacy trait.

setMappingTemplate

@Stability(Deprecated)
@Deprecated
public void setMappingTemplate(@Nullable
 String value)

Deprecated.

this property has been deprecated

(deprecated) This shape is deprecated: This is a legacy trait.

getOutputConversion

@Stability(Stable)
@Nullable
public Object getOutputConversion()

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

Returns union: either IResolvable or CfnTransformer.OutputConversionProperty

setOutputConversion

@Stability(Stable)
public void setOutputConversion(@Nullable
 IResolvable value)

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

setOutputConversion

@Stability(Stable)
public void setOutputConversion(@Nullable
 CfnTransformer.OutputConversionProperty value)

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

getSampleDocument

@Stability(Deprecated)
@Deprecated
@Nullable
public String getSampleDocument()

Deprecated.

this property has been deprecated

(deprecated) This shape is deprecated: This is a legacy trait.

setSampleDocument

@Stability(Deprecated)
@Deprecated
public void setSampleDocument(@Nullable
 String value)

Deprecated.

this property has been deprecated

(deprecated) This shape is deprecated: This is a legacy trait.

getSampleDocuments

@Stability(Stable)
@Nullable
public Object getSampleDocuments()

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.

Returns union: either IResolvable or CfnTransformer.SampleDocumentsProperty

setSampleDocuments

@Stability(Stable)
public void setSampleDocuments(@Nullable
 IResolvable value)

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.

setSampleDocuments

@Stability(Stable)
public void setSampleDocuments(@Nullable
 CfnTransformer.SampleDocumentsProperty value)

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.

getTags

@Stability(Stable)
@Nullable
public List<CfnTag> getTags()

A key-value pair for a specific transformer.

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnTag> value)

A key-value pair for a specific transformer.