Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.DMS.CreateReplicationInstance

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates the replication instance using the specified parameters.

DMS requires that your account have certain roles with appropriate permissions before you can create a replication instance. For information on the required roles, see Creating the IAM Roles to Use With the CLI and DMS API. For information on the required permissions, see IAM Permissions Needed to Use DMS.

Synopsis

Creating a Request

data CreateReplicationInstance Source #

See: newCreateReplicationInstance smart constructor.

Constructors

CreateReplicationInstance'

Fields

allocatedStorage :: Maybe Int
The amount of storage (in gigabytes) to be initially allocated for the replication instance.
autoMinorVersionUpgrade :: Maybe Bool
A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window. This parameter defaults to true.
Default: true
availabilityZone :: Maybe Text
The Availability Zone where the replication instance will be created. The default value is a random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region, for example: us-east-1d
dnsNameServers :: Maybe Text
A list of custom DNS name servers supported for the replication instance to access your on-premise source or target database. This list overrides the default name servers supported by the replication instance. You can specify a comma-separated list of internet addresses for up to four on-premise DNS name servers. For example: "1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4"
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.
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.
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.
networkType :: Maybe Text
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.
preferredMaintenanceWindow :: Maybe Text
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 Amazon Web Services Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
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.
replicationSubnetGroupIdentifier :: Maybe Text
A subnet group to associate with the replication instance.
resourceIdentifier :: Maybe Text
A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.
tags :: Maybe [Tag]
One or more tags to be assigned to the replication instance.
vpcSecurityGroupIds :: Maybe [Text]
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.
replicationInstanceIdentifier :: Text
The replication instance identifier. This parameter is stored as a lowercase string.
Constraints:
- Must contain 1-63 alphanumeric characters or hyphens.
- First character must be a letter.
- Can't end with a hyphen or contain two consecutive hyphens.
Example: myrepinstance
replicationInstanceClass :: Text
The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to "dms.c4.large".
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.

Instances

Instances details

ToJSON CreateReplicationInstance Source #
Instance details Defined in Amazonka.DMS.CreateReplicationInstance Methods toJSON :: CreateReplicationInstance -> Value # toEncoding :: CreateReplicationInstance -> Encoding # toJSONList :: [CreateReplicationInstance] -> Value # toEncodingList :: [CreateReplicationInstance] -> Encoding #
ToHeaders CreateReplicationInstance Source #
Instance details Defined in Amazonka.DMS.CreateReplicationInstance Methods toHeaders :: CreateReplicationInstance -> [Header] #
ToPath CreateReplicationInstance Source #
Instance details Defined in Amazonka.DMS.CreateReplicationInstance Methods toPath :: CreateReplicationInstance -> ByteString #
ToQuery CreateReplicationInstance Source #
Instance details Defined in Amazonka.DMS.CreateReplicationInstance Methods toQuery :: CreateReplicationInstance -> QueryString #
AWSRequest CreateReplicationInstance Source #
Instance details Defined in Amazonka.DMS.CreateReplicationInstance Associated Types type AWSResponse CreateReplicationInstance # Methods request :: (Service -> Service) -> CreateReplicationInstance -> Request CreateReplicationInstance # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateReplicationInstance -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateReplicationInstance))) #
Generic CreateReplicationInstance Source #
Instance details Defined in Amazonka.DMS.CreateReplicationInstance Associated Types type Rep CreateReplicationInstance :: Type -> Type # Methods from :: CreateReplicationInstance -> Rep CreateReplicationInstance x # to :: Rep CreateReplicationInstance x -> CreateReplicationInstance #
Read CreateReplicationInstance Source #
Instance details Defined in Amazonka.DMS.CreateReplicationInstance Methods readsPrec :: Int -> ReadS CreateReplicationInstance # readList :: ReadS [CreateReplicationInstance] # readPrec :: ReadPrec CreateReplicationInstance # readListPrec :: ReadPrec [CreateReplicationInstance] #
Show CreateReplicationInstance Source #
Instance details Defined in Amazonka.DMS.CreateReplicationInstance Methods showsPrec :: Int -> CreateReplicationInstance -> ShowS # show :: CreateReplicationInstance -> String # showList :: [CreateReplicationInstance] -> ShowS #
NFData CreateReplicationInstance Source #
Instance details Defined in Amazonka.DMS.CreateReplicationInstance Methods rnf :: CreateReplicationInstance -> () #
Eq CreateReplicationInstance Source #
Instance details Defined in Amazonka.DMS.CreateReplicationInstance Methods (==) :: CreateReplicationInstance -> CreateReplicationInstance -> Bool # (/=) :: CreateReplicationInstance -> CreateReplicationInstance -> Bool #
Hashable CreateReplicationInstance Source #
Instance details Defined in Amazonka.DMS.CreateReplicationInstance Methods hashWithSalt :: Int -> CreateReplicationInstance -> Int # hash :: CreateReplicationInstance -> Int #
type AWSResponse CreateReplicationInstance Source #
Instance details Defined in Amazonka.DMS.CreateReplicationInstance type AWSResponse CreateReplicationInstance = CreateReplicationInstanceResponse
type Rep CreateReplicationInstance Source #
Instance details Defined in Amazonka.DMS.CreateReplicationInstance type Rep CreateReplicationInstance = D1 ('MetaData "CreateReplicationInstance" "Amazonka.DMS.CreateReplicationInstance" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "CreateReplicationInstance'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "allocatedStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "autoMinorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dnsNameServers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "multiAZ") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "networkType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "publiclyAccessible") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "replicationSubnetGroupIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "resourceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "vpcSecurityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "replicationInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "replicationInstanceClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateReplicationInstance Source #

