CfnPartnershipProps

class aws_cdk.aws_b2bi.CfnPartnershipProps(*, capabilities, email, name, profile_id, capability_options=None, phone=None, tags=None)

Bases: object

Properties for defining a CfnPartnership.

Parameters:
  • capabilities (Sequence[str]) – Returns one or more capabilities associated with this partnership.

  • email (str) –

  • name (str) – Returns the name of the partnership.

  • profile_id (str) – Returns the unique, system-generated identifier for the profile connected to this partnership.

  • capability_options (Union[IResolvable, CapabilityOptionsProperty, Dict[str, Any], None]) – Contains the details for an Outbound EDI capability.

  • phone (Optional[str]) –

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A key-value pair for a specific partnership. Tags are metadata that you can use to search for and group capabilities for various purposes.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_b2bi as b2bi

cfn_partnership_props = b2bi.CfnPartnershipProps(
    capabilities=["capabilities"],
    email="email",
    name="name",
    profile_id="profileId",

    # the properties below are optional
    capability_options=b2bi.CfnPartnership.CapabilityOptionsProperty(
        outbound_edi=b2bi.CfnPartnership.OutboundEdiOptionsProperty(
            x12=b2bi.CfnPartnership.X12EnvelopeProperty(
                common=b2bi.CfnPartnership.X12OutboundEdiHeadersProperty(
                    delimiters=b2bi.CfnPartnership.X12DelimitersProperty(
                        component_separator="componentSeparator",
                        data_element_separator="dataElementSeparator",
                        segment_terminator="segmentTerminator"
                    ),
                    functional_group_headers=b2bi.CfnPartnership.X12FunctionalGroupHeadersProperty(
                        application_receiver_code="applicationReceiverCode",
                        application_sender_code="applicationSenderCode",
                        responsible_agency_code="responsibleAgencyCode"
                    ),
                    interchange_control_headers=b2bi.CfnPartnership.X12InterchangeControlHeadersProperty(
                        acknowledgment_requested_code="acknowledgmentRequestedCode",
                        receiver_id="receiverId",
                        receiver_id_qualifier="receiverIdQualifier",
                        repetition_separator="repetitionSeparator",
                        sender_id="senderId",
                        sender_id_qualifier="senderIdQualifier",
                        usage_indicator_code="usageIndicatorCode"
                    ),
                    validate_edi=False
                )
            )
        )
    ),
    phone="phone",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

capabilities

Returns one or more capabilities associated with this partnership.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#cfn-b2bi-partnership-capabilities

capability_options

Contains the details for an Outbound EDI capability.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#cfn-b2bi-partnership-capabilityoptions

email

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#cfn-b2bi-partnership-email

Type:

see

name

Returns the name of the partnership.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#cfn-b2bi-partnership-name

phone

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#cfn-b2bi-partnership-phone

Type:

see

profile_id

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#cfn-b2bi-partnership-profileid

tags

A key-value pair for a specific partnership.

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#cfn-b2bi-partnership-tags