interface CfnPartnershipProps

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

Properties for defining a CfnPartnership.

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 cfnPartnershipProps: b2bi.CfnPartnershipProps = {
  capabilities: ['capabilities'],
  email: 'email',
  name: 'name',
  profileId: 'profileId',

  // the properties below are optional
  capabilityOptions: {
    inboundEdi: {
      x12: {
        acknowledgmentOptions: {
          functionalAcknowledgment: 'functionalAcknowledgment',
          technicalAcknowledgment: 'technicalAcknowledgment',
        },
      },
    },
    outboundEdi: {
      x12: {
        common: {
          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,
        },
        wrapOptions: {
          lineLength: 123,
          lineTerminator: 'lineTerminator',
          wrapBy: 'wrapBy',
        },
      },
    },
  },
  phone: 'phone',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
capabilities	`string[]`	Returns one or more capabilities associated with this partnership.
email	`string`	Specifies the email address associated with this trading partner.
name	`string`	Returns the name of the partnership.
profileId	`string`	Returns the unique, system-generated identifier for the profile connected to this partnership.
capabilityOptions?	`IResolvable` `\|` `CapabilityOptionsProperty`	Contains the details for an Outbound EDI capability.
phone?	`string`	Specifies the phone number associated with the partnership.
tags?	`CfnTag[]`	A key-value pair for a specific partnership.

capabilities

Type: string[]

Returns one or more capabilities associated with this partnership.

email

Type: string

Specifies the email address associated with this trading partner.

name

Type: string

Returns the name of the partnership.

profileId

Type: string

Returns the unique, system-generated identifier for the profile connected to this partnership.

capabilityOptions?

Type: IResolvable | CapabilityOptionsProperty (optional)

Contains the details for an Outbound EDI capability.

phone?

Type: string (optional)

Specifies the phone number associated with the partnership.

tags?

Type: CfnTag[] (optional)

A key-value pair for a specific partnership.

Tags are metadata that you can use to search for and group capabilities for various purposes.