Arguments

:: Text	`CreateReplicationInstance`
-> Text	`CreateReplicationInstance`
-> CreateReplicationInstance

Create a value of CreateReplicationInstance 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:

CreateReplicationInstance, createReplicationInstance_allocatedStorage - The amount of storage (in gigabytes) to be initially allocated for the replication instance.

CreateReplicationInstance, createReplicationInstance_autoMinorVersionUpgrade - A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window. This parameter defaults to true.

Default: true

CreateReplicationInstance, createReplicationInstance_availabilityZone - The Availability Zone where the replication instance will be created. The default value is a random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region, for example: us-east-1d

CreateReplicationInstance, createReplicationInstance_dnsNameServers - A list of custom DNS name servers supported for the replication instance to access your on-premise source or target database. This list overrides the default name servers supported by the replication instance. You can specify a comma-separated list of internet addresses for up to four on-premise DNS name servers. For example: "1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4"

CreateReplicationInstance, createReplicationInstance_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.

CreateReplicationInstance, createReplicationInstance_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.

CreateReplicationInstance, createReplicationInstance_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.

CreateReplicationInstance, createReplicationInstance_networkType - 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.

CreateReplicationInstance, createReplicationInstance_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 Amazon Web Services Region, occurring on a random day of the week.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

CreateReplicationInstance, createReplicationInstance_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.

CreateReplicationInstance, createReplicationInstance_replicationSubnetGroupIdentifier - A subnet group to associate with the replication instance.

CreateReplicationInstance, createReplicationInstance_resourceIdentifier - A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.

$sel:tags:CreateReplicationInstance', createReplicationInstance_tags - One or more tags to be assigned to the replication instance.

$sel:vpcSecurityGroupIds:CreateReplicationInstance', createReplicationInstance_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.

CreateReplicationInstance, createReplicationInstance_replicationInstanceIdentifier - The replication instance identifier. This parameter is stored as a lowercase string.

Constraints:

Must contain 1-63 alphanumeric characters or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.

Example: myrepinstance

CreateReplicationInstance, createReplicationInstance_replicationInstanceClass - The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to "dms.c4.large".

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

Request Lenses

createReplicationInstance_allocatedStorage :: Lens' CreateReplicationInstance (Maybe Int) Source #

The amount of storage (in gigabytes) to be initially allocated for the replication instance.

createReplicationInstance_autoMinorVersionUpgrade :: Lens' CreateReplicationInstance (Maybe Bool) Source #

A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window. This parameter defaults to true.

Default: true

createReplicationInstance_availabilityZone :: Lens' CreateReplicationInstance (Maybe Text) Source #

The Availability Zone where the replication instance will be created. The default value is a random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region, for example: us-east-1d

createReplicationInstance_dnsNameServers :: Lens' CreateReplicationInstance (Maybe Text) Source #

A list of custom DNS name servers supported for the replication instance to access your on-premise source or target database. This list overrides the default name servers supported by the replication instance. You can specify a comma-separated list of internet addresses for up to four on-premise DNS name servers. For example: "1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4"

createReplicationInstance_engineVersion :: Lens' CreateReplicationInstance (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.

createReplicationInstance_kmsKeyId :: Lens' CreateReplicationInstance (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.

