AWS API Changes

2016/06/30 - AWS Database Migration Service - 4 updated api methods

Changes Update dms client to latest version

CreateReplicationInstance (updated)

Link ¶
Changes (request, response)
Request

{'VpcSecurityGroupIds': ['string']}

Response

{'ReplicationInstance': {'VpcSecurityGroups': [{'Status': 'string',
                                                'VpcSecurityGroupId': 'string'}]}}

Creates the replication instance using the specified parameters.

Request Syntax

client.create_replication_instance(
    ReplicationInstanceIdentifier='string',
    AllocatedStorage=123,
    ReplicationInstanceClass='string',
    VpcSecurityGroupIds=[
        'string',
    ],
    AvailabilityZone='string',
    ReplicationSubnetGroupIdentifier='string',
    PreferredMaintenanceWindow='string',
    EngineVersion='string',
    AutoMinorVersionUpgrade=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    KmsKeyId='string',
    PubliclyAccessible=True|False
)

type ReplicationInstanceIdentifier:

string

param ReplicationInstanceIdentifier:

[REQUIRED]

The replication instance identifier. This parameter is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

Example: myrepinstance

type AllocatedStorage:

integer

param AllocatedStorage:

The amount of storage (in gigabytes) to be initially allocated for the replication instance.

type ReplicationInstanceClass:

string

param ReplicationInstanceClass:

[REQUIRED]

The compute and memory capacity of the replication instance as specified by the replication instance class.

type VpcSecurityGroupIds:

list

param VpcSecurityGroupIds:

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

type AvailabilityZone:

string

param AvailabilityZone:

The EC2 Availability Zone that the replication instance will be created in.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

type ReplicationSubnetGroupIdentifier:

string

param ReplicationSubnetGroupIdentifier:

A subnet group to associate with the replication instance.

type PreferredMaintenanceWindow:

string

param PreferredMaintenanceWindow:

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 region, occurring on a random day of the week.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

type EngineVersion:

string

param EngineVersion:

The engine version number of the replication instance.

type AutoMinorVersionUpgrade:

boolean

param AutoMinorVersionUpgrade:

Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window.

Default: true

type Tags:

list

param Tags:

Tags to be associated with the replication instance.

(dict) --
- Key (string) --
  
  A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
- Value (string) --
  
  A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").

type KmsKeyId:

string

param KmsKeyId:

The KMS key identifier that will be used to encrypt the content on the replication instance. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.

type PubliclyAccessible:

boolean

param PubliclyAccessible:

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.

rtype:

dict

returns:

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'
                },
            ]
        },
        'PreferredMaintenanceWindow': 'string',
        'PendingModifiedValues': {
            'ReplicationInstanceClass': 'string',
            'AllocatedStorage': 123,
            'EngineVersion': 'string'
        },
        'EngineVersion': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'KmsKeyId': 'string',
        'ReplicationInstanceArn': 'string',
        'ReplicationInstancePublicIpAddress': 'string',
        'ReplicationInstancePrivateIpAddress': 'string',
        'PubliclyAccessible': True|False
    }
}

Response Structure

(dict) --
- ReplicationInstance (dict) --
  
  The replication instance that was created.
  - ReplicationInstanceIdentifier (string) --
    
    The replication instance identifier. This parameter is stored as a lowercase string.
    
    Constraints:
    - Must contain from 1 to 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.
    
    Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
  - ReplicationInstanceStatus (string) --
    
    The status of the replication instance.
  - 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) --
      - 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) --
      
      The description of 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) --
        
        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.
  - PreferredMaintenanceWindow (string) --
    
    The maintenance window times for the replication instance.
  - PendingModifiedValues (dict) --
    
    The pending modification values.
    - ReplicationInstanceClass (string) --
      
      The compute and memory capacity of the replication instance.
      
      Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
    - AllocatedStorage (integer) --
      
      The amount of storage (in gigabytes) that is allocated for the replication instance.
    - EngineVersion (string) --
      
      The engine version number of the replication instance.
  - EngineVersion (string) --
    
    The engine version number of the replication instance.
  - AutoMinorVersionUpgrade (boolean) --
    
    Boolean value indicating if minor version upgrades will be automatically applied to the instance.
  - KmsKeyId (string) --
    
    The KMS key identifier that is used to encrypt the content on the replication instance. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS 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.
  - 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.

