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 |
Creates a new Amazon DocumentDB cluster.
Synopsis
- data CreateDBCluster = CreateDBCluster' {
- availabilityZones :: Maybe [Text]
- backupRetentionPeriod :: Maybe Int
- dbClusterParameterGroupName :: Maybe Text
- dbSubnetGroupName :: Maybe Text
- deletionProtection :: Maybe Bool
- enableCloudwatchLogsExports :: Maybe [Text]
- engineVersion :: Maybe Text
- globalClusterIdentifier :: Maybe Text
- kmsKeyId :: Maybe Text
- masterUserPassword :: Maybe Text
- masterUsername :: Maybe Text
- port :: Maybe Int
- preSignedUrl :: Maybe Text
- preferredBackupWindow :: Maybe Text
- preferredMaintenanceWindow :: Maybe Text
- 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_dbClusterParameterGroupName :: Lens' CreateDBCluster (Maybe Text)
- createDBCluster_dbSubnetGroupName :: Lens' CreateDBCluster (Maybe Text)
- createDBCluster_deletionProtection :: Lens' CreateDBCluster (Maybe Bool)
- createDBCluster_enableCloudwatchLogsExports :: Lens' CreateDBCluster (Maybe [Text])
- 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_port :: Lens' CreateDBCluster (Maybe Int)
- createDBCluster_preSignedUrl :: Lens' CreateDBCluster (Maybe Text)
- createDBCluster_preferredBackupWindow :: Lens' CreateDBCluster (Maybe Text)
- createDBCluster_preferredMaintenanceWindow :: Lens' CreateDBCluster (Maybe Text)
- 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 #
Represents the input to CreateDBCluster.
See: newCreateDBCluster
smart constructor.
CreateDBCluster' | |
|
Instances
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 Amazon EC2 Availability Zones that instances in the 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_dbClusterParameterGroupName
- The name of the cluster parameter group to associate with this cluster.
CreateDBCluster
, createDBCluster_dbSubnetGroupName
- A subnet group to associate with this cluster.
Constraints: Must match the name of an existing DBSubnetGroup
. Must
not be default.
Example: mySubnetgroup
CreateDBCluster
, createDBCluster_deletionProtection
- Specifies whether this cluster can be deleted. If DeletionProtection
is enabled, the cluster cannot be deleted unless it is modified and
DeletionProtection
is disabled. DeletionProtection
protects clusters
from being accidentally deleted.
$sel:enableCloudwatchLogsExports:CreateDBCluster'
, createDBCluster_enableCloudwatchLogsExports
- A list of log types that need to be enabled for exporting to Amazon
CloudWatch Logs. You can enable audit logs or profiler logs. For more
information, see
Auditing Amazon DocumentDB Events
and
Profiling Amazon DocumentDB Operations.
CreateDBCluster
, createDBCluster_engineVersion
- The version number of the database engine to use. The --engine-version
will default to the latest major engine version. For production
workloads, we recommend explicitly declaring this parameter with the
intended major engine version.
CreateDBCluster
, createDBCluster_globalClusterIdentifier
- The cluster identifier of the new global cluster.
CreateDBCluster
, createDBCluster_kmsKeyId
- The KMS key identifier for an encrypted cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon Web Services account that owns the KMS encryption key that is used to encrypt the new cluster, 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 the
StorageEncrypted
parameter istrue
, Amazon DocumentDB 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 Regions.
CreateDBCluster
, createDBCluster_masterUserPassword
- The password for the master database user. This password can contain any
printable ASCII character except forward slash (/), double quote ("),
or the "at" symbol (@).
Constraints: Must contain from 8 to 100 characters.
CreateDBCluster
, createDBCluster_masterUsername
- The name of the master user for the cluster.
Constraints:
- Must be from 1 to 63 letters or numbers.
- The first character must be a letter.
- Cannot be a reserved word for the chosen database engine.
CreateDBCluster
, createDBCluster_port
- The port number on which the instances in the cluster accept
connections.
$sel:preSignedUrl:CreateDBCluster'
, createDBCluster_preSignedUrl
- 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 Web Services Region.
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 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.
CreateDBCluster
, createDBCluster_storageEncrypted
- Specifies whether the cluster is encrypted.
$sel:tags:CreateDBCluster'
, createDBCluster_tags
- The tags to be assigned to the cluster.
$sel:vpcSecurityGroupIds:CreateDBCluster'
, createDBCluster_vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this cluster.
CreateDBCluster
, createDBCluster_dbClusterIdentifier
- The cluster 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: my-cluster
CreateDBCluster
, createDBCluster_engine
- The name of the database engine to be used for this cluster.
Valid values: docdb
Request Lenses
createDBCluster_availabilityZones :: Lens' CreateDBCluster (Maybe [Text]) Source #
A list of Amazon EC2 Availability Zones that instances in the 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_dbClusterParameterGroupName :: Lens' CreateDBCluster (Maybe Text) Source #
The name of the cluster parameter group to associate with this cluster.
createDBCluster_dbSubnetGroupName :: Lens' CreateDBCluster (Maybe Text) Source #
A subnet group to associate with this cluster.
Constraints: Must match the name of an existing DBSubnetGroup
. Must
not be default.
Example: mySubnetgroup
createDBCluster_deletionProtection :: Lens' CreateDBCluster (Maybe Bool) Source #
Specifies whether this cluster can be deleted. If DeletionProtection
is enabled, the cluster cannot be deleted unless it is modified and
DeletionProtection
is disabled. DeletionProtection
protects clusters
from being accidentally deleted.
createDBCluster_enableCloudwatchLogsExports :: Lens' CreateDBCluster (Maybe [Text]) Source #
A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.
createDBCluster_engineVersion :: Lens' CreateDBCluster (Maybe Text) Source #
The version number of the database engine to use. The --engine-version
will default to the latest major engine version. For production
workloads, we recommend explicitly declaring this parameter with the
intended major engine version.
createDBCluster_globalClusterIdentifier :: Lens' CreateDBCluster (Maybe Text) Source #
The cluster identifier of the new global cluster.
createDBCluster_kmsKeyId :: Lens' CreateDBCluster (Maybe Text) Source #
The KMS key identifier for an encrypted cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon Web Services account that owns the KMS encryption key that is used to encrypt the new cluster, 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 the
StorageEncrypted
parameter istrue
, Amazon DocumentDB 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 Regions.
createDBCluster_masterUserPassword :: Lens' CreateDBCluster (Maybe Text) Source #
The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).
Constraints: Must contain from 8 to 100 characters.
createDBCluster_masterUsername :: Lens' CreateDBCluster (Maybe Text) Source #
The name of the master user for the cluster.
Constraints:
- Must be from 1 to 63 letters or numbers.
- The first character must be a letter.
- Cannot be a reserved word for the chosen database engine.
createDBCluster_port :: Lens' CreateDBCluster (Maybe Int) Source #
The port number on which the instances in the cluster accept connections.
createDBCluster_preSignedUrl :: Lens' CreateDBCluster (Maybe Text) Source #
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 Web Services Region.
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 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.
createDBCluster_storageEncrypted :: Lens' CreateDBCluster (Maybe Bool) Source #
Specifies whether the cluster is encrypted.
createDBCluster_tags :: Lens' CreateDBCluster (Maybe [Tag]) Source #
The tags to be assigned to the cluster.
createDBCluster_vpcSecurityGroupIds :: Lens' CreateDBCluster (Maybe [Text]) Source #
A list of EC2 VPC security groups to associate with this cluster.
createDBCluster_dbClusterIdentifier :: Lens' CreateDBCluster Text Source #
The cluster 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: my-cluster
createDBCluster_engine :: Lens' CreateDBCluster Text Source #
The name of the database engine to be used for this cluster.
Valid values: docdb
Destructuring the Response
data CreateDBClusterResponse Source #
See: newCreateDBClusterResponse
smart constructor.
CreateDBClusterResponse' | |
|
Instances
newCreateDBClusterResponse Source #
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.