AWS API Changes

2018/11/16 - AWS Database Migration Service - 9 updated api methods

Changes Settings structures have been added to our DMS endpoint APIs to support Kinesis and Elasticsearch as targets. We are introducing the ability to configure custom DNS name servers on a replication instance as a beta feature.

CreateEndpoint (updated)

Link ¶
Changes (request, response)
Request

{'ElasticsearchSettings': {'EndpointUri': 'string',
                           'ErrorRetryDuration': 'integer',
                           'FullLoadErrorPercentage': 'integer',
                           'ServiceAccessRoleArn': 'string'},
 'KinesisSettings': {'MessageFormat': 'json',
                     'ServiceAccessRoleArn': 'string',
                     'StreamArn': 'string'}}

Response

{'Endpoint': {'ElasticsearchSettings': {'EndpointUri': 'string',
                                        'ErrorRetryDuration': 'integer',
                                        'FullLoadErrorPercentage': 'integer',
                                        'ServiceAccessRoleArn': 'string'},
              'KinesisSettings': {'MessageFormat': 'json',
                                  'ServiceAccessRoleArn': 'string',
                                  'StreamArn': 'string'}}}

Creates an endpoint using the provided settings.

See also: AWS API Documentation

Request Syntax

client.create_endpoint(
    EndpointIdentifier='string',
    EndpointType='source'|'target',
    EngineName='string',
    Username='string',
    Password='string',
    ServerName='string',
    Port=123,
    DatabaseName='string',
    ExtraConnectionAttributes='string',
    KmsKeyId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    CertificateArn='string',
    SslMode='none'|'require'|'verify-ca'|'verify-full',
    ServiceAccessRoleArn='string',
    ExternalTableDefinition='string',
    DynamoDbSettings={
        'ServiceAccessRoleArn': 'string'
    },
    S3Settings={
        'ServiceAccessRoleArn': 'string',
        'ExternalTableDefinition': 'string',
        'CsvRowDelimiter': 'string',
        'CsvDelimiter': 'string',
        'BucketFolder': 'string',
        'BucketName': 'string',
        'CompressionType': 'none'|'gzip'
    },
    DmsTransferSettings={
        'ServiceAccessRoleArn': 'string',
        'BucketName': 'string'
    },
    MongoDbSettings={
        'Username': 'string',
        'Password': 'string',
        'ServerName': 'string',
        'Port': 123,
        'DatabaseName': 'string',
        'AuthType': 'no'|'password',
        'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1',
        'NestingLevel': 'none'|'one',
        'ExtractDocId': 'string',
        'DocsToInvestigate': 'string',
        'AuthSource': 'string',
        'KmsKeyId': 'string'
    },
    KinesisSettings={
        'StreamArn': 'string',
        'MessageFormat': 'json',
        'ServiceAccessRoleArn': 'string'
    },
    ElasticsearchSettings={
        'ServiceAccessRoleArn': 'string',
        'EndpointUri': 'string',
        'FullLoadErrorPercentage': 123,
        'ErrorRetryDuration': 123
    }
)

type EndpointIdentifier

string

param EndpointIdentifier

[REQUIRED]

The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

type EndpointType

string

param EndpointType

[REQUIRED]

The type of endpoint.

type EngineName

string

param EngineName

[REQUIRED]

The type of engine for the endpoint. Valid values, depending on the EndPointType value, include mysql , oracle , postgres , mariadb , aurora , aurora-postgresql , redshift , s3 , db2 , azuredb , sybase , dynamodb , mongodb , and sqlserver .

type Username

string

param Username

The user name to be used to log in to the endpoint database.

type Password

string

param Password

The password to be used to log in to the endpoint database.

type ServerName

string

param ServerName

The name of the server where the endpoint database resides.

type Port

integer

param Port

The port used by the endpoint database.

type DatabaseName

string

param DatabaseName

The name of the endpoint database.

type ExtraConnectionAttributes

string

param ExtraConnectionAttributes

Additional attributes associated with the connection.

type KmsKeyId

string

param KmsKeyId

The AWS KMS key identifier to use to encrypt the connection parameters. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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 Tags

list

param Tags

Tags to be added to the endpoint.

(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 CertificateArn

string

param CertificateArn

The Amazon Resource Name (ARN) for the certificate.

type SslMode

string

param SslMode

The Secure Sockets Layer (SSL) mode to use for the SSL connection. The SSL mode can be one of four values: none , require , verify-ca , verify-full . The default value is none .

type ServiceAccessRoleArn

string

param ServiceAccessRoleArn

The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.

type ExternalTableDefinition

string

param ExternalTableDefinition

The external table definition.

type DynamoDbSettings

dict

param DynamoDbSettings

Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.

ServiceAccessRoleArn (string) -- [REQUIRED]

The Amazon Resource Name (ARN) used by the service access IAM role.

type S3Settings

dict

param S3Settings

Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service User Guide.

ServiceAccessRoleArn (string) --

The Amazon Resource Name (ARN) used by the service access IAM role.
ExternalTableDefinition (string) --

The external table definition.
CsvRowDelimiter (string) --

The delimiter used to separate rows in the source files. The default is a carriage return (n).
CsvDelimiter (string) --

The delimiter used to separate columns in the source files. The default is a comma.
BucketFolder (string) --

An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/. If this parameter is not specified, then the path used is <schema_name>/<table_name>/.
BucketName (string) --

The name of the S3 bucket.
CompressionType (string) --

An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.

type DmsTransferSettings

dict

param DmsTransferSettings

The settings in JSON format for the DMS transfer type of source endpoint.

Possible attributes include the following:

serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
bucketName - The name of the S3 bucket to use.
compressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.

Shorthand syntax for these attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string

JSON syntax for these attributes is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }

ServiceAccessRoleArn (string) --

The IAM role that has permission to access the Amazon S3 bucket.
BucketName (string) --

The name of the S3 bucket to use.

type MongoDbSettings

dict

param MongoDbSettings

Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Using MongoDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.

Username (string) --

The user name you use to access the MongoDB source endpoint.
Password (string) --

The password for the user account you use to access the MongoDB source endpoint.
ServerName (string) --

The name of the server on the MongoDB source endpoint.
Port (integer) --

The port value for the MongoDB source endpoint.
DatabaseName (string) --

The database name on the MongoDB source endpoint.
AuthType (string) --

The authentication type you use to access the MongoDB source endpoint.

Valid values: NO, PASSWORD

