interface CfnPartnershipProps
Language | Type name |
---|---|
![]() | Amazon.CDK.aws_b2bi.CfnPartnershipProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsb2bi#CfnPartnershipProps |
![]() | software.amazon.awscdk.services.b2bi.CfnPartnershipProps |
![]() | aws_cdk.aws_b2bi.CfnPartnershipProps |
![]() | aws-cdk-lib » aws_b2bi » CfnPartnershipProps |
Properties for defining a CfnPartnership
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html
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. |
string | Specifies the email address associated with this trading partner. | |
name | string | Returns the name of the partnership. |
profile | string | Returns the unique, system-generated identifier for the profile connected to this partnership. |
capability | IResolvable | Capability | Contains the details for an Outbound EDI capability. |
phone? | string | Specifies the phone number associated with the partnership. |
tags? | Cfn [] | A key-value pair for a specific partnership. |
capabilities
Type:
string[]
Returns one or more capabilities associated with this partnership.
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
|
Capability
(optional)
Contains the details for an Outbound EDI capability.
phone?
Type:
string
(optional)
Specifies the phone number associated with the partnership.
tags?
Type:
Cfn
[]
(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.