DeleteReplicationInstance (updated)

Link ¶
Changes (response)

{'ReplicationInstance': {'VpcSecurityGroups': [{'Status': 'string',
                                                'VpcSecurityGroupId': 'string'}]}}

Deletes the specified replication instance.

Request Syntax

client.delete_replication_instance(
    ReplicationInstanceArn='string'
)

type ReplicationInstanceArn:

string

param ReplicationInstanceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the replication instance to be deleted.

rtype:

dict

returns:

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'
                },
            ]
        },
        'PreferredMaintenanceWindow': 'string',
        'PendingModifiedValues': {
            'ReplicationInstanceClass': 'string',
            'AllocatedStorage': 123,
            'EngineVersion': 'string'
        },
        'EngineVersion': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'KmsKeyId': 'string',
        'ReplicationInstanceArn': 'string',
        'ReplicationInstancePublicIpAddress': 'string',
        'ReplicationInstancePrivateIpAddress': 'string',
        'PubliclyAccessible': True|False
    }
}

Response Structure

(dict) --
- ReplicationInstance (dict) --
  
  The replication instance that was deleted.
  - ReplicationInstanceIdentifier (string) --
    
    The replication instance identifier. This parameter is stored as a lowercase string.
    
    Constraints:
    - Must contain from 1 to 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.
    
    Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
  - ReplicationInstanceStatus (string) --
    
    The status of the replication instance.
  - 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) --
      - 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) --
      
      The description of 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) --
        
        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.
  - PreferredMaintenanceWindow (string) --
    
    The maintenance window times for the replication instance.
  - PendingModifiedValues (dict) --
    
    The pending modification values.
    - ReplicationInstanceClass (string) --
      
      The compute and memory capacity of the replication instance.
      
      Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
    - AllocatedStorage (integer) --
      
      The amount of storage (in gigabytes) that is allocated for the replication instance.
    - EngineVersion (string) --
      
      The engine version number of the replication instance.
  - EngineVersion (string) --
    
    The engine version number of the replication instance.
  - AutoMinorVersionUpgrade (boolean) --
    
    Boolean value indicating if minor version upgrades will be automatically applied to the instance.
  - KmsKeyId (string) --
    
    The KMS key identifier that is used to encrypt the content on the replication instance. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS 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.
  - 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.

DescribeReplicationInstances (updated)

Link ¶
Changes (response)

{'ReplicationInstances': {'VpcSecurityGroups': [{'Status': 'string',
                                                 'VpcSecurityGroupId': 'string'}]}}

Returns information about replication instances for your account in the current region.

Request Syntax

client.describe_replication_instances(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)

type Filters:

list

param Filters:

Filters applied to the describe action.

Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version

(dict) --
- Name (string) -- [REQUIRED]
  
  The name of the filter.
- Values (list) -- [REQUIRED]
  
  The filter value.
  - (string) --

type MaxRecords:

integer

param MaxRecords:

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.

type Marker:

string

param Marker:

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.

rtype:

dict

returns:

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'
                    },
                ]
            },
            'PreferredMaintenanceWindow': 'string',
            'PendingModifiedValues': {
                'ReplicationInstanceClass': 'string',
                'AllocatedStorage': 123,
                'EngineVersion': 'string'
            },
            'EngineVersion': 'string',
            'AutoMinorVersionUpgrade': True|False,
            'KmsKeyId': 'string',
            'ReplicationInstanceArn': 'string',
            'ReplicationInstancePublicIpAddress': 'string',
            'ReplicationInstancePrivateIpAddress': 'string',
            'PubliclyAccessible': True|False
        },
    ]
}

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) --
    - ReplicationInstanceIdentifier (string) --
      
      The replication instance identifier. This parameter is stored as a lowercase string.
      
      Constraints:
      - Must contain from 1 to 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.
      
      Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
    - ReplicationInstanceStatus (string) --
      
      The status of the replication instance.
    - 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) --
        
        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) --
        
        The description of 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) --
        
        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.
    - PreferredMaintenanceWindow (string) --
      
      The maintenance window times for the replication instance.
    - PendingModifiedValues (dict) --
      
      The pending modification values.
      - ReplicationInstanceClass (string) --
        
        The compute and memory capacity of the replication instance.
        
        Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
      - AllocatedStorage (integer) --
        
        The amount of storage (in gigabytes) that is allocated for the replication instance.
      - EngineVersion (string) --
        
        The engine version number of the replication instance.
    - EngineVersion (string) --
      
      The engine version number of the replication instance.
    - AutoMinorVersionUpgrade (boolean) --
      
      Boolean value indicating if minor version upgrades will be automatically applied to the instance.
    - KmsKeyId (string) --
      
      The KMS key identifier that is used to encrypt the content on the replication instance. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS 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.
    - 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.

