Interface CfnTransformerProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnTransformerProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-12-06T14:43:14.699Z")
@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 .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:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnTransformerProps
static final class
An implementation forCfnTransformerProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnTransformerProps.Builder
builder()
default Object
Deprecated.this property has been deprecateddefault String
Deprecated.this property has been deprecateddefault Object
Returns a structure that contains the format options for the transformation.default Object
Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).default String
Deprecated.this property has been deprecatedgetName()
Returns the descriptive name for the transformer.default Object
Returns theOutputConversion
object, which contains the format options for the outbound transformation.default String
Deprecated.this property has been deprecateddefault Object
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 the state of the newly created transformer.getTags()
A key-value pair for a specific transformer.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getName
Returns the descriptive name for the transformer.- See Also:
-
getStatus
Returns the state of the newly created transformer.The transformer can be either
active
orinactive
. For the transformer to be used in a capability, its status mustactive
.- See Also:
-
getEdiType
Deprecated.this property has been deprecated- See Also:
-
getFileFormat
Deprecated.this property has been deprecated- See Also:
-
getInputConversion
Returns a structure that contains the format options for the transformation.- See Also:
-
getMapping
Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).- See Also:
-
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:
-
getOutputConversion
Returns theOutputConversion
object, which contains the format options for the outbound transformation.- See Also:
-
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:
-
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.- See Also:
-
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:
-
builder
- Returns:
- a
CfnTransformerProps.Builder
ofCfnTransformerProps
-