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.DocumentDB.CreateDBInstance

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new instance.

Synopsis

data CreateDBInstance = CreateDBInstance' {
- autoMinorVersionUpgrade :: Maybe Bool
- availabilityZone :: Maybe Text
- copyTagsToSnapshot :: Maybe Bool
- enablePerformanceInsights :: Maybe Bool
- performanceInsightsKMSKeyId :: Maybe Text
- preferredMaintenanceWindow :: Maybe Text
- promotionTier :: Maybe Int
- tags :: Maybe [Tag]
- dbInstanceIdentifier :: Text
- dbInstanceClass :: Text
- engine :: Text
- dbClusterIdentifier :: Text
}
newCreateDBInstance :: Text -> Text -> Text -> Text -> CreateDBInstance
createDBInstance_autoMinorVersionUpgrade :: Lens' CreateDBInstance (Maybe Bool)
createDBInstance_availabilityZone :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_copyTagsToSnapshot :: Lens' CreateDBInstance (Maybe Bool)
createDBInstance_enablePerformanceInsights :: Lens' CreateDBInstance (Maybe Bool)
createDBInstance_performanceInsightsKMSKeyId :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_preferredMaintenanceWindow :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_promotionTier :: Lens' CreateDBInstance (Maybe Int)
createDBInstance_tags :: Lens' CreateDBInstance (Maybe [Tag])
createDBInstance_dbInstanceIdentifier :: Lens' CreateDBInstance Text
createDBInstance_dbInstanceClass :: Lens' CreateDBInstance Text
createDBInstance_engine :: Lens' CreateDBInstance Text
createDBInstance_dbClusterIdentifier :: Lens' CreateDBInstance Text
data CreateDBInstanceResponse = CreateDBInstanceResponse' {
- dbInstance :: Maybe DBInstance
- httpStatus :: Int
}
newCreateDBInstanceResponse :: Int -> CreateDBInstanceResponse
createDBInstanceResponse_dbInstance :: Lens' CreateDBInstanceResponse (Maybe DBInstance)
createDBInstanceResponse_httpStatus :: Lens' CreateDBInstanceResponse Int

Creating a Request

data CreateDBInstance Source #

Represents the input to CreateDBInstance.

See: newCreateDBInstance smart constructor.

Constructors

CreateDBInstance'

Fields

autoMinorVersionUpgrade :: Maybe Bool
This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
Default: false
availabilityZone :: Maybe Text
The Amazon EC2 Availability Zone that the instance is created in.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Example: us-east-1d
copyTagsToSnapshot :: Maybe Bool
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
enablePerformanceInsights :: Maybe Bool
A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.
performanceInsightsKMSKeyId :: Maybe Text
The KMS key identifier for encryption of Performance Insights data.
The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.
preferredMaintenanceWindow :: Maybe Text
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each 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.
promotionTier :: Maybe Int
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
Default: 1
Valid values: 0-15
tags :: Maybe [Tag]
The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
dbInstanceIdentifier :: Text
The instance identifier. This parameter is stored as a lowercase string.
Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens.
- The first character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
dbInstanceClass :: Text
The compute and memory capacity of the instance; for example, db.r5.large.
engine :: Text
The name of the database engine to be used for this instance.
Valid value: docdb
dbClusterIdentifier :: Text
The identifier of the cluster that the instance will belong to.

Instances

Instances details

ToHeaders CreateDBInstance Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBInstance Methods toHeaders :: CreateDBInstance -> [Header] #
ToPath CreateDBInstance Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBInstance Methods toPath :: CreateDBInstance -> ByteString #
ToQuery CreateDBInstance Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBInstance Methods toQuery :: CreateDBInstance -> QueryString #
AWSRequest CreateDBInstance Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBInstance Associated Types type AWSResponse CreateDBInstance # Methods request :: (Service -> Service) -> CreateDBInstance -> Request CreateDBInstance # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDBInstance -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDBInstance))) #
Generic CreateDBInstance Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBInstance Associated Types type Rep CreateDBInstance :: Type -> Type # Methods from :: CreateDBInstance -> Rep CreateDBInstance x # to :: Rep CreateDBInstance x -> CreateDBInstance #
Read CreateDBInstance Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBInstance Methods readsPrec :: Int -> ReadS CreateDBInstance # readList :: ReadS [CreateDBInstance] # readPrec :: ReadPrec CreateDBInstance # readListPrec :: ReadPrec [CreateDBInstance] #
Show CreateDBInstance Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBInstance Methods showsPrec :: Int -> CreateDBInstance -> ShowS # show :: CreateDBInstance -> String # showList :: [CreateDBInstance] -> ShowS #
NFData CreateDBInstance Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBInstance Methods rnf :: CreateDBInstance -> () #
Eq CreateDBInstance Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBInstance Methods (==) :: CreateDBInstance -> CreateDBInstance -> Bool # (/=) :: CreateDBInstance -> CreateDBInstance -> Bool #
Hashable CreateDBInstance Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBInstance Methods hashWithSalt :: Int -> CreateDBInstance -> Int # hash :: CreateDBInstance -> Int #
type AWSResponse CreateDBInstance Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBInstance type AWSResponse CreateDBInstance = CreateDBInstanceResponse
type Rep CreateDBInstance Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBInstance type Rep CreateDBInstance = D1 ('MetaData "CreateDBInstance" "Amazonka.DocumentDB.CreateDBInstance" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "CreateDBInstance'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "autoMinorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "copyTagsToSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "enablePerformanceInsights") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "performanceInsightsKMSKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "promotionTier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "dbInstanceClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateDBInstance Source #

