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.102.0 (build e354887)",
           date="2024-08-23T05:56:11.728Z")
@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()
         .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:

• 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()
Object	getEdiType()	Returns the details for the EDI standard that is being used for the transformer.
String	getFileFormat()	Returns that the currently supported file formats for EDI transformations are JSON and XML .
String	getMappingTemplate()	Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
String	getName()	Returns the descriptive name for the transformer.
default String	getSampleDocument()	Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
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

getEdiType

@Stability(Stable)
@NotNull
Object getEdiType()

Returns the details for the EDI standard that is being used for the transformer.

Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

See Also:

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

getFileFormat

@Stability(Stable)
@NotNull
String getFileFormat()

Returns that the currently supported file formats for EDI transformations are JSON and XML .

See Also:

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

getMappingTemplate

@Stability(Stable)
@NotNull
String getMappingTemplate()

Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

See Also:

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

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

getSampleDocument

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

Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

See Also:

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

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