createReplicationInstance_multiAZ :: Lens' CreateReplicationInstance (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.

createReplicationInstance_networkType :: Lens' CreateReplicationInstance (Maybe Text) Source #

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.

createReplicationInstance_preferredMaintenanceWindow :: Lens' CreateReplicationInstance (Maybe Text) Source #

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 Amazon Web Services Region, occurring on a random day of the week.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

createReplicationInstance_publiclyAccessible :: Lens' CreateReplicationInstance (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.

createReplicationInstance_replicationSubnetGroupIdentifier :: Lens' CreateReplicationInstance (Maybe Text) Source #

A subnet group to associate with the replication instance.

createReplicationInstance_resourceIdentifier :: Lens' CreateReplicationInstance (Maybe Text) Source #

A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.

createReplicationInstance_tags :: Lens' CreateReplicationInstance (Maybe [Tag]) Source #

One or more tags to be assigned to the replication instance.

createReplicationInstance_vpcSecurityGroupIds :: Lens' CreateReplicationInstance (Maybe [Text]) Source #

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.

createReplicationInstance_replicationInstanceIdentifier :: Lens' CreateReplicationInstance Text Source #

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

Constraints:

Must contain 1-63 alphanumeric characters or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.

Example: myrepinstance

createReplicationInstance_replicationInstanceClass :: Lens' CreateReplicationInstance Text Source #

The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to "dms.c4.large".

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

Destructuring the Response

data CreateReplicationInstanceResponse Source #

See: newCreateReplicationInstanceResponse smart constructor.

Constructors

CreateReplicationInstanceResponse'
Fields replicationInstance :: Maybe ReplicationInstance The replication instance that was created. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateReplicationInstanceResponse Source #
Instance details Defined in Amazonka.DMS.CreateReplicationInstance Associated Types type Rep CreateReplicationInstanceResponse :: Type -> Type # Methods from :: CreateReplicationInstanceResponse -> Rep CreateReplicationInstanceResponse x # to :: Rep CreateReplicationInstanceResponse x -> CreateReplicationInstanceResponse #
Read CreateReplicationInstanceResponse Source #
Instance details Defined in Amazonka.DMS.CreateReplicationInstance Methods readsPrec :: Int -> ReadS CreateReplicationInstanceResponse # readList :: ReadS [CreateReplicationInstanceResponse] # readPrec :: ReadPrec CreateReplicationInstanceResponse # readListPrec :: ReadPrec [CreateReplicationInstanceResponse] #
Show CreateReplicationInstanceResponse Source #
Instance details Defined in Amazonka.DMS.CreateReplicationInstance Methods showsPrec :: Int -> CreateReplicationInstanceResponse -> ShowS # show :: CreateReplicationInstanceResponse -> String # showList :: [CreateReplicationInstanceResponse] -> ShowS #
NFData CreateReplicationInstanceResponse Source #
Instance details Defined in Amazonka.DMS.CreateReplicationInstance Methods rnf :: CreateReplicationInstanceResponse -> () #
Eq CreateReplicationInstanceResponse Source #
Instance details Defined in Amazonka.DMS.CreateReplicationInstance Methods (==) :: CreateReplicationInstanceResponse -> CreateReplicationInstanceResponse -> Bool # (/=) :: CreateReplicationInstanceResponse -> CreateReplicationInstanceResponse -> Bool #
type Rep CreateReplicationInstanceResponse Source #
Instance details Defined in Amazonka.DMS.CreateReplicationInstance type Rep CreateReplicationInstanceResponse = D1 ('MetaData "CreateReplicationInstanceResponse" "Amazonka.DMS.CreateReplicationInstance" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "CreateReplicationInstanceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "replicationInstance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplicationInstance)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateReplicationInstanceResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateReplicationInstanceResponse'`
-> CreateReplicationInstanceResponse

Create a value of CreateReplicationInstanceResponse 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:replicationInstance:CreateReplicationInstanceResponse', createReplicationInstanceResponse_replicationInstance - The replication instance that was created.

$sel:httpStatus:CreateReplicationInstanceResponse', createReplicationInstanceResponse_httpStatus - The response's http status code.

Response Lenses

createReplicationInstanceResponse_replicationInstance :: Lens' CreateReplicationInstanceResponse (Maybe ReplicationInstance) Source #

The replication instance that was created.

createReplicationInstanceResponse_httpStatus :: Lens' CreateReplicationInstanceResponse Int Source #

The response's http status code.