When NO is selected, user name and password parameters are not used and can be empty.
AuthMechanism (string) --

The authentication mechanism you use to access the MongoDB source endpoint.

Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1

DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
NestingLevel (string) --

Specifies either document or table mode.

Valid values: NONE, ONE

Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
ExtractDocId (string) --

Specifies the document ID. Use this attribute when NestingLevel is set to NONE.

Default value is false.
DocsToInvestigate (string) --

Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE.

Must be a positive value greater than 0. Default value is 1000.
AuthSource (string) --

The MongoDB database name. This attribute is not used when authType=NO .

The default is admin.
KmsKeyId (string) --

The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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 KinesisSettings

dict

param KinesisSettings

Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream in the AWS Database Migration User Guide.

StreamArn (string) --

The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
MessageFormat (string) --

The output format for the records created on the endpoint. The message format is JSON .
ServiceAccessRoleArn (string) --

The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.

type ElasticsearchSettings

dict

param ElasticsearchSettings

Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database Migration User Guide.

ServiceAccessRoleArn (string) -- [REQUIRED]

The Amazon Resource Name (ARN) used by service to access the IAM role.
EndpointUri (string) -- [REQUIRED]

The endpoint for the ElasticSearch cluster.
FullLoadErrorPercentage (integer) --

The maximum percentage of records that can fail to be written before a full load operation stops.
ErrorRetryDuration (integer) --

The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster.

rtype

dict

returns

Response Syntax

{
    'Endpoint': {
        'EndpointIdentifier': 'string',
        'EndpointType': 'source'|'target',
        'EngineName': 'string',
        'EngineDisplayName': 'string',
        'Username': 'string',
        'ServerName': 'string',
        'Port': 123,
        'DatabaseName': 'string',
        'ExtraConnectionAttributes': 'string',
        'Status': 'string',
        'KmsKeyId': 'string',
        'EndpointArn': 'string',
        'CertificateArn': 'string',
        'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
        'ServiceAccessRoleArn': 'string',
        'ExternalTableDefinition': 'string',
        'ExternalId': 'string',
        'DynamoDbSettings': {
            'ServiceAccessRoleArn': 'string'
        },
        'S3Settings': {
            'ServiceAccessRoleArn': 'string',
            'ExternalTableDefinition': 'string',
            'CsvRowDelimiter': 'string',
            'CsvDelimiter': 'string',
            'BucketFolder': 'string',
            'BucketName': 'string',
            'CompressionType': 'none'|'gzip'
        },
        'DmsTransferSettings': {
            'ServiceAccessRoleArn': 'string',
            'BucketName': 'string'
        },
        'MongoDbSettings': {
            'Username': 'string',
            'Password': 'string',
            'ServerName': 'string',
            'Port': 123,
            'DatabaseName': 'string',
            'AuthType': 'no'|'password',
            'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1',
            'NestingLevel': 'none'|'one',
            'ExtractDocId': 'string',
            'DocsToInvestigate': 'string',
            'AuthSource': 'string',
            'KmsKeyId': 'string'
        },
        'KinesisSettings': {
            'StreamArn': 'string',
            'MessageFormat': 'json',
            'ServiceAccessRoleArn': 'string'
        },
        'ElasticsearchSettings': {
            'ServiceAccessRoleArn': 'string',
            'EndpointUri': 'string',
            'FullLoadErrorPercentage': 123,
            'ErrorRetryDuration': 123
        }
    }
}

Response Structure

(dict) --
- Endpoint (dict) --
  
  The endpoint that was created.
  - EndpointIdentifier (string) --
    
    The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
  - EndpointType (string) --
    
    The type of endpoint.
  - EngineName (string) --
    
    The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.
  - EngineDisplayName (string) --
    
    The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."
  - Username (string) --
    
    The user name used to connect to the endpoint.
  - ServerName (string) --
    
    The name of the server at the endpoint.
  - Port (integer) --
    
    The port value used to access the endpoint.
  - DatabaseName (string) --
    
    The name of the database at the endpoint.
  - ExtraConnectionAttributes (string) --
    
    Additional connection attributes used to connect to the endpoint.
  - Status (string) --
    
    The status of the endpoint.
  - KmsKeyId (string) --
    
    The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.
  - EndpointArn (string) --
    
    The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
  - CertificateArn (string) --
    
    The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
  - SslMode (string) --
    
    The SSL mode used to connect to the endpoint.
    
    SSL mode can be one of four values: none, require, verify-ca, verify-full.
    
    The default value is none.
  - ServiceAccessRoleArn (string) --
    
    The Amazon Resource Name (ARN) used by the service access IAM role.
  - ExternalTableDefinition (string) --
    
    The external table definition.
  - ExternalId (string) --
    
    Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.
  - DynamoDbSettings (dict) --
    
    The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.
    - ServiceAccessRoleArn (string) --
      
      The Amazon Resource Name (ARN) used by the service access IAM role.
  - S3Settings (dict) --
    
    The settings for the S3 target endpoint. For more information, see the S3Settings structure.
    - ServiceAccessRoleArn (string) --
      
      The Amazon Resource Name (ARN) used by the service access IAM role.
    - ExternalTableDefinition (string) --
      
      The external table definition.
    - CsvRowDelimiter (string) --
      
      The delimiter used to separate rows in the source files. The default is a carriage return (n).
    - CsvDelimiter (string) --
      
      The delimiter used to separate columns in the source files. The default is a comma.
    - BucketFolder (string) --
      
      An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/. If this parameter is not specified, then the path used is <schema_name>/<table_name>/.
    - BucketName (string) --
      
      The name of the S3 bucket.
    - CompressionType (string) --
      
      An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
  - DmsTransferSettings (dict) --
    
    The settings in JSON format for the DMS transfer type of source endpoint.
    
    Possible attributes include the following:
    - serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
    - bucketName - The name of the S3 bucket to use.
    - compressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.
    Shorthand syntax for these attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
    
    JSON syntax for these attributes is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
    - ServiceAccessRoleArn (string) --
      
      The IAM role that has permission to access the Amazon S3 bucket.
    - BucketName (string) --
      
      The name of the S3 bucket to use.
  - MongoDbSettings (dict) --
    
    The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
    - Username (string) --
      
      The user name you use to access the MongoDB source endpoint.
    - Password (string) --
      
      The password for the user account you use to access the MongoDB source endpoint.
    - ServerName (string) --
      
      The name of the server on the MongoDB source endpoint.
    - Port (integer) --
      
      The port value for the MongoDB source endpoint.
    - DatabaseName (string) --
      
      The database name on the MongoDB source endpoint.
    - AuthType (string) --
      
      The authentication type you use to access the MongoDB source endpoint.
      
      Valid values: NO, PASSWORD
      
      When NO is selected, user name and password parameters are not used and can be empty.
    - AuthMechanism (string) --
      
      The authentication mechanism you use to access the MongoDB source endpoint.
      
      Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
      
      DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
    - NestingLevel (string) --
      
      Specifies either document or table mode.
      
      Valid values: NONE, ONE
      
      Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
    - ExtractDocId (string) --
      
      Specifies the document ID. Use this attribute when NestingLevel is set to NONE.
      
      Default value is false.
    - DocsToInvestigate (string) --
      
      Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE.
      
      Must be a positive value greater than 0. Default value is 1000.
    - AuthSource (string) --
      
      The MongoDB database name. This attribute is not used when authType=NO .
      
      The default is admin.
    - KmsKeyId (string) --
      
      The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.
  - KinesisSettings (dict) --
    
    The settings for the Amazon Kinesis source endpoint. For more information, see the KinesisSettings structure.
    - StreamArn (string) --
      
      The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
    - MessageFormat (string) --
      
      The output format for the records created on the endpoint. The message format is JSON .
    - ServiceAccessRoleArn (string) --
      
      The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.
  - ElasticsearchSettings (dict) --
    
    The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.
    - ServiceAccessRoleArn (string) --
      
      The Amazon Resource Name (ARN) used by service to access the IAM role.
    - EndpointUri (string) --
      
      The endpoint for the ElasticSearch cluster.
    - FullLoadErrorPercentage (integer) --
      
      The maximum percentage of records that can fail to be written before a full load operation stops.
    - ErrorRetryDuration (integer) --
      
      The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster.

