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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:33:57.994Z") @Stability(Stable) public class CfnPartnership extends CfnResource implements IInspectable, 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")
         .email("email")
         .name("name")
         .profileId("profileId")
         // the properties below are optional
         .capabilities(List.of("capabilities"))
         .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

    • getEmail

      @Stability(Stable) @NotNull public String getEmail()

    • setEmail

      @Stability(Stable) public void setEmail(@NotNull String value)

    • 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.

    • getCapabilities

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

    • setCapabilities

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

    • getPhone

      @Stability(Stable) @Nullable public String getPhone()

    • setPhone

      @Stability(Stable) public void setPhone(@Nullable String value)

    • 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.