Skip to content
v2.273.0

CfnReplicationConfigProps Struct ​

Properties for defining a CfnReplicationConfig.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dms as dms } from 'aws-cdk-lib';

declare const replicationSettings: any;
declare const supplementalSettings: any;
declare const tableMappings: any;
const cfnReplicationConfigProps: dms.CfnReplicationConfigProps = {
  computeConfig: {
    maxCapacityUnits: 123,

    // the properties below are optional
    availabilityZone: 'availabilityZone',
    dnsNameServers: 'dnsNameServers',
    kmsKeyId: 'kmsKeyId',
    minCapacityUnits: 123,
    multiAz: false,
    preferredMaintenanceWindow: 'preferredMaintenanceWindow',
    replicationSubnetGroupId: 'replicationSubnetGroupId',
    vpcSecurityGroupIds: ['vpcSecurityGroupIds'],
  },
  replicationConfigIdentifier: 'replicationConfigIdentifier',
  replicationType: 'replicationType',
  sourceEndpointArn: 'sourceEndpointArn',
  tableMappings: tableMappings,
  targetEndpointArn: 'targetEndpointArn',

  // the properties below are optional
  replicationSettings: replicationSettings,
  resourceIdentifier: 'resourceIdentifier',
  supplementalSettings: supplementalSettings,
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

computeConfigIResolvable | CfnReplicationConfig.ComputeConfigPropertycompute_configtyping.Union[IResolvable, ComputeConfigProperty]computeConfigIResolvableComputeConfigIResolvableComputeConfiginterface{}required#
Configuration parameters for provisioning an AWS DMS Serverless replication.
replicationConfigIdentifierstringreplication_config_identifierstrreplicationConfigIdentifierStringReplicationConfigIdentifierstringReplicationConfigIdentifier*stringrequired#
A unique identifier that you want to use to create a `ReplicationConfigArn` that is returned as part of the output from this action.
notes

You can then pass this output ReplicationConfigArn as the value of the ReplicationConfigArn option for other actions to identify both AWS DMS Serverless replications and replication configurations that you want those actions to operate on. For some actions, you can also use either this unique identifier or a corresponding ARN in action filters to identify the specific replication and replication configuration to operate on.

replicationSettingsanyreplication_settingsAnyreplicationSettingsObjectReplicationSettingsobjectReplicationSettingsinterface{}#
Optional JSON settings for AWS DMS Serverless replications that are provisioned using this replication configuration.
replicationTypestringreplication_typestrreplicationTypeStringReplicationTypestringReplicationType*stringrequired#
The type of AWS DMS Serverless replication to provision using this replication configuration.

Possible values:

  • "full-load"
  • "cdc"
  • "full-load-and-cdc"
resourceIdentifierstringresource_identifierstrresourceIdentifierStringResourceIdentifierstringResourceIdentifier*string#
Optional unique value or name that you set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource.
sourceEndpointArnstringsource_endpoint_arnstrsourceEndpointArnStringSourceEndpointArnstringSourceEndpointArn*stringrequired#
The Amazon Resource Name (ARN) of the source endpoint for this AWS DMS Serverless replication configuration.
supplementalSettingsanysupplemental_settingsAnysupplementalSettingsObjectSupplementalSettingsobjectSupplementalSettingsinterface{}#
Optional JSON settings for specifying supplemental data.
tableMappingsanytable_mappingsAnytableMappingsObjectTableMappingsobjectTableMappingsinterface{}required#
JSON table mappings for AWS DMS Serverless replications that are provisioned using this replication configuration.
tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#
One or more optional tags associated with resources used by the AWS DMS Serverless replication.
targetEndpointArnstringtarget_endpoint_arnstrtargetEndpointArnStringTargetEndpointArnstringTargetEndpointArn*stringrequired#
The Amazon Resource Name (ARN) of the target endpoint for this AWS DMS serverless replication configuration.

Used as props by ​