CfnCapability

class aws_cdk.aws_b2bi.CfnCapability(scope, id, *, configuration, name, type, instructions_documents=None, tags=None)

Bases: CfnResource

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
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 import aws_b2bi as b2bi

cfn_capability = b2bi.CfnCapability(self, "MyCfnCapability",
    configuration=b2bi.CfnCapability.CapabilityConfigurationProperty(
        edi=b2bi.CfnCapability.EdiConfigurationProperty(
            input_location=b2bi.CfnCapability.S3LocationProperty(
                bucket_name="bucketName",
                key="key"
            ),
            output_location=b2bi.CfnCapability.S3LocationProperty(
                bucket_name="bucketName",
                key="key"
            ),
            transformer_id="transformerId",
            type=b2bi.CfnCapability.EdiTypeProperty(
                x12_details=b2bi.CfnCapability.X12DetailsProperty(
                    transaction_set="transactionSet",
                    version="version"
                )
            ),

            # the properties below are optional
            capability_direction="capabilityDirection"
        )
    ),
    name="name",
    type="type",

    # the properties below are optional
    instructions_documents=[b2bi.CfnCapability.S3LocationProperty(
        bucket_name="bucketName",
        key="key"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
configuration (Union[IResolvable, CapabilityConfigurationProperty, Dict[str, Any]]) – Specifies a structure that contains the details for a capability.
name (str) – The display name of the capability.
type (str) – Returns the type of the capability. Currently, only edi is supported.
instructions_documents (Union[IResolvable, Sequence[Union[IResolvable, S3LocationProperty, Dict[str, Any]]], None]) – 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.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:: target (CfnResource)
Deprecated:: use addDependency
Stability:: deprecated
Return type:: None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str)
value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy])
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:: key (str)
See:
Return type:: Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::B2BI::Capability'

attr_capability_arn

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

CloudformationAttribute:: CapabilityArn

attr_capability_id

Returns a system-assigned unique identifier for the capability.

CloudformationAttribute:: CapabilityId

attr_created_at

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

CloudformationAttribute:: CreatedAt

attr_modified_at

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

CloudformationAttribute:: ModifiedAt

capability_ref: A reference to a Capability resource.

cdk_tag_manager: Tag Manager which manages the tags for this resource.

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

configuration: Specifies a structure that contains the details for a capability.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

instructions_documents: Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name: The display name of the capability.

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags: Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type.

type: Returns the type of the capability.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:: x (Any)
Return type:: bool
Returns:: The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:: x (Any)
Return type:: bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

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

CapabilityConfigurationProperty

class CfnCapability.CapabilityConfigurationProperty(*, edi)

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]]) – 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 import aws_b2bi as b2bi

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

        # the properties below are optional
        capability_direction="capabilityDirection"
    )
)

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 CfnCapability.EdiConfigurationProperty(*, input_location, output_location, transformer_id, type, capability_direction=None)

Bases: object

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

Parameters:

input_location (Union[IResolvable, S3LocationProperty, Dict[str, Any]]) – 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]]) – Contains the Amazon S3 bucket and prefix for the location of the output file, which is contained in an S3Location object.
transformer_id (str) – Returns the system-assigned unique identifier for the transformer.
type (Union[IResolvable, EdiTypeProperty, Dict[str, Any]]) – Returns the type of the capability. Currently, only edi is supported.
capability_direction (Optional[str]) – 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

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 import aws_b2bi as b2bi

edi_configuration_property = b2bi.CfnCapability.EdiConfigurationProperty(
    input_location=b2bi.CfnCapability.S3LocationProperty(
        bucket_name="bucketName",
        key="key"
    ),
    output_location=b2bi.CfnCapability.S3LocationProperty(
        bucket_name="bucketName",
        key="key"
    ),
    transformer_id="transformerId",
    type=b2bi.CfnCapability.EdiTypeProperty(
        x12_details=b2bi.CfnCapability.X12DetailsProperty(
            transaction_set="transactionSet",
            version="version"
        )
    ),

    # the properties below are optional
    capability_direction="capabilityDirection"
)

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 CfnCapability.EdiTypeProperty(*, x12_details)

Bases: object

Parameters:: x12_details (Union[IResolvable, X12DetailsProperty, Dict[str, Any]])
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 import aws_b2bi as b2bi

edi_type_property = b2bi.CfnCapability.EdiTypeProperty(
    x12_details=b2bi.CfnCapability.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 CfnCapability.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 import aws_b2bi as b2bi

s3_location_property = b2bi.CfnCapability.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 CfnCapability.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 import aws_b2bi as b2bi

x12_details_property = b2bi.CfnCapability.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