Package software.amazon.awscdk.services.b2bi

Interface CfnTransformerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTransformerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:15.213Z")
@Stability(Stable)
public interface CfnTransformerProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnTransformer.

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.*;
 CfnTransformerProps cfnTransformerProps = CfnTransformerProps.builder()
         .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	Interface	Description
static final class	CfnTransformerProps.Builder	A builder for CfnTransformerProps
static final class	CfnTransformerProps.Jsii$Proxy	An implementation for CfnTransformerProps

Method Summary

Modifier and Type	Method	Description
static CfnTransformerProps.Builder	builder()
default Object	getEdiType()	Deprecated. this property has been deprecated
default String	getFileFormat()	Deprecated. this property has been deprecated
default Object	getInputConversion()	Returns a structure that contains the format options for the transformation.
default Object	getMapping()	Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
default String	getMappingTemplate()	Deprecated. this property has been deprecated
String	getName()	Returns the descriptive name for the transformer.
default Object	getOutputConversion()	Returns the OutputConversion object, which contains the format options for the outbound transformation.
default String	getSampleDocument()	Deprecated. this property has been deprecated
default 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.
default List<CfnTag>	getTags()	A key-value pair for a specific transformer.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

Returns the descriptive name for the transformer.

See Also:

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

getStatus

@Stability(Stable)
@NotNull
String getStatus()

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 .

See Also:

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

getEdiType

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

Deprecated.

this property has been deprecated

Returns union: either IResolvable or CfnTransformer.EdiTypeProperty

See Also:

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

getFileFormat

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

Deprecated.

this property has been deprecated

See Also:

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

getInputConversion

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

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

Returns union: either IResolvable or CfnTransformer.InputConversionProperty

See Also:

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

getMapping

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

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

Returns union: either IResolvable or CfnTransformer.MappingProperty

See Also:

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

getMappingTemplate

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

Deprecated.

this property has been deprecated

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

Please use input-conversion or output-conversion.

See Also:

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

getOutputConversion

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

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

Returns union: either IResolvable or CfnTransformer.OutputConversionProperty

See Also:

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

getSampleDocument

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

Deprecated.

this property has been deprecated

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

Please use input-conversion or output-conversion.

See Also:

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

getSampleDocuments

@Stability(Stable)
@Nullable
default 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

See Also:

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

getTags

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

A key-value pair for a specific transformer.

Tags are metadata that you can use to search for and group capabilities for various purposes.

See Also:

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

builder

@Stability(Stable)
static CfnTransformerProps.Builder builder()

Returns:

a CfnTransformerProps.Builder of CfnTransformerProps