CfnCapabilityProps
- class aws_cdk.aws_b2bi.CfnCapabilityProps(*, configuration, name, type, instructions_documents=None, tags=None)
Bases:
object
Properties for defining a
CfnCapability
.- Parameters:
configuration (
Union
[IResolvable
,CapabilityConfigurationProperty
,Dict
[str
,Any
]]) – Specifies a structure that contains the details for a capability.name (
str
) – The display name of the capability.type (
str
) – Returns the type of the capability. Currently, onlyedi
is supported.instructions_documents (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,S3LocationProperty
,Dict
[str
,Any
]]],None
]) – 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 (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – 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:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_b2bi as b2bi cfn_capability_props = b2bi.CfnCapabilityProps( configuration=b2bi.CfnCapability.CapabilityConfigurationProperty( edi=b2bi.CfnCapability.EdiConfigurationProperty( input_location=b2bi.CfnCapability.S3LocationProperty( bucket_name="bucketName", key="key" ), output_location=b2bi.CfnCapability.S3LocationProperty( bucket_name="bucketName", key="key" ), transformer_id="transformerId", type=b2bi.CfnCapability.EdiTypeProperty( x12_details=b2bi.CfnCapability.X12DetailsProperty( transaction_set="transactionSet", version="version" ) ) ) ), name="name", type="type", # the properties below are optional instructions_documents=[b2bi.CfnCapability.S3LocationProperty( bucket_name="bucketName", key="key" )], tags=[CfnTag( key="key", value="value" )] )
Attributes
- configuration
Specifies a structure that contains the details for a capability.
- instructions_documents
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.
- 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.
You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.
- type
Returns the type of the capability.
Currently, only
edi
is supported.