Package software.amazon.awscdk.services.b2bi

Interface CfnCapabilityProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCapabilityProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-11T18:01:11.818Z")
@Stability(Stable)
public interface CfnCapabilityProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.b2bi.*;
 CfnCapabilityProps cfnCapabilityProps = CfnCapabilityProps.builder()
         .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())
                         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCapabilityProps.Builder	A builder for CfnCapabilityProps
static final class	CfnCapabilityProps.Jsii$Proxy	An implementation for CfnCapabilityProps

Method Summary

Modifier and Type	Method	Description
static CfnCapabilityProps.Builder	builder()
Object	getConfiguration()	Specifies a structure that contains the details for a capability.
default Object	getInstructionsDocuments()	Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability.
String	getName()	The display name of the capability.
default List<CfnTag>	getTags()	Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type.
String	getType()	Returns the type of the capability.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConfiguration

@Stability(Stable)
@NotNull
Object getConfiguration()

Specifies a structure that contains the details for a capability.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html#cfn-b2bi-capability-configuration

getName

@Stability(Stable)
@NotNull
String getName()

The display name of the capability.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html#cfn-b2bi-capability-name

getType

@Stability(Stable)
@NotNull
String getType()

Returns the type of the capability.

Currently, only edi is supported.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html#cfn-b2bi-capability-type

getInstructionsDocuments

@Stability(Stable)
@Nullable
default Object getInstructionsDocuments()

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 Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html#cfn-b2bi-capability-instructionsdocuments

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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 Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html#cfn-b2bi-capability-tags

builder

@Stability(Stable)
static CfnCapabilityProps.Builder builder()

Returns:

a CfnCapabilityProps.Builder of CfnCapabilityProps