interface CfnTransformerProps

Language	Type name
.NET	`Amazon.CDK.aws_b2bi.CfnTransformerProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsb2bi#CfnTransformerProps`
Java	`software.amazon.awscdk.services.b2bi.CfnTransformerProps`
Python	`aws_cdk.aws_b2bi.CfnTransformerProps`
TypeScript	`aws-cdk-lib` » `aws_b2bi` » `CfnTransformerProps`

Properties for defining a CfnTransformer.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_b2bi as b2bi } from 'aws-cdk-lib';
const cfnTransformerProps: b2bi.CfnTransformerProps = {
  name: 'name',
  status: 'status',

  // the properties below are optional
  ediType: {
    x12Details: {
      transactionSet: 'transactionSet',
      version: 'version',
    },
  },
  fileFormat: 'fileFormat',
  inputConversion: {
    fromFormat: 'fromFormat',

    // the properties below are optional
    advancedOptions: {
      x12: {
        splitOptions: {
          splitBy: 'splitBy',
        },
        validationOptions: {
          validationRules: [{
            codeListValidationRule: {
              elementId: 'elementId',

              // the properties below are optional
              codesToAdd: ['codesToAdd'],
              codesToRemove: ['codesToRemove'],
            },
            elementLengthValidationRule: {
              elementId: 'elementId',
              maxLength: 123,
              minLength: 123,
            },
            elementRequirementValidationRule: {
              elementPosition: 'elementPosition',
              requirement: 'requirement',
            },
          }],
        },
      },
    },
    formatOptions: {
      x12: {
        transactionSet: 'transactionSet',
        version: 'version',
      },
    },
  },
  mapping: {
    templateLanguage: 'templateLanguage',

    // the properties below are optional
    template: 'template',
  },
  mappingTemplate: 'mappingTemplate',
  outputConversion: {
    toFormat: 'toFormat',

    // the properties below are optional
    advancedOptions: {
      x12: {
        splitOptions: {
          splitBy: 'splitBy',
        },
        validationOptions: {
          validationRules: [{
            codeListValidationRule: {
              elementId: 'elementId',

              // the properties below are optional
              codesToAdd: ['codesToAdd'],
              codesToRemove: ['codesToRemove'],
            },
            elementLengthValidationRule: {
              elementId: 'elementId',
              maxLength: 123,
              minLength: 123,
            },
            elementRequirementValidationRule: {
              elementPosition: 'elementPosition',
              requirement: 'requirement',
            },
          }],
        },
      },
    },
    formatOptions: {
      x12: {
        transactionSet: 'transactionSet',
        version: 'version',
      },
    },
  },
  sampleDocument: 'sampleDocument',
  sampleDocuments: {
    bucketName: 'bucketName',
    keys: [{
      input: 'input',
      output: 'output',
    }],
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
name	`string`	Returns the descriptive name for the transformer.
status	`string`	Returns the state of the newly created transformer.
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.
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.
tags?	`CfnTag[]`	A key-value pair for a specific transformer.

name

Type: string

Returns the descriptive name for the transformer.

status

Type: string

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 .

ediType?⚠️

⚠️ Deprecated: this property has been deprecated

Type: IResolvable | EdiTypeProperty (optional)

fileFormat?⚠️

⚠️ Deprecated: this property has been deprecated

Type: string (optional)

inputConversion?

Type: IResolvable | InputConversionProperty (optional)

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

mapping?

Type: IResolvable | MappingProperty (optional)

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

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.

outputConversion?

Type: IResolvable | OutputConversionProperty (optional)

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

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.

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.

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.