CfnTransformerPropsMixin

class aws_cdk.mixins_preview.aws_b2bi.mixins.CfnTransformerPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a transformer. AWS B2B Data Interchange currently supports two scenarios:.

Inbound EDI : the AWS customer receives an EDI file from their trading partner. AWS B2B Data Interchange converts this EDI file into a JSON or XML file with a service-defined structure. A mapping template provided by the customer, in JSONata or XSLT format, is optionally applied to this file to produce a JSON or XML file with the structure the customer requires.
Outbound EDI : the AWS customer has a JSON or XML file containing data that they wish to use in an EDI file. A mapping template, provided by the customer (in either JSONata or XSLT format) is applied to this file to generate a JSON or XML file in the service-defined structure. This file is then converted to an EDI file.

The following fields are provided for backwards compatibility only: fileFormat , mappingTemplate , ediType , and sampleDocument .

Use the mapping data type in place of mappingTemplate and fileFormat

Use the sampleDocuments data type in place of sampleDocument

Use either the inputConversion or outputConversion in place of ediType

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html
CloudformationResource:: AWS::B2BI::Transformer
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_b2bi import mixins as b2bi_mixins

cfn_transformer_props_mixin = b2bi_mixins.CfnTransformerPropsMixin(b2bi_mixins.CfnTransformerMixinProps(
    edi_type=b2bi_mixins.CfnTransformerPropsMixin.EdiTypeProperty(
        x12_details=b2bi_mixins.CfnTransformerPropsMixin.X12DetailsProperty(
            transaction_set="transactionSet",
            version="version"
        )
    ),
    file_format="fileFormat",
    input_conversion=b2bi_mixins.CfnTransformerPropsMixin.InputConversionProperty(
        advanced_options=b2bi_mixins.CfnTransformerPropsMixin.AdvancedOptionsProperty(
            x12=b2bi_mixins.CfnTransformerPropsMixin.X12AdvancedOptionsProperty(
                split_options=b2bi_mixins.CfnTransformerPropsMixin.X12SplitOptionsProperty(
                    split_by="splitBy"
                ),
                validation_options=b2bi_mixins.CfnTransformerPropsMixin.X12ValidationOptionsProperty(
                    validation_rules=[b2bi_mixins.CfnTransformerPropsMixin.X12ValidationRuleProperty(
                        code_list_validation_rule=b2bi_mixins.CfnTransformerPropsMixin.X12CodeListValidationRuleProperty(
                            codes_to_add=["codesToAdd"],
                            codes_to_remove=["codesToRemove"],
                            element_id="elementId"
                        ),
                        element_length_validation_rule=b2bi_mixins.CfnTransformerPropsMixin.X12ElementLengthValidationRuleProperty(
                            element_id="elementId",
                            max_length=123,
                            min_length=123
                        ),
                        element_requirement_validation_rule=b2bi_mixins.CfnTransformerPropsMixin.X12ElementRequirementValidationRuleProperty(
                            element_position="elementPosition",
                            requirement="requirement"
                        )
                    )]
                )
            )
        ),
        format_options=b2bi_mixins.CfnTransformerPropsMixin.FormatOptionsProperty(
            x12=b2bi_mixins.CfnTransformerPropsMixin.X12DetailsProperty(
                transaction_set="transactionSet",
                version="version"
            )
        ),
        from_format="fromFormat"
    ),
    mapping=b2bi_mixins.CfnTransformerPropsMixin.MappingProperty(
        template="template",
        template_language="templateLanguage"
    ),
    mapping_template="mappingTemplate",
    name="name",
    output_conversion=b2bi_mixins.CfnTransformerPropsMixin.OutputConversionProperty(
        advanced_options=b2bi_mixins.CfnTransformerPropsMixin.AdvancedOptionsProperty(
            x12=b2bi_mixins.CfnTransformerPropsMixin.X12AdvancedOptionsProperty(
                split_options=b2bi_mixins.CfnTransformerPropsMixin.X12SplitOptionsProperty(
                    split_by="splitBy"
                ),
                validation_options=b2bi_mixins.CfnTransformerPropsMixin.X12ValidationOptionsProperty(
                    validation_rules=[b2bi_mixins.CfnTransformerPropsMixin.X12ValidationRuleProperty(
                        code_list_validation_rule=b2bi_mixins.CfnTransformerPropsMixin.X12CodeListValidationRuleProperty(
                            codes_to_add=["codesToAdd"],
                            codes_to_remove=["codesToRemove"],
                            element_id="elementId"
                        ),
                        element_length_validation_rule=b2bi_mixins.CfnTransformerPropsMixin.X12ElementLengthValidationRuleProperty(
                            element_id="elementId",
                            max_length=123,
                            min_length=123
                        ),
                        element_requirement_validation_rule=b2bi_mixins.CfnTransformerPropsMixin.X12ElementRequirementValidationRuleProperty(
                            element_position="elementPosition",
                            requirement="requirement"
                        )
                    )]
                )
            )
        ),
        format_options=b2bi_mixins.CfnTransformerPropsMixin.FormatOptionsProperty(
            x12=b2bi_mixins.CfnTransformerPropsMixin.X12DetailsProperty(
                transaction_set="transactionSet",
                version="version"
            )
        ),
        to_format="toFormat"
    ),
    sample_document="sampleDocument",
    sample_documents=b2bi_mixins.CfnTransformerPropsMixin.SampleDocumentsProperty(
        bucket_name="bucketName",
        keys=[b2bi_mixins.CfnTransformerPropsMixin.SampleDocumentKeysProperty(
            input="input",
            output="output"
        )]
    ),
    status="status",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::B2BI::Transformer.

Parameters:

props (Union[CfnTransformerMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['ediType', 'fileFormat', 'inputConversion', 'mapping', 'mappingTemplate', 'name', 'outputConversion', 'sampleDocument', 'sampleDocuments', 'status', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AdvancedOptionsProperty

class CfnTransformerPropsMixin.AdvancedOptionsProperty(*, x12=None)

Bases: object

A structure that contains advanced options for EDI processing.

Currently, only X12 advanced options are supported.

Parameters:: x12 (Union[IResolvable, X12AdvancedOptionsProperty, Dict[str, Any], None]) – A structure that contains X12-specific advanced options, such as split options for processing X12 EDI files.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-advancedoptions.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.mixins_preview.aws_b2bi import mixins as b2bi_mixins

advanced_options_property = b2bi_mixins.CfnTransformerPropsMixin.AdvancedOptionsProperty(
    x12=b2bi_mixins.CfnTransformerPropsMixin.X12AdvancedOptionsProperty(
        split_options=b2bi_mixins.CfnTransformerPropsMixin.X12SplitOptionsProperty(
            split_by="splitBy"
        ),
        validation_options=b2bi_mixins.CfnTransformerPropsMixin.X12ValidationOptionsProperty(
            validation_rules=[b2bi_mixins.CfnTransformerPropsMixin.X12ValidationRuleProperty(
                code_list_validation_rule=b2bi_mixins.CfnTransformerPropsMixin.X12CodeListValidationRuleProperty(
                    codes_to_add=["codesToAdd"],
                    codes_to_remove=["codesToRemove"],
                    element_id="elementId"
                ),
                element_length_validation_rule=b2bi_mixins.CfnTransformerPropsMixin.X12ElementLengthValidationRuleProperty(
                    element_id="elementId",
                    max_length=123,
                    min_length=123
                ),
                element_requirement_validation_rule=b2bi_mixins.CfnTransformerPropsMixin.X12ElementRequirementValidationRuleProperty(
                    element_position="elementPosition",
                    requirement="requirement"
                )
            )]
        )
    )
)

Attributes

x12

A structure that contains X12-specific advanced options, such as split options for processing X12 EDI files.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-advancedoptions.html#cfn-b2bi-transformer-advancedoptions-x12

EdiTypeProperty

class CfnTransformerPropsMixin.EdiTypeProperty(*, x12_details=None)

Bases: object

Parameters:: x12_details (Union[IResolvable, X12DetailsProperty, Dict[str, Any], None])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-editype.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.mixins_preview.aws_b2bi import mixins as b2bi_mixins

edi_type_property = b2bi_mixins.CfnTransformerPropsMixin.EdiTypeProperty(
    x12_details=b2bi_mixins.CfnTransformerPropsMixin.X12DetailsProperty(
        transaction_set="transactionSet",
        version="version"
    )
)

Attributes

x12_details

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

Type:: see

FormatOptionsProperty

class CfnTransformerPropsMixin.FormatOptionsProperty(*, x12=None)

Bases: object

A structure that contains the X12 transaction set and version.

Parameters:: x12 (Union[IResolvable, X12DetailsProperty, Dict[str, Any], None])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-formatoptions.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.mixins_preview.aws_b2bi import mixins as b2bi_mixins

format_options_property = b2bi_mixins.CfnTransformerPropsMixin.FormatOptionsProperty(
    x12=b2bi_mixins.CfnTransformerPropsMixin.X12DetailsProperty(
        transaction_set="transactionSet",
        version="version"
    )
)

Attributes

x12

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-formatoptions.html#cfn-b2bi-transformer-formatoptions-x12

Type:: see

InputConversionProperty

class CfnTransformerPropsMixin.InputConversionProperty(*, advanced_options=None, format_options=None, from_format=None)

Bases: object

Contains the input formatting options for an inbound transformer (takes an X12-formatted EDI document as input and converts it to JSON or XML.

Parameters:

advanced_options (Union[IResolvable, AdvancedOptionsProperty, Dict[str, Any], None]) – Specifies advanced options for the input conversion process. These options provide additional control over how EDI files are processed during transformation.
format_options (Union[IResolvable, FormatOptionsProperty, Dict[str, Any], None]) – A structure that contains the formatting options for an inbound transformer.
from_format (Optional[str]) – The format for the transformer input: currently on X12 is supported.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-inputconversion.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.mixins_preview.aws_b2bi import mixins as b2bi_mixins

input_conversion_property = b2bi_mixins.CfnTransformerPropsMixin.InputConversionProperty(
    advanced_options=b2bi_mixins.CfnTransformerPropsMixin.AdvancedOptionsProperty(
        x12=b2bi_mixins.CfnTransformerPropsMixin.X12AdvancedOptionsProperty(
            split_options=b2bi_mixins.CfnTransformerPropsMixin.X12SplitOptionsProperty(
                split_by="splitBy"
            ),
            validation_options=b2bi_mixins.CfnTransformerPropsMixin.X12ValidationOptionsProperty(
                validation_rules=[b2bi_mixins.CfnTransformerPropsMixin.X12ValidationRuleProperty(
                    code_list_validation_rule=b2bi_mixins.CfnTransformerPropsMixin.X12CodeListValidationRuleProperty(
                        codes_to_add=["codesToAdd"],
                        codes_to_remove=["codesToRemove"],
                        element_id="elementId"
                    ),
                    element_length_validation_rule=b2bi_mixins.CfnTransformerPropsMixin.X12ElementLengthValidationRuleProperty(
                        element_id="elementId",
                        max_length=123,
                        min_length=123
                    ),
                    element_requirement_validation_rule=b2bi_mixins.CfnTransformerPropsMixin.X12ElementRequirementValidationRuleProperty(
                        element_position="elementPosition",
                        requirement="requirement"
                    )
                )]
            )
        )
    ),
    format_options=b2bi_mixins.CfnTransformerPropsMixin.FormatOptionsProperty(
        x12=b2bi_mixins.CfnTransformerPropsMixin.X12DetailsProperty(
            transaction_set="transactionSet",
            version="version"
        )
    ),
    from_format="fromFormat"
)

Attributes

advanced_options

Specifies advanced options for the input conversion process.

These options provide additional control over how EDI files are processed during transformation.

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

format_options

A structure that contains the formatting options for an inbound transformer.

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

from_format

currently on X12 is supported.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-inputconversion.html#cfn-b2bi-transformer-inputconversion-fromformat
Type:: The format for the transformer input

MappingProperty

class CfnTransformerPropsMixin.MappingProperty(*, template=None, template_language=None)

Bases: object

Specifies the mapping template for the transformer.

This template is used to map the parsed EDI file using JSONata or XSLT.

Parameters:

template (Optional[str]) – A string that represents the mapping template, in the transformation language specified in templateLanguage .
template_language (Optional[str]) – The transformation language for the template, either XSLT or JSONATA.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-mapping.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.mixins_preview.aws_b2bi import mixins as b2bi_mixins

mapping_property = b2bi_mixins.CfnTransformerPropsMixin.MappingProperty(
    template="template",
    template_language="templateLanguage"
)

Attributes

template

A string that represents the mapping template, in the transformation language specified in templateLanguage .

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

template_language

The transformation language for the template, either XSLT or JSONATA.

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

OutputConversionProperty

class CfnTransformerPropsMixin.OutputConversionProperty(*, advanced_options=None, format_options=None, to_format=None)

Bases: object

Contains the formatting options for an outbound transformer (takes JSON or XML as input and converts it to an EDI document (currently only X12 format is supported).

Parameters:

advanced_options (Union[IResolvable, AdvancedOptionsProperty, Dict[str, Any], None])
format_options (Union[IResolvable, FormatOptionsProperty, Dict[str, Any], None]) – A structure that contains the X12 transaction set and version for the transformer output.
to_format (Optional[str]) – The format for the output from an outbound transformer: only X12 is currently supported.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-outputconversion.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.mixins_preview.aws_b2bi import mixins as b2bi_mixins

output_conversion_property = b2bi_mixins.CfnTransformerPropsMixin.OutputConversionProperty(
    advanced_options=b2bi_mixins.CfnTransformerPropsMixin.AdvancedOptionsProperty(
        x12=b2bi_mixins.CfnTransformerPropsMixin.X12AdvancedOptionsProperty(
            split_options=b2bi_mixins.CfnTransformerPropsMixin.X12SplitOptionsProperty(
                split_by="splitBy"
            ),
            validation_options=b2bi_mixins.CfnTransformerPropsMixin.X12ValidationOptionsProperty(
                validation_rules=[b2bi_mixins.CfnTransformerPropsMixin.X12ValidationRuleProperty(
                    code_list_validation_rule=b2bi_mixins.CfnTransformerPropsMixin.X12CodeListValidationRuleProperty(
                        codes_to_add=["codesToAdd"],
                        codes_to_remove=["codesToRemove"],
                        element_id="elementId"
                    ),
                    element_length_validation_rule=b2bi_mixins.CfnTransformerPropsMixin.X12ElementLengthValidationRuleProperty(
                        element_id="elementId",
                        max_length=123,
                        min_length=123
                    ),
                    element_requirement_validation_rule=b2bi_mixins.CfnTransformerPropsMixin.X12ElementRequirementValidationRuleProperty(
                        element_position="elementPosition",
                        requirement="requirement"
                    )
                )]
            )
        )
    ),
    format_options=b2bi_mixins.CfnTransformerPropsMixin.FormatOptionsProperty(
        x12=b2bi_mixins.CfnTransformerPropsMixin.X12DetailsProperty(
            transaction_set="transactionSet",
            version="version"
        )
    ),
    to_format="toFormat"
)

Attributes

advanced_options

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

Type:: see

format_options

A structure that contains the X12 transaction set and version for the transformer output.

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

to_format

only X12 is currently supported.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-outputconversion.html#cfn-b2bi-transformer-outputconversion-toformat
Type:: The format for the output from an outbound transformer

SampleDocumentKeysProperty

class CfnTransformerPropsMixin.SampleDocumentKeysProperty(*, input=None, output=None)

Bases: object

An array of the Amazon S3 keys used to identify the location for your sample documents.

Parameters:

input (Optional[str]) – An array of keys for your input sample documents.
output (Optional[str]) – An array of keys for your output sample documents.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-sampledocumentkeys.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.mixins_preview.aws_b2bi import mixins as b2bi_mixins

sample_document_keys_property = b2bi_mixins.CfnTransformerPropsMixin.SampleDocumentKeysProperty(
    input="input",
    output="output"
)

Attributes

input

An array of keys for your input sample documents.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-sampledocumentkeys.html#cfn-b2bi-transformer-sampledocumentkeys-input

output

An array of keys for your output sample documents.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-sampledocumentkeys.html#cfn-b2bi-transformer-sampledocumentkeys-output

SampleDocumentsProperty

class CfnTransformerPropsMixin.SampleDocumentsProperty(*, bucket_name=None, keys=None)

Bases: object

Describes a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.

Parameters:

bucket_name (Optional[str]) – Contains the Amazon S3 bucket that is used to hold your sample documents.
keys (Union[IResolvable, Sequence[Union[IResolvable, SampleDocumentKeysProperty, Dict[str, Any]]], None]) – Contains an array of the Amazon S3 keys used to identify the location for your sample documents.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-sampledocuments.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.mixins_preview.aws_b2bi import mixins as b2bi_mixins

sample_documents_property = b2bi_mixins.CfnTransformerPropsMixin.SampleDocumentsProperty(
    bucket_name="bucketName",
    keys=[b2bi_mixins.CfnTransformerPropsMixin.SampleDocumentKeysProperty(
        input="input",
        output="output"
    )]
)

Attributes

bucket_name

Contains the Amazon S3 bucket that is used to hold your sample documents.

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

keys

Contains an array of the Amazon S3 keys used to identify the location for your sample documents.

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

X12AdvancedOptionsProperty

class CfnTransformerPropsMixin.X12AdvancedOptionsProperty(*, split_options=None, validation_options=None)

Bases: object

Contains advanced options specific to X12 EDI processing, such as splitting large X12 files into smaller units.

Parameters:

split_options (Union[IResolvable, X12SplitOptionsProperty, Dict[str, Any], None]) – Specifies options for splitting X12 EDI files. These options control how large X12 files are divided into smaller, more manageable units.
validation_options (Union[IResolvable, X12ValidationOptionsProperty, Dict[str, Any], None]) – Specifies validation options for X12 EDI processing. These options control how validation rules are applied during EDI document processing, including custom validation rules for element length constraints, code list validations, and element requirement checks.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12advancedoptions.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.mixins_preview.aws_b2bi import mixins as b2bi_mixins

x12_advanced_options_property = b2bi_mixins.CfnTransformerPropsMixin.X12AdvancedOptionsProperty(
    split_options=b2bi_mixins.CfnTransformerPropsMixin.X12SplitOptionsProperty(
        split_by="splitBy"
    ),
    validation_options=b2bi_mixins.CfnTransformerPropsMixin.X12ValidationOptionsProperty(
        validation_rules=[b2bi_mixins.CfnTransformerPropsMixin.X12ValidationRuleProperty(
            code_list_validation_rule=b2bi_mixins.CfnTransformerPropsMixin.X12CodeListValidationRuleProperty(
                codes_to_add=["codesToAdd"],
                codes_to_remove=["codesToRemove"],
                element_id="elementId"
            ),
            element_length_validation_rule=b2bi_mixins.CfnTransformerPropsMixin.X12ElementLengthValidationRuleProperty(
                element_id="elementId",
                max_length=123,
                min_length=123
            ),
            element_requirement_validation_rule=b2bi_mixins.CfnTransformerPropsMixin.X12ElementRequirementValidationRuleProperty(
                element_position="elementPosition",
                requirement="requirement"
            )
        )]
    )
)

Attributes

split_options

Specifies options for splitting X12 EDI files.

These options control how large X12 files are divided into smaller, more manageable units.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12advancedoptions.html#cfn-b2bi-transformer-x12advancedoptions-splitoptions

validation_options

Specifies validation options for X12 EDI processing.

These options control how validation rules are applied during EDI document processing, including custom validation rules for element length constraints, code list validations, and element requirement checks.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12advancedoptions.html#cfn-b2bi-transformer-x12advancedoptions-validationoptions

X12CodeListValidationRuleProperty

class CfnTransformerPropsMixin.X12CodeListValidationRuleProperty(*, codes_to_add=None, codes_to_remove=None, element_id=None)

Bases: object

Code list validation rule configuration.

Parameters:

codes_to_add (Optional[Sequence[str]]) – Specifies a list of code values to add to the element’s allowed values. These codes will be considered valid for the specified element in addition to the standard codes defined by the X12 specification.
codes_to_remove (Optional[Sequence[str]]) – Specifies a list of code values to remove from the element’s allowed values. These codes will be considered invalid for the specified element, even if they are part of the standard codes defined by the X12 specification.
element_id (Optional[str]) – Specifies the four-digit element ID to which the code list modifications apply. This identifies which X12 element will have its allowed code values modified.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12codelistvalidationrule.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.mixins_preview.aws_b2bi import mixins as b2bi_mixins

x12_code_list_validation_rule_property = b2bi_mixins.CfnTransformerPropsMixin.X12CodeListValidationRuleProperty(
    codes_to_add=["codesToAdd"],
    codes_to_remove=["codesToRemove"],
    element_id="elementId"
)

Attributes

codes_to_add

Specifies a list of code values to add to the element’s allowed values.

These codes will be considered valid for the specified element in addition to the standard codes defined by the X12 specification.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12codelistvalidationrule.html#cfn-b2bi-transformer-x12codelistvalidationrule-codestoadd

codes_to_remove

Specifies a list of code values to remove from the element’s allowed values.

These codes will be considered invalid for the specified element, even if they are part of the standard codes defined by the X12 specification.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12codelistvalidationrule.html#cfn-b2bi-transformer-x12codelistvalidationrule-codestoremove

element_id

Specifies the four-digit element ID to which the code list modifications apply.

This identifies which X12 element will have its allowed code values modified.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12codelistvalidationrule.html#cfn-b2bi-transformer-x12codelistvalidationrule-elementid

X12DetailsProperty

class CfnTransformerPropsMixin.X12DetailsProperty(*, transaction_set=None, version=None)

Bases: object

A structure that contains the X12 transaction set and version.

The X12 structure is used when the system transforms an EDI (electronic data interchange) file. .. epigraph:

If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file.

Parameters:

transaction_set (Optional[str]) – Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (Optional[str]) – Returns the version to use for the specified X12 transaction set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12details.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.mixins_preview.aws_b2bi import mixins as b2bi_mixins

x12_details_property = b2bi_mixins.CfnTransformerPropsMixin.X12DetailsProperty(
    transaction_set="transactionSet",
    version="version"
)

Attributes

transaction_set

Returns an enumerated type where each value identifies an X12 transaction set.

Transaction sets are maintained by the X12 Accredited Standards Committee.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12details.html#cfn-b2bi-transformer-x12details-transactionset

version

Returns the version to use for the specified X12 transaction set.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12details.html#cfn-b2bi-transformer-x12details-version

X12ElementLengthValidationRuleProperty

class CfnTransformerPropsMixin.X12ElementLengthValidationRuleProperty(*, element_id=None, max_length=None, min_length=None)

Bases: object

Defines a validation rule that specifies custom length constraints for a specific X12 element.

This rule allows you to override the standard minimum and maximum length requirements for an element, enabling validation of trading partner-specific length requirements that may differ from the X12 specification. Both minimum and maximum length values must be specified.

Parameters:

element_id (Optional[str]) – Specifies the four-digit element ID to which the length constraints will be applied. This identifies which X12 element will have its length requirements modified.
max_length (Union[int, float, None]) – Specifies the maximum allowed length for the identified element. This value defines the upper limit for the element’s content length.
min_length (Union[int, float, None]) – Specifies the minimum required length for the identified element. This value defines the lower limit for the element’s content length.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12elementlengthvalidationrule.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.mixins_preview.aws_b2bi import mixins as b2bi_mixins

x12_element_length_validation_rule_property = b2bi_mixins.CfnTransformerPropsMixin.X12ElementLengthValidationRuleProperty(
    element_id="elementId",
    max_length=123,
    min_length=123
)

Attributes

element_id

Specifies the four-digit element ID to which the length constraints will be applied.

This identifies which X12 element will have its length requirements modified.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12elementlengthvalidationrule.html#cfn-b2bi-transformer-x12elementlengthvalidationrule-elementid

max_length

Specifies the maximum allowed length for the identified element.

This value defines the upper limit for the element’s content length.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12elementlengthvalidationrule.html#cfn-b2bi-transformer-x12elementlengthvalidationrule-maxlength

min_length

Specifies the minimum required length for the identified element.

This value defines the lower limit for the element’s content length.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12elementlengthvalidationrule.html#cfn-b2bi-transformer-x12elementlengthvalidationrule-minlength

X12ElementRequirementValidationRuleProperty

class CfnTransformerPropsMixin.X12ElementRequirementValidationRuleProperty(*, element_position=None, requirement=None)

Bases: object

Defines a validation rule that modifies the requirement status of a specific X12 element within a segment.

This rule allows you to make optional elements mandatory or mandatory elements optional, providing flexibility to accommodate different trading partner requirements and business rules. The rule targets a specific element position within a segment and sets its requirement status to either OPTIONAL or MANDATORY.

Parameters:

element_position (Optional[str]) – Specifies the position of the element within an X12 segment for which the requirement status will be modified. The format follows the pattern of segment identifier followed by element position (e.g., “ST-01” for the first element of the ST segment).
requirement (Optional[str]) – Specifies the requirement status for the element at the specified position. Valid values are OPTIONAL (the element may be omitted) or MANDATORY (the element must be present).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12elementrequirementvalidationrule.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.mixins_preview.aws_b2bi import mixins as b2bi_mixins

x12_element_requirement_validation_rule_property = b2bi_mixins.CfnTransformerPropsMixin.X12ElementRequirementValidationRuleProperty(
    element_position="elementPosition",
    requirement="requirement"
)

Attributes

element_position

Specifies the position of the element within an X12 segment for which the requirement status will be modified.

The format follows the pattern of segment identifier followed by element position (e.g., “ST-01” for the first element of the ST segment).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12elementrequirementvalidationrule.html#cfn-b2bi-transformer-x12elementrequirementvalidationrule-elementposition

requirement

Specifies the requirement status for the element at the specified position.

Valid values are OPTIONAL (the element may be omitted) or MANDATORY (the element must be present).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12elementrequirementvalidationrule.html#cfn-b2bi-transformer-x12elementrequirementvalidationrule-requirement

X12SplitOptionsProperty

class CfnTransformerPropsMixin.X12SplitOptionsProperty(*, split_by=None)

Bases: object

Contains options for splitting X12 EDI files into smaller units.

This is useful for processing large EDI files more efficiently.

Parameters:: split_by (Optional[str]) – Specifies the method used to split X12 EDI files. Valid values include TRANSACTION (split by individual transaction sets), or NONE (no splitting).
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12splitoptions.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.mixins_preview.aws_b2bi import mixins as b2bi_mixins

x12_split_options_property = b2bi_mixins.CfnTransformerPropsMixin.X12SplitOptionsProperty(
    split_by="splitBy"
)

Attributes

split_by

Specifies the method used to split X12 EDI files.

Valid values include TRANSACTION (split by individual transaction sets), or NONE (no splitting).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12splitoptions.html#cfn-b2bi-transformer-x12splitoptions-splitby

X12ValidationOptionsProperty

class CfnTransformerPropsMixin.X12ValidationOptionsProperty(*, validation_rules=None)

Bases: object

Contains configuration options for X12 EDI validation.

This structure allows you to specify custom validation rules that will be applied during EDI document processing, including element length constraints, code list modifications, and element requirement changes. These validation options provide flexibility to accommodate trading partner-specific requirements while maintaining EDI compliance. The validation rules are applied in addition to standard X12 validation to ensure documents meet both standard and custom requirements.

Parameters:: validation_rules (Union[IResolvable, Sequence[Union[IResolvable, X12ValidationRuleProperty, Dict[str, Any]]], None]) – Specifies a list of validation rules to apply during EDI document processing. These rules can include code list modifications, element length constraints, and element requirement changes.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12validationoptions.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.mixins_preview.aws_b2bi import mixins as b2bi_mixins

x12_validation_options_property = b2bi_mixins.CfnTransformerPropsMixin.X12ValidationOptionsProperty(
    validation_rules=[b2bi_mixins.CfnTransformerPropsMixin.X12ValidationRuleProperty(
        code_list_validation_rule=b2bi_mixins.CfnTransformerPropsMixin.X12CodeListValidationRuleProperty(
            codes_to_add=["codesToAdd"],
            codes_to_remove=["codesToRemove"],
            element_id="elementId"
        ),
        element_length_validation_rule=b2bi_mixins.CfnTransformerPropsMixin.X12ElementLengthValidationRuleProperty(
            element_id="elementId",
            max_length=123,
            min_length=123
        ),
        element_requirement_validation_rule=b2bi_mixins.CfnTransformerPropsMixin.X12ElementRequirementValidationRuleProperty(
            element_position="elementPosition",
            requirement="requirement"
        )
    )]
)

Attributes

validation_rules

Specifies a list of validation rules to apply during EDI document processing.

These rules can include code list modifications, element length constraints, and element requirement changes.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12validationoptions.html#cfn-b2bi-transformer-x12validationoptions-validationrules

X12ValidationRuleProperty

class CfnTransformerPropsMixin.X12ValidationRuleProperty(*, code_list_validation_rule=None, element_length_validation_rule=None, element_requirement_validation_rule=None)

Bases: object

Represents a single validation rule that can be applied during X12 EDI processing.

This is a union type that can contain one of several specific validation rule types: code list validation rules for modifying allowed element codes, element length validation rules for enforcing custom length constraints, or element requirement validation rules for changing mandatory/optional status. Each validation rule targets specific aspects of EDI document validation to ensure compliance with trading partner requirements and business rules.

Parameters:

code_list_validation_rule (Union[IResolvable, X12CodeListValidationRuleProperty, Dict[str, Any], None]) – Specifies a code list validation rule that modifies the allowed code values for a specific X12 element. This rule enables you to customize which codes are considered valid for an element, allowing for trading partner-specific code requirements.
element_length_validation_rule (Union[IResolvable, X12ElementLengthValidationRuleProperty, Dict[str, Any], None]) – Specifies an element length validation rule that defines custom length constraints for a specific X12 element. This rule allows you to enforce minimum and maximum length requirements that may differ from the standard X12 specification.
element_requirement_validation_rule (Union[IResolvable, X12ElementRequirementValidationRuleProperty, Dict[str, Any], None]) – Specifies an element requirement validation rule that modifies whether a specific X12 element is required or optional within a segment. This rule provides flexibility to accommodate different trading partner requirements for element presence.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12validationrule.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.mixins_preview.aws_b2bi import mixins as b2bi_mixins

x12_validation_rule_property = b2bi_mixins.CfnTransformerPropsMixin.X12ValidationRuleProperty(
    code_list_validation_rule=b2bi_mixins.CfnTransformerPropsMixin.X12CodeListValidationRuleProperty(
        codes_to_add=["codesToAdd"],
        codes_to_remove=["codesToRemove"],
        element_id="elementId"
    ),
    element_length_validation_rule=b2bi_mixins.CfnTransformerPropsMixin.X12ElementLengthValidationRuleProperty(
        element_id="elementId",
        max_length=123,
        min_length=123
    ),
    element_requirement_validation_rule=b2bi_mixins.CfnTransformerPropsMixin.X12ElementRequirementValidationRuleProperty(
        element_position="elementPosition",
        requirement="requirement"
    )
)

Attributes

code_list_validation_rule

Specifies a code list validation rule that modifies the allowed code values for a specific X12 element.

This rule enables you to customize which codes are considered valid for an element, allowing for trading partner-specific code requirements.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12validationrule.html#cfn-b2bi-transformer-x12validationrule-codelistvalidationrule

element_length_validation_rule

Specifies an element length validation rule that defines custom length constraints for a specific X12 element.

This rule allows you to enforce minimum and maximum length requirements that may differ from the standard X12 specification.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12validationrule.html#cfn-b2bi-transformer-x12validationrule-elementlengthvalidationrule

element_requirement_validation_rule

Specifies an element requirement validation rule that modifies whether a specific X12 element is required or optional within a segment.

This rule provides flexibility to accommodate different trading partner requirements for element presence.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12validationrule.html#cfn-b2bi-transformer-x12validationrule-elementrequirementvalidationrule