interface CfnTransformerMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.B2BI.Mixins.CfnTransformerMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsb2bi/mixins#CfnTransformerMixinProps
Java	software.amazon.awscdk.mixins.preview.services.b2bi.mixins.CfnTransformerMixinProps
Python	aws_cdk.mixins_preview.aws_b2bi.mixins.CfnTransformerMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_b2bi » mixins » CfnTransformerMixinProps

Properties for CfnTransformerPropsMixin.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as b2bi_mixins } from '@aws-cdk/mixins-preview/aws-b2bi';
const cfnTransformerMixinProps: b2bi_mixins.CfnTransformerMixinProps = {
  ediType: {
    x12Details: {
      transactionSet: 'transactionSet',
      version: 'version',
    },
  },
  fileFormat: 'fileFormat',
  inputConversion: {
    advancedOptions: {
      x12: {
        splitOptions: {
          splitBy: 'splitBy',
        },
        validationOptions: {
          validationRules: [{
            codeListValidationRule: {
              codesToAdd: ['codesToAdd'],
              codesToRemove: ['codesToRemove'],
              elementId: 'elementId',
            },
            elementLengthValidationRule: {
              elementId: 'elementId',
              maxLength: 123,
              minLength: 123,
            },
            elementRequirementValidationRule: {
              elementPosition: 'elementPosition',
              requirement: 'requirement',
            },
          }],
        },
      },
    },
    formatOptions: {
      x12: {
        transactionSet: 'transactionSet',
        version: 'version',
      },
    },
    fromFormat: 'fromFormat',
  },
  mapping: {
    template: 'template',
    templateLanguage: 'templateLanguage',
  },
  mappingTemplate: 'mappingTemplate',
  name: 'name',
  outputConversion: {
    advancedOptions: {
      x12: {
        splitOptions: {
          splitBy: 'splitBy',
        },
        validationOptions: {
          validationRules: [{
            codeListValidationRule: {
              codesToAdd: ['codesToAdd'],
              codesToRemove: ['codesToRemove'],
              elementId: 'elementId',
            },
            elementLengthValidationRule: {
              elementId: 'elementId',
              maxLength: 123,
              minLength: 123,
            },
            elementRequirementValidationRule: {
              elementPosition: 'elementPosition',
              requirement: 'requirement',
            },
          }],
        },
      },
    },
    formatOptions: {
      x12: {
        transactionSet: 'transactionSet',
        version: 'version',
      },
    },
    toFormat: 'toFormat',
  },
  sampleDocument: 'sampleDocument',
  sampleDocuments: {
    bucketName: 'bucketName',
    keys: [{
      input: 'input',
      output: 'output',
    }],
  },
  status: 'status',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
ediType?⚠️	IResolvable | EdiTypeProperty
fileFormat?⚠️	string
inputConversion?	IResolvable | InputConversionProperty	Returns a structure that contains the format options for the transformation.
mapping?	IResolvable | MappingProperty	Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
mappingTemplate?⚠️	string	This shape is deprecated: This is a legacy trait.
name?	string	Returns the descriptive name for the transformer.
outputConversion?	IResolvable | OutputConversionProperty	Returns the OutputConversion object, which contains the format options for the outbound transformation.
sampleDocument?⚠️	string	This shape is deprecated: This is a legacy trait.
sampleDocuments?	IResolvable | SampleDocumentsProperty	Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
status?	string	Returns the state of the newly created transformer.
tags?	CfnTag[]	A key-value pair for a specific transformer.

---

ediType?⚠️

⚠️ Deprecated: this property has been deprecated

Type: IResolvable | EdiTypeProperty (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#cfn-b2bi-transformer-editype

---

fileFormat?⚠️

⚠️ Deprecated: this property has been deprecated

Type: string (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#cfn-b2bi-transformer-fileformat

---

inputConversion?

Type: IResolvable | InputConversionProperty (optional)

Returns a structure that contains the format options for the transformation.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#cfn-b2bi-transformer-inputconversion

---

mapping?

Type: IResolvable | MappingProperty (optional)

Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#cfn-b2bi-transformer-mapping

---

mappingTemplate?⚠️

⚠️ Deprecated: this property has been deprecated

Type: string (optional)

This shape is deprecated: This is a legacy trait.

Please use input-conversion or output-conversion.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#cfn-b2bi-transformer-mappingtemplate

---

name?

Type: string (optional)

Returns the descriptive name for the transformer.

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

---

outputConversion?

Type: IResolvable | OutputConversionProperty (optional)

Returns the OutputConversion object, which contains the format options for the outbound transformation.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#cfn-b2bi-transformer-outputconversion

---

sampleDocument?⚠️

⚠️ Deprecated: this property has been deprecated

Type: string (optional)

This shape is deprecated: This is a legacy trait.

Please use input-conversion or output-conversion.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#cfn-b2bi-transformer-sampledocument

---

sampleDocuments?

Type: IResolvable | SampleDocumentsProperty (optional)

Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#cfn-b2bi-transformer-sampledocuments

---

status?

Type: string (optional)

Returns the state of the newly created transformer.

The transformer can be either active or inactive . For the transformer to be used in a capability, its status must active .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#cfn-b2bi-transformer-status

---

tags?

Type: CfnTag[] (optional)

A key-value pair for a specific transformer.

Tags are metadata that you can use to search for and group capabilities for various purposes.

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