# AWS::B2BI Construct Library

---

![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)

> All classes with the `Cfn` prefix in this module ([CFN Resources]) are always stable and safe to use.
>
> [CFN Resources]: https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib

---

This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.

```ts
import * as b2bi from 'aws-cdk-lib/aws-b2bi';
```

There are no official hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet. Here are some suggestions on how to proceed:

- Search [Construct Hub for B2BI construct libraries](https://constructs.dev/search?q=b2bi)
- Use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, in the same way you would use [the CloudFormation AWS::B2BI resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_B2BI.html) directly.

There are no hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet.
However, you can still use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the [CloudFormation documentation for AWS::B2BI](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_B2BI.html).

(Read the [CDK Contributing Guide](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and submit an RFC if you are interested in contributing to this construct library.)

## Types

| Name | Kind | Summary |
| --- | --- | --- |
| [`CfnCapability`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnCapability) | Construct (L1) | Instantiates a capability based on the specified parameters. |
| [`CfnPartnership`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnPartnership) | Construct (L1) | Creates a partnership between a customer and a trading partner, based on the supplied parameters. |
| [`CfnProfile`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnProfile) | Construct (L1) | Creates a customer profile. |
| [`CfnTransformer`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnTransformer) | Construct (L1) | Creates a transformer. AWS B2B Data Interchange currently supports two scenarios:. |
| [`CfnCapability.CapabilityConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnCapability.CapabilityConfigurationProperty) | Struct | A capability object. |
| [`CfnCapability.EdiConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnCapability.EdiConfigurationProperty) | Struct | Specifies the details for the EDI (electronic data interchange) transformation. |
| [`CfnCapability.EdiTypeProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnCapability.EdiTypeProperty) | Struct |  |
| [`CfnCapability.S3LocationProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnCapability.S3LocationProperty) | Struct | Specifies the details for the Amazon S3 file location that is being used with AWS B2B Data Interchange. |
| [`CfnCapability.X12DetailsProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnCapability.X12DetailsProperty) | Struct | A structure that contains the X12 transaction set and version. |
| [`CfnCapabilityProps`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnCapabilityProps) | Struct | Properties for defining a `CfnCapability`. |
| [`CfnPartnership.CapabilityOptionsProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnPartnership.CapabilityOptionsProperty) | Struct | Contains the details for an Outbound EDI capability. |
| [`CfnPartnership.InboundEdiOptionsProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnPartnership.InboundEdiOptionsProperty) | Struct | Contains options for processing inbound EDI files. |
| [`CfnPartnership.OutboundEdiOptionsProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnPartnership.OutboundEdiOptionsProperty) | Struct | A container for outbound EDI options. |
| [`CfnPartnership.WrapOptionsProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnPartnership.WrapOptionsProperty) | Struct | Contains options for wrapping (line folding) in X12 EDI files. |
| [`CfnPartnership.X12AcknowledgmentOptionsProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnPartnership.X12AcknowledgmentOptionsProperty) | Struct | Contains options for configuring X12 acknowledgments. |
| [`CfnPartnership.X12ControlNumbersProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnPartnership.X12ControlNumbersProperty) | Struct | Contains configuration for X12 control numbers used in X12 EDI generation. |
| [`CfnPartnership.X12DelimitersProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnPartnership.X12DelimitersProperty) | Struct | In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header. |
| [`CfnPartnership.X12EnvelopeProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnPartnership.X12EnvelopeProperty) | Struct | A wrapper structure for an X12 definition object. |
| [`CfnPartnership.X12FunctionalGroupHeadersProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnPartnership.X12FunctionalGroupHeadersProperty) | Struct | Part of the X12 message structure. |
| [`CfnPartnership.X12InboundEdiOptionsProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnPartnership.X12InboundEdiOptionsProperty) | Struct | Contains options specific to processing inbound X12 EDI files. |
| [`CfnPartnership.X12InterchangeControlHeadersProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnPartnership.X12InterchangeControlHeadersProperty) | Struct | In X12, the Interchange Control Header is the first segment of an EDI document and is part of the Interchange Envelope. |
| [`CfnPartnership.X12OutboundEdiHeadersProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnPartnership.X12OutboundEdiHeadersProperty) | Struct | A structure containing the details for an outbound EDI object. |
| [`CfnPartnershipProps`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnPartnershipProps) | Struct | Properties for defining a `CfnPartnership`. |
| [`CfnProfileProps`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnProfileProps) | Struct | Properties for defining a `CfnProfile`. |
| [`CfnTransformer.AdvancedOptionsProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnTransformer.AdvancedOptionsProperty) | Struct | A structure that contains advanced options for EDI processing. |
| [`CfnTransformer.EdiTypeProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnTransformer.EdiTypeProperty) | Struct |  |
| [`CfnTransformer.FormatOptionsProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnTransformer.FormatOptionsProperty) | Struct | A structure that contains the X12 transaction set and version. |
| [`CfnTransformer.InputConversionProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnTransformer.InputConversionProperty) | Struct | Contains the input formatting options for an inbound transformer (takes an X12-formatted EDI document as input and converts it to JSON or XML. |
| [`CfnTransformer.MappingProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnTransformer.MappingProperty) | Struct | Specifies the mapping template for the transformer. |
| [`CfnTransformer.OutputConversionProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnTransformer.OutputConversionProperty) | Struct | 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). |
| [`CfnTransformer.SampleDocumentKeysProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnTransformer.SampleDocumentKeysProperty) | Struct | An array of the Amazon S3 keys used to identify the location for your sample documents. |
| [`CfnTransformer.SampleDocumentsProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnTransformer.SampleDocumentsProperty) | Struct | 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. |
| [`CfnTransformer.X12AdvancedOptionsProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnTransformer.X12AdvancedOptionsProperty) | Struct | Contains advanced options specific to X12 EDI processing, such as splitting large X12 files into smaller units. |
| [`CfnTransformer.X12CodeListValidationRuleProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnTransformer.X12CodeListValidationRuleProperty) | Struct | Code list validation rule configuration. |
| [`CfnTransformer.X12DetailsProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnTransformer.X12DetailsProperty) | Struct | A structure that contains the X12 transaction set and version. |
| [`CfnTransformer.X12ElementLengthValidationRuleProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnTransformer.X12ElementLengthValidationRuleProperty) | Struct | Defines a validation rule that specifies custom length constraints for a specific X12 element. |
| [`CfnTransformer.X12ElementRequirementValidationRuleProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnTransformer.X12ElementRequirementValidationRuleProperty) | Struct | Defines a validation rule that modifies the requirement status of a specific X12 element within a segment. |
| [`CfnTransformer.X12SplitOptionsProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnTransformer.X12SplitOptionsProperty) | Struct | Contains options for splitting X12 EDI files into smaller units. |
| [`CfnTransformer.X12ValidationOptionsProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnTransformer.X12ValidationOptionsProperty) | Struct | Contains configuration options for X12 EDI validation. |
| [`CfnTransformer.X12ValidationRuleProperty`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnTransformer.X12ValidationRuleProperty) | Struct | Represents a single validation rule that can be applied during X12 EDI processing. |
| [`CfnTransformerProps`](/v2/docs/aws-cdk-lib.aws_b2bi.CfnTransformerProps) | Struct | Properties for defining a `CfnTransformer`. |