CfnTransformerProps

class aws_cdk.aws_b2bi.CfnTransformerProps(*, name, status, edi_type=None, file_format=None, input_conversion=None, mapping=None, mapping_template=None, output_conversion=None, sample_document=None, sample_documents=None, tags=None)

Bases: object

Properties for defining a CfnTransformer.

Parameters:

• name (str) – Returns the descriptive name for the transformer.

• status (str) – 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 .

• edi_type (Union[IResolvable, EdiTypeProperty, Dict[str, Any], None]) –

• file_format (Optional[str]) –

• input_conversion (Union[IResolvable, InputConversionProperty, Dict[str, Any], None]) – Returns a structure that contains the format options for the transformation.

• mapping (Union[IResolvable, MappingProperty, Dict[str, Any], None]) – Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).

• mapping_template (Optional[str]) – (deprecated) This shape is deprecated: This is a legacy trait. Please use input-conversion or output-conversion.

• output_conversion (Union[IResolvable, OutputConversionProperty, Dict[str, Any], None]) – Returns the OutputConversion object, which contains the format options for the outbound transformation.

• sample_document (Optional[str]) – (deprecated) This shape is deprecated: This is a legacy trait. Please use input-conversion or output-conversion.

• sample_documents (Union[IResolvable, SampleDocumentsProperty, Dict[str, Any], None]) – 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.

• tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_b2bi as b2bi

cfn_transformer_props = b2bi.CfnTransformerProps(
    name="name",
    status="status",

    # the properties below are optional
    edi_type=b2bi.CfnTransformer.EdiTypeProperty(
        x12_details=b2bi.CfnTransformer.X12DetailsProperty(
            transaction_set="transactionSet",
            version="version"
        )
    ),
    file_format="fileFormat",
    input_conversion=b2bi.CfnTransformer.InputConversionProperty(
        from_format="fromFormat",

        # the properties below are optional
        format_options=b2bi.CfnTransformer.FormatOptionsProperty(
            x12=b2bi.CfnTransformer.X12DetailsProperty(
                transaction_set="transactionSet",
                version="version"
            )
        )
    ),
    mapping=b2bi.CfnTransformer.MappingProperty(
        template_language="templateLanguage",

        # the properties below are optional
        template="template"
    ),
    mapping_template="mappingTemplate",
    output_conversion=b2bi.CfnTransformer.OutputConversionProperty(
        to_format="toFormat",

        # the properties below are optional
        format_options=b2bi.CfnTransformer.FormatOptionsProperty(
            x12=b2bi.CfnTransformer.X12DetailsProperty(
                transaction_set="transactionSet",
                version="version"
            )
        )
    ),
    sample_document="sampleDocument",
    sample_documents=b2bi.CfnTransformer.SampleDocumentsProperty(
        bucket_name="bucketName",
        keys=[b2bi.CfnTransformer.SampleDocumentKeysProperty(
            input="input",
            output="output"
        )]
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

edi_type

this property has been deprecated

See:

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

Stability:

deprecated

Type:

deprecated

file_format

this property has been deprecated

See:

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

Stability:

deprecated

Type:

deprecated

input_conversion

Returns a structure that contains the format options for the transformation.

See:

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

mapping

Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).

See:

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

mapping_template

This is a legacy trait.

Please use input-conversion or output-conversion.

Deprecated:

this property has been deprecated

See:

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

Stability:

deprecated

Type:

(deprecated) This shape is deprecated

name

Returns the descriptive name for the transformer.

See:

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

output_conversion

Returns the OutputConversion object, which contains the format options for the outbound transformation.

See:

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

sample_document

This is a legacy trait.

Please use input-conversion or output-conversion.

Deprecated:

this property has been deprecated

See:

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

Stability:

deprecated

Type:

(deprecated) This shape is deprecated

sample_documents

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:

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

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 .

See:

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

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.

See:

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