class CfnTransformerPropsMixin (mixin)

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.B2BI.CfnTransformerPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsb2bi#CfnTransformerPropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.b2bi.CfnTransformerPropsMixin
Python	aws_cdk.cfn_property_mixins.aws_b2bi.CfnTransformerPropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_b2bi » CfnTransformerPropsMixin

Implements IMixin

Extends Mixin

Creates a transformer. AWS B2B Data Interchange currently supports two scenarios:.

• Inbound EDI : the AWS customer receives an EDI file from their trading partner. AWS B2B Data Interchange converts this EDI file into a JSON or XML file with a service-defined structure. A mapping template provided by the customer, in JSONata or XSLT format, is optionally applied to this file to produce a JSON or XML file with the structure the customer requires.
• Outbound EDI : the AWS customer has a JSON or XML file containing data that they wish to use in an EDI file. A mapping template, provided by the customer (in either JSONata or XSLT format) is applied to this file to generate a JSON or XML file in the service-defined structure. This file is then converted to an EDI file.

The following fields are provided for backwards compatibility only: fileFormat , mappingTemplate , ediType , and sampleDocument .

• Use the mapping data type in place of mappingTemplate and fileFormat
• Use the sampleDocuments data type in place of sampleDocument
• Use either the inputConversion or outputConversion in place of ediType

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 { aws_b2bi as b2bi } from '@aws-cdk/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const mergeStrategy: cdk.IMergeStrategy;
const cfnTransformerPropsMixin = new b2bi.CfnTransformerPropsMixin({
  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',
  }],
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnTransformerPropsMixin(props: CfnTransformerMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnTransformerMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::B2BI::Transformer.

Properties

Name	Type	Description
props	CfnTransformerMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnTransformerMixinProps

---

strategy

Type: IMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.