interface X12ValidationRuleProperty

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

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.

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 x12ValidationRuleProperty: b2bi.CfnTransformer.X12ValidationRuleProperty = {
  codeListValidationRule: {
    elementId: 'elementId',

    // the properties below are optional
    codesToAdd: ['codesToAdd'],
    codesToRemove: ['codesToRemove'],
  },
  elementLengthValidationRule: {
    elementId: 'elementId',
    maxLength: 123,
    minLength: 123,
  },
  elementRequirementValidationRule: {
    elementPosition: 'elementPosition',
    requirement: 'requirement',
  },
};

Properties

Name	Type	Description
codeListValidationRule?	`IResolvable` `\|` `X12CodeListValidationRuleProperty`	Specifies a code list validation rule that modifies the allowed code values for a specific X12 element.
elementLengthValidationRule?	`IResolvable` `\|` `X12ElementLengthValidationRuleProperty`	Specifies an element length validation rule that defines custom length constraints for a specific X12 element.
elementRequirementValidationRule?	`IResolvable` `\|` `X12ElementRequirementValidationRuleProperty`	Specifies an element requirement validation rule that modifies whether a specific X12 element is required or optional within a segment.

codeListValidationRule?

Type: IResolvable | X12CodeListValidationRuleProperty (optional)

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.

elementLengthValidationRule?

Type: IResolvable | X12ElementLengthValidationRuleProperty (optional)

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.

elementRequirementValidationRule?

Type: IResolvable | X12ElementRequirementValidationRuleProperty (optional)

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.