CreateReplicationInstance (updated)

Link ¶
Changes (request, response)
Request

{'DnsNameServers': 'string'}

Response

{'ReplicationInstance': {'DnsNameServers': 'string'}}

Creates the replication instance using the specified parameters.

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'
        },
    ],
    KmsKeyId='string',
    PubliclyAccessible=True|False,
    DnsNameServers='string'
)

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 MultiAZ

boolean

param MultiAZ

Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .

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 AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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 .

type DnsNameServers

string

param DnsNameServers

A list of DNS name servers supported for the replication instance.

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,
            'MultiAZ': True|False,
            'EngineVersion': 'string'
        },
        'MultiAZ': True|False,
        'EngineVersion': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'KmsKeyId': 'string',
        'ReplicationInstanceArn': 'string',
        'ReplicationInstancePublicIpAddress': 'string',
        'ReplicationInstancePrivateIpAddress': 'string',
        'ReplicationInstancePublicIpAddresses': [
            'string',
        ],
        'ReplicationInstancePrivateIpAddresses': [
            'string',
        ],
        'PubliclyAccessible': True|False,
        'SecondaryAvailabilityZone': 'string',
        'FreeUntil': datetime(2015, 1, 1),
        'DnsNameServers': 'string'
    }
}

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.
    - MultiAZ (boolean) --
      
      Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .
    - EngineVersion (string) --
      
      The engine version number of the replication instance.
  - MultiAZ (boolean) --
    
    Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .
  - 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 AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.
  - ReplicationInstancePublicIpAddresses (list) --
    
    The public IP address of the replication instance.
    - (string) --
  - ReplicationInstancePrivateIpAddresses (list) --
    
    The private IP address of 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 for the replication instance.

DeleteEndpoint (updated)

Link ¶
Changes (response)

{'Endpoint': {'ElasticsearchSettings': {'EndpointUri': 'string',
                                        'ErrorRetryDuration': 'integer',
                                        'FullLoadErrorPercentage': 'integer',
                                        'ServiceAccessRoleArn': 'string'},
              'KinesisSettings': {'MessageFormat': 'json',
                                  'ServiceAccessRoleArn': 'string',
                                  'StreamArn': 'string'}}}

Deletes the specified endpoint.

Note

All tasks associated with the endpoint must be deleted before you can delete the endpoint.

See also: AWS API Documentation

Request Syntax

client.delete_endpoint(
    EndpointArn='string'
)

type EndpointArn

string

param EndpointArn

[REQUIRED]

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

rtype

dict

returns

Response Syntax

{
    'Endpoint': {
        'EndpointIdentifier': 'string',
        'EndpointType': 'source'|'target',
        'EngineName': 'string',
        'EngineDisplayName': 'string',
        'Username': 'string',
        'ServerName': 'string',
        'Port': 123,
        'DatabaseName': 'string',
        'ExtraConnectionAttributes': 'string',
        'Status': 'string',
        'KmsKeyId': 'string',
        'EndpointArn': 'string',
        'CertificateArn': 'string',
        'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
        'ServiceAccessRoleArn': 'string',
        'ExternalTableDefinition': 'string',
        'ExternalId': 'string',
        'DynamoDbSettings': {
            'ServiceAccessRoleArn': 'string'
        },
        'S3Settings': {
            'ServiceAccessRoleArn': 'string',
            'ExternalTableDefinition': 'string',
            'CsvRowDelimiter': 'string',
            'CsvDelimiter': 'string',
            'BucketFolder': 'string',
            'BucketName': 'string',
            'CompressionType': 'none'|'gzip'
        },
        'DmsTransferSettings': {
            'ServiceAccessRoleArn': 'string',
            'BucketName': 'string'
        },
        'MongoDbSettings': {
            'Username': 'string',
            'Password': 'string',
            'ServerName': 'string',
            'Port': 123,
            'DatabaseName': 'string',
            'AuthType': 'no'|'password',
            'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1',
            'NestingLevel': 'none'|'one',
            'ExtractDocId': 'string',
            'DocsToInvestigate': 'string',
            'AuthSource': 'string',
            'KmsKeyId': 'string'
        },
        'KinesisSettings': {
            'StreamArn': 'string',
            'MessageFormat': 'json',
            'ServiceAccessRoleArn': 'string'
        },
        'ElasticsearchSettings': {
            'ServiceAccessRoleArn': 'string',
            'EndpointUri': 'string',
            'FullLoadErrorPercentage': 123,
            'ErrorRetryDuration': 123
        }
    }
}

Response Structure

