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.103.1 (build bef2dea)",
           date="2024-10-05T03:43:39.202Z")
@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")
         .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:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnTransformer.Builder	A fluent builder for CfnTransformer.
static interface	CfnTransformer.EdiTypeProperty	Specifies the details for the EDI standard that is being used for the transformer.
static interface	CfnTransformer.FormatOptionsProperty	Example:
static interface	CfnTransformer.InputConversionProperty	Example:
static interface	CfnTransformer.MappingProperty	Example:
static interface	CfnTransformer.OutputConversionProperty	Example:
static interface	CfnTransformer.SampleDocumentKeysProperty	Example:
static interface	CfnTransformer.SampleDocumentsProperty	Example:
static interface	CfnTransformer.X12DetailsProperty	A structure that contains the X12 transaction set and version.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnTransformer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTransformer(software.amazon.jsii.JsiiObjectRef objRef)
	CfnTransformer(software.constructs.Construct scope, String id, CfnTransformerProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrCreatedAt()	Returns a timestamp indicating when the transformer was created.
String	getAttrModifiedAt()	Returns a timestamp representing the date and time for the most recent change for the transformer object.
String	getAttrTransformerArn()	Returns an Amazon Resource Name (ARN) for a specific transformer.
String	getAttrTransformerId()	The system-assigned unique identifier for the transformer.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
Object	getEdiType()	Deprecated. this property has been deprecated
String	getFileFormat()	Deprecated. this property has been deprecated
Object	getInputConversion()
Object	getMapping()
String	getMappingTemplate()	Deprecated. this property has been deprecated
String	getName()	Returns the descriptive name for the transformer.
Object	getOutputConversion()
String	getSampleDocument()	Deprecated. this property has been deprecated
Object	getSampleDocuments()
String	getStatus()	Returns the state of the newly created transformer.
List<CfnTag>	getTags()	A key-value pair for a specific transformer.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setEdiType(IResolvable value)	Deprecated. this property has been deprecated
void	setEdiType(CfnTransformer.EdiTypeProperty value)	Deprecated. this property has been deprecated
void	setFileFormat(String value)	Deprecated. this property has been deprecated
void	setInputConversion(IResolvable value)
void	setInputConversion(CfnTransformer.InputConversionProperty value)
void	setMapping(IResolvable value)
void	setMapping(CfnTransformer.MappingProperty value)
void	setMappingTemplate(String value)	Deprecated. this property has been deprecated
void	setName(String value)	Returns the descriptive name for the transformer.
void	setOutputConversion(IResolvable value)
void	setOutputConversion(CfnTransformer.OutputConversionProperty value)
void	setSampleDocument(String value)	Deprecated. this property has been deprecated
void	setSampleDocuments(IResolvable value)
void	setSampleDocuments(CfnTransformer.SampleDocumentsProperty value)
void	setStatus(String value)	Returns the state of the newly created transformer.
void	setTags(List<CfnTag> value)	A key-value pair for a specific transformer.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

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

setEdiType

@Stability(Deprecated)
@Deprecated
public void setEdiType(@Nullable
 IResolvable value)

Deprecated.

this property has been deprecated

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

setEdiType

@Stability(Deprecated)
@Deprecated
public void setEdiType(@Nullable
 CfnTransformer.EdiTypeProperty value)

Deprecated.

this property has been deprecated

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

getFileFormat

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

Deprecated.

this property has been deprecated

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

setFileFormat

@Stability(Deprecated)
@Deprecated
public void setFileFormat(@Nullable
 String value)

Deprecated.

this property has been deprecated

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

getInputConversion

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

setInputConversion

@Stability(Stable)
public void setInputConversion(@Nullable
 IResolvable value)

setInputConversion

@Stability(Stable)
public void setInputConversion(@Nullable
 CfnTransformer.InputConversionProperty value)

getMapping

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

setMapping

@Stability(Stable)
public void setMapping(@Nullable
 IResolvable value)

setMapping

@Stability(Stable)
public void setMapping(@Nullable
 CfnTransformer.MappingProperty value)

getMappingTemplate

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

Deprecated.

this property has been deprecated

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

setMappingTemplate

@Stability(Deprecated)
@Deprecated
public void setMappingTemplate(@Nullable
 String value)

Deprecated.

this property has been deprecated

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

getOutputConversion

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

setOutputConversion

@Stability(Stable)
public void setOutputConversion(@Nullable
 IResolvable value)

setOutputConversion

@Stability(Stable)
public void setOutputConversion(@Nullable
 CfnTransformer.OutputConversionProperty value)

getSampleDocument

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

Deprecated.

this property has been deprecated

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

setSampleDocument

@Stability(Deprecated)
@Deprecated
public void setSampleDocument(@Nullable
 String value)

Deprecated.

this property has been deprecated

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

getSampleDocuments

@Stability(Stable)
@Nullable
public Object getSampleDocuments()

setSampleDocuments

@Stability(Stable)
public void setSampleDocuments(@Nullable
 IResolvable value)

setSampleDocuments

@Stability(Stable)
public void setSampleDocuments(@Nullable
 CfnTransformer.SampleDocumentsProperty value)

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.