AWS::B2BI::Partnership

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::B2BI::Partnership",
  "Properties" : {
      "Capabilities" : [ String, ... ],
      "CapabilityOptions" : CapabilityOptions,
      "Email" : String,
      "Name" : String,
      "Phone" : String,
      "ProfileId" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::B2BI::Partnership
Properties:
  Capabilities: 
    - String
  CapabilityOptions: 
    CapabilityOptions
  Email: String
  Name: String
  Phone: String
  ProfileId: String
  Tags: 
    - Tag

Properties

Capabilities

Returns one or more capabilities associated with this partnership.

Required: Yes

Type: Array of String

Minimum: 1

Maximum: 64

Update requires: No interruption

CapabilityOptions

Contains the details for an Outbound EDI capability.

Required: No

Type: CapabilityOptions

Update requires: No interruption

Email

Property description not available.

Required: Yes

Type: String

Pattern: ^[\w\.\-]+@[\w\.\-]+$

Minimum: 5

Maximum: 254

Update requires: Replacement

Name

Returns the name of the partnership.

Required: Yes

Type: String

Minimum: 1

Maximum: 254

Update requires: No interruption

Phone

Property description not available.

Required: No

Type: String

Pattern: ^\+?([0-9 \t\-()\/]{7,})(?:\s*(?:#|x\.?|ext\.?|extension) \t*(\d+))?$

Minimum: 7

Maximum: 22

Update requires: Replacement

ProfileId

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

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_-]+$

Minimum: 1

Maximum: 64

Update requires: Replacement

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.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: No interruption

Return values

Ref

Fn::GetAtt

CreatedAt

Returns a timestamp for creation date and time of the partnership.

ModifiedAt

Returns a timestamp that identifies the most recent date and time that the partnership was modified.

PartnershipArn

Returns an Amazon Resource Name (ARN) for a specific AWS resource, such as a capability, partnership, profile, or transformer.

PartnershipId

Returns the unique, system-generated identifier for a partnership.

TradingPartnerId

Returns the unique, system-generated identifier for a trading partner.