DatabaseMigrationService / Client / create_replication_instance

create_replication_instance#

DatabaseMigrationService.Client.create_replication_instance(**kwargs)#

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.

Note

If you don’t specify a version when creating a replication instance, DMS will create the instance using the default engine version. For information about the default engine version, see Release Notes.

Request Syntax

response = 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',
    KerberosAuthenticationSettings={
        'KeyCacheSecretId': 'string',
        'KeyCacheSecretIamArn': 'string',
        'Krb5FileContents': 'string'
    }
)

Parameters:

ReplicationInstanceIdentifier (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
AllocatedStorage (integer) – The amount of storage (in gigabytes) to be initially allocated for the replication instance.
ReplicationInstanceClass (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 Choosing the right DMS replication instance; and, Selecting the best size for a replication instance.
VpcSecurityGroupIds (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) –
AvailabilityZone (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.
ReplicationSubnetGroupIdentifier (string) – A subnet group to associate with the replication instance.
PreferredMaintenanceWindow (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.
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.
AutoMinorVersionUpgrade (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
Tags (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.
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.
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.
DnsNameServers (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"
ResourceIdentifier (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.
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.
KerberosAuthenticationSettings (dict) –
Specifies the ID of the secret that stores the key cache file required for kerberos authentication, when creating a replication instance.
- KeyCacheSecretId (string) –
  
  Specifies the secret ID of the key cache for the replication instance.
- KeyCacheSecretIamArn (string) –
  
  Specifies the Amazon Resource Name (ARN) of the IAM role that grants Amazon Web Services DMS access to the secret containing key cache file for the replication instance.
- Krb5FileContents (string) –
  
  Specifies the ID of the secret that stores the key cache file required for kerberos authentication of the replication instance.

Return type:

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'
                },
            ],
            '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',
        'KerberosAuthenticationSettings': {
            'KeyCacheSecretId': 'string',
            'KeyCacheSecretIamArn': 'string',
            'Krb5FileContents': '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.
  - KerberosAuthenticationSettings (dict) –
    
    Specifies the ID of the secret that stores the key cache file required for kerberos authentication, when replicating an instance.
    - KeyCacheSecretId (string) –
      
      Specifies the secret ID of the key cache for the replication instance.
    - KeyCacheSecretIamArn (string) –
      
      Specifies the Amazon Resource Name (ARN) of the IAM role that grants Amazon Web Services DMS access to the secret containing key cache file for the replication instance.
    - Krb5FileContents (string) –
      
      Specifies the ID of the secret that stores the key cache file required for kerberos authentication of the replication instance.

Exceptions

DatabaseMigrationService.Client.exceptions.AccessDeniedFault
DatabaseMigrationService.Client.exceptions.ResourceAlreadyExistsFault
DatabaseMigrationService.Client.exceptions.InsufficientResourceCapacityFault
DatabaseMigrationService.Client.exceptions.ResourceQuotaExceededFault
DatabaseMigrationService.Client.exceptions.StorageQuotaExceededFault
DatabaseMigrationService.Client.exceptions.ResourceNotFoundFault
DatabaseMigrationService.Client.exceptions.ReplicationSubnetGroupDoesNotCoverEnoughAZs
DatabaseMigrationService.Client.exceptions.InvalidResourceStateFault
DatabaseMigrationService.Client.exceptions.InvalidSubnet
DatabaseMigrationService.Client.exceptions.KMSKeyNotAccessibleFault

Examples

Creates the replication instance using the specified parameters.

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

print(response)

Expected Output:

{
    'ReplicationInstance': {
        'AllocatedStorage': 5,
        'AutoMinorVersionUpgrade': True,
        'EngineVersion': '1.5.0',
        'KmsKeyId': 'arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd',
        'PendingModifiedValues': {
        },
        'PreferredMaintenanceWindow': 'sun:06:00-sun:14:00',
        'PubliclyAccessible': True,
        'ReplicationInstanceArn': 'arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ',
        'ReplicationInstanceClass': 'dms.t2.micro',
        'ReplicationInstanceIdentifier': 'test-rep-1',
        'ReplicationInstanceStatus': 'creating',
        'ReplicationSubnetGroup': {
            'ReplicationSubnetGroupDescription': 'default',
            'ReplicationSubnetGroupIdentifier': 'default',
            'SubnetGroupStatus': 'Complete',
            'Subnets': [
                {
                    'SubnetAvailabilityZone': {
                        'Name': 'us-east-1d',
                    },
                    'SubnetIdentifier': 'subnet-f6dd91af',
                    'SubnetStatus': 'Active',
                },
                {
                    'SubnetAvailabilityZone': {
                        'Name': 'us-east-1b',
                    },
                    'SubnetIdentifier': 'subnet-3605751d',
                    'SubnetStatus': 'Active',
                },
                {
                    'SubnetAvailabilityZone': {
                        'Name': 'us-east-1c',
                    },
                    'SubnetIdentifier': 'subnet-c2daefb5',
                    'SubnetStatus': 'Active',
                },
                {
                    'SubnetAvailabilityZone': {
                        'Name': 'us-east-1e',
                    },
                    'SubnetIdentifier': 'subnet-85e90cb8',
                    'SubnetStatus': 'Active',
                },
            ],
            'VpcId': 'vpc-6741a603',
        },
    },
    'ResponseMetadata': {
        '...': '...',
    },
}