Package software.amazon.awscdk.services.b2bi

Class CfnPartnership

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.b2bi.CfnPartnership
All Implemented Interfaces:
IInspectable, ITaggableV2, IPartnershipRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:31.869Z") @Stability(Stable) public class CfnPartnership extends CfnResource implements IInspectable, IPartnershipRef, ITaggableV2
Creates a partnership between a customer and a trading partner, based on the supplied parameters.

A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.b2bi.*;
 CfnPartnership cfnPartnership = CfnPartnership.Builder.create(this, "MyCfnPartnership")
         .capabilities(List.of("capabilities"))
         .email("email")
         .name("name")
         .profileId("profileId")
         // the properties below are optional
         .capabilityOptions(CapabilityOptionsProperty.builder()
                 .inboundEdi(InboundEdiOptionsProperty.builder()
                         .x12(X12InboundEdiOptionsProperty.builder()
                                 .acknowledgmentOptions(X12AcknowledgmentOptionsProperty.builder()
                                         .functionalAcknowledgment("functionalAcknowledgment")
                                         .technicalAcknowledgment("technicalAcknowledgment")
                                         .build())
                                 .build())
                         .build())
                 .outboundEdi(OutboundEdiOptionsProperty.builder()
                         .x12(X12EnvelopeProperty.builder()
                                 .common(X12OutboundEdiHeadersProperty.builder()
                                         .controlNumbers(X12ControlNumbersProperty.builder()
                                                 .startingFunctionalGroupControlNumber(123)
                                                 .startingInterchangeControlNumber(123)
                                                 .startingTransactionSetControlNumber(123)
                                                 .build())
                                         .delimiters(X12DelimitersProperty.builder()
                                                 .componentSeparator("componentSeparator")
                                                 .dataElementSeparator("dataElementSeparator")
                                                 .segmentTerminator("segmentTerminator")
                                                 .build())
                                         .functionalGroupHeaders(X12FunctionalGroupHeadersProperty.builder()
                                                 .applicationReceiverCode("applicationReceiverCode")
                                                 .applicationSenderCode("applicationSenderCode")
                                                 .responsibleAgencyCode("responsibleAgencyCode")
                                                 .build())
                                         .gs05TimeFormat("gs05TimeFormat")
                                         .interchangeControlHeaders(X12InterchangeControlHeadersProperty.builder()
                                                 .acknowledgmentRequestedCode("acknowledgmentRequestedCode")
                                                 .receiverId("receiverId")
                                                 .receiverIdQualifier("receiverIdQualifier")
                                                 .repetitionSeparator("repetitionSeparator")
                                                 .senderId("senderId")
                                                 .senderIdQualifier("senderIdQualifier")
                                                 .usageIndicatorCode("usageIndicatorCode")
                                                 .build())
                                         .validateEdi(false)
                                         .build())
                                 .wrapOptions(WrapOptionsProperty.builder()
                                         .lineLength(123)
                                         .lineTerminator("lineTerminator")
                                         .wrapBy("wrapBy")
                                         .build())
                                 .build())
                         .build())
                 .build())
         .phone("phone")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnPartnership

      protected CfnPartnership(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnPartnership

      protected CfnPartnership(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnPartnership

      @Stability(Stable) public CfnPartnership(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPartnershipProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      Returns a timestamp for creation date and time of the partnership.

    • getAttrModifiedAt

      @Stability(Stable) @NotNull public String getAttrModifiedAt()
      Returns a timestamp that identifies the most recent date and time that the partnership was modified.

    • getAttrPartnershipArn

      @Stability(Stable) @NotNull public String getAttrPartnershipArn()
      Returns an Amazon Resource Name (ARN) for a specific AWS resource, such as a capability, partnership, profile, or transformer.

    • getAttrPartnershipId

      @Stability(Stable) @NotNull public String getAttrPartnershipId()
      Returns the unique, system-generated identifier for a partnership.

    • getAttrTradingPartnerId

      @Stability(Stable) @NotNull public String getAttrTradingPartnerId()
      Returns the unique, system-generated identifier for a trading partner.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getPartnershipRef

      @Stability(Stable) @NotNull public PartnershipReference getPartnershipRef()
      A reference to a Partnership resource.
      Specified by:
      getPartnershipRef in interface IPartnershipRef

    • getCapabilities

      @Stability(Stable) @NotNull public List<String> getCapabilities()
      Returns one or more capabilities associated with this partnership.

    • setCapabilities

      @Stability(Stable) public void setCapabilities(@NotNull List<String> value)
      Returns one or more capabilities associated with this partnership.

    • getEmail

      @Stability(Stable) @NotNull public String getEmail()
      Specifies the email address associated with this trading partner.

    • setEmail

      @Stability(Stable) public void setEmail(@NotNull String value)
      Specifies the email address associated with this trading partner.

    • getName

      @Stability(Stable) @NotNull public String getName()
      Returns the name of the partnership.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      Returns the name of the partnership.

    • getProfileId

      @Stability(Stable) @NotNull public String getProfileId()
      Returns the unique, system-generated identifier for the profile connected to this partnership.

    • setProfileId

      @Stability(Stable) public void setProfileId(@NotNull String value)
      Returns the unique, system-generated identifier for the profile connected to this partnership.

    • getCapabilityOptions

      @Stability(Stable) @Nullable public Object getCapabilityOptions()
      Contains the details for an Outbound EDI capability.

      Returns union: either IResolvable or CfnPartnership.CapabilityOptionsProperty

    • setCapabilityOptions

      @Stability(Stable) public void setCapabilityOptions(@Nullable IResolvable value)
      Contains the details for an Outbound EDI capability.

    • setCapabilityOptions

      @Stability(Stable) public void setCapabilityOptions(@Nullable CfnPartnership.CapabilityOptionsProperty value)
      Contains the details for an Outbound EDI capability.

    • getPhone

      @Stability(Stable) @Nullable public String getPhone()
      Specifies the phone number associated with the partnership.

    • setPhone

      @Stability(Stable) public void setPhone(@Nullable String value)
      Specifies the phone number associated with the partnership.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A key-value pair for a specific partnership.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A key-value pair for a specific partnership.