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.Neptune.CreateDBCluster

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new Amazon Neptune DB cluster.

You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon Neptune DB instance.

Note that when you create a new cluster using CreateDBCluster directly, deletion protection is disabled by default (when you create a new production cluster in the console, deletion protection is enabled by default). You can only delete a DB cluster if its DeletionProtection field is set to false.

Synopsis

data CreateDBCluster = CreateDBCluster' {
- availabilityZones :: Maybe [Text]
- backupRetentionPeriod :: Maybe Int
- characterSetName :: Maybe Text
- copyTagsToSnapshot :: Maybe Bool
- dbClusterParameterGroupName :: Maybe Text
- dbSubnetGroupName :: Maybe Text
- databaseName :: Maybe Text
- deletionProtection :: Maybe Bool
- enableCloudwatchLogsExports :: Maybe [Text]
- enableIAMDatabaseAuthentication :: Maybe Bool
- engineVersion :: Maybe Text
- globalClusterIdentifier :: Maybe Text
- kmsKeyId :: Maybe Text
- masterUserPassword :: Maybe Text
- masterUsername :: Maybe Text
- optionGroupName :: Maybe Text
- port :: Maybe Int
- preSignedUrl :: Maybe Text
- preferredBackupWindow :: Maybe Text
- preferredMaintenanceWindow :: Maybe Text
- replicationSourceIdentifier :: Maybe Text
- serverlessV2ScalingConfiguration :: Maybe ServerlessV2ScalingConfiguration
- storageEncrypted :: Maybe Bool
- tags :: Maybe [Tag]
- vpcSecurityGroupIds :: Maybe [Text]
- dbClusterIdentifier :: Text
- engine :: Text
}
newCreateDBCluster :: Text -> Text -> CreateDBCluster
createDBCluster_availabilityZones :: Lens' CreateDBCluster (Maybe [Text])
createDBCluster_backupRetentionPeriod :: Lens' CreateDBCluster (Maybe Int)
createDBCluster_characterSetName :: Lens' CreateDBCluster (Maybe Text)
createDBCluster_copyTagsToSnapshot :: Lens' CreateDBCluster (Maybe Bool)
createDBCluster_dbClusterParameterGroupName :: Lens' CreateDBCluster (Maybe Text)
createDBCluster_dbSubnetGroupName :: Lens' CreateDBCluster (Maybe Text)
createDBCluster_databaseName :: Lens' CreateDBCluster (Maybe Text)
createDBCluster_deletionProtection :: Lens' CreateDBCluster (Maybe Bool)
createDBCluster_enableCloudwatchLogsExports :: Lens' CreateDBCluster (Maybe [Text])
createDBCluster_enableIAMDatabaseAuthentication :: Lens' CreateDBCluster (Maybe Bool)
createDBCluster_engineVersion :: Lens' CreateDBCluster (Maybe Text)
createDBCluster_globalClusterIdentifier :: Lens' CreateDBCluster (Maybe Text)
createDBCluster_kmsKeyId :: Lens' CreateDBCluster (Maybe Text)
createDBCluster_masterUserPassword :: Lens' CreateDBCluster (Maybe Text)
createDBCluster_masterUsername :: Lens' CreateDBCluster (Maybe Text)
createDBCluster_optionGroupName :: Lens' CreateDBCluster (Maybe Text)
createDBCluster_port :: Lens' CreateDBCluster (Maybe Int)
createDBCluster_preSignedUrl :: Lens' CreateDBCluster (Maybe Text)
createDBCluster_preferredBackupWindow :: Lens' CreateDBCluster (Maybe Text)
createDBCluster_preferredMaintenanceWindow :: Lens' CreateDBCluster (Maybe Text)
createDBCluster_replicationSourceIdentifier :: Lens' CreateDBCluster (Maybe Text)
createDBCluster_serverlessV2ScalingConfiguration :: Lens' CreateDBCluster (Maybe ServerlessV2ScalingConfiguration)
createDBCluster_storageEncrypted :: Lens' CreateDBCluster (Maybe Bool)
createDBCluster_tags :: Lens' CreateDBCluster (Maybe [Tag])
createDBCluster_vpcSecurityGroupIds :: Lens' CreateDBCluster (Maybe [Text])
createDBCluster_dbClusterIdentifier :: Lens' CreateDBCluster Text
createDBCluster_engine :: Lens' CreateDBCluster Text
data CreateDBClusterResponse = CreateDBClusterResponse' {
- dbCluster :: Maybe DBCluster
- httpStatus :: Int
}
newCreateDBClusterResponse :: Int -> CreateDBClusterResponse
createDBClusterResponse_dbCluster :: Lens' CreateDBClusterResponse (Maybe DBCluster)
createDBClusterResponse_httpStatus :: Lens' CreateDBClusterResponse Int

