aws_dms_replication_instance

account_id

Type: STRING

allocated_storage

Type: INT32
Provider name: AllocatedStorage
Description: The amount of storage (in gigabytes) that is allocated for the replication instance.

auto_minor_version_upgrade

Type: BOOLEAN
Provider name: AutoMinorVersionUpgrade
Description: Boolean value indicating if minor version upgrades will be automatically applied to the instance.

availability_zone

Type: STRING
Provider name: AvailabilityZone
Description: The Availability Zone for the instance.

dns_name_servers

Type: STRING
Provider name: DnsNameServers
Description: The DNS name servers supported for the replication instance to access your on-premise source or target database.

engine_version

Type: STRING
Provider name: EngineVersion
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.

free_until

Type: TIMESTAMP
Provider name: FreeUntil
Description: The expiration date of the free replication instance that is part of the Free DMS program.

instance_create_time

Type: TIMESTAMP
Provider name: InstanceCreateTime
Description: The time the replication instance was created.

kms_key_id

Type: STRING
Provider name: KmsKeyId
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.

multi_az

Type: BOOLEAN
Provider name: MultiAZ
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.

network_type

Type: STRING
Provider name: NetworkType
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.

pending_modified_values

Type: STRUCT
Provider name: PendingModifiedValues
Description: The pending modification values.

  • allocated_storage
    Type: INT32
    Provider name: AllocatedStorage
    Description: The amount of storage (in gigabytes) that is allocated for the replication instance.
  • engine_version
    Type: STRING
    Provider name: EngineVersion
    Description: The engine version number of the replication instance.
  • multi_az
    Type: BOOLEAN
    Provider name: MultiAZ
    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.
  • network_type
    Type: STRING
    Provider name: NetworkType
    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.
  • replication_instance_class
    Type: STRING
    Provider name: ReplicationInstanceClass
    Description: 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

Type: STRING
Provider name: PreferredMaintenanceWindow
Description: The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.

publicly_accessible

Type: BOOLEAN
Provider name: PubliclyAccessible
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.

replication_instance_arn

Type: STRING
Provider name: ReplicationInstanceArn
Description: The Amazon Resource Name (ARN) of the replication instance.

replication_instance_class

Type: STRING
Provider name: ReplicationInstanceClass
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.

replication_instance_identifier

Type: STRING
Provider name: ReplicationInstanceIdentifier
Description: 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

replication_instance_ipv6_addresses

Type: UNORDERED_LIST_STRING
Provider name: ReplicationInstanceIpv6Addresses
Description: One or more IPv6 addresses for the replication instance.

replication_instance_private_ip_address

Type: STRING
Provider name: ReplicationInstancePrivateIpAddress
Description: The private IP address of the replication instance.

replication_instance_private_ip_addresses

Type: UNORDERED_LIST_STRING
Provider name: ReplicationInstancePrivateIpAddresses
Description: One or more private IP addresses for the replication instance.

replication_instance_public_ip_address

Type: STRING
Provider name: ReplicationInstancePublicIpAddress
Description: The public IP address of the replication instance.

replication_instance_public_ip_addresses

Type: UNORDERED_LIST_STRING
Provider name: ReplicationInstancePublicIpAddresses
Description: One or more public IP addresses for the replication instance.

replication_instance_status

Type: STRING
Provider name: ReplicationInstanceStatus
Description: 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”

replication_subnet_group

Type: STRUCT
Provider name: ReplicationSubnetGroup
Description: The subnet group for the replication instance.

  • replication_subnet_group_description
    Type: STRING
    Provider name: ReplicationSubnetGroupDescription
    Description: A description for the replication subnet group.
  • replication_subnet_group_identifier
    Type: STRING
    Provider name: ReplicationSubnetGroupIdentifier
    Description: The identifier of the replication instance subnet group.
  • subnet_group_status
    Type: STRING
    Provider name: SubnetGroupStatus
    Description: The status of the subnet group.
  • subnets
    Type: UNORDERED_LIST_STRUCT
    Provider name: Subnets
    Description: The subnets that are in the subnet group.
    • subnet_availability_zone
      Type: STRUCT
      Provider name: SubnetAvailabilityZone
      Description: The Availability Zone of the subnet.
      • name
        Type: STRING
        Provider name: Name
        Description: The name of the Availability Zone.
    • subnet_identifier
      Type: STRING
      Provider name: SubnetIdentifier
      Description: The subnet identifier.
    • subnet_status
      Type: STRING
      Provider name: SubnetStatus
      Description: The status of the subnet.
  • supported_network_types
    Type: UNORDERED_LIST_STRING
    Provider name: SupportedNetworkTypes
    Description: The IP addressing protocol supported by the subnet group. This is used by a replication instance with values such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
  • vpc_id
    Type: STRING
    Provider name: VpcId
    Description: The ID of the VPC.

secondary_availability_zone

Type: STRING
Provider name: SecondaryAvailabilityZone
Description: The Availability Zone of the standby replication instance in a Multi-AZ deployment.

tags

Type: UNORDERED_LIST_STRING

vpc_security_groups

Type: UNORDERED_LIST_STRUCT
Provider name: VpcSecurityGroups
Description: The VPC security group for the instance.

  • status
    Type: STRING
    Provider name: Status
    Description: The status of the VPC security group.
  • vpc_security_group_id
    Type: STRING
    Provider name: VpcSecurityGroupId
    Description: The VPC security group ID.