Arguments

:: Text	`CreateDBInstance`
-> Text	`CreateDBInstance`
-> Text	`CreateDBInstance`
-> Text	`CreateDBInstance`
-> CreateDBInstance

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

CreateDBInstance, createDBInstance_autoMinorVersionUpgrade - This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Default: false

CreateDBInstance, createDBInstance_availabilityZone - The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

Example: us-east-1d

CreateDBInstance, createDBInstance_copyTagsToSnapshot - A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

$sel:enablePerformanceInsights:CreateDBInstance', createDBInstance_enablePerformanceInsights - A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

$sel:performanceInsightsKMSKeyId:CreateDBInstance', createDBInstance_performanceInsightsKMSKeyId - The KMS key identifier for encryption of Performance Insights data.

The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.

CreateDBInstance, createDBInstance_preferredMaintenanceWindow - The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each 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.

CreateDBInstance, createDBInstance_promotionTier - A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

$sel:tags:CreateDBInstance', createDBInstance_tags - The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

CreateDBInstance, createDBInstance_dbInstanceIdentifier - The instance identifier. This parameter is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

CreateDBInstance, createDBInstance_dbInstanceClass - The compute and memory capacity of the instance; for example, db.r5.large.

CreateDBInstance, createDBInstance_engine - The name of the database engine to be used for this instance.

Valid value: docdb

CreateDBInstance, createDBInstance_dbClusterIdentifier - The identifier of the cluster that the instance will belong to.

Request Lenses

createDBInstance_autoMinorVersionUpgrade :: Lens' CreateDBInstance (Maybe Bool) Source #

This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Default: false

createDBInstance_availabilityZone :: Lens' CreateDBInstance (Maybe Text) Source #

The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

Example: us-east-1d

createDBInstance_copyTagsToSnapshot :: Lens' CreateDBInstance (Maybe Bool) Source #

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

createDBInstance_enablePerformanceInsights :: Lens' CreateDBInstance (Maybe Bool) Source #

A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

createDBInstance_performanceInsightsKMSKeyId :: Lens' CreateDBInstance (Maybe Text) Source #

The KMS key identifier for encryption of Performance Insights data.

The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.

createDBInstance_preferredMaintenanceWindow :: Lens' CreateDBInstance (Maybe Text) Source #

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each 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.

createDBInstance_promotionTier :: Lens' CreateDBInstance (Maybe Int) Source #

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

createDBInstance_tags :: Lens' CreateDBInstance (Maybe [Tag]) Source #

The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

createDBInstance_dbInstanceIdentifier :: Lens' CreateDBInstance Text Source #

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

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

createDBInstance_dbInstanceClass :: Lens' CreateDBInstance Text Source #

The compute and memory capacity of the instance; for example, db.r5.large.

createDBInstance_engine :: Lens' CreateDBInstance Text Source #

The name of the database engine to be used for this instance.

Valid value: docdb

createDBInstance_dbClusterIdentifier :: Lens' CreateDBInstance Text Source #

The identifier of the cluster that the instance will belong to.

Destructuring the Response

data CreateDBInstanceResponse Source #

See: newCreateDBInstanceResponse smart constructor.

Constructors

CreateDBInstanceResponse'
Fields dbInstance :: Maybe DBInstance httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateDBInstanceResponse Source #

Arguments

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

Create a value of CreateDBInstanceResponse 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:dbInstance:CreateDBInstanceResponse', createDBInstanceResponse_dbInstance - Undocumented member.

$sel:httpStatus:CreateDBInstanceResponse', createDBInstanceResponse_httpStatus - The response's http status code.

Response Lenses

createDBInstanceResponse_dbInstance :: Lens' CreateDBInstanceResponse (Maybe DBInstance) Source #

Undocumented member.

createDBInstanceResponse_httpStatus :: Lens' CreateDBInstanceResponse Int Source #

The response's http status code.