Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Creates a new Amazon Aurora DB cluster.
You can use the ReplicationSourceIdentifier
parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon RDS MySQL DB instance. For cross-region replication where the DB cluster identified by ReplicationSourceIdentifier
is encrypted, you must also specify the PreSignedUrl
parameter.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Synopsis
- createDBCluster :: Text -> Text -> CreateDBCluster
- data CreateDBCluster
- cdcEngineVersion :: Lens' CreateDBCluster (Maybe Text)
- cdcStorageEncrypted :: Lens' CreateDBCluster (Maybe Bool)
- cdcMasterUserPassword :: Lens' CreateDBCluster (Maybe Text)
- cdcReplicationSourceIdentifier :: Lens' CreateDBCluster (Maybe Text)
- cdcMasterUsername :: Lens' CreateDBCluster (Maybe Text)
- cdcDBSubnetGroupName :: Lens' CreateDBCluster (Maybe Text)
- cdcBacktrackWindow :: Lens' CreateDBCluster (Maybe Integer)
- cdcPreSignedURL :: Lens' CreateDBCluster (Maybe Text)
- cdcPreferredMaintenanceWindow :: Lens' CreateDBCluster (Maybe Text)
- cdcAvailabilityZones :: Lens' CreateDBCluster [Text]
- cdcCharacterSetName :: Lens' CreateDBCluster (Maybe Text)
- cdcKMSKeyId :: Lens' CreateDBCluster (Maybe Text)
- cdcPreferredBackupWindow :: Lens' CreateDBCluster (Maybe Text)
- cdcBackupRetentionPeriod :: Lens' CreateDBCluster (Maybe Int)
- cdcVPCSecurityGroupIds :: Lens' CreateDBCluster [Text]
- cdcDatabaseName :: Lens' CreateDBCluster (Maybe Text)
- cdcDBClusterParameterGroupName :: Lens' CreateDBCluster (Maybe Text)
- cdcOptionGroupName :: Lens' CreateDBCluster (Maybe Text)
- cdcTags :: Lens' CreateDBCluster [Tag]
- cdcPort :: Lens' CreateDBCluster (Maybe Int)
- cdcEnableIAMDatabaseAuthentication :: Lens' CreateDBCluster (Maybe Bool)
- cdcDBClusterIdentifier :: Lens' CreateDBCluster Text
- cdcEngine :: Lens' CreateDBCluster Text
- createDBClusterResponse :: Int -> CreateDBClusterResponse
- data CreateDBClusterResponse
- cdcrsDBCluster :: Lens' CreateDBClusterResponse (Maybe DBCluster)
- cdcrsResponseStatus :: Lens' CreateDBClusterResponse Int
Creating a Request
Creates a value of CreateDBCluster
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cdcEngineVersion
- The version number of the database engine to use. Aurora MySQL Example:5.6.10a
,5.7.12
Aurora PostgreSQL Example:9.6.3
cdcStorageEncrypted
- Specifies whether the DB cluster is encrypted.cdcMasterUserPassword
- The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters.cdcReplicationSourceIdentifier
- The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.cdcMasterUsername
- The name of the master user for the DB cluster. Constraints: * Must be 1 to 16 letters or numbers. * First character must be a letter. * Cannot be a reserved word for the chosen database engine.cdcDBSubnetGroupName
- 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
cdcBacktrackWindow
- The target backtrack window, in seconds. To disable backtracking, set this value to 0. Default: 0 Constraints: * If specified, this value must be set to a number from 0 to 259,200 (72 hours).cdcPreSignedURL
- A URL that contains a Signature Version 4 signed request for theCreateDBCluster
action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specifyPreSignedUrl
when you are performing cross-region replication from an encrypted DB cluster. The pre-signed URL must be a valid request for theCreateDBCluster
API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied. The pre-signed URL request must contain the following parameter values: *KmsKeyId
- The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same KMS key for both theCreateDBCluster
action that is called in the destination AWS Region, and the action contained in the pre-signed URL. *DestinationRegion
- The name of the AWS Region that Aurora Read Replica will be created in. *ReplicationSourceIdentifier
- The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then yourReplicationSourceIdentifier
would look like Example:arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1
. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process .cdcPreferredMaintenanceWindow
- 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 AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window.cdcAvailabilityZones
- A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on AWS Regions and Availability Zones, see Regions and Availability Zones .cdcCharacterSetName
- A value that indicates that the DB cluster should be associated with the specified CharacterSet.cdcKMSKeyId
- The AWS 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 AWS 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 inKmsKeyId
: * IfReplicationSourceIdentifier
identifies an encrypted source, then Amazon RDS will use the encryption key used to encrypt the source. Otherwise, Amazon RDS will use your default encryption key. * If theStorageEncrypted
parameter is true andReplicationSourceIdentifier
is not specified, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region. If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must setKmsKeyId
to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the Read Replica in that AWS Region.cdcPreferredBackupWindow
- The daily time range during which automated backups are created if automated backups are enabled using theBackupRetentionPeriod
parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide. Constraints: * Must be in the formathh24:mi-hh24:mi
. * Must be in Universal Coordinated Time (UTC). * Must not conflict with the preferred maintenance window. * Must be at least 30 minutes.cdcBackupRetentionPeriod
- 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 35cdcVPCSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB cluster.cdcDatabaseName
- The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating.cdcDBClusterParameterGroupName
- The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted,default.aurora5.6
is used. Constraints: * If supplied, must match the name of an existing DBClusterParameterGroup.cdcOptionGroupName
- A value that indicates that the DB cluster should be associated with the specified option group. Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.cdcTags
- Undocumented member.cdcPort
- The port number on which the instances in the DB cluster accept connections. Default:3306
if engine is set as aurora or5432
if set to aurora-postgresql.cdcEnableIAMDatabaseAuthentication
- True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default:false
cdcDBClusterIdentifier
- 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
cdcEngine
- The name of the database engine to be used for this DB cluster. Valid Values:aurora
(for MySQL 5.6-compatible Aurora),aurora-mysql
(for MySQL 5.7-compatible Aurora), andaurora-postgresql
data CreateDBCluster Source #
See: createDBCluster
smart constructor.
Instances
Request Lenses
cdcEngineVersion :: Lens' CreateDBCluster (Maybe Text) Source #
The version number of the database engine to use. Aurora MySQL Example: 5.6.10a
, 5.7.12
Aurora PostgreSQL Example: 9.6.3
cdcStorageEncrypted :: Lens' CreateDBCluster (Maybe Bool) Source #
Specifies whether the DB cluster is encrypted.
cdcMasterUserPassword :: Lens' CreateDBCluster (Maybe Text) Source #
The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters.
cdcReplicationSourceIdentifier :: 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.
cdcMasterUsername :: Lens' CreateDBCluster (Maybe Text) Source #
The name of the master user for the DB cluster. Constraints: * Must be 1 to 16 letters or numbers. * First character must be a letter. * Cannot be a reserved word for the chosen database engine.
cdcDBSubnetGroupName :: 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
cdcBacktrackWindow :: Lens' CreateDBCluster (Maybe Integer) Source #
The target backtrack window, in seconds. To disable backtracking, set this value to 0. Default: 0 Constraints: * If specified, this value must be set to a number from 0 to 259,200 (72 hours).
cdcPreSignedURL :: Lens' CreateDBCluster (Maybe Text) Source #
A URL that contains a Signature Version 4 signed request for the CreateDBCluster
action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl
when you are performing cross-region replication from an encrypted DB cluster. The pre-signed URL must be a valid request for the CreateDBCluster
API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied. The pre-signed URL request must contain the following parameter values: * KmsKeyId
- The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same KMS key for both the CreateDBCluster
action that is called in the destination AWS Region, and the action contained in the pre-signed URL. * DestinationRegion
- The name of the AWS Region that Aurora Read Replica will be created in. * ReplicationSourceIdentifier
- The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier
would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1
. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process .
cdcPreferredMaintenanceWindow :: 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 AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window.
cdcAvailabilityZones :: Lens' CreateDBCluster [Text] Source #
A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on AWS Regions and Availability Zones, see Regions and Availability Zones .
cdcCharacterSetName :: Lens' CreateDBCluster (Maybe Text) Source #
A value that indicates that the DB cluster should be associated with the specified CharacterSet.
cdcKMSKeyId :: Lens' CreateDBCluster (Maybe Text) Source #
The AWS 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 AWS 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 RDS will use the encryption key used to encrypt the source. Otherwise, Amazon RDS will use your default encryption key. * If the StorageEncrypted
parameter is true and ReplicationSourceIdentifier
is not specified, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region. If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId
to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the Read Replica in that AWS Region.
cdcPreferredBackupWindow :: 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 AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS 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.
cdcBackupRetentionPeriod :: 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
cdcVPCSecurityGroupIds :: Lens' CreateDBCluster [Text] Source #
A list of EC2 VPC security groups to associate with this DB cluster.
cdcDatabaseName :: 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 RDS will not create a database in the DB cluster you are creating.
cdcDBClusterParameterGroupName :: Lens' CreateDBCluster (Maybe Text) Source #
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, default.aurora5.6
is used. Constraints: * If supplied, must match the name of an existing DBClusterParameterGroup.
cdcOptionGroupName :: Lens' CreateDBCluster (Maybe Text) Source #
A value that indicates that the DB cluster should be associated with the specified option group. Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
cdcPort :: Lens' CreateDBCluster (Maybe Int) Source #
The port number on which the instances in the DB cluster accept connections. Default: 3306
if engine is set as aurora or 5432
if set to aurora-postgresql.
cdcEnableIAMDatabaseAuthentication :: Lens' CreateDBCluster (Maybe Bool) Source #
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false
cdcDBClusterIdentifier :: 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
cdcEngine :: Lens' CreateDBCluster Text Source #
The name of the database engine to be used for this DB cluster. Valid Values: aurora
(for MySQL 5.6-compatible Aurora), aurora-mysql
(for MySQL 5.7-compatible Aurora), and aurora-postgresql
Destructuring the Response
createDBClusterResponse Source #
Creates a value of CreateDBClusterResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cdcrsDBCluster
- Undocumented member.cdcrsResponseStatus
- -- | The response status code.
data CreateDBClusterResponse Source #
See: createDBClusterResponse
smart constructor.
Instances
Response Lenses
cdcrsDBCluster :: Lens' CreateDBClusterResponse (Maybe DBCluster) Source #
Undocumented member.
cdcrsResponseStatus :: Lens' CreateDBClusterResponse Int Source #
- - | The response status code.