(dict) --
- Endpoint (dict) --
  
  The endpoint that was deleted.
  - EndpointIdentifier (string) --
    
    The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
  - EndpointType (string) --
    
    The type of endpoint.
  - EngineName (string) --
    
    The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.
  - EngineDisplayName (string) --
    
    The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."
  - Username (string) --
    
    The user name used to connect to the endpoint.
  - ServerName (string) --
    
    The name of the server at the endpoint.
  - Port (integer) --
    
    The port value used to access the endpoint.
  - DatabaseName (string) --
    
    The name of the database at the endpoint.
  - ExtraConnectionAttributes (string) --
    
    Additional connection attributes used to connect to the endpoint.
  - Status (string) --
    
    The status of the endpoint.
  - KmsKeyId (string) --
    
    The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.
  - EndpointArn (string) --
    
    The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
  - CertificateArn (string) --
    
    The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
  - SslMode (string) --
    
    The SSL mode used to connect to the endpoint.
    
    SSL mode can be one of four values: none, require, verify-ca, verify-full.
    
    The default value is none.
  - ServiceAccessRoleArn (string) --
    
    The Amazon Resource Name (ARN) used by the service access IAM role.
  - ExternalTableDefinition (string) --
    
    The external table definition.
  - ExternalId (string) --
    
    Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.
  - DynamoDbSettings (dict) --
    
    The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.
    - ServiceAccessRoleArn (string) --
      
      The Amazon Resource Name (ARN) used by the service access IAM role.
  - S3Settings (dict) --
    
    The settings for the S3 target endpoint. For more information, see the S3Settings structure.
    - ServiceAccessRoleArn (string) --
      
      The Amazon Resource Name (ARN) used by the service access IAM role.
    - ExternalTableDefinition (string) --
      
      The external table definition.
    - CsvRowDelimiter (string) --
      
      The delimiter used to separate rows in the source files. The default is a carriage return (n).
    - CsvDelimiter (string) --
      
      The delimiter used to separate columns in the source files. The default is a comma.
    - BucketFolder (string) --
      
      An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/. If this parameter is not specified, then the path used is <schema_name>/<table_name>/.
    - BucketName (string) --
      
      The name of the S3 bucket.
    - CompressionType (string) --
      
      An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
  - DmsTransferSettings (dict) --
    
    The settings in JSON format for the DMS transfer type of source endpoint.
    
    Possible attributes include the following:
    - serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
    - bucketName - The name of the S3 bucket to use.
    - compressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.
    Shorthand syntax for these attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
    
    JSON syntax for these attributes is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
    - ServiceAccessRoleArn (string) --
      
      The IAM role that has permission to access the Amazon S3 bucket.
    - BucketName (string) --
      
      The name of the S3 bucket to use.
  - MongoDbSettings (dict) --
    
    The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
    - Username (string) --
      
      The user name you use to access the MongoDB source endpoint.
    - Password (string) --
      
      The password for the user account you use to access the MongoDB source endpoint.
    - ServerName (string) --
      
      The name of the server on the MongoDB source endpoint.
    - Port (integer) --
      
      The port value for the MongoDB source endpoint.
    - DatabaseName (string) --
      
      The database name on the MongoDB source endpoint.
    - AuthType (string) --
      
      The authentication type you use to access the MongoDB source endpoint.
      
      Valid values: NO, PASSWORD
      
      When NO is selected, user name and password parameters are not used and can be empty.
    - AuthMechanism (string) --
      
      The authentication mechanism you use to access the MongoDB source endpoint.
      
      Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
      
      DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
    - NestingLevel (string) --
      
      Specifies either document or table mode.
      
      Valid values: NONE, ONE
      
      Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
    - ExtractDocId (string) --
      
      Specifies the document ID. Use this attribute when NestingLevel is set to NONE.
      
      Default value is false.
    - DocsToInvestigate (string) --
      
      Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE.
      
      Must be a positive value greater than 0. Default value is 1000.
    - AuthSource (string) --
      
      The MongoDB database name. This attribute is not used when authType=NO .
      
      The default is admin.
    - KmsKeyId (string) --
      
      The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.
  - KinesisSettings (dict) --
    
    The settings for the Amazon Kinesis source endpoint. For more information, see the KinesisSettings structure.
    - StreamArn (string) --
      
      The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
    - MessageFormat (string) --
      
      The output format for the records created on the endpoint. The message format is JSON .
    - ServiceAccessRoleArn (string) --
      
      The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.
  - ElasticsearchSettings (dict) --
    
    The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.
    - ServiceAccessRoleArn (string) --
      
      The Amazon Resource Name (ARN) used by service to access the IAM role.
    - EndpointUri (string) --
      
      The endpoint for the ElasticSearch cluster.
    - FullLoadErrorPercentage (integer) --
      
      The maximum percentage of records that can fail to be written before a full load operation stops.
    - ErrorRetryDuration (integer) --
      
      The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster.

DeleteReplicationInstance (updated)

Link ¶
Changes (response)

{'ReplicationInstance': {'DnsNameServers': 'string'}}

Deletes the specified replication instance.

Note

You must delete any migration tasks that are associated with the replication instance before you can delete it.

See also: AWS API Documentation

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,
            'MultiAZ': True|False,
            'EngineVersion': 'string'
        },
        'MultiAZ': True|False,
        'EngineVersion': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'KmsKeyId': 'string',
        'ReplicationInstanceArn': 'string',
        'ReplicationInstancePublicIpAddress': 'string',
        'ReplicationInstancePrivateIpAddress': 'string',
        'ReplicationInstancePublicIpAddresses': [
            'string',
        ],
        'ReplicationInstancePrivateIpAddresses': [
            'string',
        ],
        'PubliclyAccessible': True|False,
        'SecondaryAvailabilityZone': 'string',
        'FreeUntil': datetime(2015, 1, 1),
        'DnsNameServers': 'string'
    }
}

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.
    - MultiAZ (boolean) --
      
      Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .
    - EngineVersion (string) --
      
      The engine version number of the replication instance.
  - MultiAZ (boolean) --
    
    Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .
  - 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 AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.
  - ReplicationInstancePublicIpAddresses (list) --
    
    The public IP address of the replication instance.
    - (string) --
  - ReplicationInstancePrivateIpAddresses (list) --
    
    The private IP address of 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 for the replication instance.

DescribeEndpoints (updated)

Link ¶
Changes (response)

