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.98.0 (build 00b106d)", date="2024-05-24T02:42:34.279Z") @Stability(Stable) public class CfnTransformer extends CfnResource implements IInspectable, ITaggableV2
Creates a transformer.

A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.

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")
         .ediType(EdiTypeProperty.builder()
                 .x12Details(X12DetailsProperty.builder()
                         .transactionSet("transactionSet")
                         .version("version")
                         .build())
                 .build())
         .fileFormat("fileFormat")
         .mappingTemplate("mappingTemplate")
         .name("name")
         .status("status")
         // the properties below are optional
         .sampleDocument("sampleDocument")
         .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

    • getEdiType

      @Stability(Stable) @NotNull public Object getEdiType()
      Returns the details for the EDI standard that is being used for the transformer.

    • setEdiType

      @Stability(Stable) public void setEdiType(@NotNull IResolvable value)
      Returns the details for the EDI standard that is being used for the transformer.

    • setEdiType

      @Stability(Stable) public void setEdiType(@NotNull CfnTransformer.EdiTypeProperty value)
      Returns the details for the EDI standard that is being used for the transformer.

    • getFileFormat

      @Stability(Stable) @NotNull public String getFileFormat()
      Returns that the currently supported file formats for EDI transformations are JSON and XML .

    • setFileFormat

      @Stability(Stable) public void setFileFormat(@NotNull String value)
      Returns that the currently supported file formats for EDI transformations are JSON and XML .

    • getMappingTemplate

      @Stability(Stable) @NotNull public String getMappingTemplate()
      Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

    • setMappingTemplate

      @Stability(Stable) public void setMappingTemplate(@NotNull String value)
      Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

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

    • getSampleDocument

      @Stability(Stable) @Nullable public String getSampleDocument()
      Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

    • setSampleDocument

      @Stability(Stable) public void setSampleDocument(@Nullable String value)
      Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

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