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:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.106.0 (build e852934)", date="2025-01-25T00:20:51.273Z") @Stability(Stable) public class CfnTransformer extends CfnResource implements IInspectable, 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
                 .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
                 .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:

  • 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

    • 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

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

    • 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).

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

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

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