libZSservicesZSamazonka-docdbZSamazonka-docdb
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DocumentDB.CreateDBInstance

Description

Creates a new instance.

Synopsis

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

  • 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

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

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

    Constraints: Minimum 30-minute window.

  • 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 Region.

    Example: us-east-1d

  • 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
Eq CreateDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

Read CreateDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

Show CreateDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

Generic CreateDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

Associated Types

type Rep CreateDBInstance :: Type -> Type #

NFData CreateDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

Methods

rnf :: CreateDBInstance -> () #

Hashable CreateDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

AWSRequest CreateDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

Associated Types

type AWSResponse CreateDBInstance #

ToHeaders CreateDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

ToPath CreateDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

ToQuery CreateDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

type Rep CreateDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

type Rep CreateDBInstance = D1 ('MetaData "CreateDBInstance" "Amazonka.DocumentDB.CreateDBInstance" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "CreateDBInstance'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "autoMinorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "promotionTier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((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))))))
type AWSResponse CreateDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

newCreateDBInstance Source #

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:

$sel:autoMinorVersionUpgrade: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

$sel:promotionTier: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:preferredMaintenanceWindow: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 Region, occurring on a random day of the week.

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

Constraints: Minimum 30-minute window.

$sel:availabilityZone: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 Region.

Example: us-east-1d

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

$sel:dbInstanceIdentifier: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

$sel:dbInstanceClass:CreateDBInstance', createDBInstance_dbInstanceClass - The compute and memory capacity of the instance; for example, db.r5.large.

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

Valid value: docdb

$sel:dbClusterIdentifier: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_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_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 Region, occurring on a random day of the week.

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

Constraints: Minimum 30-minute window.

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 Region.

Example: us-east-1d

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

Instances

Instances details
Eq CreateDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

Read CreateDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

Show CreateDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

Generic CreateDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

Associated Types

type Rep CreateDBInstanceResponse :: Type -> Type #

NFData CreateDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

type Rep CreateDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

type Rep CreateDBInstanceResponse = D1 ('MetaData "CreateDBInstanceResponse" "Amazonka.DocumentDB.CreateDBInstance" "libZSservicesZSamazonka-docdbZSamazonka-docdb" '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 #

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