aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
1,122 lines (1,121 loc) • 77.5 kB
TypeScript
import * as cdk from "../../core";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
/**
* Indicates that this resource can be referenced as a Capability.
*
* @stability experimental
*/
export interface ICapabilityRef extends constructs.IConstruct {
/**
* A reference to a Capability resource.
*/
readonly capabilityRef: CapabilityReference;
}
/**
* Instantiates a capability based on the specified parameters.
*
* A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
*
* @cloudformationResource AWS::B2BI::Capability
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html
*/
export declare class CfnCapability extends cdk.CfnResource implements cdk.IInspectable, ICapabilityRef, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnCapability from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnCapability;
/**
* Returns an Amazon Resource Name (ARN) for a specific AWS resource, such as a capability, partnership, profile, or transformer.
*
* @cloudformationAttribute CapabilityArn
*/
readonly attrCapabilityArn: string;
/**
* Returns a system-assigned unique identifier for the capability.
*
* @cloudformationAttribute CapabilityId
*/
readonly attrCapabilityId: string;
/**
* Returns a timestamp for creation date and time of the capability.
*
* @cloudformationAttribute CreatedAt
*/
readonly attrCreatedAt: string;
/**
* Returns a timestamp that identifies the most recent date and time that the capability was modified.
*
* @cloudformationAttribute ModifiedAt
*/
readonly attrModifiedAt: string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* Specifies a structure that contains the details for a capability.
*/
configuration: CfnCapability.CapabilityConfigurationProperty | cdk.IResolvable;
/**
* Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability.
*/
instructionsDocuments?: Array<cdk.IResolvable | CfnCapability.S3LocationProperty> | cdk.IResolvable;
/**
* The display name of the capability.
*/
name: string;
/**
* Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type.
*/
tags?: Array<cdk.CfnTag>;
/**
* Returns the type of the capability.
*/
type: string;
/**
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnCapabilityProps);
get capabilityRef(): CapabilityReference;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnCapability {
/**
* A capability object.
*
* Currently, only EDI (electronic data interchange) capabilities are supported. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-capabilityconfiguration.html
*/
interface CapabilityConfigurationProperty {
/**
* An EDI (electronic data interchange) configuration object.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-capabilityconfiguration.html#cfn-b2bi-capability-capabilityconfiguration-edi
*/
readonly edi: CfnCapability.EdiConfigurationProperty | cdk.IResolvable;
}
/**
* Specifies the details for the EDI (electronic data interchange) transformation.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-ediconfiguration.html
*/
interface EdiConfigurationProperty {
/**
* Specifies whether this is capability is for inbound or outbound transformations.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-ediconfiguration.html#cfn-b2bi-capability-ediconfiguration-capabilitydirection
*/
readonly capabilityDirection?: string;
/**
* Contains the Amazon S3 bucket and prefix for the location of the input file, which is contained in an `S3Location` object.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-ediconfiguration.html#cfn-b2bi-capability-ediconfiguration-inputlocation
*/
readonly inputLocation: cdk.IResolvable | CfnCapability.S3LocationProperty;
/**
* Contains the Amazon S3 bucket and prefix for the location of the output file, which is contained in an `S3Location` object.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-ediconfiguration.html#cfn-b2bi-capability-ediconfiguration-outputlocation
*/
readonly outputLocation: cdk.IResolvable | CfnCapability.S3LocationProperty;
/**
* Returns the system-assigned unique identifier for the transformer.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-ediconfiguration.html#cfn-b2bi-capability-ediconfiguration-transformerid
*/
readonly transformerId: string;
/**
* Returns the type of the capability.
*
* Currently, only `edi` is supported.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-ediconfiguration.html#cfn-b2bi-capability-ediconfiguration-type
*/
readonly type: CfnCapability.EdiTypeProperty | cdk.IResolvable;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-editype.html
*/
interface EdiTypeProperty {
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-editype.html#cfn-b2bi-capability-editype-x12details
*/
readonly x12Details: cdk.IResolvable | CfnCapability.X12DetailsProperty;
}
/**
* A structure that contains the X12 transaction set and version.
*
* The X12 structure is used when the system transforms an EDI (electronic data interchange) file.
*
* > If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-x12details.html
*/
interface X12DetailsProperty {
/**
* Returns an enumerated type where each value identifies an X12 transaction set.
*
* Transaction sets are maintained by the X12 Accredited Standards Committee.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-x12details.html#cfn-b2bi-capability-x12details-transactionset
*/
readonly transactionSet?: string;
/**
* Returns the version to use for the specified X12 transaction set.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-x12details.html#cfn-b2bi-capability-x12details-version
*/
readonly version?: string;
}
/**
* Specifies the details for the Amazon S3 file location that is being used with AWS B2B Data Interchange.
*
* File locations in Amazon S3 are identified using a combination of the bucket and key.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-s3location.html
*/
interface S3LocationProperty {
/**
* Specifies the name of the Amazon S3 bucket.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-s3location.html#cfn-b2bi-capability-s3location-bucketname
*/
readonly bucketName?: string;
/**
* Specifies the Amazon S3 key for the file location.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-s3location.html#cfn-b2bi-capability-s3location-key
*/
readonly key?: string;
}
}
/**
* Properties for defining a `CfnCapability`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html
*/
export interface CfnCapabilityProps {
/**
* Specifies a structure that contains the details for a capability.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html#cfn-b2bi-capability-configuration
*/
readonly configuration: CfnCapability.CapabilityConfigurationProperty | cdk.IResolvable;
/**
* Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability.
*
* Each item contains the name of the bucket and the key, to identify the document's location.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html#cfn-b2bi-capability-instructionsdocuments
*/
readonly instructionsDocuments?: Array<cdk.IResolvable | CfnCapability.S3LocationProperty> | cdk.IResolvable;
/**
* The display name of the capability.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html#cfn-b2bi-capability-name
*/
readonly name: string;
/**
* Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type.
*
* You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html#cfn-b2bi-capability-tags
*/
readonly tags?: Array<cdk.CfnTag>;
/**
* Returns the type of the capability.
*
* Currently, only `edi` is supported.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html#cfn-b2bi-capability-type
*/
readonly type: string;
}
/**
* A reference to a Capability resource.
*
* @struct
* @stability external
*/
export interface CapabilityReference {
/**
* The CapabilityId of the Capability resource.
*/
readonly capabilityId: string;
/**
* The ARN of the Capability resource.
*/
readonly capabilityArn: string;
}
/**
* Indicates that this resource can be referenced as a Partnership.
*
* @stability experimental
*/
export interface IPartnershipRef extends constructs.IConstruct {
/**
* A reference to a Partnership resource.
*/
readonly partnershipRef: PartnershipReference;
}
/**
* 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.
*
* @cloudformationResource AWS::B2BI::Partnership
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html
*/
export declare class CfnPartnership extends cdk.CfnResource implements cdk.IInspectable, IPartnershipRef, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnPartnership from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnPartnership;
/**
* Returns a timestamp for creation date and time of the partnership.
*
* @cloudformationAttribute CreatedAt
*/
readonly attrCreatedAt: string;
/**
* Returns a timestamp that identifies the most recent date and time that the partnership was modified.
*
* @cloudformationAttribute ModifiedAt
*/
readonly attrModifiedAt: string;
/**
* Returns an Amazon Resource Name (ARN) for a specific AWS resource, such as a capability, partnership, profile, or transformer.
*
* @cloudformationAttribute PartnershipArn
*/
readonly attrPartnershipArn: string;
/**
* Returns the unique, system-generated identifier for a partnership.
*
* @cloudformationAttribute PartnershipId
*/
readonly attrPartnershipId: string;
/**
* Returns the unique, system-generated identifier for a trading partner.
*
* @cloudformationAttribute TradingPartnerId
*/
readonly attrTradingPartnerId: string;
/**
* Returns one or more capabilities associated with this partnership.
*/
capabilities: Array<string>;
/**
* Contains the details for an Outbound EDI capability.
*/
capabilityOptions?: CfnPartnership.CapabilityOptionsProperty | cdk.IResolvable;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* Specifies the email address associated with this trading partner.
*/
email: string;
/**
* Returns the name of the partnership.
*/
name: string;
/**
* Specifies the phone number associated with the partnership.
*/
phone?: string;
/**
* Returns the unique, system-generated identifier for the profile connected to this partnership.
*/
profileId: string;
/**
* A key-value pair for a specific partnership.
*/
tags?: Array<cdk.CfnTag>;
/**
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnPartnershipProps);
get partnershipRef(): PartnershipReference;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnPartnership {
/**
* Contains the details for an Outbound EDI capability.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-capabilityoptions.html
*/
interface CapabilityOptionsProperty {
/**
* A structure that contains the inbound EDI options for the capability.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-capabilityoptions.html#cfn-b2bi-partnership-capabilityoptions-inboundedi
*/
readonly inboundEdi?: CfnPartnership.InboundEdiOptionsProperty | cdk.IResolvable;
/**
* A structure that contains the outbound EDI options.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-capabilityoptions.html#cfn-b2bi-partnership-capabilityoptions-outboundedi
*/
readonly outboundEdi?: cdk.IResolvable | CfnPartnership.OutboundEdiOptionsProperty;
}
/**
* A container for outbound EDI options.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-outboundedioptions.html
*/
interface OutboundEdiOptionsProperty {
/**
* A structure that contains an X12 envelope structure.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-outboundedioptions.html#cfn-b2bi-partnership-outboundedioptions-x12
*/
readonly x12: cdk.IResolvable | CfnPartnership.X12EnvelopeProperty;
}
/**
* A wrapper structure for an X12 definition object.
*
* the X12 envelope ensures the integrity of the data and the efficiency of the information exchange. The X12 message structure has hierarchical levels. From highest to the lowest, they are:
*
* - Interchange Envelope
* - Functional Group
* - Transaction Set
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12envelope.html
*/
interface X12EnvelopeProperty {
/**
* A container for the X12 outbound EDI headers.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12envelope.html#cfn-b2bi-partnership-x12envelope-common
*/
readonly common?: cdk.IResolvable | CfnPartnership.X12OutboundEdiHeadersProperty;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12envelope.html#cfn-b2bi-partnership-x12envelope-wrapoptions
*/
readonly wrapOptions?: cdk.IResolvable | CfnPartnership.WrapOptionsProperty;
}
/**
* A structure containing the details for an outbound EDI object.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html
*/
interface X12OutboundEdiHeadersProperty {
/**
* Specifies control number configuration for outbound X12 EDI headers.
*
* These settings determine the starting values for interchange, functional group, and transaction set control numbers.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-controlnumbers
*/
readonly controlNumbers?: cdk.IResolvable | CfnPartnership.X12ControlNumbersProperty;
/**
* The delimiters, for example semicolon ( `;` ), that separates sections of the headers for the X12 object.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-delimiters
*/
readonly delimiters?: cdk.IResolvable | CfnPartnership.X12DelimitersProperty;
/**
* The functional group headers for the X12 object.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-functionalgroupheaders
*/
readonly functionalGroupHeaders?: cdk.IResolvable | CfnPartnership.X12FunctionalGroupHeadersProperty;
/**
* Specifies the time format in the GS05 element (time) of the functional group header.
*
* The following formats use 24-hour clock time:
*
* - `HHMM` - Hours and minutes
* - `HHMMSS` - Hours, minutes, and seconds
* - `HHMMSSDD` - Hours, minutes, seconds, and decimal seconds
*
* Where:
*
* - `HH` - Hours (00-23)
* - `MM` - Minutes (00-59)
* - `SS` - Seconds (00-59)
* - `DD` - Hundredths of seconds (00-99)
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-gs05timeformat
*/
readonly gs05TimeFormat?: string;
/**
* In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-interchangecontrolheaders
*/
readonly interchangeControlHeaders?: cdk.IResolvable | CfnPartnership.X12InterchangeControlHeadersProperty;
/**
* Specifies whether or not to validate the EDI for this X12 object: `TRUE` or `FALSE` .
*
* When enabled, this performs both standard EDI validation and applies any configured custom validation rules including element length constraints, code list validations, and element requirement checks. Validation results are returned in the response validation messages.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-validateedi
*/
readonly validateEdi?: boolean | cdk.IResolvable;
}
/**
* In X12, the Interchange Control Header is the first segment of an EDI document and is part of the Interchange Envelope.
*
* It contains information about the sender and receiver, the date and time of transmission, and the X12 version being used. It also includes delivery information, such as the sender and receiver IDs.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html
*/
interface X12InterchangeControlHeadersProperty {
/**
* Located at position ISA-14 in the header.
*
* The value "1" indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value "0" is used otherwise.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-acknowledgmentrequestedcode
*/
readonly acknowledgmentRequestedCode?: string;
/**
* Located at position ISA-08 in the header.
*
* This value (along with the `receiverIdQualifier` ) identifies the intended recipient of the interchange.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-receiverid
*/
readonly receiverId?: string;
/**
* Located at position ISA-07 in the header.
*
* Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-receiveridqualifier
*/
readonly receiverIdQualifier?: string;
/**
* Located at position ISA-11 in the header.
*
* This string makes it easier when you need to group similar adjacent element values together without using extra segments.
*
* > This parameter is only honored for version greater than 401 ( `VERSION_4010` and higher).
* >
* > For versions less than 401, this field is called [StandardsId](https://docs.aws.amazon.com/https://www.stedi.com/edi/x12-004010/segment/ISA#ISA-11) , in which case our service sets the value to `U` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-repetitionseparator
*/
readonly repetitionSeparator?: string;
/**
* Located at position ISA-06 in the header.
*
* This value (along with the `senderIdQualifier` ) identifies the sender of the interchange.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-senderid
*/
readonly senderId?: string;
/**
* Located at position ISA-05 in the header.
*
* Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-senderidqualifier
*/
readonly senderIdQualifier?: string;
/**
* Located at position ISA-15 in the header. Specifies how this interchange is being used:.
*
* - `T` indicates this interchange is for testing.
* - `P` indicates this interchange is for production.
* - `I` indicates this interchange is informational.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-usageindicatorcode
*/
readonly usageIndicatorCode?: string;
}
/**
* Part of the X12 message structure.
*
* These are the functional group headers for the X12 EDI object.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12functionalgroupheaders.html
*/
interface X12FunctionalGroupHeadersProperty {
/**
* A value representing the code used to identify the party receiving a message, at position GS-03.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12functionalgroupheaders.html#cfn-b2bi-partnership-x12functionalgroupheaders-applicationreceivercode
*/
readonly applicationReceiverCode?: string;
/**
* A value representing the code used to identify the party transmitting a message, at position GS-02.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12functionalgroupheaders.html#cfn-b2bi-partnership-x12functionalgroupheaders-applicationsendercode
*/
readonly applicationSenderCode?: string;
/**
* A code that identifies the issuer of the standard, at position GS-07.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12functionalgroupheaders.html#cfn-b2bi-partnership-x12functionalgroupheaders-responsibleagencycode
*/
readonly responsibleAgencyCode?: string;
}
/**
* In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.
*
* The delimiters are part of the message's syntax and divide up its different elements.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12delimiters.html
*/
interface X12DelimitersProperty {
/**
* The component, or sub-element, separator.
*
* The default value is `:` (colon).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12delimiters.html#cfn-b2bi-partnership-x12delimiters-componentseparator
*/
readonly componentSeparator?: string;
/**
* The data element separator.
*
* The default value is `*` (asterisk).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12delimiters.html#cfn-b2bi-partnership-x12delimiters-dataelementseparator
*/
readonly dataElementSeparator?: string;
/**
* The segment terminator.
*
* The default value is `~` (tilde).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12delimiters.html#cfn-b2bi-partnership-x12delimiters-segmentterminator
*/
readonly segmentTerminator?: string;
}
/**
* Contains configuration for X12 control numbers used in X12 EDI generation.
*
* Control numbers are used to uniquely identify interchanges, functional groups, and transaction sets.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12controlnumbers.html
*/
interface X12ControlNumbersProperty {
/**
* Specifies the starting functional group control number (GS06) to use for X12 EDI generation.
*
* This number is incremented for each new functional group. For the GS (functional group) envelope, AWS B2B Data Interchange generates a functional group control number that is unique to the sender ID, receiver ID, and functional identifier code combination.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12controlnumbers.html#cfn-b2bi-partnership-x12controlnumbers-startingfunctionalgroupcontrolnumber
*/
readonly startingFunctionalGroupControlNumber?: number;
/**
* Specifies the starting interchange control number (ISA13) to use for X12 EDI generation.
*
* This number is incremented for each new interchange. For the ISA (interchange) envelope, AWS B2B Data Interchange generates an interchange control number that is unique for the ISA05 and ISA06 (sender) & ISA07 and ISA08 (receiver) combination.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12controlnumbers.html#cfn-b2bi-partnership-x12controlnumbers-startinginterchangecontrolnumber
*/
readonly startingInterchangeControlNumber?: number;
/**
* Specifies the starting transaction set control number (ST02) to use for X12 EDI generation.
*
* This number is incremented for each new transaction set.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12controlnumbers.html#cfn-b2bi-partnership-x12controlnumbers-startingtransactionsetcontrolnumber
*/
readonly startingTransactionSetControlNumber?: number;
}
/**
* Contains options for wrapping (line folding) in X12 EDI files.
*
* Wrapping controls how long lines are handled in the EDI output.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-wrapoptions.html
*/
interface WrapOptionsProperty {
/**
* Specifies the maximum length of a line before wrapping occurs.
*
* This value is used when `wrapBy` is set to `LINE_LENGTH` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-wrapoptions.html#cfn-b2bi-partnership-wrapoptions-linelength
*/
readonly lineLength?: number;
/**
* Specifies the character sequence used to terminate lines when wrapping. Valid values:.
*
* - `CRLF` : carriage return and line feed
* - `LF` : line feed)
* - `CR` : carriage return
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-wrapoptions.html#cfn-b2bi-partnership-wrapoptions-lineterminator
*/
readonly lineTerminator?: string;
/**
* Specifies the method used for wrapping lines in the EDI output. Valid values:.
*
* - `SEGMENT` : Wraps by segment.
* - `ONE_LINE` : Indicates that the entire content is on a single line.
*
* > When you specify `ONE_LINE` , do not provide either the line length nor the line terminator value.
* - `LINE_LENGTH` : Wraps by character count, as specified by `lineLength` value.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-wrapoptions.html#cfn-b2bi-partnership-wrapoptions-wrapby
*/
readonly wrapBy?: string;
}
/**
* Contains options for processing inbound EDI files.
*
* These options allow for customizing how incoming EDI documents are processed.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-inboundedioptions.html
*/
interface InboundEdiOptionsProperty {
/**
* A structure that contains X12-specific options for processing inbound X12 EDI files.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-inboundedioptions.html#cfn-b2bi-partnership-inboundedioptions-x12
*/
readonly x12?: cdk.IResolvable | CfnPartnership.X12InboundEdiOptionsProperty;
}
/**
* Contains options specific to processing inbound X12 EDI files.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12inboundedioptions.html
*/
interface X12InboundEdiOptionsProperty {
/**
* Specifies acknowledgment options for inbound X12 EDI files.
*
* These options control how functional and technical acknowledgments are handled.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12inboundedioptions.html#cfn-b2bi-partnership-x12inboundedioptions-acknowledgmentoptions
*/
readonly acknowledgmentOptions?: cdk.IResolvable | CfnPartnership.X12AcknowledgmentOptionsProperty;
}
/**
* Contains options for configuring X12 acknowledgments.
*
* These options control how functional and technical acknowledgments are handled.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12acknowledgmentoptions.html
*/
interface X12AcknowledgmentOptionsProperty {
/**
* Specifies whether functional acknowledgments (997/999) should be generated for incoming X12 transactions.
*
* Valid values are `DO_NOT_GENERATE` , `GENERATE_ALL_SEGMENTS` and `GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP` .
*
* If you choose `GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP` , AWS B2B Data Interchange skips the AK2_Loop when generating an acknowledgment document.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12acknowledgmentoptions.html#cfn-b2bi-partnership-x12acknowledgmentoptions-functionalacknowledgment
*/
readonly functionalAcknowledgment: string;
/**
* Specifies whether technical acknowledgments (TA1) should be generated for incoming X12 interchanges.
*
* Valid values are `DO_NOT_GENERATE` and `GENERATE_ALL_SEGMENTS` and.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12acknowledgmentoptions.html#cfn-b2bi-partnership-x12acknowledgmentoptions-technicalacknowledgment
*/
readonly technicalAcknowledgment: string;
}
}
/**
* Properties for defining a `CfnPartnership`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html
*/
export interface CfnPartnershipProps {
/**
* 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
*/
readonly capabilities: Array<string>;
/**
* 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
*/
readonly capabilityOptions?: CfnPartnership.CapabilityOptionsProperty | cdk.IResolvable;
/**
* Specifies the email address associated with this trading partner.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#cfn-b2bi-partnership-email
*/
readonly email: string;
/**
* Returns the name of the partnership.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#cfn-b2bi-partnership-name
*/
readonly name: string;
/**
* Specifies the phone number associated with the partnership.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#cfn-b2bi-partnership-phone
*/
readonly phone?: string;
/**
* 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
*/
readonly profileId: string;
/**
* 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
*/
readonly tags?: Array<cdk.CfnTag>;
}
/**
* A reference to a Partnership resource.
*
* @struct
* @stability external
*/
export interface PartnershipReference {
/**
* The PartnershipId of the Partnership resource.
*/
readonly partnershipId: string;
/**
* The ARN of the Partnership resource.
*/
readonly partnershipArn: string;
}
/**
* Indicates that this resource can be referenced as a Profile.
*
* @stability experimental
*/
export interface IProfileRef extends constructs.IConstruct {
/**
* A reference to a Profile resource.
*/
readonly profileRef: ProfileReference;
}
/**
* Creates a customer profile.
*
* You can have up to five customer profiles, each representing a distinct private network. A profile is the mechanism used to create the concept of a private network.
*
* @cloudformationResource AWS::B2BI::Profile
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html
*/
export declare class CfnProfile extends cdk.CfnResource implements cdk.IInspectable, IProfileRef, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnProfile from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnProfile;
/**
* Returns the timestamp for creation date and time of the profile.
*
* @cloudformationAttribute CreatedAt
*/
readonly attrCreatedAt: string;
/**
* Returns the name of the logging group.
*
* @cloudformationAttribute LogGroupName
*/
readonly attrLogGroupName: string;
/**
* Returns the timestamp that identifies the most recent date and time that the profile was modified.
*
* @cloudformationAttribute ModifiedAt
*/
readonly attrModifiedAt: string;
/**
* Returns an Amazon Resource Name (ARN) for the profile.
*
* @cloudformationAttribute ProfileArn
*/
readonly attrProfileArn: string;
/**
* @cloudformationAttribute ProfileId
*/
readonly attrProfileId: string;
/**
* Returns the name for the business associated with this profile.
*/
businessName: string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
email?: string;
/**
* Specifies whether or not logging is enabled for this profile.
*/
logging: string;
/**
* Returns the display name for profile.
*/
name: string;
/**
* Specifies the phone number associated with the profile.
*/
phone: string;
/**
* A key-value pair for a specific profile.
*/
tags?: Array<cdk.CfnTag>;
/**
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnProfileProps);
get profileRef(): ProfileReference;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
/**
* Properties for defining a `CfnProfile`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html
*/
export interface CfnProfileProps {
/**
* Returns the name for the business associated with this profile.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html#cfn-b2bi-profile-businessname
*/
readonly businessName: string;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html#cfn-b2bi-profile-email
*/
readonly email?: string;
/**
* Specifies whether or not logging is enabled for this profile.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html#cfn-b2bi-profile-logging
*/
readonly logging: string;
/**
* Returns the display name for profile.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html#cfn-b2bi-profile-name
*/
readonly name: string;
/**
* Specifies the phone number associated with the profile.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html#cfn-b2bi-profile-phone
*/
readonly phone: string;
/**
* A key-value pair for a specific profile.
*
* 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-profile.html#cfn-b2bi-profile-tags
*/
readonly tags?: Array<cdk.CfnTag>;
}
/**
* A reference to a Profile resource.
*
* @struct
* @stability external
*/
export interface ProfileReference {
/**
* The ProfileId of the Profile resource.
*/
readonly profileId: string;
/**
* The ARN of the Profile resource.
*/
readonly profileArn: string;
}
/**
* Indicates that this resource can be referenced as a Transformer.
*
* @stability experimental
*/
export interface ITransformerRef extends constructs.IConstruct {
/**
* A reference to a Transformer resource.
*/
readonly transformerRef: TransformerReference;
}
/**
* Creates a transformer. AWS B2B Data Interchange currently supports two scenarios:.
*
* - *Inbound EDI* : the AWS customer receives an EDI file from their trading partner. AWS B2B Data Interchange converts this EDI file into a JSON or XML file with a service-defined structure. A mapping template provided by the customer, in JSONata or XSLT format, is optionally applied to this file to produce a JSON or XML file with the structure the customer requires.
* - *Outbound EDI* : the AWS customer has a JSON or XML file containing data that they wish to use in an EDI file. A mapping template, provided by the customer (in either JSONata or XSLT format) is applied to this file to generate a JSON or XML file in the service-defined structure. This file is then converted to an EDI file.
*
* > The following fields are provided for backwards compatibility only: `fileFormat` , `mappingTemplate` , `ediType` , and `sampleDocument` .
* >
* > - Use the `mapping` data type in place of `mappingTemplate` and `fileFormat`
* > - Use the `sampleDocuments` data type in place of `sampleDocument`
* > - Use either the `inputConversion` or `outputConversion` in place of `ediType`
*
* @cloudformationResource AWS::B2BI::Transformer
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html
*/
export declare class CfnTransformer extends cdk.CfnResource implements cdk.IInspectable, ITransformerRef, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnTransformer from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnTransformer;
/**
* Returns a timestamp indicating when the transformer was created. For example, `2023-07-20T19:58:44.624Z` .
*
* @cloudformationAttribute CreatedAt
*/
readonly attrCreatedAt: string;
/**
* Returns a timestamp representing the date and time for the most recent change for the transformer object.
*
* @cloudformationAttribute ModifiedAt
*/
readonly attrModifiedAt: string;
/**
* Returns an Amazon Resource Name (ARN) for a specific transformer.
*
* @cloudformationAttribute TransformerArn
*/
readonly attrTransformerArn: string;
/**
* The system-assigned unique identifier for the transformer.
*
* @cloudformationAttribute TransformerId
*/
readonly attrTransformerId: string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* @deprecated this property has been deprecated
*/
ediType?: CfnTransformer.EdiTypeProperty | cdk.IResolvable;
/**
* @deprecated this property has been deprecated
*/
fileFormat?: string;
/**
* Returns a structure that contains the format options for the transformation.
*/
inputConversion?: CfnTransformer.InputConversionProperty | cdk.IResolvable;
/**
* Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
*/
mapping?: cdk.IResolvable | CfnTransformer.MappingProperty;
/**
* This shape is deprecated: This is a legacy trait.
*