CfnCapabilityPropsMixin

class aws_cdk.mixins_preview.aws_b2bi.mixins.CfnCapabilityPropsMixin(props, *, strategy=None)

Bases: Mixin

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html
CloudformationResource:: AWS::B2BI::Capability
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_b2bi import mixins as b2bi_mixins

cfn_capability_props_mixin = b2bi_mixins.CfnCapabilityPropsMixin(b2bi_mixins.CfnCapabilityMixinProps(
    configuration=b2bi_mixins.CfnCapabilityPropsMixin.CapabilityConfigurationProperty(
        edi=b2bi_mixins.CfnCapabilityPropsMixin.EdiConfigurationProperty(
            capability_direction="capabilityDirection",
            input_location=b2bi_mixins.CfnCapabilityPropsMixin.S3LocationProperty(
                bucket_name="bucketName",
                key="key"
            ),
            output_location=b2bi_mixins.CfnCapabilityPropsMixin.S3LocationProperty(
                bucket_name="bucketName",
                key="key"
            ),
            transformer_id="transformerId",
            type=b2bi_mixins.CfnCapabilityPropsMixin.EdiTypeProperty(
                x12_details=b2bi_mixins.CfnCapabilityPropsMixin.X12DetailsProperty(
                    transaction_set="transactionSet",
                    version="version"
                )
            )
        )
    ),
    instructions_documents=[b2bi_mixins.CfnCapabilityPropsMixin.S3LocationProperty(
        bucket_name="bucketName",
        key="key"
    )],
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    type="type"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::B2BI::Capability.

Parameters:

props (Union[CfnCapabilityMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['configuration', 'instructionsDocuments', 'name', 'tags', 'type']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

CapabilityConfigurationProperty

class CfnCapabilityPropsMixin.CapabilityConfigurationProperty(*, edi=None)

Bases: object

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.

Parameters:: edi (Union[IResolvable, EdiConfigurationProperty, Dict[str, Any], None]) – An EDI (electronic data interchange) configuration object.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-capabilityconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_b2bi import mixins as b2bi_mixins

capability_configuration_property = b2bi_mixins.CfnCapabilityPropsMixin.CapabilityConfigurationProperty(
    edi=b2bi_mixins.CfnCapabilityPropsMixin.EdiConfigurationProperty(
        capability_direction="capabilityDirection",
        input_location=b2bi_mixins.CfnCapabilityPropsMixin.S3LocationProperty(
            bucket_name="bucketName",
            key="key"
        ),
        output_location=b2bi_mixins.CfnCapabilityPropsMixin.S3LocationProperty(
            bucket_name="bucketName",
            key="key"
        ),
        transformer_id="transformerId",
        type=b2bi_mixins.CfnCapabilityPropsMixin.EdiTypeProperty(
            x12_details=b2bi_mixins.CfnCapabilityPropsMixin.X12DetailsProperty(
                transaction_set="transactionSet",
                version="version"
            )
        )
    )
)

Attributes

edi

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

EdiConfigurationProperty

class CfnCapabilityPropsMixin.EdiConfigurationProperty(*, capability_direction=None, input_location=None, output_location=None, transformer_id=None, type=None)

Bases: object

Specifies the details for the EDI (electronic data interchange) transformation.

Parameters:

capability_direction (Optional[str]) – Specifies whether this is capability is for inbound or outbound transformations.
input_location (Union[IResolvable, S3LocationProperty, Dict[str, Any], None]) – Contains the Amazon S3 bucket and prefix for the location of the input file, which is contained in an S3Location object.
output_location (Union[IResolvable, S3LocationProperty, Dict[str, Any], None]) – Contains the Amazon S3 bucket and prefix for the location of the output file, which is contained in an S3Location object.
transformer_id (Optional[str]) – Returns the system-assigned unique identifier for the transformer.
type (Union[IResolvable, EdiTypeProperty, Dict[str, Any], None]) – 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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_b2bi import mixins as b2bi_mixins

edi_configuration_property = b2bi_mixins.CfnCapabilityPropsMixin.EdiConfigurationProperty(
    capability_direction="capabilityDirection",
    input_location=b2bi_mixins.CfnCapabilityPropsMixin.S3LocationProperty(
        bucket_name="bucketName",
        key="key"
    ),
    output_location=b2bi_mixins.CfnCapabilityPropsMixin.S3LocationProperty(
        bucket_name="bucketName",
        key="key"
    ),
    transformer_id="transformerId",
    type=b2bi_mixins.CfnCapabilityPropsMixin.EdiTypeProperty(
        x12_details=b2bi_mixins.CfnCapabilityPropsMixin.X12DetailsProperty(
            transaction_set="transactionSet",
            version="version"
        )
    )
)

Attributes

capability_direction

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

input_location

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

output_location

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

transformer_id

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

type

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

EdiTypeProperty

class CfnCapabilityPropsMixin.EdiTypeProperty(*, x12_details=None)

Bases: object

Parameters:: x12_details (Union[IResolvable, X12DetailsProperty, Dict[str, Any], None])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-editype.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_b2bi import mixins as b2bi_mixins

edi_type_property = b2bi_mixins.CfnCapabilityPropsMixin.EdiTypeProperty(
    x12_details=b2bi_mixins.CfnCapabilityPropsMixin.X12DetailsProperty(
        transaction_set="transactionSet",
        version="version"
    )
)

Attributes

x12_details

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-editype.html#cfn-b2bi-capability-editype-x12details

Type:: see

S3LocationProperty

class CfnCapabilityPropsMixin.S3LocationProperty(*, bucket_name=None, key=None)

Bases: object

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.

Parameters:

bucket_name (Optional[str]) – Specifies the name of the Amazon S3 bucket.
key (Optional[str]) – Specifies the Amazon S3 key for the file location.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-s3location.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_b2bi import mixins as b2bi_mixins

s3_location_property = b2bi_mixins.CfnCapabilityPropsMixin.S3LocationProperty(
    bucket_name="bucketName",
    key="key"
)

Attributes

bucket_name

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

key

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

X12DetailsProperty

class CfnCapabilityPropsMixin.X12DetailsProperty(*, transaction_set=None, version=None)

Bases: object

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. .. epigraph:

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.

Parameters:

transaction_set (Optional[str]) – Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (Optional[str]) – 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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_b2bi import mixins as b2bi_mixins

x12_details_property = b2bi_mixins.CfnCapabilityPropsMixin.X12DetailsProperty(
    transaction_set="transactionSet",
    version="version"
)

Attributes

transaction_set

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

version

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