Skip to content
AWS for Query.Farm

aws.dms.describe_replication_instances

Example SQL Queries

SELECT * FROM
aws.dms.describe_replication_instances;

Description

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

Table Definition

Column NameColumn Data Type
filters Input Column

Filters applied to replication instances.

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

STRUCT(
    "name" VARCHAR,
    "values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].name

The name of the filter as specified for a Describe* or similar operation.

filters[].values[]
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
allocated_storage

The amount of storage (in gigabytes) that is allocated for the replication instance.

BIGINT
auto_minor_version_upgrade

Boolean value indicating if minor version upgrades will be automatically applied to the instance.

BOOLEAN
availability_zone

The Availability Zone for the instance.

VARCHAR
dns_name_servers

The DNS name servers supported for the replication instance to access your on-premise source or target database.

VARCHAR
engine_version

The engine version number of the replication instance.

If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.

When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true.

VARCHAR
free_until

The expiration date of the free replication instance that is part of the Free DMS program. 

TIMESTAMP_S
instance_create_time

The time the replication instance was created.

TIMESTAMP_S
kms_key_id

An KMS key identifier that is used to encrypt the data on the replication instance.

If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

VARCHAR
multi_az

Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true. 

BOOLEAN
network_type

The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.

VARCHAR
pending_modified_values

The pending modification values.

STRUCT(
    "replication_instance_class" VARCHAR,
    "allocated_storage" BIGINT,
    "multi_az" BOOLEAN,
    "engine_version" VARCHAR,
    "network_type" VARCHAR
)
Show child fields
pending_modified_values.allocated_storage

The amount of storage (in gigabytes) that is allocated for the replication instance.

pending_modified_values.engine_version

The engine version number of the replication instance.

pending_modified_values.multi_az

Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.

pending_modified_values.network_type

The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.

pending_modified_values.replication_instance_class

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

For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.

preferred_maintenance_window

The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.

VARCHAR
publicly_accessible

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. 

BOOLEAN
replication_instance_arn

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

VARCHAR
replication_instance_class

The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a default value is pre-selected in the DMS console.

For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration. 

VARCHAR
replication_instance_identifier

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

Constraints:

  • Must contain 1-63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: myrepinstance 

VARCHAR
replication_instance_ipv6_addresses

One or more IPv6 addresses for the replication instance.

VARCHAR[]
Show child fields
replication_instance_ipv6_addresses[]
replication_instance_private_ip_address

The private IP address of the replication instance.

VARCHAR
replication_instance_private_ip_addresses

One or more private IP addresses for the replication instance.

VARCHAR[]
Show child fields
replication_instance_private_ip_addresses[]
replication_instance_public_ip_address

The public IP address of the replication instance.

VARCHAR
replication_instance_public_ip_addresses

One or more public IP addresses for the replication instance.

VARCHAR[]
Show child fields
replication_instance_public_ip_addresses[]
replication_instance_status

The status of the replication instance. The possible return values include:

  • "available"

  • "creating"

  • "deleted"

  • "deleting"

  • "failed"

  • "modifying"

  • "upgrading"

  • "rebooting"

  • "resetting-master-credentials"

  • "storage-full"

  • "incompatible-credentials"

  • "incompatible-network"

  • "maintenance" 

VARCHAR
replication_subnet_group

The subnet group for the replication instance.

STRUCT(
    "replication_subnet_group_identifier" VARCHAR,
    "replication_subnet_group_description" VARCHAR,
    "vpc_id" VARCHAR,
    "subnet_group_status" VARCHAR,
    "subnets" STRUCT(
        "subnet_identifier" VARCHAR,
        "subnet_availability_zone" STRUCT(
            "name" VARCHAR
        ),
        "subnet_status" VARCHAR
    )[],
    "supported_network_types" VARCHAR[]
)
Show child fields
replication_subnet_group.replication_subnet_group_description

A description for the replication subnet group.

replication_subnet_group.replication_subnet_group_identifier

The identifier of the replication instance subnet group.

replication_subnet_group.subnet_group_status

The status of the subnet group.

replication_subnet_group.subnets[]
Show child fields
replication_subnet_group.subnets[].subnet_availability_zone

The Availability Zone of the subnet.

Show child fields
replication_subnet_group.subnets[].subnet_availability_zone.name

The name of the Availability Zone.

replication_subnet_group.subnets[].subnet_identifier

The subnet identifier.

replication_subnet_group.subnets[].subnet_status

The status of the subnet.

replication_subnet_group.supported_network_types[]
replication_subnet_group.vpc_id

The ID of the VPC.

secondary_availability_zone

The Availability Zone of the standby replication instance in a Multi-AZ deployment.

VARCHAR
vpc_security_groups

The VPC security group for the instance.

STRUCT(
    "vpc_security_group_id" VARCHAR,
    "status" VARCHAR
)[]
Show child fields
vpc_security_groups[]
Show child fields
vpc_security_groups[].status

The status of the VPC security group.

vpc_security_groups[].vpc_security_group_id

The VPC security group ID.