interface CfnCapabilityProps

Language	Type name
.NET	`Amazon.CDK.aws_b2bi.CfnCapabilityProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsb2bi#CfnCapabilityProps`
Java	`software.amazon.awscdk.services.b2bi.CfnCapabilityProps`
Python	`aws_cdk.aws_b2bi.CfnCapabilityProps`
TypeScript	`aws-cdk-lib` » `aws_b2bi` » `CfnCapabilityProps`

Properties for defining a CfnCapability.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_b2bi as b2bi } from 'aws-cdk-lib';
const cfnCapabilityProps: b2bi.CfnCapabilityProps = {
  configuration: {
    edi: {
      inputLocation: {
        bucketName: 'bucketName',
        key: 'key',
      },
      outputLocation: {
        bucketName: 'bucketName',
        key: 'key',
      },
      transformerId: 'transformerId',
      type: {
        x12Details: {
          transactionSet: 'transactionSet',
          version: 'version',
        },
      },

      // the properties below are optional
      capabilityDirection: 'capabilityDirection',
    },
  },
  name: 'name',
  type: 'type',

  // the properties below are optional
  instructionsDocuments: [{
    bucketName: 'bucketName',
    key: 'key',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
configuration	`IResolvable` `\|` `CapabilityConfigurationProperty`	Specifies a structure that contains the details for a capability.
name	`string`	The display name of the capability.
type	`string`	Returns the type of the capability.
instructionsDocuments?	`IResolvable` `\|` `IResolvable` `\|` `S3LocationProperty[]`	Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability.
tags?	`CfnTag[]`	Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type.

configuration

Type: IResolvable | CapabilityConfigurationProperty

Specifies a structure that contains the details for a capability.

name

Type: string

The display name of the capability.

type

Type: string

Returns the type of the capability.

Currently, only edi is supported.

instructionsDocuments?

Type: IResolvable | IResolvable | S3LocationProperty[] (optional)

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?

Type: CfnTag[] (optional)

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.