Creating a Request

data CreateDBCluster Source #

See: newCreateDBCluster smart constructor.

Constructors

CreateDBCluster'

Fields

availabilityZones :: Maybe [Text]
A list of EC2 Availability Zones that instances in the DB cluster can be created in.
backupRetentionPeriod :: Maybe Int
The number of days for which automated backups are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
- Must be a value from 1 to 35
characterSetName :: Maybe Text
(Not supported by Neptune)
copyTagsToSnapshot :: Maybe Bool
/If set to true, tags are copied to any snapshot of the DB cluster that is created./
dbClusterParameterGroupName :: Maybe Text
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default is used.
Constraints:
- If supplied, must match the name of an existing DBClusterParameterGroup.
dbSubnetGroupName :: Maybe Text
A DB subnet group to associate with this DB cluster.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
databaseName :: Maybe Text
The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Neptune will not create a database in the DB cluster you are creating.
deletionProtection :: Maybe Bool
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is enabled.
enableCloudwatchLogsExports :: Maybe [Text]
The list of log types that need to be enabled for exporting to CloudWatch Logs.
enableIAMDatabaseAuthentication :: Maybe Bool
If set to true, enables Amazon Identity and Access Management (IAM) authentication for the entire DB cluster (this cannot be set at an instance level).
Default: false.
engineVersion :: Maybe Text
The version number of the database engine to use for the new DB cluster.
Example: 1.0.2.1
globalClusterIdentifier :: Maybe Text
The ID of the Neptune global database to which this new DB cluster should be added.
kmsKeyId :: Maybe Text
The Amazon KMS key identifier for an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same Amazon account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
If an encryption key is not specified in KmsKeyId:
- If ReplicationSourceIdentifier identifies an encrypted source, then Amazon Neptune will use the encryption key used to encrypt the source. Otherwise, Amazon Neptune will use your default encryption key.
- If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, then Amazon Neptune will use your default encryption key.
Amazon KMS creates the default encryption key for your Amazon account. Your Amazon account has a different default encryption key for each Amazon Region.
If you create a Read Replica of an encrypted DB cluster in another Amazon Region, you must set KmsKeyId to a KMS key ID that is valid in the destination Amazon Region. This key is used to encrypt the Read Replica in that Amazon Region.
masterUserPassword :: Maybe Text
Not supported by Neptune.
masterUsername :: Maybe Text
Not supported by Neptune.
optionGroupName :: Maybe Text
(Not supported by Neptune)
port :: Maybe Int
The port number on which the instances in the DB cluster accept connections.
Default: 8182
preSignedUrl :: Maybe Text
This parameter is not currently supported.
preferredBackupWindow :: Maybe Text
The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Neptune User Guide.
Constraints:
- Must be in the format hh24:mi-hh24:mi.
- Must be in Universal Coordinated Time (UTC).
- Must not conflict with the preferred maintenance window.
- Must be at least 30 minutes.
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
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Neptune User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
replicationSourceIdentifier :: Maybe Text
The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
serverlessV2ScalingConfiguration :: Maybe ServerlessV2ScalingConfiguration
storageEncrypted :: Maybe Bool
Specifies whether the DB cluster is encrypted.
tags :: Maybe [Tag]
The tags to assign to the new DB cluster.
vpcSecurityGroupIds :: Maybe [Text]
A list of EC2 VPC security groups to associate with this DB cluster.
dbClusterIdentifier :: Text
The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
engine :: Text
The name of the database engine to be used for this DB cluster.
Valid Values: neptune

Instances

Instances details