{'Endpoints': {'ElasticsearchSettings': {'EndpointUri': 'string',
                                         'ErrorRetryDuration': 'integer',
                                         'FullLoadErrorPercentage': 'integer',
                                         'ServiceAccessRoleArn': 'string'},
               'KinesisSettings': {'MessageFormat': 'json',
                                   'ServiceAccessRoleArn': 'string',
                                   'StreamArn': 'string'}}}

Returns information about the endpoints for your account in the current region.

See also: AWS API Documentation

Request Syntax

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

type Filters

list

param Filters

Filters applied to the describe action.

Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name

(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',
    'Endpoints': [
        {
            'EndpointIdentifier': 'string',
            'EndpointType': 'source'|'target',
            'EngineName': 'string',
            'EngineDisplayName': 'string',
            'Username': 'string',
            'ServerName': 'string',
            'Port': 123,
            'DatabaseName': 'string',
            'ExtraConnectionAttributes': 'string',
            'Status': 'string',
            'KmsKeyId': 'string',
            'EndpointArn': 'string',
            'CertificateArn': 'string',
            'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
            'ServiceAccessRoleArn': 'string',
            'ExternalTableDefinition': 'string',
            'ExternalId': 'string',
            'DynamoDbSettings': {
                'ServiceAccessRoleArn': 'string'
            },
            'S3Settings': {
                'ServiceAccessRoleArn': 'string',
                'ExternalTableDefinition': 'string',
                'CsvRowDelimiter': 'string',
                'CsvDelimiter': 'string',
                'BucketFolder': 'string',
                'BucketName': 'string',
                'CompressionType': 'none'|'gzip'
            },
            'DmsTransferSettings': {
                'ServiceAccessRoleArn': 'string',
                'BucketName': 'string'
            },
            'MongoDbSettings': {
                'Username': 'string',
                'Password': 'string',
                'ServerName': 'string',
                'Port': 123,
                'DatabaseName': 'string',
                'AuthType': 'no'|'password',
                'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1',
                'NestingLevel': 'none'|'one',
                'ExtractDocId': 'string',
                'DocsToInvestigate': 'string',
                'AuthSource': 'string',
                'KmsKeyId': 'string'
            },
            'KinesisSettings': {
                'StreamArn': 'string',
                'MessageFormat': 'json',
                'ServiceAccessRoleArn': 'string'
            },
            'ElasticsearchSettings': {
                'ServiceAccessRoleArn': 'string',
                'EndpointUri': 'string',
                'FullLoadErrorPercentage': 123,
                'ErrorRetryDuration': 123
            }
        },
    ]
}

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 .
- Endpoints (list) --
  
  Endpoint description.
  - (dict) --
    - EndpointIdentifier (string) --
      
      The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
    - EndpointType (string) --
      
      The type of endpoint.
    - EngineName (string) --
      
      The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.
    - EngineDisplayName (string) --
      
      The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."
    - Username (string) --
      
      The user name used to connect to the endpoint.
    - ServerName (string) --
      
      The name of the server at the endpoint.
    - Port (integer) --
      
      The port value used to access the endpoint.
    - DatabaseName (string) --
      
      The name of the database at the endpoint.
    - ExtraConnectionAttributes (string) --
      
      Additional connection attributes used to connect to the endpoint.
    - Status (string) --
      
      The status of the endpoint.
    - KmsKeyId (string) --
      
      The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.
    - EndpointArn (string) --
      
      The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
    - CertificateArn (string) --
      
      The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
    - SslMode (string) --
      
      The SSL mode used to connect to the endpoint.
      
      SSL mode can be one of four values: none, require, verify-ca, verify-full.
      
      The default value is none.
    - ServiceAccessRoleArn (string) --
      
      The Amazon Resource Name (ARN) used by the service access IAM role.
    - ExternalTableDefinition (string) --
      
      The external table definition.
    - ExternalId (string) --
      
      Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.
    - DynamoDbSettings (dict) --
      
      The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.
      - ServiceAccessRoleArn (string) --
        
        The Amazon Resource Name (ARN) used by the service access IAM role.
    - S3Settings (dict) --
      
      The settings for the S3 target endpoint. For more information, see the S3Settings structure.
      - ServiceAccessRoleArn (string) --
        
        The Amazon Resource Name (ARN) used by the service access IAM role.
      - ExternalTableDefinition (string) --
        
        The external table definition.
      - CsvRowDelimiter (string) --
        
        The delimiter used to separate rows in the source files. The default is a carriage return (n).
      - CsvDelimiter (string) --
        
        The delimiter used to separate columns in the source files. The default is a comma.
      - BucketFolder (string) --
        
        An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/. If this parameter is not specified, then the path used is <schema_name>/<table_name>/.
      - BucketName (string) --
        
        The name of the S3 bucket.
      - CompressionType (string) --
        
        An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
    - DmsTransferSettings (dict) --
      
      The settings in JSON format for the DMS transfer type of source endpoint.
      
      Possible attributes include the following:
      - serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
      - bucketName - The name of the S3 bucket to use.
      - compressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.
      Shorthand syntax for these attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
      
      JSON syntax for these attributes is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
      - ServiceAccessRoleArn (string) --
        
        The IAM role that has permission to access the Amazon S3 bucket.
      - BucketName (string) --
        
        The name of the S3 bucket to use.
    - MongoDbSettings (dict) --
      
      The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
      - Username (string) --
        
        The user name you use to access the MongoDB source endpoint.
      - Password (string) --
        
        The password for the user account you use to access the MongoDB source endpoint.
      - ServerName (string) --
        
        The name of the server on the MongoDB source endpoint.
      - Port (integer) --
        
        The port value for the MongoDB source endpoint.
      - DatabaseName (string) --
        
        The database name on the MongoDB source endpoint.
      - AuthType (string) --
        
        The authentication type you use to access the MongoDB source endpoint.
        
        Valid values: NO, PASSWORD
        
        When NO is selected, user name and password parameters are not used and can be empty.
      - AuthMechanism (string) --
        
        The authentication mechanism you use to access the MongoDB source endpoint.
        
        Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
        
        DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
      - NestingLevel (string) --
        
        Specifies either document or table mode.
        
        Valid values: NONE, ONE
        
        Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
      - ExtractDocId (string) --
        
        Specifies the document ID. Use this attribute when NestingLevel is set to NONE.
        
        Default value is false.
      - DocsToInvestigate (string) --
        
        Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE.
        
        Must be a positive value greater than 0. Default value is 1000.
      - AuthSource (string) --
        
        The MongoDB database name. This attribute is not used when authType=NO .
        
        The default is admin.
      - KmsKeyId (string) --
        
        The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.
    - KinesisSettings (dict) --
      
      The settings for the Amazon Kinesis source endpoint. For more information, see the KinesisSettings structure.
      - StreamArn (string) --
        
        The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
      - MessageFormat (string) --
        
        The output format for the records created on the endpoint. The message format is JSON .
      - ServiceAccessRoleArn (string) --
        
        The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.
    - ElasticsearchSettings (dict) --
      
      The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.
      - ServiceAccessRoleArn (string) --
        
        The Amazon Resource Name (ARN) used by service to access the IAM role.
      - EndpointUri (string) --
        
        The endpoint for the ElasticSearch cluster.
      - FullLoadErrorPercentage (integer) --
        
        The maximum percentage of records that can fail to be written before a full load operation stops.
      - ErrorRetryDuration (integer) --
        
        The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster.

