CfnReplicationInstanceProps Struct
Properties for defining a CfnReplicationInstance.
Example
// 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';
const cfnReplicationInstanceProps: dms.CfnReplicationInstanceProps = {
replicationInstanceClass: 'replicationInstanceClass',
// the properties below are optional
allocatedStorage: 123,
allowMajorVersionUpgrade: false,
autoMinorVersionUpgrade: false,
availabilityZone: 'availabilityZone',
dnsNameServers: 'dnsNameServers',
engineVersion: 'engineVersion',
kmsKeyId: 'kmsKeyId',
multiAz: false,
networkType: 'networkType',
preferredMaintenanceWindow: 'preferredMaintenanceWindow',
publiclyAccessible: false,
replicationInstanceIdentifier: 'replicationInstanceIdentifier',
replicationSubnetGroupIdentifier: 'replicationSubnetGroupIdentifier',
resourceIdentifier: 'resourceIdentifier',
tags: [{
key: 'key',
value: 'value',
}],
vpcSecurityGroupIds: ['vpcSecurityGroupIds'],
};
Properties
allocatedStorageoptionalnumberallocated_storageoptionalint | floatallocatedStorageoptionalNumberAllocatedStorageoptionaldoubleAllocatedStorageoptional*float64#allowMajorVersionUpgradeoptionalboolean | IResolvableallow_major_version_upgradeoptionaltyping.Union[bool, IResolvable]allowMajorVersionUpgradeoptionalBooleanAllowMajorVersionUpgradeoptionalboolAllowMajorVersionUpgradeoptionalinterface{}#notes
Changing this parameter does not result in an outage, and the change is asynchronously applied as soon as possible.
This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the replication instance's current version.
autoMinorVersionUpgradeoptionalboolean | IResolvableauto_minor_version_upgradeoptionaltyping.Union[bool, IResolvable]autoMinorVersionUpgradeoptionalBooleanAutoMinorVersionUpgradeoptionalboolAutoMinorVersionUpgradeoptionalinterface{}#This parameter defaults to true .
Default: true
availabilityZoneoptionalstringavailability_zoneoptionalstravailabilityZoneoptionalStringAvailabilityZoneoptionalstringAvailabilityZoneoptional*string#The default value is a random, system-chosen Availability Zone in the endpoint's AWS Region , for example us-east-1d .
dnsNameServersoptionalstringdns_name_serversoptionalstrdnsNameServersoptionalStringDnsNameServersoptionalstringDnsNameServersoptional*string#This list overrides the default name servers supported by the replication instance. You can specify a comma-separated list of internet addresses for up to four on-premise DNS name servers. For example: "1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4"
engineVersionoptionalstringengine_versionoptionalstrengineVersionoptionalStringEngineVersionoptionalstringEngineVersionoptional*string#If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
kmsKeyIdoptionalstringkms_key_idoptionalstrkmsKeyIdoptionalStringKmsKeyIdoptionalstringKmsKeyIdoptional*string#notes
If you don't specify a value for the KmsKeyId parameter, AWS DMS uses your default encryption key.
AWS creates the default encryption key for your AWS account . Your AWS account has a different default encryption key for each AWS Region .
multiAzoptionalboolean | IResolvablemulti_azoptionaltyping.Union[bool, IResolvable]multiAzoptionalBooleanMultiAzoptionalboolMultiAzoptionalinterface{}#You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .
networkTypeoptionalstringnetwork_typeoptionalstrnetworkTypeoptionalStringNetworkTypeoptionalstringNetworkTypeoptional*string#IPv6 only is not yet supported.
preferredMaintenanceWindowoptionalstringpreferred_maintenance_windowoptionalstrpreferredMaintenanceWindowoptionalStringPreferredMaintenanceWindowoptionalstringPreferredMaintenanceWindowoptional*string#notes
Format : ddd:hh24:mi-ddd:hh24:mi
Default : A 30-minute window selected at random from an 8-hour block of time per AWS Region , occurring on a random day of the week.
Valid days ( ddd ): Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints : Minimum 30-minute window.
publiclyAccessibleoptionalboolean | IResolvablepublicly_accessibleoptionaltyping.Union[bool, IResolvable]publiclyAccessibleoptionalBooleanPubliclyAccessibleoptionalboolPubliclyAccessibleoptionalinterface{}#A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true .
replicationInstanceClassstringreplication_instance_classstrreplicationInstanceClassStringReplicationInstanceClassstringReplicationInstanceClass*stringrequired#notes
For example, to specify the instance class dms.c4.large, set this parameter to "dms.c4.large" . For more information on the settings and capacities for the available replication instance classes, see Selecting the right AWS DMS replication instance for your migration in the AWS Database Migration Service User Guide .
replicationInstanceIdentifieroptionalstringreplication_instance_identifieroptionalstrreplicationInstanceIdentifieroptionalStringReplicationInstanceIdentifieroptionalstringReplicationInstanceIdentifieroptional*string#Constraints:
- Must contain 1-63 alphanumeric characters or hyphens.
- First character must be a letter.
- Can't end with a hyphen or contain two consecutive hyphens.
Example: myrepinstance
replicationSubnetGroupIdentifieroptionalstringreplication_subnet_group_identifieroptionalstrreplicationSubnetGroupIdentifieroptionalStringReplicationSubnetGroupIdentifieroptionalstringReplicationSubnetGroupIdentifieroptional*string#resourceIdentifieroptionalstringresource_identifieroptionalstrresourceIdentifieroptionalStringResourceIdentifieroptionalstringResourceIdentifieroptional*string#notes
The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1 . For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1 . If you don't specify a ResourceIdentifier value, AWS DMS generates a default identifier value for the end of EndpointArn .
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#vpcSecurityGroupIdsoptionalstring[]vpc_security_group_idsoptionaltyping.List[str]vpcSecurityGroupIdsoptionalList<String>VpcSecurityGroupIdsoptionalstring[]VpcSecurityGroupIdsoptional*[]*string#The VPC security group must work with the VPC containing the replication instance.