CfnPartnershipPropsMixin

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

Bases: Mixin

Creates a partnership between a customer and a trading partner, based on the supplied parameters.

A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.

See:

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

CloudformationResource:

AWS::B2BI::Partnership

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_partnership_props_mixin = b2bi_mixins.CfnPartnershipPropsMixin(b2bi_mixins.CfnPartnershipMixinProps(
    capabilities=["capabilities"],
    capability_options=b2bi_mixins.CfnPartnershipPropsMixin.CapabilityOptionsProperty(
        inbound_edi=b2bi_mixins.CfnPartnershipPropsMixin.InboundEdiOptionsProperty(
            x12=b2bi_mixins.CfnPartnershipPropsMixin.X12InboundEdiOptionsProperty(
                acknowledgment_options=b2bi_mixins.CfnPartnershipPropsMixin.X12AcknowledgmentOptionsProperty(
                    functional_acknowledgment="functionalAcknowledgment",
                    technical_acknowledgment="technicalAcknowledgment"
                )
            )
        ),
        outbound_edi=b2bi_mixins.CfnPartnershipPropsMixin.OutboundEdiOptionsProperty(
            x12=b2bi_mixins.CfnPartnershipPropsMixin.X12EnvelopeProperty(
                common=b2bi_mixins.CfnPartnershipPropsMixin.X12OutboundEdiHeadersProperty(
                    control_numbers=b2bi_mixins.CfnPartnershipPropsMixin.X12ControlNumbersProperty(
                        starting_functional_group_control_number=123,
                        starting_interchange_control_number=123,
                        starting_transaction_set_control_number=123
                    ),
                    delimiters=b2bi_mixins.CfnPartnershipPropsMixin.X12DelimitersProperty(
                        component_separator="componentSeparator",
                        data_element_separator="dataElementSeparator",
                        segment_terminator="segmentTerminator"
                    ),
                    functional_group_headers=b2bi_mixins.CfnPartnershipPropsMixin.X12FunctionalGroupHeadersProperty(
                        application_receiver_code="applicationReceiverCode",
                        application_sender_code="applicationSenderCode",
                        responsible_agency_code="responsibleAgencyCode"
                    ),
                    gs05_time_format="gs05TimeFormat",
                    interchange_control_headers=b2bi_mixins.CfnPartnershipPropsMixin.X12InterchangeControlHeadersProperty(
                        acknowledgment_requested_code="acknowledgmentRequestedCode",
                        receiver_id="receiverId",
                        receiver_id_qualifier="receiverIdQualifier",
                        repetition_separator="repetitionSeparator",
                        sender_id="senderId",
                        sender_id_qualifier="senderIdQualifier",
                        usage_indicator_code="usageIndicatorCode"
                    ),
                    validate_edi=False
                ),
                wrap_options=b2bi_mixins.CfnPartnershipPropsMixin.WrapOptionsProperty(
                    line_length=123,
                    line_terminator="lineTerminator",
                    wrap_by="wrapBy"
                )
            )
        )
    ),
    email="email",
    name="name",
    phone="phone",
    profile_id="profileId",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

  • props (Union[CfnPartnershipMixinProps, 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 = ['capabilities', 'capabilityOptions', 'email', 'name', 'phone', 'profileId', '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

CapabilityOptionsProperty

class CfnPartnershipPropsMixin.CapabilityOptionsProperty(*, inbound_edi=None, outbound_edi=None)

Bases: object

Contains the details for an Outbound EDI capability.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-capabilityoptions.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

capability_options_property = b2bi_mixins.CfnPartnershipPropsMixin.CapabilityOptionsProperty(
    inbound_edi=b2bi_mixins.CfnPartnershipPropsMixin.InboundEdiOptionsProperty(
        x12=b2bi_mixins.CfnPartnershipPropsMixin.X12InboundEdiOptionsProperty(
            acknowledgment_options=b2bi_mixins.CfnPartnershipPropsMixin.X12AcknowledgmentOptionsProperty(
                functional_acknowledgment="functionalAcknowledgment",
                technical_acknowledgment="technicalAcknowledgment"
            )
        )
    ),
    outbound_edi=b2bi_mixins.CfnPartnershipPropsMixin.OutboundEdiOptionsProperty(
        x12=b2bi_mixins.CfnPartnershipPropsMixin.X12EnvelopeProperty(
            common=b2bi_mixins.CfnPartnershipPropsMixin.X12OutboundEdiHeadersProperty(
                control_numbers=b2bi_mixins.CfnPartnershipPropsMixin.X12ControlNumbersProperty(
                    starting_functional_group_control_number=123,
                    starting_interchange_control_number=123,
                    starting_transaction_set_control_number=123
                ),
                delimiters=b2bi_mixins.CfnPartnershipPropsMixin.X12DelimitersProperty(
                    component_separator="componentSeparator",
                    data_element_separator="dataElementSeparator",
                    segment_terminator="segmentTerminator"
                ),
                functional_group_headers=b2bi_mixins.CfnPartnershipPropsMixin.X12FunctionalGroupHeadersProperty(
                    application_receiver_code="applicationReceiverCode",
                    application_sender_code="applicationSenderCode",
                    responsible_agency_code="responsibleAgencyCode"
                ),
                gs05_time_format="gs05TimeFormat",
                interchange_control_headers=b2bi_mixins.CfnPartnershipPropsMixin.X12InterchangeControlHeadersProperty(
                    acknowledgment_requested_code="acknowledgmentRequestedCode",
                    receiver_id="receiverId",
                    receiver_id_qualifier="receiverIdQualifier",
                    repetition_separator="repetitionSeparator",
                    sender_id="senderId",
                    sender_id_qualifier="senderIdQualifier",
                    usage_indicator_code="usageIndicatorCode"
                ),
                validate_edi=False
            ),
            wrap_options=b2bi_mixins.CfnPartnershipPropsMixin.WrapOptionsProperty(
                line_length=123,
                line_terminator="lineTerminator",
                wrap_by="wrapBy"
            )
        )
    )
)

Attributes

inbound_edi

A structure that contains the inbound EDI options for the capability.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-capabilityoptions.html#cfn-b2bi-partnership-capabilityoptions-inboundedi

outbound_edi

A structure that contains the outbound EDI options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-capabilityoptions.html#cfn-b2bi-partnership-capabilityoptions-outboundedi

InboundEdiOptionsProperty

class CfnPartnershipPropsMixin.InboundEdiOptionsProperty(*, x12=None)

Bases: object

Contains options for processing inbound EDI files.

These options allow for customizing how incoming EDI documents are processed.

Parameters:

x12 (Union[IResolvable, X12InboundEdiOptionsProperty, Dict[str, Any], None]) – A structure that contains X12-specific options for processing inbound X12 EDI files.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-inboundedioptions.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

inbound_edi_options_property = b2bi_mixins.CfnPartnershipPropsMixin.InboundEdiOptionsProperty(
    x12=b2bi_mixins.CfnPartnershipPropsMixin.X12InboundEdiOptionsProperty(
        acknowledgment_options=b2bi_mixins.CfnPartnershipPropsMixin.X12AcknowledgmentOptionsProperty(
            functional_acknowledgment="functionalAcknowledgment",
            technical_acknowledgment="technicalAcknowledgment"
        )
    )
)

Attributes

x12

A structure that contains X12-specific options for processing inbound X12 EDI files.

See:

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

OutboundEdiOptionsProperty

class CfnPartnershipPropsMixin.OutboundEdiOptionsProperty(*, x12=None)

Bases: object

A container for outbound EDI options.

Parameters:

x12 (Union[IResolvable, X12EnvelopeProperty, Dict[str, Any], None]) – A structure that contains an X12 envelope structure.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-outboundedioptions.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

outbound_edi_options_property = b2bi_mixins.CfnPartnershipPropsMixin.OutboundEdiOptionsProperty(
    x12=b2bi_mixins.CfnPartnershipPropsMixin.X12EnvelopeProperty(
        common=b2bi_mixins.CfnPartnershipPropsMixin.X12OutboundEdiHeadersProperty(
            control_numbers=b2bi_mixins.CfnPartnershipPropsMixin.X12ControlNumbersProperty(
                starting_functional_group_control_number=123,
                starting_interchange_control_number=123,
                starting_transaction_set_control_number=123
            ),
            delimiters=b2bi_mixins.CfnPartnershipPropsMixin.X12DelimitersProperty(
                component_separator="componentSeparator",
                data_element_separator="dataElementSeparator",
                segment_terminator="segmentTerminator"
            ),
            functional_group_headers=b2bi_mixins.CfnPartnershipPropsMixin.X12FunctionalGroupHeadersProperty(
                application_receiver_code="applicationReceiverCode",
                application_sender_code="applicationSenderCode",
                responsible_agency_code="responsibleAgencyCode"
            ),
            gs05_time_format="gs05TimeFormat",
            interchange_control_headers=b2bi_mixins.CfnPartnershipPropsMixin.X12InterchangeControlHeadersProperty(
                acknowledgment_requested_code="acknowledgmentRequestedCode",
                receiver_id="receiverId",
                receiver_id_qualifier="receiverIdQualifier",
                repetition_separator="repetitionSeparator",
                sender_id="senderId",
                sender_id_qualifier="senderIdQualifier",
                usage_indicator_code="usageIndicatorCode"
            ),
            validate_edi=False
        ),
        wrap_options=b2bi_mixins.CfnPartnershipPropsMixin.WrapOptionsProperty(
            line_length=123,
            line_terminator="lineTerminator",
            wrap_by="wrapBy"
        )
    )
)

Attributes

x12

A structure that contains an X12 envelope structure.

See:

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

WrapOptionsProperty

class CfnPartnershipPropsMixin.WrapOptionsProperty(*, line_length=None, line_terminator=None, wrap_by=None)

Bases: object

Contains options for wrapping (line folding) in X12 EDI files.

Wrapping controls how long lines are handled in the EDI output.

Parameters:

  • line_length (Union[int, float, None]) – Specifies the maximum length of a line before wrapping occurs. This value is used when wrapBy is set to LINE_LENGTH .

  • line_terminator (Optional[str]) – Specifies the character sequence used to terminate lines when wrapping. Valid values:. - CRLF : carriage return and line feed - LF : line feed) - CR : carriage return

  • wrap_by (Optional[str]) – Specifies the method used for wrapping lines in the EDI output. Valid values:. - SEGMENT : Wraps by segment. - ONE_LINE : Indicates that the entire content is on a single line. .. epigraph:: When you specify ONE_LINE , do not provide either the line length nor the line terminator value. - LINE_LENGTH : Wraps by character count, as specified by lineLength value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-wrapoptions.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

wrap_options_property = b2bi_mixins.CfnPartnershipPropsMixin.WrapOptionsProperty(
    line_length=123,
    line_terminator="lineTerminator",
    wrap_by="wrapBy"
)

Attributes

line_length

Specifies the maximum length of a line before wrapping occurs.

This value is used when wrapBy is set to LINE_LENGTH .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-wrapoptions.html#cfn-b2bi-partnership-wrapoptions-linelength

line_terminator

.

  • CRLF : carriage return and line feed

  • LF : line feed)

  • CR : carriage return

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-wrapoptions.html#cfn-b2bi-partnership-wrapoptions-lineterminator

Type:

Specifies the character sequence used to terminate lines when wrapping. Valid values

wrap_by

.

  • SEGMENT : Wraps by segment.

  • ONE_LINE : Indicates that the entire content is on a single line.

When you specify ONE_LINE , do not provide either the line length nor the line terminator value.

  • LINE_LENGTH : Wraps by character count, as specified by lineLength value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-wrapoptions.html#cfn-b2bi-partnership-wrapoptions-wrapby

Type:

Specifies the method used for wrapping lines in the EDI output. Valid values

X12AcknowledgmentOptionsProperty

class CfnPartnershipPropsMixin.X12AcknowledgmentOptionsProperty(*, functional_acknowledgment=None, technical_acknowledgment=None)

Bases: object

Contains options for configuring X12 acknowledgments.

These options control how functional and technical acknowledgments are handled.

Parameters:

  • functional_acknowledgment (Optional[str]) – Specifies whether functional acknowledgments (997/999) should be generated for incoming X12 transactions. Valid values are DO_NOT_GENERATE , GENERATE_ALL_SEGMENTS and GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP . If you choose GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP , AWS B2B Data Interchange skips the AK2_Loop when generating an acknowledgment document.

  • technical_acknowledgment (Optional[str]) – Specifies whether technical acknowledgments (TA1) should be generated for incoming X12 interchanges. Valid values are DO_NOT_GENERATE and GENERATE_ALL_SEGMENTS and.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12acknowledgmentoptions.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_acknowledgment_options_property = b2bi_mixins.CfnPartnershipPropsMixin.X12AcknowledgmentOptionsProperty(
    functional_acknowledgment="functionalAcknowledgment",
    technical_acknowledgment="technicalAcknowledgment"
)

Attributes

functional_acknowledgment

Specifies whether functional acknowledgments (997/999) should be generated for incoming X12 transactions.

Valid values are DO_NOT_GENERATE , GENERATE_ALL_SEGMENTS and GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP .

If you choose GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP , AWS B2B Data Interchange skips the AK2_Loop when generating an acknowledgment document.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12acknowledgmentoptions.html#cfn-b2bi-partnership-x12acknowledgmentoptions-functionalacknowledgment

technical_acknowledgment

Specifies whether technical acknowledgments (TA1) should be generated for incoming X12 interchanges.

Valid values are DO_NOT_GENERATE and GENERATE_ALL_SEGMENTS and.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12acknowledgmentoptions.html#cfn-b2bi-partnership-x12acknowledgmentoptions-technicalacknowledgment

X12ControlNumbersProperty

class CfnPartnershipPropsMixin.X12ControlNumbersProperty(*, starting_functional_group_control_number=None, starting_interchange_control_number=None, starting_transaction_set_control_number=None)

Bases: object

Contains configuration for X12 control numbers used in X12 EDI generation.

Control numbers are used to uniquely identify interchanges, functional groups, and transaction sets.

Parameters:

  • starting_functional_group_control_number (Union[int, float, None]) – Specifies the starting functional group control number (GS06) to use for X12 EDI generation. This number is incremented for each new functional group. For the GS (functional group) envelope, AWS B2B Data Interchange generates a functional group control number that is unique to the sender ID, receiver ID, and functional identifier code combination.

  • starting_interchange_control_number (Union[int, float, None]) – Specifies the starting interchange control number (ISA13) to use for X12 EDI generation. This number is incremented for each new interchange. For the ISA (interchange) envelope, AWS B2B Data Interchange generates an interchange control number that is unique for the ISA05 and ISA06 (sender) & ISA07 and ISA08 (receiver) combination.

  • starting_transaction_set_control_number (Union[int, float, None]) – Specifies the starting transaction set control number (ST02) to use for X12 EDI generation. This number is incremented for each new transaction set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12controlnumbers.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_control_numbers_property = b2bi_mixins.CfnPartnershipPropsMixin.X12ControlNumbersProperty(
    starting_functional_group_control_number=123,
    starting_interchange_control_number=123,
    starting_transaction_set_control_number=123
)

Attributes

starting_functional_group_control_number

Specifies the starting functional group control number (GS06) to use for X12 EDI generation.

This number is incremented for each new functional group. For the GS (functional group) envelope, AWS B2B Data Interchange generates a functional group control number that is unique to the sender ID, receiver ID, and functional identifier code combination.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12controlnumbers.html#cfn-b2bi-partnership-x12controlnumbers-startingfunctionalgroupcontrolnumber

starting_interchange_control_number

Specifies the starting interchange control number (ISA13) to use for X12 EDI generation.

This number is incremented for each new interchange. For the ISA (interchange) envelope, AWS B2B Data Interchange generates an interchange control number that is unique for the ISA05 and ISA06 (sender) & ISA07 and ISA08 (receiver) combination.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12controlnumbers.html#cfn-b2bi-partnership-x12controlnumbers-startinginterchangecontrolnumber

starting_transaction_set_control_number

Specifies the starting transaction set control number (ST02) to use for X12 EDI generation.

This number is incremented for each new transaction set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12controlnumbers.html#cfn-b2bi-partnership-x12controlnumbers-startingtransactionsetcontrolnumber

X12DelimitersProperty

class CfnPartnershipPropsMixin.X12DelimitersProperty(*, component_separator=None, data_element_separator=None, segment_terminator=None)

Bases: object

In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.

The delimiters are part of the message’s syntax and divide up its different elements.

Parameters:

  • component_separator (Optional[str]) – The component, or sub-element, separator. The default value is : (colon).

  • data_element_separator (Optional[str]) – The data element separator. The default value is * (asterisk).

  • segment_terminator (Optional[str]) – The segment terminator. The default value is ~ (tilde).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12delimiters.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_delimiters_property = b2bi_mixins.CfnPartnershipPropsMixin.X12DelimitersProperty(
    component_separator="componentSeparator",
    data_element_separator="dataElementSeparator",
    segment_terminator="segmentTerminator"
)

Attributes

component_separator

The component, or sub-element, separator.

The default value is : (colon).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12delimiters.html#cfn-b2bi-partnership-x12delimiters-componentseparator

data_element_separator

The data element separator.

The default value is * (asterisk).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12delimiters.html#cfn-b2bi-partnership-x12delimiters-dataelementseparator

segment_terminator

The segment terminator.

The default value is ~ (tilde).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12delimiters.html#cfn-b2bi-partnership-x12delimiters-segmentterminator

X12EnvelopeProperty

class CfnPartnershipPropsMixin.X12EnvelopeProperty(*, common=None, wrap_options=None)

Bases: object

A wrapper structure for an X12 definition object.

the X12 envelope ensures the integrity of the data and the efficiency of the information exchange. The X12 message structure has hierarchical levels. From highest to the lowest, they are:

  • Interchange Envelope

  • Functional Group

  • Transaction Set

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12envelope.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_envelope_property = b2bi_mixins.CfnPartnershipPropsMixin.X12EnvelopeProperty(
    common=b2bi_mixins.CfnPartnershipPropsMixin.X12OutboundEdiHeadersProperty(
        control_numbers=b2bi_mixins.CfnPartnershipPropsMixin.X12ControlNumbersProperty(
            starting_functional_group_control_number=123,
            starting_interchange_control_number=123,
            starting_transaction_set_control_number=123
        ),
        delimiters=b2bi_mixins.CfnPartnershipPropsMixin.X12DelimitersProperty(
            component_separator="componentSeparator",
            data_element_separator="dataElementSeparator",
            segment_terminator="segmentTerminator"
        ),
        functional_group_headers=b2bi_mixins.CfnPartnershipPropsMixin.X12FunctionalGroupHeadersProperty(
            application_receiver_code="applicationReceiverCode",
            application_sender_code="applicationSenderCode",
            responsible_agency_code="responsibleAgencyCode"
        ),
        gs05_time_format="gs05TimeFormat",
        interchange_control_headers=b2bi_mixins.CfnPartnershipPropsMixin.X12InterchangeControlHeadersProperty(
            acknowledgment_requested_code="acknowledgmentRequestedCode",
            receiver_id="receiverId",
            receiver_id_qualifier="receiverIdQualifier",
            repetition_separator="repetitionSeparator",
            sender_id="senderId",
            sender_id_qualifier="senderIdQualifier",
            usage_indicator_code="usageIndicatorCode"
        ),
        validate_edi=False
    ),
    wrap_options=b2bi_mixins.CfnPartnershipPropsMixin.WrapOptionsProperty(
        line_length=123,
        line_terminator="lineTerminator",
        wrap_by="wrapBy"
    )
)

Attributes

common

A container for the X12 outbound EDI headers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12envelope.html#cfn-b2bi-partnership-x12envelope-common

wrap_options

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12envelope.html#cfn-b2bi-partnership-x12envelope-wrapoptions

Type:

see

X12FunctionalGroupHeadersProperty

class CfnPartnershipPropsMixin.X12FunctionalGroupHeadersProperty(*, application_receiver_code=None, application_sender_code=None, responsible_agency_code=None)

Bases: object

Part of the X12 message structure.

These are the functional group headers for the X12 EDI object.

Parameters:

  • application_receiver_code (Optional[str]) – A value representing the code used to identify the party receiving a message, at position GS-03.

  • application_sender_code (Optional[str]) – A value representing the code used to identify the party transmitting a message, at position GS-02.

  • responsible_agency_code (Optional[str]) – A code that identifies the issuer of the standard, at position GS-07.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12functionalgroupheaders.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_functional_group_headers_property = b2bi_mixins.CfnPartnershipPropsMixin.X12FunctionalGroupHeadersProperty(
    application_receiver_code="applicationReceiverCode",
    application_sender_code="applicationSenderCode",
    responsible_agency_code="responsibleAgencyCode"
)

Attributes

application_receiver_code

A value representing the code used to identify the party receiving a message, at position GS-03.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12functionalgroupheaders.html#cfn-b2bi-partnership-x12functionalgroupheaders-applicationreceivercode

application_sender_code

A value representing the code used to identify the party transmitting a message, at position GS-02.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12functionalgroupheaders.html#cfn-b2bi-partnership-x12functionalgroupheaders-applicationsendercode

responsible_agency_code

A code that identifies the issuer of the standard, at position GS-07.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12functionalgroupheaders.html#cfn-b2bi-partnership-x12functionalgroupheaders-responsibleagencycode

X12InboundEdiOptionsProperty

class CfnPartnershipPropsMixin.X12InboundEdiOptionsProperty(*, acknowledgment_options=None)

Bases: object

Contains options specific to processing inbound X12 EDI files.

Parameters:

acknowledgment_options (Union[IResolvable, X12AcknowledgmentOptionsProperty, Dict[str, Any], None]) – Specifies acknowledgment options for inbound X12 EDI files. These options control how functional and technical acknowledgments are handled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12inboundedioptions.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_inbound_edi_options_property = b2bi_mixins.CfnPartnershipPropsMixin.X12InboundEdiOptionsProperty(
    acknowledgment_options=b2bi_mixins.CfnPartnershipPropsMixin.X12AcknowledgmentOptionsProperty(
        functional_acknowledgment="functionalAcknowledgment",
        technical_acknowledgment="technicalAcknowledgment"
    )
)

Attributes

acknowledgment_options

Specifies acknowledgment options for inbound X12 EDI files.

These options control how functional and technical acknowledgments are handled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12inboundedioptions.html#cfn-b2bi-partnership-x12inboundedioptions-acknowledgmentoptions

X12InterchangeControlHeadersProperty

class CfnPartnershipPropsMixin.X12InterchangeControlHeadersProperty(*, acknowledgment_requested_code=None, receiver_id=None, receiver_id_qualifier=None, repetition_separator=None, sender_id=None, sender_id_qualifier=None, usage_indicator_code=None)

Bases: object

In X12, the Interchange Control Header is the first segment of an EDI document and is part of the Interchange Envelope.

It contains information about the sender and receiver, the date and time of transmission, and the X12 version being used. It also includes delivery information, such as the sender and receiver IDs.

Parameters:

  • acknowledgment_requested_code (Optional[str]) – Located at position ISA-14 in the header. The value “1” indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value “0” is used otherwise.

  • receiver_id (Optional[str]) – Located at position ISA-08 in the header. This value (along with the receiverIdQualifier ) identifies the intended recipient of the interchange.

  • receiver_id_qualifier (Optional[str]) – Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.

  • repetition_separator (Optional[str]) – Located at position ISA-11 in the header. This string makes it easier when you need to group similar adjacent element values together without using extra segments. .. epigraph:: This parameter is only honored for version greater than 401 ( VERSION_4010 and higher). For versions less than 401, this field is called StandardsId , in which case our service sets the value to U .

  • sender_id (Optional[str]) – Located at position ISA-06 in the header. This value (along with the senderIdQualifier ) identifies the sender of the interchange.

  • sender_id_qualifier (Optional[str]) – Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.

  • usage_indicator_code (Optional[str]) – Located at position ISA-15 in the header. Specifies how this interchange is being used:. - T indicates this interchange is for testing. - P indicates this interchange is for production. - I indicates this interchange is informational.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.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_interchange_control_headers_property = b2bi_mixins.CfnPartnershipPropsMixin.X12InterchangeControlHeadersProperty(
    acknowledgment_requested_code="acknowledgmentRequestedCode",
    receiver_id="receiverId",
    receiver_id_qualifier="receiverIdQualifier",
    repetition_separator="repetitionSeparator",
    sender_id="senderId",
    sender_id_qualifier="senderIdQualifier",
    usage_indicator_code="usageIndicatorCode"
)

Attributes

acknowledgment_requested_code

Located at position ISA-14 in the header.

The value “1” indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value “0” is used otherwise.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-acknowledgmentrequestedcode

receiver_id

Located at position ISA-08 in the header.

This value (along with the receiverIdQualifier ) identifies the intended recipient of the interchange.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-receiverid

receiver_id_qualifier

Located at position ISA-07 in the header.

Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-receiveridqualifier

repetition_separator

Located at position ISA-11 in the header.

This string makes it easier when you need to group similar adjacent element values together without using extra segments. .. epigraph:

This parameter is only honored for version greater than 401 ( ``VERSION_4010`` and higher).

For versions less than 401, this field is called `StandardsId <https://docs.aws.amazon.com/https://www.stedi.com/edi/x12-004010/segment/ISA#ISA-11>`_ , in which case our service sets the value to ``U`` .
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-repetitionseparator

sender_id

Located at position ISA-06 in the header.

This value (along with the senderIdQualifier ) identifies the sender of the interchange.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-senderid

sender_id_qualifier

Located at position ISA-05 in the header.

Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-senderidqualifier

usage_indicator_code

.

  • T indicates this interchange is for testing.

  • P indicates this interchange is for production.

  • I indicates this interchange is informational.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-usageindicatorcode

Type:

Located at position ISA-15 in the header. Specifies how this interchange is being used

X12OutboundEdiHeadersProperty

class CfnPartnershipPropsMixin.X12OutboundEdiHeadersProperty(*, control_numbers=None, delimiters=None, functional_group_headers=None, gs05_time_format=None, interchange_control_headers=None, validate_edi=None)

Bases: object

A structure containing the details for an outbound EDI object.

Parameters:

  • control_numbers (Union[IResolvable, X12ControlNumbersProperty, Dict[str, Any], None]) – Specifies control number configuration for outbound X12 EDI headers. These settings determine the starting values for interchange, functional group, and transaction set control numbers.

  • delimiters (Union[IResolvable, X12DelimitersProperty, Dict[str, Any], None]) – The delimiters, for example semicolon ( ; ), that separates sections of the headers for the X12 object.

  • functional_group_headers (Union[IResolvable, X12FunctionalGroupHeadersProperty, Dict[str, Any], None]) – The functional group headers for the X12 object.

  • gs05_time_format (Optional[str]) – Specifies the time format in the GS05 element (time) of the functional group header. The following formats use 24-hour clock time: - HHMM - Hours and minutes - HHMMSS - Hours, minutes, and seconds - HHMMSSDD - Hours, minutes, seconds, and decimal seconds Where: - HH - Hours (00-23) - MM - Minutes (00-59) - SS - Seconds (00-59) - DD - Hundredths of seconds (00-99)

  • interchange_control_headers (Union[IResolvable, X12InterchangeControlHeadersProperty, Dict[str, Any], None]) – In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.

  • validate_edi (Union[bool, IResolvable, None]) – Specifies whether or not to validate the EDI for this X12 object: TRUE or FALSE . When enabled, this performs both standard EDI validation and applies any configured custom validation rules including element length constraints, code list validations, and element requirement checks. Validation results are returned in the response validation messages.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.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_outbound_edi_headers_property = b2bi_mixins.CfnPartnershipPropsMixin.X12OutboundEdiHeadersProperty(
    control_numbers=b2bi_mixins.CfnPartnershipPropsMixin.X12ControlNumbersProperty(
        starting_functional_group_control_number=123,
        starting_interchange_control_number=123,
        starting_transaction_set_control_number=123
    ),
    delimiters=b2bi_mixins.CfnPartnershipPropsMixin.X12DelimitersProperty(
        component_separator="componentSeparator",
        data_element_separator="dataElementSeparator",
        segment_terminator="segmentTerminator"
    ),
    functional_group_headers=b2bi_mixins.CfnPartnershipPropsMixin.X12FunctionalGroupHeadersProperty(
        application_receiver_code="applicationReceiverCode",
        application_sender_code="applicationSenderCode",
        responsible_agency_code="responsibleAgencyCode"
    ),
    gs05_time_format="gs05TimeFormat",
    interchange_control_headers=b2bi_mixins.CfnPartnershipPropsMixin.X12InterchangeControlHeadersProperty(
        acknowledgment_requested_code="acknowledgmentRequestedCode",
        receiver_id="receiverId",
        receiver_id_qualifier="receiverIdQualifier",
        repetition_separator="repetitionSeparator",
        sender_id="senderId",
        sender_id_qualifier="senderIdQualifier",
        usage_indicator_code="usageIndicatorCode"
    ),
    validate_edi=False
)

Attributes

control_numbers

Specifies control number configuration for outbound X12 EDI headers.

These settings determine the starting values for interchange, functional group, and transaction set control numbers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-controlnumbers

delimiters

The delimiters, for example semicolon ( ; ), that separates sections of the headers for the X12 object.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-delimiters

functional_group_headers

The functional group headers for the X12 object.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-functionalgroupheaders

gs05_time_format

Specifies the time format in the GS05 element (time) of the functional group header.

The following formats use 24-hour clock time:

  • HHMM - Hours and minutes

  • HHMMSS - Hours, minutes, and seconds

  • HHMMSSDD - Hours, minutes, seconds, and decimal seconds

Where:

  • HH - Hours (00-23)

  • MM - Minutes (00-59)

  • SS - Seconds (00-59)

  • DD - Hundredths of seconds (00-99)

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-gs05timeformat

interchange_control_headers

In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-interchangecontrolheaders

validate_edi

TRUE or FALSE .

When enabled, this performs both standard EDI validation and applies any configured custom validation rules including element length constraints, code list validations, and element requirement checks. Validation results are returned in the response validation messages.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-validateedi

Type:

Specifies whether or not to validate the EDI for this X12 object