{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-dms/refs/heads/main/json-schema/amazon-dms-replication-instance-schema.json", "title": "ReplicationInstance", "description": "Provides information that defines a replication instance.", "type": "object", "properties": { "ReplicationInstanceIdentifier": { "allOf": [ { "$ref": "#/components/schemas/String" }, { "description": "

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

Constraints:

Example: myrepinstance

" } ] }, "ReplicationInstanceClass": { "allOf": [ { "$ref": "#/components/schemas/String" }, { "description": "

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

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

" } ] }, "ReplicationInstanceStatus": { "allOf": [ { "$ref": "#/components/schemas/String" }, { "description": "

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

" } ] }, "AllocatedStorage": { "allOf": [ { "$ref": "#/components/schemas/Integer" }, { "description": "The amount of storage (in gigabytes) that is allocated for the replication instance." } ] }, "InstanceCreateTime": { "allOf": [ { "$ref": "#/components/schemas/TStamp" }, { "description": "The time the replication instance was created." } ] }, "VpcSecurityGroups": { "allOf": [ { "$ref": "#/components/schemas/VpcSecurityGroupMembershipList" }, { "description": "The VPC security group for the instance." } ] }, "AvailabilityZone": { "allOf": [ { "$ref": "#/components/schemas/String" }, { "description": "The Availability Zone for the instance." } ] }, "ReplicationSubnetGroup": { "allOf": [ { "$ref": "#/components/schemas/ReplicationSubnetGroup" }, { "description": "The subnet group for the replication instance." } ] }, "PreferredMaintenanceWindow": { "allOf": [ { "$ref": "#/components/schemas/String" }, { "description": "The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time." } ] }, "PendingModifiedValues": { "allOf": [ { "$ref": "#/components/schemas/ReplicationPendingModifiedValues" }, { "description": "The pending modification values." } ] }, "MultiAZ": { "allOf": [ { "$ref": "#/components/schemas/Boolean" }, { "description": " Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true. " } ] }, "EngineVersion": { "allOf": [ { "$ref": "#/components/schemas/String" }, { "description": "

The engine version number of the replication instance.

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

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

" } ] }, "AutoMinorVersionUpgrade": { "allOf": [ { "$ref": "#/components/schemas/Boolean" }, { "description": "Boolean value indicating if minor version upgrades will be automatically applied to the instance." } ] }, "KmsKeyId": { "allOf": [ { "$ref": "#/components/schemas/String" }, { "description": "

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

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

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

" } ] }, "ReplicationInstanceArn": { "allOf": [ { "$ref": "#/components/schemas/String" }, { "description": "The Amazon Resource Name (ARN) of the replication instance." } ] }, "ReplicationInstancePublicIpAddress": { "allOf": [ { "$ref": "#/components/schemas/String" }, { "deprecated": true, "description": "The public IP address of the replication instance." } ] }, "ReplicationInstancePrivateIpAddress": { "allOf": [ { "$ref": "#/components/schemas/String" }, { "deprecated": true, "description": "The private IP address of the replication instance." } ] }, "ReplicationInstancePublicIpAddresses": { "allOf": [ { "$ref": "#/components/schemas/ReplicationInstancePublicIpAddressList" }, { "description": "One or more public IP addresses for the replication instance." } ] }, "ReplicationInstancePrivateIpAddresses": { "allOf": [ { "$ref": "#/components/schemas/ReplicationInstancePrivateIpAddressList" }, { "description": "One or more private IP addresses for the replication instance." } ] }, "ReplicationInstanceIpv6Addresses": { "allOf": [ { "$ref": "#/components/schemas/ReplicationInstanceIpv6AddressList" }, { "description": "One or more IPv6 addresses for the replication instance." } ] }, "PubliclyAccessible": { "allOf": [ { "$ref": "#/components/schemas/Boolean" }, { "description": " 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": { "allOf": [ { "$ref": "#/components/schemas/String" }, { "description": "The Availability Zone of the standby replication instance in a Multi-AZ deployment." } ] }, "FreeUntil": { "allOf": [ { "$ref": "#/components/schemas/TStamp" }, { "description": " The expiration date of the free replication instance that is part of the Free DMS program. " } ] }, "DnsNameServers": { "allOf": [ { "$ref": "#/components/schemas/String" }, { "description": "The DNS name servers supported for the replication instance to access your on-premise source or target database." } ] }, "NetworkType": { "allOf": [ { "$ref": "#/components/schemas/String" }, { "description": "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." } ] } } }