Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DMS.Types.ReplicationInstance

Description

Synopsis

Documentation

data ReplicationInstance Source #

Provides information that defines a replication instance.

See: newReplicationInstance smart constructor.

Constructors

ReplicationInstance'

Fields

engineVersion :: Maybe Text
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.
publiclyAccessible :: Maybe Bool
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.
autoMinorVersionUpgrade :: Maybe Bool
Boolean value indicating if minor version upgrades will be automatically applied to the instance.
replicationInstancePublicIpAddresses :: Maybe [Text]
One or more public IP addresses for the replication instance.
replicationSubnetGroup :: Maybe ReplicationSubnetGroup
The subnet group for the replication instance.
instanceCreateTime :: Maybe POSIX
The time the replication instance was created.
freeUntil :: Maybe POSIX
The expiration date of the free replication instance that is part of the Free DMS program.

replicationInstanceStatus :: Maybe Text

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"
```

replicationInstancePrivateIpAddresses :: Maybe [Text]
One or more private IP addresses for the replication instance.
preferredMaintenanceWindow :: Maybe Text
The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.
replicationInstancePrivateIpAddress :: Maybe Text
The private IP address of the replication instance.
kmsKeyId :: Maybe Text
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.
availabilityZone :: Maybe Text
The Availability Zone for the instance.
vpcSecurityGroups :: Maybe [VpcSecurityGroupMembership]
The VPC security group for the instance.
multiAZ :: Maybe Bool
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.
secondaryAvailabilityZone :: Maybe Text
The Availability Zone of the standby replication instance in a Multi-AZ deployment.
replicationInstanceArn :: Maybe Text
The Amazon Resource Name (ARN) of the replication instance.
allocatedStorage :: Maybe Int
The amount of storage (in gigabytes) that is allocated for the replication instance.
dnsNameServers :: Maybe Text
The DNS name servers supported for the replication instance to access your on-premise source or target database.
replicationInstancePublicIpAddress :: Maybe Text
The public IP address of the replication instance.
replicationInstanceClass :: Maybe Text
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.
replicationInstanceIdentifier :: Maybe Text
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
pendingModifiedValues :: Maybe ReplicationPendingModifiedValues
The pending modification values.

Instances

Instances details

Eq ReplicationInstance Source #
Instance details Defined in Amazonka.DMS.Types.ReplicationInstance Methods (==) :: ReplicationInstance -> ReplicationInstance -> Bool # (/=) :: ReplicationInstance -> ReplicationInstance -> Bool #
Read ReplicationInstance Source #
Instance details Defined in Amazonka.DMS.Types.ReplicationInstance Methods readsPrec :: Int -> ReadS ReplicationInstance # readList :: ReadS [ReplicationInstance] # readPrec :: ReadPrec ReplicationInstance # readListPrec :: ReadPrec [ReplicationInstance] #
Show ReplicationInstance Source #
Instance details Defined in Amazonka.DMS.Types.ReplicationInstance Methods showsPrec :: Int -> ReplicationInstance -> ShowS # show :: ReplicationInstance -> String # showList :: [ReplicationInstance] -> ShowS #
Generic ReplicationInstance Source #
Instance details Defined in Amazonka.DMS.Types.ReplicationInstance Associated Types type Rep ReplicationInstance :: Type -> Type # Methods from :: ReplicationInstance -> Rep ReplicationInstance x # to :: Rep ReplicationInstance x -> ReplicationInstance #
NFData ReplicationInstance Source #
Instance details Defined in Amazonka.DMS.Types.ReplicationInstance Methods rnf :: ReplicationInstance -> () #
Hashable ReplicationInstance Source #
Instance details Defined in Amazonka.DMS.Types.ReplicationInstance Methods hashWithSalt :: Int -> ReplicationInstance -> Int # hash :: ReplicationInstance -> Int #
FromJSON ReplicationInstance Source #
Instance details Defined in Amazonka.DMS.Types.ReplicationInstance Methods parseJSON :: Value -> Parser ReplicationInstance # parseJSONList :: Value -> Parser [ReplicationInstance] #
type Rep ReplicationInstance Source #
Instance details Defined in Amazonka.DMS.Types.ReplicationInstance type Rep ReplicationInstance = D1 ('MetaData "ReplicationInstance" "Amazonka.DMS.Types.ReplicationInstance" "libZSservicesZSamazonka-dmsZSamazonka-dms" 'False) (C1 ('MetaCons "ReplicationInstance'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "publiclyAccessible") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "autoMinorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "replicationInstancePublicIpAddresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "replicationSubnetGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplicationSubnetGroup))))) :: ((S1 ('MetaSel ('Just "instanceCreateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "freeUntil") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "replicationInstanceStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "replicationInstancePrivateIpAddresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "replicationInstancePrivateIpAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :: (((S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "vpcSecurityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VpcSecurityGroupMembership])))) :: (S1 ('MetaSel ('Just "multiAZ") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "secondaryAvailabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "replicationInstanceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "allocatedStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "dnsNameServers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "replicationInstancePublicIpAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "replicationInstanceClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "replicationInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "pendingModifiedValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplicationPendingModifiedValues))))))))

newReplicationInstance :: ReplicationInstance Source #

Create a value of ReplicationInstance with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:engineVersion:ReplicationInstance', replicationInstance_engineVersion - 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.

$sel:publiclyAccessible:ReplicationInstance', replicationInstance_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.

$sel:autoMinorVersionUpgrade:ReplicationInstance', replicationInstance_autoMinorVersionUpgrade - Boolean value indicating if minor version upgrades will be automatically applied to the instance.

$sel:replicationInstancePublicIpAddresses:ReplicationInstance', replicationInstance_replicationInstancePublicIpAddresses - One or more public IP addresses for the replication instance.

$sel:replicationSubnetGroup:ReplicationInstance', replicationInstance_replicationSubnetGroup - The subnet group for the replication instance.

$sel:instanceCreateTime:ReplicationInstance', replicationInstance_instanceCreateTime - The time the replication instance was created.

$sel:freeUntil:ReplicationInstance', replicationInstance_freeUntil - The expiration date of the free replication instance that is part of the Free DMS program.

$sel:replicationInstanceStatus:ReplicationInstance', replicationInstance_replicationInstanceStatus - 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"
```

