Class CfnPartnership

Creates a partnership between a customer and a trading partner, based on the supplied parameters.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnPartnership
Inherited Members
Namespace: Amazon.CDK.AwsB2Bi
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnPartnership : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnPartnership Inherits CfnResource Implements IInspectable, ITaggableV2
Remarks

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

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

CloudformationResource: AWS::B2BI::Partnership

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Aws_b2bi;

             var cfnPartnership = new CfnPartnership(this, "MyCfnPartnership", new CfnPartnershipProps {
                 Capabilities = new [] { "capabilities" },
                 Email = "email",
                 Name = "name",
                 ProfileId = "profileId",

                 // the properties below are optional
                 CapabilityOptions = new CapabilityOptionsProperty {
                     InboundEdi = new InboundEdiOptionsProperty {
                         X12 = new X12InboundEdiOptionsProperty {
                             AcknowledgmentOptions = new X12AcknowledgmentOptionsProperty {
                                 FunctionalAcknowledgment = "functionalAcknowledgment",
                                 TechnicalAcknowledgment = "technicalAcknowledgment"
                             }
                         }
                     },
                     OutboundEdi = new OutboundEdiOptionsProperty {
                         X12 = new X12EnvelopeProperty {
                             Common = new X12OutboundEdiHeadersProperty {
                                 ControlNumbers = new X12ControlNumbersProperty {
                                     StartingFunctionalGroupControlNumber = 123,
                                     StartingInterchangeControlNumber = 123,
                                     StartingTransactionSetControlNumber = 123
                                 },
                                 Delimiters = new X12DelimitersProperty {
                                     ComponentSeparator = "componentSeparator",
                                     DataElementSeparator = "dataElementSeparator",
                                     SegmentTerminator = "segmentTerminator"
                                 },
                                 FunctionalGroupHeaders = new X12FunctionalGroupHeadersProperty {
                                     ApplicationReceiverCode = "applicationReceiverCode",
                                     ApplicationSenderCode = "applicationSenderCode",
                                     ResponsibleAgencyCode = "responsibleAgencyCode"
                                 },
                                 Gs05TimeFormat = "gs05TimeFormat",
                                 InterchangeControlHeaders = new X12InterchangeControlHeadersProperty {
                                     AcknowledgmentRequestedCode = "acknowledgmentRequestedCode",
                                     ReceiverId = "receiverId",
                                     ReceiverIdQualifier = "receiverIdQualifier",
                                     RepetitionSeparator = "repetitionSeparator",
                                     SenderId = "senderId",
                                     SenderIdQualifier = "senderIdQualifier",
                                     UsageIndicatorCode = "usageIndicatorCode"
                                 },
                                 ValidateEdi = false
                             },
                             WrapOptions = new WrapOptionsProperty {
                                 LineLength = 123,
                                 LineTerminator = "lineTerminator",
                                 WrapBy = "wrapBy"
                             }
                         }
                     }
                 },
                 Phone = "phone",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnPartnership(Construct, string, ICfnPartnershipProps)

Creates a partnership between a customer and a trading partner, based on the supplied parameters.

Properties

AttrCreatedAt

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

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

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

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

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

The CloudFormation resource type name for this resource class.
Capabilities

Returns one or more capabilities associated with this partnership.
CapabilityOptions

Contains the details for an Outbound EDI capability.
CdkTagManager

Tag Manager which manages the tags for this resource.
CfnProperties

Creates a partnership between a customer and a trading partner, based on the supplied parameters.
Email

Specifies the email address associated with this trading partner.
Name

Returns the name of the partnership.
Phone

Specifies the phone number associated with the partnership.
ProfileId

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

A key-value pair for a specific partnership.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)

Creates a partnership between a customer and a trading partner, based on the supplied parameters.

Constructors

CfnPartnership(Construct, string, ICfnPartnershipProps)

Creates a partnership between a customer and a trading partner, based on the supplied parameters.

public CfnPartnership(Construct scope, string id, ICfnPartnershipProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnPartnershipProps

Resource properties.

Remarks

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

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

CloudformationResource: AWS::B2BI::Partnership

ExampleMetadata: fixture=_generated

Properties

AttrCreatedAt

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

public virtual string AttrCreatedAt { get; }
Property Value

string

Remarks

CloudformationAttribute: CreatedAt

AttrModifiedAt

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

public virtual string AttrModifiedAt { get; }
Property Value

string

Remarks

CloudformationAttribute: ModifiedAt

AttrPartnershipArn

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

public virtual string AttrPartnershipArn { get; }
Property Value

string

Remarks

CloudformationAttribute: PartnershipArn

AttrPartnershipId

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

public virtual string AttrPartnershipId { get; }
Property Value

string

Remarks

CloudformationAttribute: PartnershipId

AttrTradingPartnerId

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

public virtual string AttrTradingPartnerId { get; }
Property Value

string

Remarks

CloudformationAttribute: TradingPartnerId

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

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

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

CloudformationResource: AWS::B2BI::Partnership

ExampleMetadata: fixture=_generated

Capabilities

Returns one or more capabilities associated with this partnership.

public virtual string[] Capabilities { get; set; }
Property Value

string[]

Remarks

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

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

CloudformationResource: AWS::B2BI::Partnership

ExampleMetadata: fixture=_generated

CapabilityOptions

Contains the details for an Outbound EDI capability.

public virtual object? CapabilityOptions { get; set; }
Property Value

object

Remarks

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

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

CloudformationResource: AWS::B2BI::Partnership

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

Remarks

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

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

CloudformationResource: AWS::B2BI::Partnership

ExampleMetadata: fixture=_generated

CfnProperties

Creates a partnership between a customer and a trading partner, based on the supplied parameters.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

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

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

CloudformationResource: AWS::B2BI::Partnership

ExampleMetadata: fixture=_generated

Email

Specifies the email address associated with this trading partner.

public virtual string Email { get; set; }
Property Value

string

Remarks

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

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

CloudformationResource: AWS::B2BI::Partnership

ExampleMetadata: fixture=_generated

Name

Returns the name of the partnership.

public virtual string Name { get; set; }
Property Value

string

Remarks

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

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

CloudformationResource: AWS::B2BI::Partnership

ExampleMetadata: fixture=_generated

Phone

Specifies the phone number associated with the partnership.

public virtual string? Phone { get; set; }
Property Value

string

Remarks

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

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

CloudformationResource: AWS::B2BI::Partnership

ExampleMetadata: fixture=_generated

ProfileId

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

public virtual string ProfileId { get; set; }
Property Value

string

Remarks

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

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

CloudformationResource: AWS::B2BI::Partnership

ExampleMetadata: fixture=_generated

Tags

A key-value pair for a specific partnership.

public virtual ICfnTag[]? Tags { get; set; }
Property Value

ICfnTag[]

Remarks

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

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

CloudformationResource: AWS::B2BI::Partnership

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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

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

CloudformationResource: AWS::B2BI::Partnership

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a partnership between a customer and a trading partner, based on the supplied parameters.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

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

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

CloudformationResource: AWS::B2BI::Partnership

ExampleMetadata: fixture=_generated

Implements