ToHeaders CreateDBCluster Source #
Instance details Defined in Amazonka.Neptune.CreateDBCluster Methods toHeaders :: CreateDBCluster -> [Header] #
ToPath CreateDBCluster Source #
Instance details Defined in Amazonka.Neptune.CreateDBCluster Methods toPath :: CreateDBCluster -> ByteString #
ToQuery CreateDBCluster Source #
Instance details Defined in Amazonka.Neptune.CreateDBCluster Methods toQuery :: CreateDBCluster -> QueryString #
AWSRequest CreateDBCluster Source #
Instance details Defined in Amazonka.Neptune.CreateDBCluster Associated Types type AWSResponse CreateDBCluster # Methods request :: (Service -> Service) -> CreateDBCluster -> Request CreateDBCluster # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDBCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDBCluster))) #
Generic CreateDBCluster Source #
Instance details Defined in Amazonka.Neptune.CreateDBCluster Associated Types type Rep CreateDBCluster :: Type -> Type # Methods from :: CreateDBCluster -> Rep CreateDBCluster x # to :: Rep CreateDBCluster x -> CreateDBCluster #
Read CreateDBCluster Source #
Instance details Defined in Amazonka.Neptune.CreateDBCluster Methods readsPrec :: Int -> ReadS CreateDBCluster # readList :: ReadS [CreateDBCluster] # readPrec :: ReadPrec CreateDBCluster # readListPrec :: ReadPrec [CreateDBCluster] #
Show CreateDBCluster Source #
Instance details Defined in Amazonka.Neptune.CreateDBCluster Methods showsPrec :: Int -> CreateDBCluster -> ShowS # show :: CreateDBCluster -> String # showList :: [CreateDBCluster] -> ShowS #
NFData CreateDBCluster Source #
Instance details Defined in Amazonka.Neptune.CreateDBCluster Methods rnf :: CreateDBCluster -> () #
Eq CreateDBCluster Source #
Instance details Defined in Amazonka.Neptune.CreateDBCluster Methods (==) :: CreateDBCluster -> CreateDBCluster -> Bool # (/=) :: CreateDBCluster -> CreateDBCluster -> Bool #
Hashable CreateDBCluster Source #
Instance details Defined in Amazonka.Neptune.CreateDBCluster Methods hashWithSalt :: Int -> CreateDBCluster -> Int # hash :: CreateDBCluster -> Int #
type AWSResponse CreateDBCluster Source #
Instance details Defined in Amazonka.Neptune.CreateDBCluster type AWSResponse CreateDBCluster = CreateDBClusterResponse
type Rep CreateDBCluster Source #
Instance details Defined in Amazonka.Neptune.CreateDBCluster type Rep CreateDBCluster = D1 ('MetaData "CreateDBCluster" "Amazonka.Neptune.CreateDBCluster" "amazonka-neptune-2.0-2gYqDRsIJxo6L8BEj2Stvk" 'False) (C1 ('MetaCons "CreateDBCluster'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "availabilityZones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "backupRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "characterSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "copyTagsToSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "dbClusterParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dbSubnetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "enableCloudwatchLogsExports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: ((S1 ('MetaSel ('Just "enableIAMDatabaseAuthentication") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "globalClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :: (((S1 ('MetaSel ('Just "masterUserPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "masterUsername") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "optionGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "preSignedUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "preferredBackupWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "replicationSourceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "serverlessV2ScalingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServerlessV2ScalingConfiguration)) :: S1 ('MetaSel ('Just "storageEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "vpcSecurityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newCreateDBCluster Source #

Arguments

:: Text	`CreateDBCluster`
-> Text	`CreateDBCluster`
-> CreateDBCluster

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

CreateDBCluster, createDBCluster_availabilityZones - A list of EC2 Availability Zones that instances in the DB cluster can be created in.

CreateDBCluster, createDBCluster_backupRetentionPeriod - The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

Must be a value from 1 to 35

CreateDBCluster, createDBCluster_characterSetName - (Not supported by Neptune)

CreateDBCluster, createDBCluster_copyTagsToSnapshot - /If set to true, tags are copied to any snapshot of the DB cluster that is created./

CreateDBCluster, createDBCluster_dbClusterParameterGroupName - The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default is used.

Constraints:

If supplied, must match the name of an existing DBClusterParameterGroup.

CreateDBCluster, createDBCluster_dbSubnetGroupName - A DB subnet group to associate with this DB cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

CreateDBCluster, createDBCluster_databaseName - The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Neptune will not create a database in the DB cluster you are creating.

CreateDBCluster, createDBCluster_deletionProtection - A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is enabled.

$sel:enableCloudwatchLogsExports:CreateDBCluster', createDBCluster_enableCloudwatchLogsExports - The list of log types that need to be enabled for exporting to CloudWatch Logs.

$sel:enableIAMDatabaseAuthentication:CreateDBCluster', createDBCluster_enableIAMDatabaseAuthentication - If set to true, enables Amazon Identity and Access Management (IAM) authentication for the entire DB cluster (this cannot be set at an instance level).

Default: false.

CreateDBCluster, createDBCluster_engineVersion - The version number of the database engine to use for the new DB cluster.

Example: 1.0.2.1

CreateDBCluster, createDBCluster_globalClusterIdentifier - The ID of the Neptune global database to which this new DB cluster should be added.

CreateDBCluster, createDBCluster_kmsKeyId - The Amazon KMS key identifier for an encrypted DB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same Amazon account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

If an encryption key is not specified in KmsKeyId:

If ReplicationSourceIdentifier identifies an encrypted source, then Amazon Neptune will use the encryption key used to encrypt the source. Otherwise, Amazon Neptune will use your default encryption key.
If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, then Amazon Neptune will use your default encryption key.

Amazon KMS creates the default encryption key for your Amazon account. Your Amazon account has a different default encryption key for each Amazon Region.

If you create a Read Replica of an encrypted DB cluster in another Amazon Region, you must set KmsKeyId to a KMS key ID that is valid in the destination Amazon Region. This key is used to encrypt the Read Replica in that Amazon Region.

CreateDBCluster, createDBCluster_masterUserPassword - Not supported by Neptune.

CreateDBCluster, createDBCluster_masterUsername - Not supported by Neptune.

CreateDBCluster, createDBCluster_optionGroupName - (Not supported by Neptune)

CreateDBCluster, createDBCluster_port - The port number on which the instances in the DB cluster accept connections.

Default: 8182

$sel:preSignedUrl:CreateDBCluster', createDBCluster_preSignedUrl - This parameter is not currently supported.

CreateDBCluster, createDBCluster_preferredBackupWindow - The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Neptune User Guide.

Constraints:

Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.

CreateDBCluster, createDBCluster_preferredMaintenanceWindow - The weekly time range 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 Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Neptune User Guide.

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

Constraints: Minimum 30-minute window.

CreateDBCluster, createDBCluster_replicationSourceIdentifier - The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

CreateDBCluster, createDBCluster_serverlessV2ScalingConfiguration - Undocumented member.

CreateDBCluster, createDBCluster_storageEncrypted - Specifies whether the DB cluster is encrypted.

$sel:tags:CreateDBCluster', createDBCluster_tags - The tags to assign to the new DB cluster.

$sel:vpcSecurityGroupIds:CreateDBCluster', createDBCluster_vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with this DB cluster.

CreateDBCluster, createDBCluster_dbClusterIdentifier - The DB cluster identifier. This parameter is stored as a lowercase string.

Constraints:

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

Example: my-cluster1

CreateDBCluster, createDBCluster_engine - The name of the database engine to be used for this DB cluster.

Valid Values: neptune

Request Lenses

createDBCluster_availabilityZones :: Lens' CreateDBCluster (Maybe [Text]) Source #

A list of EC2 Availability Zones that instances in the DB cluster can be created in.

createDBCluster_backupRetentionPeriod :: Lens' CreateDBCluster (Maybe Int) Source #

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

Must be a value from 1 to 35

createDBCluster_characterSetName :: Lens' CreateDBCluster (Maybe Text) Source #

(Not supported by Neptune)

createDBCluster_copyTagsToSnapshot :: Lens' CreateDBCluster (Maybe Bool) Source #

/If set to true, tags are copied to any snapshot of the DB cluster that is created./

createDBCluster_dbClusterParameterGroupName :: Lens' CreateDBCluster (Maybe Text) Source #

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default is used.

Constraints:

If supplied, must match the name of an existing DBClusterParameterGroup.

createDBCluster_dbSubnetGroupName :: Lens' CreateDBCluster (Maybe Text) Source #

A DB subnet group to associate with this DB cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

createDBCluster_databaseName :: Lens' CreateDBCluster (Maybe Text) Source #

The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Neptune will not create a database in the DB cluster you are creating.

createDBCluster_deletionProtection :: Lens' CreateDBCluster (Maybe Bool) Source #

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is enabled.

createDBCluster_enableCloudwatchLogsExports :: Lens' CreateDBCluster (Maybe [Text]) Source #

The list of log types that need to be enabled for exporting to CloudWatch Logs.

createDBCluster_enableIAMDatabaseAuthentication :: Lens' CreateDBCluster (Maybe Bool) Source #

If set to true, enables Amazon Identity and Access Management (IAM) authentication for the entire DB cluster (this cannot be set at an instance level).

Default: false.

createDBCluster_engineVersion :: Lens' CreateDBCluster (Maybe Text) Source #

The version number of the database engine to use for the new DB cluster.

Example: 1.0.2.1

createDBCluster_globalClusterIdentifier :: Lens' CreateDBCluster (Maybe Text) Source #

The ID of the Neptune global database to which this new DB cluster should be added.

createDBCluster_kmsKeyId :: Lens' CreateDBCluster (Maybe Text) Source #

The Amazon KMS key identifier for an encrypted DB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same Amazon account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

If an encryption key is not specified in KmsKeyId:

If ReplicationSourceIdentifier identifies an encrypted source, then Amazon Neptune will use the encryption key used to encrypt the source. Otherwise, Amazon Neptune will use your default encryption key.
If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, then Amazon Neptune will use your default encryption key.

Amazon KMS creates the default encryption key for your Amazon account. Your Amazon account has a different default encryption key for each Amazon Region.

If you create a Read Replica of an encrypted DB cluster in another Amazon Region, you must set KmsKeyId to a KMS key ID that is valid in the destination Amazon Region. This key is used to encrypt the Read Replica in that Amazon Region.

createDBCluster_masterUserPassword :: Lens' CreateDBCluster (Maybe Text) Source #

Not supported by Neptune.

createDBCluster_masterUsername :: Lens' CreateDBCluster (Maybe Text) Source #

Not supported by Neptune.

createDBCluster_optionGroupName :: Lens' CreateDBCluster (Maybe Text) Source #

(Not supported by Neptune)

createDBCluster_port :: Lens' CreateDBCluster (Maybe Int) Source #

The port number on which the instances in the DB cluster accept connections.

Default: 8182

createDBCluster_preSignedUrl :: Lens' CreateDBCluster (Maybe Text) Source #

This parameter is not currently supported.

createDBCluster_preferredBackupWindow :: Lens' CreateDBCluster (Maybe Text) Source #

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Neptune User Guide.

Constraints:

Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.

createDBCluster_preferredMaintenanceWindow :: Lens' CreateDBCluster (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

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Neptune User Guide.

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

Constraints: Minimum 30-minute window.

createDBCluster_replicationSourceIdentifier :: Lens' CreateDBCluster (Maybe Text) Source #

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

createDBCluster_serverlessV2ScalingConfiguration :: Lens' CreateDBCluster (Maybe ServerlessV2ScalingConfiguration) Source #

Undocumented member.

createDBCluster_storageEncrypted :: Lens' CreateDBCluster (Maybe Bool) Source #

Specifies whether the DB cluster is encrypted.

createDBCluster_tags :: Lens' CreateDBCluster (Maybe [Tag]) Source #

The tags to assign to the new DB cluster.

createDBCluster_vpcSecurityGroupIds :: Lens' CreateDBCluster (Maybe [Text]) Source #

A list of EC2 VPC security groups to associate with this DB cluster.

createDBCluster_dbClusterIdentifier :: Lens' CreateDBCluster Text Source #

The DB cluster identifier. This parameter is stored as a lowercase string.

Constraints:

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

Example: my-cluster1

createDBCluster_engine :: Lens' CreateDBCluster Text Source #

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

Valid Values: neptune

Destructuring the Response

data CreateDBClusterResponse Source #

See: newCreateDBClusterResponse smart constructor.

Constructors

CreateDBClusterResponse'
Fields dbCluster :: Maybe DBCluster httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateDBClusterResponse Source #

Arguments

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

Create a value of CreateDBClusterResponse 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:dbCluster:CreateDBClusterResponse', createDBClusterResponse_dbCluster - Undocumented member.

$sel:httpStatus:CreateDBClusterResponse', createDBClusterResponse_httpStatus - The response's http status code.

Response Lenses

createDBClusterResponse_dbCluster :: Lens' CreateDBClusterResponse (Maybe DBCluster) Source #

Undocumented member.

createDBClusterResponse_httpStatus :: Lens' CreateDBClusterResponse Int Source #

The response's http status code.