$sel:replicationInstancePrivateIpAddresses:ReplicationInstance', replicationInstance_replicationInstancePrivateIpAddresses - One or more private IP addresses for the replication instance.

$sel:preferredMaintenanceWindow:ReplicationInstance', replicationInstance_preferredMaintenanceWindow - The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.

$sel:replicationInstancePrivateIpAddress:ReplicationInstance', replicationInstance_replicationInstancePrivateIpAddress - The private IP address of the replication instance.

$sel:kmsKeyId:ReplicationInstance', replicationInstance_kmsKeyId - 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.

$sel:availabilityZone:ReplicationInstance', replicationInstance_availabilityZone - The Availability Zone for the instance.

$sel:vpcSecurityGroups:ReplicationInstance', replicationInstance_vpcSecurityGroups - The VPC security group for the instance.

$sel:multiAZ:ReplicationInstance', replicationInstance_multiAZ - 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.

$sel:secondaryAvailabilityZone:ReplicationInstance', replicationInstance_secondaryAvailabilityZone - The Availability Zone of the standby replication instance in a Multi-AZ deployment.

$sel:replicationInstanceArn:ReplicationInstance', replicationInstance_replicationInstanceArn - The Amazon Resource Name (ARN) of the replication instance.

$sel:allocatedStorage:ReplicationInstance', replicationInstance_allocatedStorage - The amount of storage (in gigabytes) that is allocated for the replication instance.

$sel:dnsNameServers:ReplicationInstance', replicationInstance_dnsNameServers - The DNS name servers supported for the replication instance to access your on-premise source or target database.

$sel:replicationInstancePublicIpAddress:ReplicationInstance', replicationInstance_replicationInstancePublicIpAddress - The public IP address of the replication instance.

$sel:replicationInstanceClass:ReplicationInstance', replicationInstance_replicationInstanceClass - 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.

$sel:replicationInstanceIdentifier:ReplicationInstance', replicationInstance_replicationInstanceIdentifier - 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

$sel:pendingModifiedValues:ReplicationInstance', replicationInstance_pendingModifiedValues - The pending modification values.

replicationInstance_engineVersion :: Lens' ReplicationInstance (Maybe Text) Source #

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.

replicationInstance_publiclyAccessible :: Lens' ReplicationInstance (Maybe Bool) Source #

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.

replicationInstance_autoMinorVersionUpgrade :: Lens' ReplicationInstance (Maybe Bool) Source #

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

replicationInstance_replicationInstancePublicIpAddresses :: Lens' ReplicationInstance (Maybe [Text]) Source #

One or more public IP addresses for the replication instance.

replicationInstance_replicationSubnetGroup :: Lens' ReplicationInstance (Maybe ReplicationSubnetGroup) Source #

The subnet group for the replication instance.

replicationInstance_instanceCreateTime :: Lens' ReplicationInstance (Maybe UTCTime) Source #

The time the replication instance was created.

replicationInstance_freeUntil :: Lens' ReplicationInstance (Maybe UTCTime) Source #

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

replicationInstance_replicationInstanceStatus :: Lens' ReplicationInstance (Maybe Text) Source #

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"
```

replicationInstance_replicationInstancePrivateIpAddresses :: Lens' ReplicationInstance (Maybe [Text]) Source #

One or more private IP addresses for the replication instance.

replicationInstance_preferredMaintenanceWindow :: Lens' ReplicationInstance (Maybe Text) Source #

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

replicationInstance_replicationInstancePrivateIpAddress :: Lens' ReplicationInstance (Maybe Text) Source #

The private IP address of the replication instance.

replicationInstance_kmsKeyId :: Lens' ReplicationInstance (Maybe Text) Source #

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.

replicationInstance_availabilityZone :: Lens' ReplicationInstance (Maybe Text) Source #

The Availability Zone for the instance.

replicationInstance_vpcSecurityGroups :: Lens' ReplicationInstance (Maybe [VpcSecurityGroupMembership]) Source #

The VPC security group for the instance.

replicationInstance_multiAZ :: Lens' ReplicationInstance (Maybe Bool) Source #

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.

replicationInstance_secondaryAvailabilityZone :: Lens' ReplicationInstance (Maybe Text) Source #

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

replicationInstance_replicationInstanceArn :: Lens' ReplicationInstance (Maybe Text) Source #

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

replicationInstance_allocatedStorage :: Lens' ReplicationInstance (Maybe Int) Source #

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

replicationInstance_dnsNameServers :: Lens' ReplicationInstance (Maybe Text) Source #

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

replicationInstance_replicationInstancePublicIpAddress :: Lens' ReplicationInstance (Maybe Text) Source #

The public IP address of the replication instance.

replicationInstance_replicationInstanceClass :: Lens' ReplicationInstance (Maybe Text) Source #

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.

replicationInstance_replicationInstanceIdentifier :: Lens' ReplicationInstance (Maybe Text) Source #

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

replicationInstance_pendingModifiedValues :: Lens' ReplicationInstance (Maybe ReplicationPendingModifiedValues) Source #

The pending modification values.