2022/11/17 - AWS Database Migration Service - 9 updated api methods
Changes Adds support for Internet Protocol Version 6 (IPv6) on DMS Replication Instances
{'NetworkType': 'string'}
Response {'ReplicationInstance': {'NetworkType': 'string',
'PendingModifiedValues': {'NetworkType': 'string'},
'ReplicationInstanceIpv6Addresses': ['string'],
'ReplicationSubnetGroup': {'SupportedNetworkTypes': ['string']}}}
Creates the replication instance using the specified parameters.
DMS requires that your account have certain roles with appropriate permissions before you can create a replication instance. For information on the required roles, see Creating the IAM Roles to Use With the CLI and DMS API. For information on the required permissions, see IAM Permissions Needed to Use DMS.
See also: AWS API Documentation
Request Syntax
client.create_replication_instance(
ReplicationInstanceIdentifier='string',
AllocatedStorage=123,
ReplicationInstanceClass='string',
VpcSecurityGroupIds=[
'string',
],
AvailabilityZone='string',
ReplicationSubnetGroupIdentifier='string',
PreferredMaintenanceWindow='string',
MultiAZ=True|False,
EngineVersion='string',
AutoMinorVersionUpgrade=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string',
'ResourceArn': 'string'
},
],
KmsKeyId='string',
PubliclyAccessible=True|False,
DnsNameServers='string',
ResourceIdentifier='string',
NetworkType='string'
)
string
[REQUIRED]
The replication instance identifier. This parameter is stored as a lowercase 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
integer
The amount of storage (in gigabytes) to be initially allocated for the replication instance.
string
[REQUIRED]
The compute and memory capacity of the replication instance as defined for the specified replication instance class. 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 DMS replication instance for your migration.
list
Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.
(string) --
string
The Availability Zone where the replication instance will be created. The default value is a random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region, for example: us-east-1d
string
A subnet group to associate with the replication instance.
string
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per Amazon Web Services Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
boolean
Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
string
The engine version number of the replication instance.
If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
boolean
A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window. This parameter defaults to true.
Default: true
list
One or more tags to be assigned to the replication instance.
(dict) --
A user-defined key-value pair that describes metadata added to an DMS resource and that is used by operations such as the following:
AddTagsToResource
ListTagsForResource
RemoveTagsFromResource
Key (string) --
A key is the required name of the tag. The string value can be 1-128 Unicode characters in length and can't be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regular expressions: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be 1-256 Unicode characters in length and can't be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regular expressions: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
ResourceArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the resource for which the tag is created.
string
An KMS key identifier that is used to encrypt the data on the replication instance.
If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
boolean
Specifies the accessibility options for the replication instance. 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.
string
A list of custom DNS name servers supported for the replication instance to access your on-premise source or target database. 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"
string
A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. 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, DMS generates a default identifier value for the end of EndpointArn.
string
The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
dict
Response Syntax
{
'ReplicationInstance': {
'ReplicationInstanceIdentifier': 'string',
'ReplicationInstanceClass': 'string',
'ReplicationInstanceStatus': 'string',
'AllocatedStorage': 123,
'InstanceCreateTime': datetime(2015, 1, 1),
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'AvailabilityZone': 'string',
'ReplicationSubnetGroup': {
'ReplicationSubnetGroupIdentifier': 'string',
'ReplicationSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'SupportedNetworkTypes': [
'string',
]
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'ReplicationInstanceClass': 'string',
'AllocatedStorage': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'NetworkType': 'string'
},
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'KmsKeyId': 'string',
'ReplicationInstanceArn': 'string',
'ReplicationInstancePublicIpAddress': 'string',
'ReplicationInstancePrivateIpAddress': 'string',
'ReplicationInstancePublicIpAddresses': [
'string',
],
'ReplicationInstancePrivateIpAddresses': [
'string',
],
'ReplicationInstanceIpv6Addresses': [
'string',
],
'PubliclyAccessible': True|False,
'SecondaryAvailabilityZone': 'string',
'FreeUntil': datetime(2015, 1, 1),
'DnsNameServers': 'string',
'NetworkType': 'string'
}
}
Response Structure
(dict) --
ReplicationInstance (dict) --
The replication instance that was created.
ReplicationInstanceIdentifier (string) --
The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.
Constraints:
Must contain 1-63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: myrepinstance
ReplicationInstanceClass (string) --
The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a default value is pre-selected in the DMS console.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
ReplicationInstanceStatus (string) --
The status of the replication instance. The possible return values include:
"available"
"creating"
"deleted"
"deleting"
"failed"
"modifying"
"upgrading"
"rebooting"
"resetting-master-credentials"
"storage-full"
"incompatible-credentials"
"incompatible-network"
"maintenance"
AllocatedStorage (integer) --
The amount of storage (in gigabytes) that is allocated for the replication instance.
InstanceCreateTime (datetime) --
The time the replication instance was created.
VpcSecurityGroups (list) --
The VPC security group for the instance.
(dict) --
Describes the status of a security group associated with the virtual private cloud (VPC) hosting your replication and DB instances.
VpcSecurityGroupId (string) --
The VPC security group ID.
Status (string) --
The status of the VPC security group.
AvailabilityZone (string) --
The Availability Zone for the instance.
ReplicationSubnetGroup (dict) --
The subnet group for the replication instance.
ReplicationSubnetGroupIdentifier (string) --
The identifier of the replication instance subnet group.
ReplicationSubnetGroupDescription (string) --
A description for the replication subnet group.
VpcId (string) --
The ID of the VPC.
SubnetGroupStatus (string) --
The status of the subnet group.
Subnets (list) --
The subnets that are in the subnet group.
(dict) --
In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.
SubnetIdentifier (string) --
The subnet identifier.
SubnetAvailabilityZone (dict) --
The Availability Zone of the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
The status of the subnet.
SupportedNetworkTypes (list) --
The IP addressing protocol supported by the subnet group. This is used by a replication instance with values such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
(string) --
PreferredMaintenanceWindow (string) --
The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.
PendingModifiedValues (dict) --
The pending modification values.
ReplicationInstanceClass (string) --
The compute and memory capacity of the replication instance as defined for the specified replication instance class.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
AllocatedStorage (integer) --
The amount of storage (in gigabytes) that is allocated for the replication instance.
MultiAZ (boolean) --
Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
EngineVersion (string) --
The engine version number of the replication instance.
NetworkType (string) --
The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
MultiAZ (boolean) --
Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
EngineVersion (string) --
The engine version number of the replication instance.
If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true.
AutoMinorVersionUpgrade (boolean) --
Boolean value indicating if minor version upgrades will be automatically applied to the instance.
KmsKeyId (string) --
An KMS key identifier that is used to encrypt the data on the replication instance.
If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
ReplicationInstanceArn (string) --
The Amazon Resource Name (ARN) of the replication instance.
ReplicationInstancePublicIpAddress (string) --
The public IP address of the replication instance.
ReplicationInstancePrivateIpAddress (string) --
The private IP address of the replication instance.
ReplicationInstancePublicIpAddresses (list) --
One or more public IP addresses for the replication instance.
(string) --
ReplicationInstancePrivateIpAddresses (list) --
One or more private IP addresses for the replication instance.
(string) --
ReplicationInstanceIpv6Addresses (list) --
One or more IPv6 addresses for the replication instance.
(string) --
PubliclyAccessible (boolean) --
Specifies the accessibility options for the replication instance. 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.
SecondaryAvailabilityZone (string) --
The Availability Zone of the standby replication instance in a Multi-AZ deployment.
FreeUntil (datetime) --
The expiration date of the free replication instance that is part of the Free DMS program.
DnsNameServers (string) --
The DNS name servers supported for the replication instance to access your on-premise source or target database.
NetworkType (string) --
The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
{'ReplicationSubnetGroup': {'SupportedNetworkTypes': ['string']}}
Creates a replication subnet group given a list of the subnet IDs in a VPC.
The VPC needs to have at least one subnet in at least two availability zones in the Amazon Web Services Region, otherwise the service will throw a ReplicationSubnetGroupDoesNotCoverEnoughAZs exception.
See also: AWS API Documentation
Request Syntax
client.create_replication_subnet_group(
ReplicationSubnetGroupIdentifier='string',
ReplicationSubnetGroupDescription='string',
SubnetIds=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string',
'ResourceArn': 'string'
},
]
)
string
[REQUIRED]
The name for the replication subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens. Must not be "default".
Example: mySubnetgroup
string
[REQUIRED]
The description for the subnet group.
list
[REQUIRED]
One or more subnet IDs to be assigned to the subnet group.
(string) --
list
One or more tags to be assigned to the subnet group.
(dict) --
A user-defined key-value pair that describes metadata added to an DMS resource and that is used by operations such as the following:
AddTagsToResource
ListTagsForResource
RemoveTagsFromResource
Key (string) --
A key is the required name of the tag. The string value can be 1-128 Unicode characters in length and can't be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regular expressions: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be 1-256 Unicode characters in length and can't be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regular expressions: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
ResourceArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the resource for which the tag is created.
dict
Response Syntax
{
'ReplicationSubnetGroup': {
'ReplicationSubnetGroupIdentifier': 'string',
'ReplicationSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'SupportedNetworkTypes': [
'string',
]
}
}
Response Structure
(dict) --
ReplicationSubnetGroup (dict) --
The replication subnet group that was created.
ReplicationSubnetGroupIdentifier (string) --
The identifier of the replication instance subnet group.
ReplicationSubnetGroupDescription (string) --
A description for the replication subnet group.
VpcId (string) --
The ID of the VPC.
SubnetGroupStatus (string) --
The status of the subnet group.
Subnets (list) --
The subnets that are in the subnet group.
(dict) --
In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.
SubnetIdentifier (string) --
The subnet identifier.
SubnetAvailabilityZone (dict) --
The Availability Zone of the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
The status of the subnet.
SupportedNetworkTypes (list) --
The IP addressing protocol supported by the subnet group. This is used by a replication instance with values such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
(string) --
{'ReplicationInstance': {'NetworkType': 'string',
'PendingModifiedValues': {'NetworkType': 'string'},
'ReplicationInstanceIpv6Addresses': ['string'],
'ReplicationSubnetGroup': {'SupportedNetworkTypes': ['string']}}}
Deletes the specified replication instance.
See also: AWS API Documentation
Request Syntax
client.delete_replication_instance(
ReplicationInstanceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the replication instance to be deleted.
dict
Response Syntax
{
'ReplicationInstance': {
'ReplicationInstanceIdentifier': 'string',
'ReplicationInstanceClass': 'string',
'ReplicationInstanceStatus': 'string',
'AllocatedStorage': 123,
'InstanceCreateTime': datetime(2015, 1, 1),
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'AvailabilityZone': 'string',
'ReplicationSubnetGroup': {
'ReplicationSubnetGroupIdentifier': 'string',
'ReplicationSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'SupportedNetworkTypes': [
'string',
]
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'ReplicationInstanceClass': 'string',
'AllocatedStorage': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'NetworkType': 'string'
},
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'KmsKeyId': 'string',
'ReplicationInstanceArn': 'string',
'ReplicationInstancePublicIpAddress': 'string',
'ReplicationInstancePrivateIpAddress': 'string',
'ReplicationInstancePublicIpAddresses': [
'string',
],
'ReplicationInstancePrivateIpAddresses': [
'string',
],
'ReplicationInstanceIpv6Addresses': [
'string',
],
'PubliclyAccessible': True|False,
'SecondaryAvailabilityZone': 'string',
'FreeUntil': datetime(2015, 1, 1),
'DnsNameServers': 'string',
'NetworkType': 'string'
}
}
Response Structure
(dict) --
ReplicationInstance (dict) --
The replication instance that was deleted.
ReplicationInstanceIdentifier (string) --
The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.
Constraints:
Must contain 1-63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: myrepinstance
ReplicationInstanceClass (string) --
The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a default value is pre-selected in the DMS console.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
ReplicationInstanceStatus (string) --
The status of the replication instance. The possible return values include:
"available"
"creating"
"deleted"
"deleting"
"failed"
"modifying"
"upgrading"
"rebooting"
"resetting-master-credentials"
"storage-full"
"incompatible-credentials"
"incompatible-network"
"maintenance"
AllocatedStorage (integer) --
The amount of storage (in gigabytes) that is allocated for the replication instance.
InstanceCreateTime (datetime) --
The time the replication instance was created.
VpcSecurityGroups (list) --
The VPC security group for the instance.
(dict) --
Describes the status of a security group associated with the virtual private cloud (VPC) hosting your replication and DB instances.
VpcSecurityGroupId (string) --
The VPC security group ID.
Status (string) --
The status of the VPC security group.
AvailabilityZone (string) --
The Availability Zone for the instance.
ReplicationSubnetGroup (dict) --
The subnet group for the replication instance.
ReplicationSubnetGroupIdentifier (string) --
The identifier of the replication instance subnet group.
ReplicationSubnetGroupDescription (string) --
A description for the replication subnet group.
VpcId (string) --
The ID of the VPC.
SubnetGroupStatus (string) --
The status of the subnet group.
Subnets (list) --
The subnets that are in the subnet group.
(dict) --
In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.
SubnetIdentifier (string) --
The subnet identifier.
SubnetAvailabilityZone (dict) --
The Availability Zone of the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
The status of the subnet.
SupportedNetworkTypes (list) --
The IP addressing protocol supported by the subnet group. This is used by a replication instance with values such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
(string) --
PreferredMaintenanceWindow (string) --
The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.
PendingModifiedValues (dict) --
The pending modification values.
ReplicationInstanceClass (string) --
The compute and memory capacity of the replication instance as defined for the specified replication instance class.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
AllocatedStorage (integer) --
The amount of storage (in gigabytes) that is allocated for the replication instance.
MultiAZ (boolean) --
Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
EngineVersion (string) --
The engine version number of the replication instance.
NetworkType (string) --
The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
MultiAZ (boolean) --
Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
EngineVersion (string) --
The engine version number of the replication instance.
If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true.
AutoMinorVersionUpgrade (boolean) --
Boolean value indicating if minor version upgrades will be automatically applied to the instance.
KmsKeyId (string) --
An KMS key identifier that is used to encrypt the data on the replication instance.
If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
ReplicationInstanceArn (string) --
The Amazon Resource Name (ARN) of the replication instance.
ReplicationInstancePublicIpAddress (string) --
The public IP address of the replication instance.
ReplicationInstancePrivateIpAddress (string) --
The private IP address of the replication instance.
ReplicationInstancePublicIpAddresses (list) --
One or more public IP addresses for the replication instance.
(string) --
ReplicationInstancePrivateIpAddresses (list) --
One or more private IP addresses for the replication instance.
(string) --
ReplicationInstanceIpv6Addresses (list) --
One or more IPv6 addresses for the replication instance.
(string) --
PubliclyAccessible (boolean) --
Specifies the accessibility options for the replication instance. 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.
SecondaryAvailabilityZone (string) --
The Availability Zone of the standby replication instance in a Multi-AZ deployment.
FreeUntil (datetime) --
The expiration date of the free replication instance that is part of the Free DMS program.
DnsNameServers (string) --
The DNS name servers supported for the replication instance to access your on-premise source or target database.
NetworkType (string) --
The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
{'ReplicationInstances': {'NetworkType': 'string',
'PendingModifiedValues': {'NetworkType': 'string'},
'ReplicationInstanceIpv6Addresses': ['string'],
'ReplicationSubnetGroup': {'SupportedNetworkTypes': ['string']}}}
Returns information about replication instances for your account in the current region.
See also: AWS API Documentation
Request Syntax
client.describe_replication_instances(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
list
Filters applied to replication instances.
Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version
(dict) --
Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
Name (string) -- [REQUIRED]
The name of the filter as specified for a Describe* or similar operation.
Values (list) -- [REQUIRED]
The filter value, which can specify one or more values used to narrow the returned results.
(string) --
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
dict
Response Syntax
{
'Marker': 'string',
'ReplicationInstances': [
{
'ReplicationInstanceIdentifier': 'string',
'ReplicationInstanceClass': 'string',
'ReplicationInstanceStatus': 'string',
'AllocatedStorage': 123,
'InstanceCreateTime': datetime(2015, 1, 1),
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'AvailabilityZone': 'string',
'ReplicationSubnetGroup': {
'ReplicationSubnetGroupIdentifier': 'string',
'ReplicationSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'SupportedNetworkTypes': [
'string',
]
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'ReplicationInstanceClass': 'string',
'AllocatedStorage': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'NetworkType': 'string'
},
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'KmsKeyId': 'string',
'ReplicationInstanceArn': 'string',
'ReplicationInstancePublicIpAddress': 'string',
'ReplicationInstancePrivateIpAddress': 'string',
'ReplicationInstancePublicIpAddresses': [
'string',
],
'ReplicationInstancePrivateIpAddresses': [
'string',
],
'ReplicationInstanceIpv6Addresses': [
'string',
],
'PubliclyAccessible': True|False,
'SecondaryAvailabilityZone': 'string',
'FreeUntil': datetime(2015, 1, 1),
'DnsNameServers': 'string',
'NetworkType': 'string'
},
]
}
Response Structure
(dict) --
Marker (string) --
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
ReplicationInstances (list) --
The replication instances described.
(dict) --
Provides information that defines a replication instance.
ReplicationInstanceIdentifier (string) --
The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.
Constraints:
Must contain 1-63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: myrepinstance
ReplicationInstanceClass (string) --
The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a default value is pre-selected in the DMS console.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
ReplicationInstanceStatus (string) --
The status of the replication instance. The possible return values include:
"available"
"creating"
"deleted"
"deleting"
"failed"
"modifying"
"upgrading"
"rebooting"
"resetting-master-credentials"
"storage-full"
"incompatible-credentials"
"incompatible-network"
"maintenance"
AllocatedStorage (integer) --
The amount of storage (in gigabytes) that is allocated for the replication instance.
InstanceCreateTime (datetime) --
The time the replication instance was created.
VpcSecurityGroups (list) --
The VPC security group for the instance.
(dict) --
Describes the status of a security group associated with the virtual private cloud (VPC) hosting your replication and DB instances.
VpcSecurityGroupId (string) --
The VPC security group ID.
Status (string) --
The status of the VPC security group.
AvailabilityZone (string) --
The Availability Zone for the instance.
ReplicationSubnetGroup (dict) --
The subnet group for the replication instance.
ReplicationSubnetGroupIdentifier (string) --
The identifier of the replication instance subnet group.
ReplicationSubnetGroupDescription (string) --
A description for the replication subnet group.
VpcId (string) --
The ID of the VPC.
SubnetGroupStatus (string) --
The status of the subnet group.
Subnets (list) --
The subnets that are in the subnet group.
(dict) --
In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.
SubnetIdentifier (string) --
The subnet identifier.
SubnetAvailabilityZone (dict) --
The Availability Zone of the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
The status of the subnet.
SupportedNetworkTypes (list) --
The IP addressing protocol supported by the subnet group. This is used by a replication instance with values such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
(string) --
PreferredMaintenanceWindow (string) --
The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.
PendingModifiedValues (dict) --
The pending modification values.
ReplicationInstanceClass (string) --
The compute and memory capacity of the replication instance as defined for the specified replication instance class.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
AllocatedStorage (integer) --
The amount of storage (in gigabytes) that is allocated for the replication instance.
MultiAZ (boolean) --
Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
EngineVersion (string) --
The engine version number of the replication instance.
NetworkType (string) --
The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
MultiAZ (boolean) --
Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
EngineVersion (string) --
The engine version number of the replication instance.
If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true.
AutoMinorVersionUpgrade (boolean) --
Boolean value indicating if minor version upgrades will be automatically applied to the instance.
KmsKeyId (string) --
An KMS key identifier that is used to encrypt the data on the replication instance.
If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
ReplicationInstanceArn (string) --
The Amazon Resource Name (ARN) of the replication instance.
ReplicationInstancePublicIpAddress (string) --
The public IP address of the replication instance.
ReplicationInstancePrivateIpAddress (string) --
The private IP address of the replication instance.
ReplicationInstancePublicIpAddresses (list) --
One or more public IP addresses for the replication instance.
(string) --
ReplicationInstancePrivateIpAddresses (list) --
One or more private IP addresses for the replication instance.
(string) --
ReplicationInstanceIpv6Addresses (list) --
One or more IPv6 addresses for the replication instance.
(string) --
PubliclyAccessible (boolean) --
Specifies the accessibility options for the replication instance. 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.
SecondaryAvailabilityZone (string) --
The Availability Zone of the standby replication instance in a Multi-AZ deployment.
FreeUntil (datetime) --
The expiration date of the free replication instance that is part of the Free DMS program.
DnsNameServers (string) --
The DNS name servers supported for the replication instance to access your on-premise source or target database.
NetworkType (string) --
The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
{'ReplicationSubnetGroups': {'SupportedNetworkTypes': ['string']}}
Returns information about the replication subnet groups.
See also: AWS API Documentation
Request Syntax
client.describe_replication_subnet_groups(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
list
Filters applied to replication subnet groups.
Valid filter names: replication-subnet-group-id
(dict) --
Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
Name (string) -- [REQUIRED]
The name of the filter as specified for a Describe* or similar operation.
Values (list) -- [REQUIRED]
The filter value, which can specify one or more values used to narrow the returned results.
(string) --
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
dict
Response Syntax
{
'Marker': 'string',
'ReplicationSubnetGroups': [
{
'ReplicationSubnetGroupIdentifier': 'string',
'ReplicationSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'SupportedNetworkTypes': [
'string',
]
},
]
}
Response Structure
(dict) --
Marker (string) --
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
ReplicationSubnetGroups (list) --
A description of the replication subnet groups.
(dict) --
Describes a subnet group in response to a request by the DescribeReplicationSubnetGroups operation.
ReplicationSubnetGroupIdentifier (string) --
The identifier of the replication instance subnet group.
ReplicationSubnetGroupDescription (string) --
A description for the replication subnet group.
VpcId (string) --
The ID of the VPC.
SubnetGroupStatus (string) --
The status of the subnet group.
Subnets (list) --
The subnets that are in the subnet group.
(dict) --
In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.
SubnetIdentifier (string) --
The subnet identifier.
SubnetAvailabilityZone (dict) --
The Availability Zone of the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
The status of the subnet.
SupportedNetworkTypes (list) --
The IP addressing protocol supported by the subnet group. This is used by a replication instance with values such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
(string) --
{'TableStatistics': {'AppliedDdls': 'long',
'AppliedDeletes': 'long',
'AppliedInserts': 'long',
'AppliedUpdates': 'long'}}
Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.
Note that the "last updated" column the DMS console only indicates the time that DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the table.
See also: AWS API Documentation
Request Syntax
client.describe_table_statistics(
ReplicationTaskArn='string',
MaxRecords=123,
Marker='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the replication task.
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 500.
string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
list
Filters applied to table statistics.
Valid filter names: schema-name | table-name | table-state
A combination of filters creates an AND condition where each record matches all specified filters.
(dict) --
Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
Name (string) -- [REQUIRED]
The name of the filter as specified for a Describe* or similar operation.
Values (list) -- [REQUIRED]
The filter value, which can specify one or more values used to narrow the returned results.
(string) --
dict
Response Syntax
{
'ReplicationTaskArn': 'string',
'TableStatistics': [
{
'SchemaName': 'string',
'TableName': 'string',
'Inserts': 123,
'Deletes': 123,
'Updates': 123,
'Ddls': 123,
'AppliedInserts': 123,
'AppliedDeletes': 123,
'AppliedUpdates': 123,
'AppliedDdls': 123,
'FullLoadRows': 123,
'FullLoadCondtnlChkFailedRows': 123,
'FullLoadErrorRows': 123,
'FullLoadStartTime': datetime(2015, 1, 1),
'FullLoadEndTime': datetime(2015, 1, 1),
'FullLoadReloaded': True|False,
'LastUpdateTime': datetime(2015, 1, 1),
'TableState': 'string',
'ValidationPendingRecords': 123,
'ValidationFailedRecords': 123,
'ValidationSuspendedRecords': 123,
'ValidationState': 'string',
'ValidationStateDetails': 'string'
},
],
'Marker': 'string'
}
Response Structure
(dict) --
ReplicationTaskArn (string) --
The Amazon Resource Name (ARN) of the replication task.
TableStatistics (list) --
The table statistics.
(dict) --
Provides a collection of table statistics in response to a request by the DescribeTableStatistics operation.
SchemaName (string) --
The schema name.
TableName (string) --
The name of the table.
Inserts (integer) --
The number of insert actions performed on a table.
Deletes (integer) --
The number of delete actions performed on a table.
Updates (integer) --
The number of update actions performed on a table.
Ddls (integer) --
The data definition language (DDL) used to build and modify the structure of your tables.
AppliedInserts (integer) --
The number of insert actions applied on a target table.
AppliedDeletes (integer) --
The number of delete actions applied on a target table.
AppliedUpdates (integer) --
The number of update actions applied on a target table.
AppliedDdls (integer) --
The number of data definition language (DDL) statements used to build and modify the structure of your tables applied on the target.
FullLoadRows (integer) --
The number of rows added during the full load operation.
FullLoadCondtnlChkFailedRows (integer) --
The number of rows that failed conditional checks during the full load operation (valid only for migrations where DynamoDB is the target).
FullLoadErrorRows (integer) --
The number of rows that failed to load during the full load operation (valid only for migrations where DynamoDB is the target).
FullLoadStartTime (datetime) --
The time when the full load operation started.
FullLoadEndTime (datetime) --
The time when the full load operation completed.
FullLoadReloaded (boolean) --
A value that indicates if the table was reloaded ( true) or loaded as part of a new full load operation ( false).
LastUpdateTime (datetime) --
The last time a table was updated.
TableState (string) --
The state of the tables described.
Valid states: Table does not exist | Before load | Full load | Table completed | Table cancelled | Table error | Table is being reloaded
ValidationPendingRecords (integer) --
The number of records that have yet to be validated.
ValidationFailedRecords (integer) --
The number of records that failed validation.
ValidationSuspendedRecords (integer) --
The number of records that couldn't be validated.
ValidationState (string) --
The validation state of the table.
This parameter can have the following values:
Not enabled – Validation isn't enabled for the table in the migration task.
Pending records – Some records in the table are waiting for validation.
Mismatched records – Some records in the table don't match between the source and target.
Suspended records – Some records in the table couldn't be validated.
No primary key –The table couldn't be validated because it has no primary key.
Table error – The table wasn't validated because it's in an error state and some data wasn't migrated.
Validated – All rows in the table are validated. If the table is updated, the status can change from Validated.
Error – The table couldn't be validated because of an unexpected error.
Pending validation – The table is waiting validation.
Preparing table – Preparing the table enabled in the migration task for validation.
Pending revalidation – All rows in the table are pending validation after the table was updated.
ValidationStateDetails (string) --
Additional details about the state of validation.
Marker (string) --
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
{'NetworkType': 'string'}
Response {'ReplicationInstance': {'NetworkType': 'string',
'PendingModifiedValues': {'NetworkType': 'string'},
'ReplicationInstanceIpv6Addresses': ['string'],
'ReplicationSubnetGroup': {'SupportedNetworkTypes': ['string']}}}
Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request.
Some settings are applied during the maintenance window.
See also: AWS API Documentation
Request Syntax
client.modify_replication_instance(
ReplicationInstanceArn='string',
AllocatedStorage=123,
ApplyImmediately=True|False,
ReplicationInstanceClass='string',
VpcSecurityGroupIds=[
'string',
],
PreferredMaintenanceWindow='string',
MultiAZ=True|False,
EngineVersion='string',
AllowMajorVersionUpgrade=True|False,
AutoMinorVersionUpgrade=True|False,
ReplicationInstanceIdentifier='string',
NetworkType='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the replication instance.
integer
The amount of storage (in gigabytes) to be allocated for the replication instance.
boolean
Indicates whether the changes should be applied immediately or during the next maintenance window.
string
The compute and memory capacity of the replication instance as defined for the specified replication instance class. 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 DMS replication instance for your migration.
list
Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.
(string) --
string
The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
boolean
Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
string
The engine version number of the replication instance.
When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true.
boolean
Indicates that major version upgrades are allowed. 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.
boolean
A value that indicates that minor version upgrades are applied automatically to the replication instance during the maintenance window. Changing this parameter doesn't result in an outage, except in the case described following. The change is asynchronously applied as soon as possible.
An outage does result if these factors apply:
This parameter is set to true during the maintenance window.
A newer minor version is available.
DMS has enabled automatic patching for the given engine version.
string
The replication instance identifier. This parameter is stored as a lowercase string.
string
The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
dict
Response Syntax
{
'ReplicationInstance': {
'ReplicationInstanceIdentifier': 'string',
'ReplicationInstanceClass': 'string',
'ReplicationInstanceStatus': 'string',
'AllocatedStorage': 123,
'InstanceCreateTime': datetime(2015, 1, 1),
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'AvailabilityZone': 'string',
'ReplicationSubnetGroup': {
'ReplicationSubnetGroupIdentifier': 'string',
'ReplicationSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'SupportedNetworkTypes': [
'string',
]
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'ReplicationInstanceClass': 'string',
'AllocatedStorage': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'NetworkType': 'string'
},
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'KmsKeyId': 'string',
'ReplicationInstanceArn': 'string',
'ReplicationInstancePublicIpAddress': 'string',
'ReplicationInstancePrivateIpAddress': 'string',
'ReplicationInstancePublicIpAddresses': [
'string',
],
'ReplicationInstancePrivateIpAddresses': [
'string',
],
'ReplicationInstanceIpv6Addresses': [
'string',
],
'PubliclyAccessible': True|False,
'SecondaryAvailabilityZone': 'string',
'FreeUntil': datetime(2015, 1, 1),
'DnsNameServers': 'string',
'NetworkType': 'string'
}
}
Response Structure
(dict) --
ReplicationInstance (dict) --
The modified replication instance.
ReplicationInstanceIdentifier (string) --
The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.
Constraints:
Must contain 1-63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: myrepinstance
ReplicationInstanceClass (string) --
The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a default value is pre-selected in the DMS console.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
ReplicationInstanceStatus (string) --
The status of the replication instance. The possible return values include:
"available"
"creating"
"deleted"
"deleting"
"failed"
"modifying"
"upgrading"
"rebooting"
"resetting-master-credentials"
"storage-full"
"incompatible-credentials"
"incompatible-network"
"maintenance"
AllocatedStorage (integer) --
The amount of storage (in gigabytes) that is allocated for the replication instance.
InstanceCreateTime (datetime) --
The time the replication instance was created.
VpcSecurityGroups (list) --
The VPC security group for the instance.
(dict) --
Describes the status of a security group associated with the virtual private cloud (VPC) hosting your replication and DB instances.
VpcSecurityGroupId (string) --
The VPC security group ID.
Status (string) --
The status of the VPC security group.
AvailabilityZone (string) --
The Availability Zone for the instance.
ReplicationSubnetGroup (dict) --
The subnet group for the replication instance.
ReplicationSubnetGroupIdentifier (string) --
The identifier of the replication instance subnet group.
ReplicationSubnetGroupDescription (string) --
A description for the replication subnet group.
VpcId (string) --
The ID of the VPC.
SubnetGroupStatus (string) --
The status of the subnet group.
Subnets (list) --
The subnets that are in the subnet group.
(dict) --
In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.
SubnetIdentifier (string) --
The subnet identifier.
SubnetAvailabilityZone (dict) --
The Availability Zone of the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
The status of the subnet.
SupportedNetworkTypes (list) --
The IP addressing protocol supported by the subnet group. This is used by a replication instance with values such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
(string) --
PreferredMaintenanceWindow (string) --
The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.
PendingModifiedValues (dict) --
The pending modification values.
ReplicationInstanceClass (string) --
The compute and memory capacity of the replication instance as defined for the specified replication instance class.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
AllocatedStorage (integer) --
The amount of storage (in gigabytes) that is allocated for the replication instance.
MultiAZ (boolean) --
Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
EngineVersion (string) --
The engine version number of the replication instance.
NetworkType (string) --
The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
MultiAZ (boolean) --
Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
EngineVersion (string) --
The engine version number of the replication instance.
If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true.
AutoMinorVersionUpgrade (boolean) --
Boolean value indicating if minor version upgrades will be automatically applied to the instance.
KmsKeyId (string) --
An KMS key identifier that is used to encrypt the data on the replication instance.
If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
ReplicationInstanceArn (string) --
The Amazon Resource Name (ARN) of the replication instance.
ReplicationInstancePublicIpAddress (string) --
The public IP address of the replication instance.
ReplicationInstancePrivateIpAddress (string) --
The private IP address of the replication instance.
ReplicationInstancePublicIpAddresses (list) --
One or more public IP addresses for the replication instance.
(string) --
ReplicationInstancePrivateIpAddresses (list) --
One or more private IP addresses for the replication instance.
(string) --
ReplicationInstanceIpv6Addresses (list) --
One or more IPv6 addresses for the replication instance.
(string) --
PubliclyAccessible (boolean) --
Specifies the accessibility options for the replication instance. 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.
SecondaryAvailabilityZone (string) --
The Availability Zone of the standby replication instance in a Multi-AZ deployment.
FreeUntil (datetime) --
The expiration date of the free replication instance that is part of the Free DMS program.
DnsNameServers (string) --
The DNS name servers supported for the replication instance to access your on-premise source or target database.
NetworkType (string) --
The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
{'ReplicationSubnetGroup': {'SupportedNetworkTypes': ['string']}}
Modifies the settings for the specified replication subnet group.
See also: AWS API Documentation
Request Syntax
client.modify_replication_subnet_group(
ReplicationSubnetGroupIdentifier='string',
ReplicationSubnetGroupDescription='string',
SubnetIds=[
'string',
]
)
string
[REQUIRED]
The name of the replication instance subnet group.
string
A description for the replication instance subnet group.
list
[REQUIRED]
A list of subnet IDs.
(string) --
dict
Response Syntax
{
'ReplicationSubnetGroup': {
'ReplicationSubnetGroupIdentifier': 'string',
'ReplicationSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'SupportedNetworkTypes': [
'string',
]
}
}
Response Structure
(dict) --
ReplicationSubnetGroup (dict) --
The modified replication subnet group.
ReplicationSubnetGroupIdentifier (string) --
The identifier of the replication instance subnet group.
ReplicationSubnetGroupDescription (string) --
A description for the replication subnet group.
VpcId (string) --
The ID of the VPC.
SubnetGroupStatus (string) --
The status of the subnet group.
Subnets (list) --
The subnets that are in the subnet group.
(dict) --
In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.
SubnetIdentifier (string) --
The subnet identifier.
SubnetAvailabilityZone (dict) --
The Availability Zone of the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
The status of the subnet.
SupportedNetworkTypes (list) --
The IP addressing protocol supported by the subnet group. This is used by a replication instance with values such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
(string) --
{'ReplicationInstance': {'NetworkType': 'string',
'PendingModifiedValues': {'NetworkType': 'string'},
'ReplicationInstanceIpv6Addresses': ['string'],
'ReplicationSubnetGroup': {'SupportedNetworkTypes': ['string']}}}
Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again.
See also: AWS API Documentation
Request Syntax
client.reboot_replication_instance(
ReplicationInstanceArn='string',
ForceFailover=True|False,
ForcePlannedFailover=True|False
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the replication instance.
boolean
If this parameter is true, the reboot is conducted through a Multi-AZ failover. If the instance isn't configured for Multi-AZ, then you can't specify true. ( --force-planned-failover and --force-failover can't both be set to true.)
boolean
If this parameter is true, the reboot is conducted through a planned Multi-AZ failover where resources are released and cleaned up prior to conducting the failover. If the instance isn''t configured for Multi-AZ, then you can't specify true. ( --force-planned-failover and --force-failover can't both be set to true.)
dict
Response Syntax
{
'ReplicationInstance': {
'ReplicationInstanceIdentifier': 'string',
'ReplicationInstanceClass': 'string',
'ReplicationInstanceStatus': 'string',
'AllocatedStorage': 123,
'InstanceCreateTime': datetime(2015, 1, 1),
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'AvailabilityZone': 'string',
'ReplicationSubnetGroup': {
'ReplicationSubnetGroupIdentifier': 'string',
'ReplicationSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'SupportedNetworkTypes': [
'string',
]
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'ReplicationInstanceClass': 'string',
'AllocatedStorage': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'NetworkType': 'string'
},
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'KmsKeyId': 'string',
'ReplicationInstanceArn': 'string',
'ReplicationInstancePublicIpAddress': 'string',
'ReplicationInstancePrivateIpAddress': 'string',
'ReplicationInstancePublicIpAddresses': [
'string',
],
'ReplicationInstancePrivateIpAddresses': [
'string',
],
'ReplicationInstanceIpv6Addresses': [
'string',
],
'PubliclyAccessible': True|False,
'SecondaryAvailabilityZone': 'string',
'FreeUntil': datetime(2015, 1, 1),
'DnsNameServers': 'string',
'NetworkType': 'string'
}
}
Response Structure
(dict) --
ReplicationInstance (dict) --
The replication instance that is being rebooted.
ReplicationInstanceIdentifier (string) --
The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.
Constraints:
Must contain 1-63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: myrepinstance
ReplicationInstanceClass (string) --
The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a default value is pre-selected in the DMS console.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
ReplicationInstanceStatus (string) --
The status of the replication instance. The possible return values include:
"available"
"creating"
"deleted"
"deleting"
"failed"
"modifying"
"upgrading"
"rebooting"
"resetting-master-credentials"
"storage-full"
"incompatible-credentials"
"incompatible-network"
"maintenance"
AllocatedStorage (integer) --
The amount of storage (in gigabytes) that is allocated for the replication instance.
InstanceCreateTime (datetime) --
The time the replication instance was created.
VpcSecurityGroups (list) --
The VPC security group for the instance.
(dict) --
Describes the status of a security group associated with the virtual private cloud (VPC) hosting your replication and DB instances.
VpcSecurityGroupId (string) --
The VPC security group ID.
Status (string) --
The status of the VPC security group.
AvailabilityZone (string) --
The Availability Zone for the instance.
ReplicationSubnetGroup (dict) --
The subnet group for the replication instance.
ReplicationSubnetGroupIdentifier (string) --
The identifier of the replication instance subnet group.
ReplicationSubnetGroupDescription (string) --
A description for the replication subnet group.
VpcId (string) --
The ID of the VPC.
SubnetGroupStatus (string) --
The status of the subnet group.
Subnets (list) --
The subnets that are in the subnet group.
(dict) --
In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.
SubnetIdentifier (string) --
The subnet identifier.
SubnetAvailabilityZone (dict) --
The Availability Zone of the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
The status of the subnet.
SupportedNetworkTypes (list) --
The IP addressing protocol supported by the subnet group. This is used by a replication instance with values such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
(string) --
PreferredMaintenanceWindow (string) --
The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.
PendingModifiedValues (dict) --
The pending modification values.
ReplicationInstanceClass (string) --
The compute and memory capacity of the replication instance as defined for the specified replication instance class.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
AllocatedStorage (integer) --
The amount of storage (in gigabytes) that is allocated for the replication instance.
MultiAZ (boolean) --
Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
EngineVersion (string) --
The engine version number of the replication instance.
NetworkType (string) --
The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
MultiAZ (boolean) --
Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
EngineVersion (string) --
The engine version number of the replication instance.
If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true.
AutoMinorVersionUpgrade (boolean) --
Boolean value indicating if minor version upgrades will be automatically applied to the instance.
KmsKeyId (string) --
An KMS key identifier that is used to encrypt the data on the replication instance.
If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
ReplicationInstanceArn (string) --
The Amazon Resource Name (ARN) of the replication instance.
ReplicationInstancePublicIpAddress (string) --
The public IP address of the replication instance.
ReplicationInstancePrivateIpAddress (string) --
The private IP address of the replication instance.
ReplicationInstancePublicIpAddresses (list) --
One or more public IP addresses for the replication instance.
(string) --
ReplicationInstancePrivateIpAddresses (list) --
One or more private IP addresses for the replication instance.
(string) --
ReplicationInstanceIpv6Addresses (list) --
One or more IPv6 addresses for the replication instance.
(string) --
PubliclyAccessible (boolean) --
Specifies the accessibility options for the replication instance. 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.
SecondaryAvailabilityZone (string) --
The Availability Zone of the standby replication instance in a Multi-AZ deployment.
FreeUntil (datetime) --
The expiration date of the free replication instance that is part of the Free DMS program.
DnsNameServers (string) --
The DNS name servers supported for the replication instance to access your on-premise source or target database.
NetworkType (string) --
The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.