Package software.amazon.awscdk.services.b2bi

Class CfnCapability

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.b2bi.CfnCapability
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggableV2, ICapabilityRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:39:58.933Z") @Stability(Stable) public class CfnCapability extends CfnResource implements IInspectable, ICapabilityRef, ITaggableV2
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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.b2bi.*;
 CfnCapability cfnCapability = CfnCapability.Builder.create(this, "MyCfnCapability")
         .configuration(CapabilityConfigurationProperty.builder()
                 .edi(EdiConfigurationProperty.builder()
                         .inputLocation(S3LocationProperty.builder()
                                 .bucketName("bucketName")
                                 .key("key")
                                 .build())
                         .outputLocation(S3LocationProperty.builder()
                                 .bucketName("bucketName")
                                 .key("key")
                                 .build())
                         .transformerId("transformerId")
                         .type(EdiTypeProperty.builder()
                                 .x12Details(X12DetailsProperty.builder()
                                         .transactionSet("transactionSet")
                                         .version("version")
                                         .build())
                                 .build())
                         // the properties below are optional
                         .capabilityDirection("capabilityDirection")
                         .build())
                 .build())
         .name("name")
         .type("type")
         // the properties below are optional
         .instructionsDocuments(List.of(S3LocationProperty.builder()
                 .bucketName("bucketName")
                 .key("key")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCapability

      protected CfnCapability(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnCapability

      protected CfnCapability(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnCapability

      @Stability(Stable) public CfnCapability(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCapabilityProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCapabilityArn

      @Stability(Stable) @NotNull public String getAttrCapabilityArn()
      Returns an Amazon Resource Name (ARN) for a specific AWS resource, such as a capability, partnership, profile, or transformer.

    • getAttrCapabilityId

      @Stability(Stable) @NotNull public String getAttrCapabilityId()
      Returns a system-assigned unique identifier for the capability.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      Returns a timestamp for creation date and time of the capability.

    • getAttrModifiedAt

      @Stability(Stable) @NotNull public String getAttrModifiedAt()
      Returns a timestamp that identifies the most recent date and time that the capability was modified.

    • getCapabilityRef

      @Stability(Stable) @NotNull public CapabilityReference getCapabilityRef()
      A reference to a Capability resource.
      Specified by:
      getCapabilityRef in interface ICapabilityRef

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getConfiguration

      @Stability(Stable) @NotNull public Object getConfiguration()
      Specifies a structure that contains the details for a capability.

      Returns union: either IResolvable or CfnCapability.CapabilityConfigurationProperty

    • setConfiguration

      @Stability(Stable) public void setConfiguration(@NotNull IResolvable value)
      Specifies a structure that contains the details for a capability.

    • setConfiguration

      @Stability(Stable) public void setConfiguration(@NotNull CfnCapability.CapabilityConfigurationProperty value)
      Specifies a structure that contains the details for a capability.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The display name of the capability.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The display name of the capability.

    • getType

      @Stability(Stable) @NotNull public String getType()
      Returns the type of the capability.

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      Returns the type of the capability.

    • getInstructionsDocuments

      @Stability(Stable) @Nullable public Object getInstructionsDocuments()
      Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnCapability.S3LocationProperty>

    • setInstructionsDocuments

      @Stability(Stable) public void setInstructionsDocuments(@Nullable IResolvable value)
      Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability.

    • setInstructionsDocuments

      @Stability(Stable) public void setInstructionsDocuments(@Nullable List<Object> value)
      Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type.