interface X12OutboundEdiHeadersProperty

Language	Type name
.NET	`Amazon.CDK.aws_b2bi.CfnPartnership.X12OutboundEdiHeadersProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsb2bi#CfnPartnership_X12OutboundEdiHeadersProperty`
Java	`software.amazon.awscdk.services.b2bi.CfnPartnership.X12OutboundEdiHeadersProperty`
Python	`aws_cdk.aws_b2bi.CfnPartnership.X12OutboundEdiHeadersProperty`
TypeScript	`aws-cdk-lib` » `aws_b2bi` » `CfnPartnership` » `X12OutboundEdiHeadersProperty`

A structure containing the details for an outbound EDI object.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_b2bi as b2bi } from 'aws-cdk-lib';
const x12OutboundEdiHeadersProperty: b2bi.CfnPartnership.X12OutboundEdiHeadersProperty = {
  controlNumbers: {
    startingFunctionalGroupControlNumber: 123,
    startingInterchangeControlNumber: 123,
    startingTransactionSetControlNumber: 123,
  },
  delimiters: {
    componentSeparator: 'componentSeparator',
    dataElementSeparator: 'dataElementSeparator',
    segmentTerminator: 'segmentTerminator',
  },
  functionalGroupHeaders: {
    applicationReceiverCode: 'applicationReceiverCode',
    applicationSenderCode: 'applicationSenderCode',
    responsibleAgencyCode: 'responsibleAgencyCode',
  },
  gs05TimeFormat: 'gs05TimeFormat',
  interchangeControlHeaders: {
    acknowledgmentRequestedCode: 'acknowledgmentRequestedCode',
    receiverId: 'receiverId',
    receiverIdQualifier: 'receiverIdQualifier',
    repetitionSeparator: 'repetitionSeparator',
    senderId: 'senderId',
    senderIdQualifier: 'senderIdQualifier',
    usageIndicatorCode: 'usageIndicatorCode',
  },
  validateEdi: false,
};

Properties

Name	Type	Description
controlNumbers?	`IResolvable` `\|` `X12ControlNumbersProperty`	Specifies control number configuration for outbound X12 EDI headers.
delimiters?	`IResolvable` `\|` `X12DelimitersProperty`	The delimiters, for example semicolon ( `;` ), that separates sections of the headers for the X12 object.
functionalGroupHeaders?	`IResolvable` `\|` `X12FunctionalGroupHeadersProperty`	The functional group headers for the X12 object.
gs05TimeFormat?	`string`	Specifies the time format in the GS05 element (time) of the functional group header.
interchangeControlHeaders?	`IResolvable` `\|` `X12InterchangeControlHeadersProperty`	In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.
validateEdi?	`boolean \|` `IResolvable`	Specifies whether or not to validate the EDI for this X12 object: `TRUE` or `FALSE` .

controlNumbers?

Type: IResolvable | X12ControlNumbersProperty (optional)

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?

Type: IResolvable | X12DelimitersProperty (optional)

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

functionalGroupHeaders?

Type: IResolvable | X12FunctionalGroupHeadersProperty (optional)

The functional group headers for the X12 object.

gs05TimeFormat?

Type: string (optional)

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)

interchangeControlHeaders?

Type: IResolvable | X12InterchangeControlHeadersProperty (optional)

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

validateEdi?

Type: boolean | IResolvable (optional)

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.