Package software.amazon.awscdk.services.b2bi

Class CfnTransformer.Builder

java.lang.Object

software.amazon.awscdk.services.b2bi.CfnTransformer.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTransformer>

Enclosing class:

CfnTransformer

@Stability(Stable)
public static final class CfnTransformer.Builder
extends Object
implements software.amazon.jsii.Builder<CfnTransformer>

A fluent builder for CfnTransformer.

Method Summary

Modifier and Type	Method	Description
CfnTransformer	build()
static CfnTransformer.Builder	create(software.constructs.Construct scope, String id)
CfnTransformer.Builder	ediType(IResolvable ediType)	Returns the details for the EDI standard that is being used for the transformer.
CfnTransformer.Builder	ediType(CfnTransformer.EdiTypeProperty ediType)	Returns the details for the EDI standard that is being used for the transformer.
CfnTransformer.Builder	fileFormat(String fileFormat)	Returns that the currently supported file formats for EDI transformations are JSON and XML .
CfnTransformer.Builder	mappingTemplate(String mappingTemplate)	Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
CfnTransformer.Builder	name(String name)	Returns the descriptive name for the transformer.
CfnTransformer.Builder	sampleDocument(String sampleDocument)	Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
CfnTransformer.Builder	status(String status)	Returns the state of the newly created transformer.
CfnTransformer.Builder	tags(List<? extends CfnTag> tags)	A key-value pair for a specific transformer.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnTransformer.Builder create(software.constructs.Construct scope,
 String id)

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.

Returns:

a new instance of CfnTransformer.Builder.

ediType

@Stability(Stable)
public CfnTransformer.Builder ediType(IResolvable ediType)

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.

Parameters:

ediType - Returns the details for the EDI standard that is being used for the transformer. This parameter is required.

Returns:

this

See Also:

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

ediType

@Stability(Stable)
public CfnTransformer.Builder ediType(CfnTransformer.EdiTypeProperty ediType)

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.

Parameters:

ediType - Returns the details for the EDI standard that is being used for the transformer. This parameter is required.

Returns:

this

See Also:

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

fileFormat

@Stability(Stable)
public CfnTransformer.Builder fileFormat(String fileFormat)

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

Parameters:

fileFormat - Returns that the currently supported file formats for EDI transformations are JSON and XML . This parameter is required.

Returns:

this

See Also:

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

mappingTemplate

@Stability(Stable)
public CfnTransformer.Builder mappingTemplate(String mappingTemplate)

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

Parameters:

mappingTemplate - Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data. This parameter is required.

Returns:

this

See Also:

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

name

@Stability(Stable)
public CfnTransformer.Builder name(String name)

Returns the descriptive name for the transformer.

Parameters:

name - Returns the descriptive name for the transformer. This parameter is required.

Returns:

this

See Also:

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

status

@Stability(Stable)
public CfnTransformer.Builder status(String status)

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 .

Parameters:

status - Returns the state of the newly created transformer. This parameter is required.

Returns:

this

See Also:

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

sampleDocument

@Stability(Stable)
public CfnTransformer.Builder sampleDocument(String sampleDocument)

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

Parameters:

sampleDocument - Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnTransformer.Builder tags(List<? extends CfnTag> tags)

A key-value pair for a specific transformer.

Tags are metadata that you can use to search for and group capabilities for various purposes.

Parameters:

tags - A key-value pair for a specific transformer. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnTransformer build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnTransformer>

Returns:

a newly built instance of CfnTransformer.