class CfnEndpointPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.DMS.Mixins.CfnEndpointPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsdms/mixins#CfnEndpointPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.dms.mixins.CfnEndpointPropsMixin
Python	aws_cdk.mixins_preview.aws_dms.mixins.CfnEndpointPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_dms » mixins » CfnEndpointPropsMixin

Implements IMixin

Extends Mixin

The AWS::DMS::Endpoint resource specifies an AWS DMS endpoint.

Currently, AWS CloudFormation supports all AWS DMS endpoint types.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as dms_mixins } from '@aws-cdk/mixins-preview/aws-dms';
const cfnEndpointPropsMixin = new dms_mixins.CfnEndpointPropsMixin({
  certificateArn: 'certificateArn',
  databaseName: 'databaseName',
  docDbSettings: {
    docsToInvestigate: 123,
    extractDocId: false,
    nestingLevel: 'nestingLevel',
    secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
    secretsManagerSecretId: 'secretsManagerSecretId',
  },
  dynamoDbSettings: {
    serviceAccessRoleArn: 'serviceAccessRoleArn',
  },
  elasticsearchSettings: {
    endpointUri: 'endpointUri',
    errorRetryDuration: 123,
    fullLoadErrorPercentage: 123,
    serviceAccessRoleArn: 'serviceAccessRoleArn',
  },
  endpointIdentifier: 'endpointIdentifier',
  endpointType: 'endpointType',
  engineName: 'engineName',
  extraConnectionAttributes: 'extraConnectionAttributes',
  gcpMySqlSettings: {
    afterConnectScript: 'afterConnectScript',
    cleanSourceMetadataOnMismatch: false,
    databaseName: 'databaseName',
    eventsPollInterval: 123,
    maxFileSize: 123,
    parallelLoadThreads: 123,
    password: 'password',
    port: 123,
    secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
    secretsManagerSecretId: 'secretsManagerSecretId',
    serverName: 'serverName',
    serverTimezone: 'serverTimezone',
    username: 'username',
  },
  ibmDb2Settings: {
    currentLsn: 'currentLsn',
    keepCsvFiles: false,
    loadTimeout: 123,
    maxFileSize: 123,
    maxKBytesPerRead: 123,
    secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
    secretsManagerSecretId: 'secretsManagerSecretId',
    setDataCaptureChanges: false,
    writeBufferSize: 123,
  },
  kafkaSettings: {
    broker: 'broker',
    includeControlDetails: false,
    includeNullAndEmpty: false,
    includePartitionValue: false,
    includeTableAlterOperations: false,
    includeTransactionDetails: false,
    messageFormat: 'messageFormat',
    messageMaxBytes: 123,
    noHexPrefix: false,
    partitionIncludeSchemaTable: false,
    saslPassword: 'saslPassword',
    saslUserName: 'saslUserName',
    securityProtocol: 'securityProtocol',
    sslCaCertificateArn: 'sslCaCertificateArn',
    sslClientCertificateArn: 'sslClientCertificateArn',
    sslClientKeyArn: 'sslClientKeyArn',
    sslClientKeyPassword: 'sslClientKeyPassword',
    topic: 'topic',
  },
  kinesisSettings: {
    includeControlDetails: false,
    includeNullAndEmpty: false,
    includePartitionValue: false,
    includeTableAlterOperations: false,
    includeTransactionDetails: false,
    messageFormat: 'messageFormat',
    noHexPrefix: false,
    partitionIncludeSchemaTable: false,
    serviceAccessRoleArn: 'serviceAccessRoleArn',
    streamArn: 'streamArn',
  },
  kmsKeyId: 'kmsKeyId',
  microsoftSqlServerSettings: {
    bcpPacketSize: 123,
    controlTablesFileGroup: 'controlTablesFileGroup',
    databaseName: 'databaseName',
    forceLobLookup: false,
    password: 'password',
    port: 123,
    querySingleAlwaysOnNode: false,
    readBackupOnly: false,
    safeguardPolicy: 'safeguardPolicy',
    secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
    secretsManagerSecretId: 'secretsManagerSecretId',
    serverName: 'serverName',
    tlogAccessMode: 'tlogAccessMode',
    trimSpaceInChar: false,
    useBcpFullLoad: false,
    username: 'username',
    useThirdPartyBackupDevice: false,
  },
  mongoDbSettings: {
    authMechanism: 'authMechanism',
    authSource: 'authSource',
    authType: 'authType',
    databaseName: 'databaseName',
    docsToInvestigate: 'docsToInvestigate',
    extractDocId: 'extractDocId',
    nestingLevel: 'nestingLevel',
    password: 'password',
    port: 123,
    secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
    secretsManagerSecretId: 'secretsManagerSecretId',
    serverName: 'serverName',
    username: 'username',
  },
  mySqlSettings: {
    afterConnectScript: 'afterConnectScript',
    cleanSourceMetadataOnMismatch: false,
    eventsPollInterval: 123,
    maxFileSize: 123,
    parallelLoadThreads: 123,
    secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
    secretsManagerSecretId: 'secretsManagerSecretId',
    serverTimezone: 'serverTimezone',
    targetDbType: 'targetDbType',
  },
  neptuneSettings: {
    errorRetryDuration: 123,
    iamAuthEnabled: false,
    maxFileSize: 123,
    maxRetryCount: 123,
    s3BucketFolder: 's3BucketFolder',
    s3BucketName: 's3BucketName',
    serviceAccessRoleArn: 'serviceAccessRoleArn',
  },
  oracleSettings: {
    accessAlternateDirectly: false,
    additionalArchivedLogDestId: 123,
    addSupplementalLogging: false,
    allowSelectNestedTables: false,
    archivedLogDestId: 123,
    archivedLogsOnly: false,
    asmPassword: 'asmPassword',
    asmServer: 'asmServer',
    asmUser: 'asmUser',
    charLengthSemantics: 'charLengthSemantics',
    directPathNoLog: false,
    directPathParallelLoad: false,
    enableHomogenousTablespace: false,
    extraArchivedLogDestIds: [123],
    failTasksOnLobTruncation: false,
    numberDatatypeScale: 123,
    oraclePathPrefix: 'oraclePathPrefix',
    parallelAsmReadThreads: 123,
    readAheadBlocks: 123,
    readTableSpaceName: false,
    replacePathPrefix: false,
    retryInterval: 123,
    secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
    secretsManagerOracleAsmAccessRoleArn: 'secretsManagerOracleAsmAccessRoleArn',
    secretsManagerOracleAsmSecretId: 'secretsManagerOracleAsmSecretId',
    secretsManagerSecretId: 'secretsManagerSecretId',
    securityDbEncryption: 'securityDbEncryption',
    securityDbEncryptionName: 'securityDbEncryptionName',
    spatialDataOptionToGeoJsonFunctionName: 'spatialDataOptionToGeoJsonFunctionName',
    standbyDelayTime: 123,
    useAlternateFolderForOnline: false,
    useBFile: false,
    useDirectPathFullLoad: false,
    useLogminerReader: false,
    usePathPrefix: 'usePathPrefix',
  },
  password: 'password',
  port: 123,
  postgreSqlSettings: {
    afterConnectScript: 'afterConnectScript',
    babelfishDatabaseName: 'babelfishDatabaseName',
    captureDdls: false,
    databaseMode: 'databaseMode',
    ddlArtifactsSchema: 'ddlArtifactsSchema',
    executeTimeout: 123,
    failTasksOnLobTruncation: false,
    heartbeatEnable: false,
    heartbeatFrequency: 123,
    heartbeatSchema: 'heartbeatSchema',
    mapBooleanAsBoolean: false,
    maxFileSize: 123,
    pluginName: 'pluginName',
    secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
    secretsManagerSecretId: 'secretsManagerSecretId',
    slotName: 'slotName',
  },
  redisSettings: {
    authPassword: 'authPassword',
    authType: 'authType',
    authUserName: 'authUserName',
    port: 123,
    serverName: 'serverName',
    sslCaCertificateArn: 'sslCaCertificateArn',
    sslSecurityProtocol: 'sslSecurityProtocol',
  },
  redshiftSettings: {
    acceptAnyDate: false,
    afterConnectScript: 'afterConnectScript',
    bucketFolder: 'bucketFolder',
    bucketName: 'bucketName',
    caseSensitiveNames: false,
    compUpdate: false,
    connectionTimeout: 123,
    dateFormat: 'dateFormat',
    emptyAsNull: false,
    encryptionMode: 'encryptionMode',
    explicitIds: false,
    fileTransferUploadStreams: 123,
    loadTimeout: 123,
    mapBooleanAsBoolean: false,
    maxFileSize: 123,
    removeQuotes: false,
    replaceChars: 'replaceChars',
    replaceInvalidChars: 'replaceInvalidChars',
    secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
    secretsManagerSecretId: 'secretsManagerSecretId',
    serverSideEncryptionKmsKeyId: 'serverSideEncryptionKmsKeyId',
    serviceAccessRoleArn: 'serviceAccessRoleArn',
    timeFormat: 'timeFormat',
    trimBlanks: false,
    truncateColumns: false,
    writeBufferSize: 123,
  },
  resourceIdentifier: 'resourceIdentifier',
  s3Settings: {
    addColumnName: false,
    addTrailingPaddingCharacter: false,
    bucketFolder: 'bucketFolder',
    bucketName: 'bucketName',
    cannedAclForObjects: 'cannedAclForObjects',
    cdcInsertsAndUpdates: false,
    cdcInsertsOnly: false,
    cdcMaxBatchInterval: 123,
    cdcMinFileSize: 123,
    cdcPath: 'cdcPath',
    compressionType: 'compressionType',
    csvDelimiter: 'csvDelimiter',
    csvNoSupValue: 'csvNoSupValue',
    csvNullValue: 'csvNullValue',
    csvRowDelimiter: 'csvRowDelimiter',
    dataFormat: 'dataFormat',
    dataPageSize: 123,
    datePartitionDelimiter: 'datePartitionDelimiter',
    datePartitionEnabled: false,
    datePartitionSequence: 'datePartitionSequence',
    datePartitionTimezone: 'datePartitionTimezone',
    dictPageSizeLimit: 123,
    enableStatistics: false,
    encodingType: 'encodingType',
    encryptionMode: 'encryptionMode',
    expectedBucketOwner: 'expectedBucketOwner',
    externalTableDefinition: 'externalTableDefinition',
    glueCatalogGeneration: false,
    ignoreHeaderRows: 123,
    includeOpForFullLoad: false,
    maxFileSize: 123,
    parquetTimestampInMillisecond: false,
    parquetVersion: 'parquetVersion',
    preserveTransactions: false,
    rfc4180: false,
    rowGroupLength: 123,
    serverSideEncryptionKmsKeyId: 'serverSideEncryptionKmsKeyId',
    serviceAccessRoleArn: 'serviceAccessRoleArn',
    timestampColumnName: 'timestampColumnName',
    useCsvNoSupValue: false,
    useTaskStartTimeForFullLoadTimestamp: false,
  },
  serverName: 'serverName',
  sslMode: 'sslMode',
  sybaseSettings: {
    secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
    secretsManagerSecretId: 'secretsManagerSecretId',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  username: 'username',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnEndpointPropsMixin(props: CfnEndpointMixinProps, options?: CfnPropertyMixinOptions)

Parameters

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

Create a mixin to apply properties to AWS::DMS::Endpoint.

Properties

Name	Type	Description
props	CfnEndpointMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnEndpointMixinProps

---

strategy

Type: PropertyMergeStrategy

---

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): IConstruct

Parameters

• construct IConstruct

Returns

• 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.