DescribeReplicationInstances (updated)

Link ¶
Changes (response)

{'ReplicationInstances': {'DnsNameServers': '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'
)

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

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,
                'MultiAZ': True|False,
                'EngineVersion': 'string'
            },
            'MultiAZ': True|False,
            'EngineVersion': 'string',
            'AutoMinorVersionUpgrade': True|False,
            'KmsKeyId': 'string',
            'ReplicationInstanceArn': 'string',
            'ReplicationInstancePublicIpAddress': 'string',
            'ReplicationInstancePrivateIpAddress': 'string',
            'ReplicationInstancePublicIpAddresses': [
                'string',
            ],
            'ReplicationInstancePrivateIpAddresses': [
                'string',
            ],
            'PubliclyAccessible': True|False,
            'SecondaryAvailabilityZone': 'string',
            'FreeUntil': datetime(2015, 1, 1),
            'DnsNameServers': '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) --
    - 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.
      - MultiAZ (boolean) --
        
        Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .
      - EngineVersion (string) --
        
        The engine version number of the replication instance.
    - MultiAZ (boolean) --
      
      Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .
    - 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 AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.
    - ReplicationInstancePublicIpAddresses (list) --
      
      The public IP address of the replication instance.
      - (string) --
    - ReplicationInstancePrivateIpAddresses (list) --
      
      The private IP address of 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 for the replication instance.

ModifyEndpoint (updated)

Link ¶
Changes (request, response)
Request

{'ElasticsearchSettings': {'EndpointUri': 'string',
                           'ErrorRetryDuration': 'integer',
                           'FullLoadErrorPercentage': 'integer',
                           'ServiceAccessRoleArn': 'string'},
 'KinesisSettings': {'MessageFormat': 'json',
                     'ServiceAccessRoleArn': 'string',
                     'StreamArn': 'string'}}

Response

{'Endpoint': {'ElasticsearchSettings': {'EndpointUri': 'string',
                                        'ErrorRetryDuration': 'integer',
                                        'FullLoadErrorPercentage': 'integer',
                                        'ServiceAccessRoleArn': 'string'},
              'KinesisSettings': {'MessageFormat': 'json',
                                  'ServiceAccessRoleArn': 'string',
                                  'StreamArn': 'string'}}}

Modifies the specified endpoint.

See also: AWS API Documentation

Request Syntax

client.modify_endpoint(
    EndpointArn='string',
    EndpointIdentifier='string',
    EndpointType='source'|'target',
    EngineName='string',
    Username='string',
    Password='string',
    ServerName='string',
    Port=123,
    DatabaseName='string',
    ExtraConnectionAttributes='string',
    CertificateArn='string',
    SslMode='none'|'require'|'verify-ca'|'verify-full',
    ServiceAccessRoleArn='string',
    ExternalTableDefinition='string',
    DynamoDbSettings={
        'ServiceAccessRoleArn': 'string'
    },
    S3Settings={
        'ServiceAccessRoleArn': 'string',
        'ExternalTableDefinition': 'string',
        'CsvRowDelimiter': 'string',
        'CsvDelimiter': 'string',
        'BucketFolder': 'string',
        'BucketName': 'string',
        'CompressionType': 'none'|'gzip'
    },
    DmsTransferSettings={
        'ServiceAccessRoleArn': 'string',
        'BucketName': 'string'
    },
    MongoDbSettings={
        'Username': 'string',
        'Password': 'string',
        'ServerName': 'string',
        'Port': 123,
        'DatabaseName': 'string',
        'AuthType': 'no'|'password',
        'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1',
        'NestingLevel': 'none'|'one',
        'ExtractDocId': 'string',
        'DocsToInvestigate': 'string',
        'AuthSource': 'string',
        'KmsKeyId': 'string'
    },
    KinesisSettings={
        'StreamArn': 'string',
        'MessageFormat': 'json',
        'ServiceAccessRoleArn': 'string'
    },
    ElasticsearchSettings={
        'ServiceAccessRoleArn': 'string',
        'EndpointUri': 'string',
        'FullLoadErrorPercentage': 123,
        'ErrorRetryDuration': 123
    }
)

type EndpointArn

string

param EndpointArn

[REQUIRED]

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

type EndpointIdentifier

string

param EndpointIdentifier

The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

type EndpointType

string

param EndpointType

The type of endpoint.

type EngineName

string

param EngineName

The type of engine for the endpoint. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.

type Username

string

param Username

The user name to be used to login to the endpoint database.

type Password

string

param Password

The password to be used to login to the endpoint database.

type ServerName

string

param ServerName

The name of the server where the endpoint database resides.

type Port

integer

param Port

The port used by the endpoint database.

type DatabaseName

string

param DatabaseName

The name of the endpoint database.

type ExtraConnectionAttributes

string

param ExtraConnectionAttributes

Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.

type CertificateArn

string

param CertificateArn

The Amazon Resource Name (ARN) of the certificate used for SSL connection.

type SslMode

string

param SslMode

The SSL mode to be used.

SSL mode can be one of four values: none, require, verify-ca, verify-full.

The default value is none.

type ServiceAccessRoleArn

string

param ServiceAccessRoleArn

The Amazon Resource Name (ARN) for the service access role you want to use to modify the endpoint.

type ExternalTableDefinition

string

param ExternalTableDefinition

The external table definition.

type DynamoDbSettings

dict

param DynamoDbSettings

