Network.AWS.RDS.CreateDBCluster

Creates a new Amazon Aurora DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

See: AWS API Reference for CreateDBCluster.

Creating a Request

createDBCluster

Arguments

:: Text

cdcDBClusterIdentifier

-> Text

cdcEngine

-> Text

cdcMasterUsername

-> Text

cdcMasterUserPassword

-> CreateDBCluster

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
• cdcStorageEncrypted
• cdcDBSubnetGroupName
• cdcPreferredMaintenanceWindow
• cdcAvailabilityZones
• cdcCharacterSetName
• cdcKMSKeyId
• cdcPreferredBackupWindow
• cdcBackupRetentionPeriod
• cdcVPCSecurityGroupIds
• cdcDatabaseName
• cdcDBClusterParameterGroupName
• cdcOptionGroupName
• cdcTags
• cdcPort
• cdcDBClusterIdentifier
• cdcEngine
• cdcMasterUsername
• cdcMasterUserPassword

data CreateDBCluster

See: createDBCluster smart constructor.

Instances

Eq CreateDBCluster

Data CreateDBCluster

Read CreateDBCluster

Show CreateDBCluster

Generic CreateDBCluster

AWSRequest CreateDBCluster

ToPath CreateDBCluster

ToHeaders CreateDBCluster

ToQuery CreateDBCluster

type Rep CreateDBCluster

type Rs CreateDBCluster = CreateDBClusterResponse

Request Lenses

cdcEngineVersion :: Lens' CreateDBCluster (Maybe Text)

The version number of the database engine to use.

Aurora

Example: '5.6.10a'

cdcStorageEncrypted :: Lens' CreateDBCluster (Maybe Bool)

Specifies whether the DB cluster is encrypted.

cdcDBSubnetGroupName :: Lens' CreateDBCluster (Maybe Text)

A DB subnet group to associate with this DB cluster.

cdcPreferredMaintenanceWindow :: Lens' CreateDBCluster (Maybe Text)

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

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

Default: A 30-minute window selected at random from an 8-hour block of time per 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]

A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones.

cdcCharacterSetName :: Lens' CreateDBCluster (Maybe Text)

A value that indicates that the DB cluster should be associated with the specified CharacterSet.

cdcKMSKeyId :: Lens' CreateDBCluster (Maybe Text)

The 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 KM encryption key.

If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, 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.

cdcPreferredBackupWindow :: Lens' CreateDBCluster (Maybe Text)

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

Default: A 30-minute window selected at random from an 8-hour block of time per 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'.
• Times should 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)

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]

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

cdcDatabaseName :: Lens' CreateDBCluster (Maybe Text)

The name for your database of up to 8 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)

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, 'default.aurora5.6' for the specified engine will be used.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

cdcOptionGroupName :: Lens' CreateDBCluster (Maybe Text)

A value that indicates that the DB cluster should be associated with the specified option group.

Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.

cdcTags :: Lens' CreateDBCluster [Tag]

Undocumented member.

cdcPort :: Lens' CreateDBCluster (Maybe Int)

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

Default: '3306'

cdcDBClusterIdentifier :: Lens' CreateDBCluster Text

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

Constraints:

• Must contain from 1 to 63 alphanumeric characters 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

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

Valid Values: aurora

cdcMasterUsername :: Lens' CreateDBCluster Text

The name of the master user for the client DB cluster.

Constraints:

• Must be 1 to 16 alphanumeric characters.
• First character must be a letter.
• Cannot be a reserved word for the chosen database engine.

cdcMasterUserPassword :: Lens' CreateDBCluster Text

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.

Destructuring the Response

createDBClusterResponse

Arguments

:: Int

cdcrsResponseStatus

-> CreateDBClusterResponse

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
• cdcrsResponseStatus

data CreateDBClusterResponse

See: createDBClusterResponse smart constructor.

Instances

Eq CreateDBClusterResponse

Data CreateDBClusterResponse

Read CreateDBClusterResponse

Show CreateDBClusterResponse

Generic CreateDBClusterResponse

type Rep CreateDBClusterResponse

Response Lenses

cdcrsDBCluster :: Lens' CreateDBClusterResponse (Maybe DBCluster)

Undocumented member.

cdcrsResponseStatus :: Lens' CreateDBClusterResponse Int

The response status code.