Interface ICfnCapabilityProps

Properties for defining a CfnCapability.

Namespace: Amazon.CDK.AwsB2Bi

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnCapabilityProps

Syntax (vb)

Public Interface ICfnCapabilityProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Aws_b2bi;

var cfnCapabilityProps = new CfnCapabilityProps {
    Configuration = new CapabilityConfigurationProperty {
        Edi = new EdiConfigurationProperty {
            InputLocation = new S3LocationProperty {
                BucketName = "bucketName",
                Key = "key"
            },
            OutputLocation = new S3LocationProperty {
                BucketName = "bucketName",
                Key = "key"
            },
            TransformerId = "transformerId",
            Type = new EdiTypeProperty {
                X12Details = new X12DetailsProperty {
                    TransactionSet = "transactionSet",
                    Version = "version"
                }
            },

            // the properties below are optional
            CapabilityDirection = "capabilityDirection"
        }
    },
    Name = "name",
    Type = "type",

    // the properties below are optional
    InstructionsDocuments = new [] { new S3LocationProperty {
        BucketName = "bucketName",
        Key = "key"
    } },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};

Synopsis

Properties

Configuration	Specifies a structure that contains the details for a capability.
InstructionsDocuments	Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability.
Name	The display name of the capability.
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.

Properties

Configuration

Specifies a structure that contains the details for a capability.

object Configuration { get; }

Property Value

System.Object

Remarks

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

InstructionsDocuments

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

virtual object InstructionsDocuments { get; }

Property Value

System.Object

Remarks

Each item contains the name of the bucket and the key, to identify the document's location.

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

Name

The display name of the capability.

string Name { get; }

Property Value

System.String

Remarks

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

Tags

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

virtual ICfnTag[] Tags { get; }

Property Value

ICfnTag[]

Remarks

You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

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

Type

Returns the type of the capability.

string Type { get; }

Property Value

System.String

Remarks

Currently, only edi is supported.

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