ServiceAccessRoleArn (string) -- [REQUIRED]

The Amazon Resource Name (ARN) used by the service access IAM role.

type S3Settings

dict

param S3Settings

ServiceAccessRoleArn (string) --

The Amazon Resource Name (ARN) used by the service access IAM role.
ExternalTableDefinition (string) --

The external table definition.
CsvRowDelimiter (string) --

The delimiter used to separate rows in the source files. The default is a carriage return (n).
CsvDelimiter (string) --

The delimiter used to separate columns in the source files. The default is a comma.
BucketFolder (string) --

An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/. If this parameter is not specified, then the path used is <schema_name>/<table_name>/.
BucketName (string) --

The name of the S3 bucket.
CompressionType (string) --

An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.

type DmsTransferSettings

dict

param DmsTransferSettings

The settings in JSON format for the DMS transfer type of source endpoint.

Attributes include the following:

serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
BucketName - The name of the S3 bucket to use.
compressionType - An optional parameter to use GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.

Shorthand syntax: ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string

JSON syntax:

{ "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }

ServiceAccessRoleArn (string) --

The IAM role that has permission to access the Amazon S3 bucket.
BucketName (string) --

The name of the S3 bucket to use.

type MongoDbSettings

dict

param MongoDbSettings

Username (string) --

The user name you use to access the MongoDB source endpoint.
Password (string) --

The password for the user account you use to access the MongoDB source endpoint.
ServerName (string) --

The name of the server on the MongoDB source endpoint.
Port (integer) --

The port value for the MongoDB source endpoint.
DatabaseName (string) --

The database name on the MongoDB source endpoint.
AuthType (string) --

The authentication type you use to access the MongoDB source endpoint.

Valid values: NO, PASSWORD

When NO is selected, user name and password parameters are not used and can be empty.
AuthMechanism (string) --

The authentication mechanism you use to access the MongoDB source endpoint.

Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1

DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
NestingLevel (string) --

Specifies either document or table mode.

Valid values: NONE, ONE

Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
ExtractDocId (string) --

Specifies the document ID. Use this attribute when NestingLevel is set to NONE.

Default value is false.
DocsToInvestigate (string) --

Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE.

Must be a positive value greater than 0. Default value is 1000.
AuthSource (string) --

The MongoDB database name. This attribute is not used when authType=NO .

The default is admin.
KmsKeyId (string) --

The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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 KinesisSettings

dict

param KinesisSettings

StreamArn (string) --

The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
MessageFormat (string) --

The output format for the records created on the endpoint. The message format is JSON .
ServiceAccessRoleArn (string) --

The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.

type ElasticsearchSettings

dict

param ElasticsearchSettings

ServiceAccessRoleArn (string) -- [REQUIRED]

The Amazon Resource Name (ARN) used by service to access the IAM role.
EndpointUri (string) -- [REQUIRED]

The endpoint for the ElasticSearch cluster.
FullLoadErrorPercentage (integer) --

The maximum percentage of records that can fail to be written before a full load operation stops.
ErrorRetryDuration (integer) --

The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster.

rtype

dict

returns

Response Syntax

{
    'Endpoint': {
        'EndpointIdentifier': 'string',
        'EndpointType': 'source'|'target',
        'EngineName': 'string',
        'EngineDisplayName': 'string',
        'Username': 'string',
        'ServerName': 'string',
        'Port': 123,
        'DatabaseName': 'string',
        'ExtraConnectionAttributes': 'string',
        'Status': 'string',
        'KmsKeyId': 'string',
        'EndpointArn': 'string',
        'CertificateArn': 'string',
        'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
        'ServiceAccessRoleArn': 'string',
        'ExternalTableDefinition': 'string',
        'ExternalId': 'string',
        'DynamoDbSettings': {
            'ServiceAccessRoleArn': 'string'
        },
        'S3Settings': {
            'ServiceAccessRoleArn': 'string',
            'ExternalTableDefinition': 'string',
            'CsvRowDelimiter': 'string',
            'CsvDelimiter': 'string',
            'BucketFolder': 'string',
            'BucketName': 'string',
            'CompressionType': 'none'|'gzip'
        },
        'DmsTransferSettings': {
            'ServiceAccessRoleArn': 'string',
            'BucketName': 'string'
        },
        'MongoDbSettings': {
            'Username': 'string',
            'Password': 'string',
            'ServerName': 'string',
            'Port': 123,
            'DatabaseName': 'string',
            'AuthType': 'no'|'password',
            'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1',
            'NestingLevel': 'none'|'one',
            'ExtractDocId': 'string',
            'DocsToInvestigate': 'string',
            'AuthSource': 'string',
            'KmsKeyId': 'string'
        },
        'KinesisSettings': {
            'StreamArn': 'string',
            'MessageFormat': 'json',
            'ServiceAccessRoleArn': 'string'
        },
        'ElasticsearchSettings': {
            'ServiceAccessRoleArn': 'string',
            'EndpointUri': 'string',
            'FullLoadErrorPercentage': 123,
            'ErrorRetryDuration': 123
        }
    }
}

Response Structure

(dict) --
- Endpoint (dict) --
  
  The modified endpoint.
  - EndpointIdentifier (string) --
    
    The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
  - EndpointType (string) --
    
    The type of endpoint.
  - EngineName (string) --
    
    The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.
  - EngineDisplayName (string) --
    
    The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."
  - Username (string) --
    
    The user name used to connect to the endpoint.
  - ServerName (string) --
    
    The name of the server at the endpoint.
  - Port (integer) --
    
    The port value used to access the endpoint.
  - DatabaseName (string) --
    
    The name of the database at the endpoint.
  - ExtraConnectionAttributes (string) --
    
    Additional connection attributes used to connect to the endpoint.
  - Status (string) --
    
    The status of the endpoint.
  - KmsKeyId (string) --
    
    The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.
  - EndpointArn (string) --
    
    The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
  - CertificateArn (string) --
    
    The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
  - SslMode (string) --
    
    The SSL mode used to connect to the endpoint.
    
    SSL mode can be one of four values: none, require, verify-ca, verify-full.
    
    The default value is none.
  - ServiceAccessRoleArn (string) --
    
    The Amazon Resource Name (ARN) used by the service access IAM role.
  - ExternalTableDefinition (string) --
    
    The external table definition.
  - ExternalId (string) --
    
    Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.
  - DynamoDbSettings (dict) --
    
    The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.
    - ServiceAccessRoleArn (string) --
      
      The Amazon Resource Name (ARN) used by the service access IAM role.
  - S3Settings (dict) --
    
    The settings for the S3 target endpoint. For more information, see the S3Settings structure.
    - ServiceAccessRoleArn (string) --
      
      The Amazon Resource Name (ARN) used by the service access IAM role.
    - ExternalTableDefinition (string) --
      
      The external table definition.
    - CsvRowDelimiter (string) --
      
      The delimiter used to separate rows in the source files. The default is a carriage return (n).
    - CsvDelimiter (string) --
      
      The delimiter used to separate columns in the source files. The default is a comma.
    - BucketFolder (string) --
      
      An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/. If this parameter is not specified, then the path used is <schema_name>/<table_name>/.
    - BucketName (string) --
      
      The name of the S3 bucket.
    - CompressionType (string) --
      
      An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
  - DmsTransferSettings (dict) --
    
    The settings in JSON format for the DMS transfer type of source endpoint.
    
    Possible attributes include the following:
    - serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
    - bucketName - The name of the S3 bucket to use.
    - compressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.
    Shorthand syntax for these attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
    
    JSON syntax for these attributes is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
    - ServiceAccessRoleArn (string) --
      
      The IAM role that has permission to access the Amazon S3 bucket.
    - BucketName (string) --
      
      The name of the S3 bucket to use.
  - MongoDbSettings (dict) --
    
    The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
    - Username (string) --
      
      The user name you use to access the MongoDB source endpoint.
    - Password (string) --
      
      The password for the user account you use to access the MongoDB source endpoint.
    - ServerName (string) --
      
      The name of the server on the MongoDB source endpoint.
    - Port (integer) --
      
      The port value for the MongoDB source endpoint.
    - DatabaseName (string) --
      
      The database name on the MongoDB source endpoint.
    - AuthType (string) --
      
      The authentication type you use to access the MongoDB source endpoint.
      
      Valid values: NO, PASSWORD
      
      When NO is selected, user name and password parameters are not used and can be empty.
    - AuthMechanism (string) --
      
      The authentication mechanism you use to access the MongoDB source endpoint.
      
      Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
      
      DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
    - NestingLevel (string) --
      
      Specifies either document or table mode.
      
      Valid values: NONE, ONE
      
      Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
    - ExtractDocId (string) --
      
      Specifies the document ID. Use this attribute when NestingLevel is set to NONE.
      
      Default value is false.
    - DocsToInvestigate (string) --
      
      Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE.
      
      Must be a positive value greater than 0. Default value is 1000.
    - AuthSource (string) --
      
      The MongoDB database name. This attribute is not used when authType=NO .
      
      The default is admin.
    - KmsKeyId (string) --
      
      The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.
  - KinesisSettings (dict) --
    
    The settings for the Amazon Kinesis source endpoint. For more information, see the KinesisSettings structure.
    - StreamArn (string) --
      
      The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
    - MessageFormat (string) --
      
      The output format for the records created on the endpoint. The message format is JSON .
    - ServiceAccessRoleArn (string) --
      
      The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.
  - ElasticsearchSettings (dict) --
    
    The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.
    - ServiceAccessRoleArn (string) --
      
      The Amazon Resource Name (ARN) used by service to access the IAM role.
    - EndpointUri (string) --
      
      The endpoint for the ElasticSearch cluster.
    - FullLoadErrorPercentage (integer) --
      
      The maximum percentage of records that can fail to be written before a full load operation stops.
    - ErrorRetryDuration (integer) --
      
      The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster.

ModifyReplicationInstance (updated)

Link ¶
Changes (response)

{'ReplicationInstance': {'DnsNameServers': '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'
)

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 MultiAZ

boolean

param MultiAZ

Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .

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,
            'MultiAZ': True|False,
            'EngineVersion': 'string'
        },
        'MultiAZ': True|False,
        'EngineVersion': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'KmsKeyId': 'string',
        'ReplicationInstanceArn': 'string',
        'ReplicationInstancePublicIpAddress': 'string',
        'ReplicationInstancePrivateIpAddress': 'string',
        'ReplicationInstancePublicIpAddresses': [
            'string',
        ],
        'ReplicationInstancePrivateIpAddresses': [
            'string',
        ],
        'PubliclyAccessible': True|False,
        'SecondaryAvailabilityZone': 'string',
        'FreeUntil': datetime(2015, 1, 1),
        'DnsNameServers': 'string'
    }
}

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.
    - MultiAZ (boolean) --
      
      Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .
    - EngineVersion (string) --
      
      The engine version number of the replication instance.
  - MultiAZ (boolean) --
    
    Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .
  - 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 AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.
  - ReplicationInstancePublicIpAddresses (list) --
    
    The public IP address of the replication instance.
    - (string) --
  - ReplicationInstancePrivateIpAddresses (list) --
    
    The private IP address of 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 for the replication instance.