ModifyReplicationInstance (updated)

Link ¶
Changes (request, response)
Request

{'VpcSecurityGroupIds': ['string']}

Response

{'ReplicationInstance': {'VpcSecurityGroups': [{'Status': 'string',
                                                'VpcSecurityGroupId': '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.

Request Syntax

client.modify_replication_instance(
    ReplicationInstanceArn='string',
    AllocatedStorage=123,
    ApplyImmediately=True|False,
    ReplicationInstanceClass='string',
    VpcSecurityGroupIds=[
        'string',
    ],
    PreferredMaintenanceWindow='string',
    EngineVersion='string',
    AllowMajorVersionUpgrade=True|False,
    AutoMinorVersionUpgrade=True|False,
    ReplicationInstanceIdentifier='string'
)

type ReplicationInstanceArn:

string

param ReplicationInstanceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the replication instance.

type AllocatedStorage:

integer

param AllocatedStorage:

The amount of storage (in gigabytes) to be allocated for the replication instance.

type ApplyImmediately:

boolean

param ApplyImmediately:

Indicates whether the changes should be applied immediately or during the next maintenance window.

type ReplicationInstanceClass:

string

param ReplicationInstanceClass:

The compute and memory capacity of the replication instance.

type VpcSecurityGroupIds:

list

param VpcSecurityGroupIds:

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

type PreferredMaintenanceWindow:

string

param PreferredMaintenanceWindow:

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

type EngineVersion:

string

param EngineVersion:

The engine version number of the replication instance.

type AllowMajorVersionUpgrade:

boolean

param AllowMajorVersionUpgrade:

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.

Constraints: 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.

type AutoMinorVersionUpgrade:

boolean

param AutoMinorVersionUpgrade:

Indicates that minor version upgrades will be applied automatically to the replication instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and AWS DMS has enabled auto patching for that engine version.

type ReplicationInstanceIdentifier:

string

param ReplicationInstanceIdentifier:

The replication instance identifier. This parameter is stored as a lowercase string.

rtype:

dict

returns:

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'
                },
            ]
        },
        'PreferredMaintenanceWindow': 'string',
        'PendingModifiedValues': {
            'ReplicationInstanceClass': 'string',
            'AllocatedStorage': 123,
            'EngineVersion': 'string'
        },
        'EngineVersion': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'KmsKeyId': 'string',
        'ReplicationInstanceArn': 'string',
        'ReplicationInstancePublicIpAddress': 'string',
        'ReplicationInstancePrivateIpAddress': 'string',
        'PubliclyAccessible': True|False
    }
}

Response Structure

(dict) --
- ReplicationInstance (dict) --
  
  The modified replication instance.
  - ReplicationInstanceIdentifier (string) --
    
    The replication instance identifier. This parameter is stored as a lowercase string.
    
    Constraints:
    - Must contain from 1 to 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.
    
    Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
  - ReplicationInstanceStatus (string) --
    
    The status of the replication instance.
  - 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) --
      - 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) --
      
      The description of 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) --
        
        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.
  - PreferredMaintenanceWindow (string) --
    
    The maintenance window times for the replication instance.
  - PendingModifiedValues (dict) --
    
    The pending modification values.
    - ReplicationInstanceClass (string) --
      
      The compute and memory capacity of the replication instance.
      
      Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
    - AllocatedStorage (integer) --
      
      The amount of storage (in gigabytes) that is allocated for the replication instance.
    - EngineVersion (string) --
      
      The engine version number of the replication instance.
  - EngineVersion (string) --
    
    The engine version number of the replication instance.
  - AutoMinorVersionUpgrade (boolean) --
    
    Boolean value indicating if minor version upgrades will be automatically applied to the instance.
  - KmsKeyId (string) --
    
    The KMS key identifier that is used to encrypt the content on the replication instance. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS 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.
  - 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.