Class CfnCapability

Instantiates a capability based on the specified parameters.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnCapability

Implements

IInspectable

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AwsB2Bi

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnCapability : CfnResource, IInspectable, ITaggableV2

Syntax (vb)

Public Class CfnCapability Inherits CfnResource Implements IInspectable, ITaggableV2

Remarks

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

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 cfnCapability = new CfnCapability(this, "MyCfnCapability", 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

Constructors

CfnCapability(Construct, string, ICfnCapabilityProps)

Instantiates a capability based on the specified parameters.

Properties

AttrCapabilityArn	Returns an Amazon Resource Name (ARN) for a specific AWS resource, such as a capability, partnership, profile, or transformer.
AttrCapabilityId	Returns a system-assigned unique identifier for the capability.
AttrCreatedAt	Returns a timestamp for creation date and time of the capability.
AttrModifiedAt	Returns a timestamp that identifies the most recent date and time that the capability was modified.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	Instantiates a capability based on the specified parameters.
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.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	Instantiates a capability based on the specified parameters.

Constructors

CfnCapability(Construct, string, ICfnCapabilityProps)

Instantiates a capability based on the specified parameters.

public CfnCapability(Construct scope, string id, ICfnCapabilityProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnCapabilityProps

Resource properties.

Remarks

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

Properties

AttrCapabilityArn

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

public virtual string AttrCapabilityArn { get; }

Property Value

string

Remarks

CloudformationAttribute: CapabilityArn

AttrCapabilityId

Returns a system-assigned unique identifier for the capability.

public virtual string AttrCapabilityId { get; }

Property Value

string

Remarks

CloudformationAttribute: CapabilityId

AttrCreatedAt

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

public virtual string AttrCreatedAt { get; }

Property Value

string

Remarks

CloudformationAttribute: CreatedAt

AttrModifiedAt

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

public virtual string AttrModifiedAt { get; }

Property Value

string

Remarks

CloudformationAttribute: ModifiedAt

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

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

CfnProperties

Instantiates a capability based on the specified parameters.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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

Configuration

Specifies a structure that contains the details for a capability.

public virtual object Configuration { get; set; }

Property Value

object

Remarks

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

InstructionsDocuments

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

public virtual object? InstructionsDocuments { get; set; }

Property Value

object

Remarks

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

Name

The display name of the capability.

public virtual string Name { get; set; }

Property Value

string

Remarks

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

Tags

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

public virtual ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

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

Type

Returns the type of the capability.

public virtual string Type { get; set; }

Property Value

string

Remarks

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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

RenderProperties(IDictionary<string, object>)

Instantiates a capability based on the specified parameters.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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

Implements

IInspectable

ITaggableV2