RebootReplicationInstance (updated)

Link ¶
Changes (response)

{'ReplicationInstance': {'DnsNameServers': '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
)

type ReplicationInstanceArn

string

param ReplicationInstanceArn

[REQUIRED]

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

type ForceFailover

boolean

param ForceFailover

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

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,
            'MultiAZ': True|False,
            'EngineVersion': 'string'
        },
        'MultiAZ': True|False,
        'EngineVersion': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'KmsKeyId': 'string',
        'ReplicationInstanceArn': 'string',
        'ReplicationInstancePublicIpAddress': 'string',
        'ReplicationInstancePrivateIpAddress': 'string',
        'ReplicationInstancePublicIpAddresses': [
            'string',
        ],
        'ReplicationInstancePrivateIpAddresses': [
            'string',
        ],
        'PubliclyAccessible': True|False,
        'SecondaryAvailabilityZone': 'string',
        'FreeUntil': datetime(2015, 1, 1),
        'DnsNameServers': 'string'
    }
}

Response Structure

(dict) --
- ReplicationInstance (dict) --
  
  The replication instance that is being rebooted.
  - 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.
    - MultiAZ (boolean) --
      
      Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .
    - EngineVersion (string) --
      
      The engine version number of the replication instance.
  - MultiAZ (boolean) --
    
    Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .
  - 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 AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.
  - ReplicationInstancePublicIpAddresses (list) --
    
    The public IP address of the replication instance.
    - (string) --
  - ReplicationInstancePrivateIpAddresses (list) --
    
    The private IP address of 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 for the replication instance.