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.RDS.Lens

Contents

Operations
Types

Description

Synopsis

Operations

AddRoleToDBCluster

addRoleToDBCluster_featureName :: Lens' AddRoleToDBCluster (Maybe Text) Source #

The name of the feature for the DB cluster that the IAM role is to be associated with. For information about supported feature names, see DBEngineVersion.

addRoleToDBCluster_dbClusterIdentifier :: Lens' AddRoleToDBCluster Text Source #

The name of the DB cluster to associate the IAM role with.

addRoleToDBCluster_roleArn :: Lens' AddRoleToDBCluster Text Source #

The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.

AddRoleToDBInstance

addRoleToDBInstance_dbInstanceIdentifier :: Lens' AddRoleToDBInstance Text Source #

The name of the DB instance to associate the IAM role with.

addRoleToDBInstance_roleArn :: Lens' AddRoleToDBInstance Text Source #

The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for example arn:aws:iam::123456789012:role/AccessRole.

addRoleToDBInstance_featureName :: Lens' AddRoleToDBInstance Text Source #

The name of the feature for the DB instance that the IAM role is to be associated with. For information about supported feature names, see DBEngineVersion.

AddSourceIdentifierToSubscription

addSourceIdentifierToSubscription_subscriptionName :: Lens' AddSourceIdentifierToSubscription Text Source #

The name of the RDS event notification subscription you want to add a source identifier to.

addSourceIdentifierToSubscription_sourceIdentifier :: Lens' AddSourceIdentifierToSubscription Text Source #

The identifier of the event source to be added.

Constraints:

If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
If the source type is an RDS Proxy, a DBProxyName value must be supplied.

addSourceIdentifierToSubscriptionResponse_eventSubscription :: Lens' AddSourceIdentifierToSubscriptionResponse (Maybe EventSubscription) Source #

Undocumented member.

addSourceIdentifierToSubscriptionResponse_httpStatus :: Lens' AddSourceIdentifierToSubscriptionResponse Int Source #

The response's http status code.

AddTagsToResource

addTagsToResource_resourceName :: Lens' AddTagsToResource Text Source #

The Amazon RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

addTagsToResource_tags :: Lens' AddTagsToResource [Tag] Source #

The tags to be assigned to the Amazon RDS resource.

ApplyPendingMaintenanceAction

applyPendingMaintenanceAction_resourceIdentifier :: Lens' ApplyPendingMaintenanceAction Text Source #

The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

applyPendingMaintenanceAction_applyAction :: Lens' ApplyPendingMaintenanceAction Text Source #

The pending maintenance action to apply to this resource.

Valid values: system-update, db-upgrade, hardware-maintenance, ca-certificate-rotation

applyPendingMaintenanceAction_optInType :: Lens' ApplyPendingMaintenanceAction Text Source #

A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate can't be undone.

Valid values:

immediate - Apply the maintenance action immediately.
next-maintenance - Apply the maintenance action during the next maintenance window for the resource.
undo-opt-in - Cancel any existing next-maintenance opt-in requests.

applyPendingMaintenanceActionResponse_resourcePendingMaintenanceActions :: Lens' ApplyPendingMaintenanceActionResponse (Maybe ResourcePendingMaintenanceActions) Source #

Undocumented member.

applyPendingMaintenanceActionResponse_httpStatus :: Lens' ApplyPendingMaintenanceActionResponse Int Source #

The response's http status code.

AuthorizeDBSecurityGroupIngress

authorizeDBSecurityGroupIngress_cidrip :: Lens' AuthorizeDBSecurityGroupIngress (Maybe Text) Source #

The IP range to authorize.

authorizeDBSecurityGroupIngress_eC2SecurityGroupId :: Lens' AuthorizeDBSecurityGroupIngress (Maybe Text) Source #

Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

authorizeDBSecurityGroupIngress_eC2SecurityGroupName :: Lens' AuthorizeDBSecurityGroupIngress (Maybe Text) Source #

Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

authorizeDBSecurityGroupIngress_eC2SecurityGroupOwnerId :: Lens' AuthorizeDBSecurityGroupIngress (Maybe Text) Source #

Amazon Web Services account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The Amazon Web Services access key ID isn't an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

authorizeDBSecurityGroupIngress_dbSecurityGroupName :: Lens' AuthorizeDBSecurityGroupIngress Text Source #

The name of the DB security group to add authorization to.

authorizeDBSecurityGroupIngressResponse_dbSecurityGroup :: Lens' AuthorizeDBSecurityGroupIngressResponse (Maybe DBSecurityGroup) Source #

Undocumented member.

authorizeDBSecurityGroupIngressResponse_httpStatus :: Lens' AuthorizeDBSecurityGroupIngressResponse Int Source #

The response's http status code.

BacktrackDBCluster

backtrackDBCluster_force :: Lens' BacktrackDBCluster (Maybe Bool) Source #

A value that indicates whether to force the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.

backtrackDBCluster_useEarliestTimeOnPointInTimeUnavailable :: Lens' BacktrackDBCluster (Maybe Bool) Source #

A value that indicates whether to backtrack the DB cluster to the earliest possible backtrack time when BacktrackTo is set to a timestamp earlier than the earliest backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest backtrack time, an error occurs.

backtrackDBCluster_dbClusterIdentifier :: Lens' BacktrackDBCluster Text Source #

The DB cluster identifier of the DB cluster to be backtracked. 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.
Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

backtrackDBCluster_backtrackTo :: Lens' BacktrackDBCluster UTCTime Source #

The timestamp of the time to backtrack the DB cluster to, specified in ISO 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia page.

If the specified time isn't a consistent time for the DB cluster, Aurora automatically chooses the nearest possible consistent time for the DB cluster.

Constraints:

Must contain a valid ISO 8601 timestamp.
Can't contain a timestamp set in the future.

Example: 2017-07-08T18:00Z

dbClusterBacktrack_backtrackIdentifier :: Lens' DBClusterBacktrack (Maybe Text) Source #

Contains the backtrack identifier.

dbClusterBacktrack_backtrackRequestCreationTime :: Lens' DBClusterBacktrack (Maybe UTCTime) Source #

The timestamp of the time at which the backtrack was requested.

dbClusterBacktrack_backtrackTo :: Lens' DBClusterBacktrack (Maybe UTCTime) Source #

The timestamp of the time to which the DB cluster was backtracked.

dbClusterBacktrack_backtrackedFrom :: Lens' DBClusterBacktrack (Maybe UTCTime) Source #

The timestamp of the time from which the DB cluster was backtracked.

dbClusterBacktrack_dbClusterIdentifier :: Lens' DBClusterBacktrack (Maybe Text) Source #

Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

dbClusterBacktrack_status :: Lens' DBClusterBacktrack (Maybe Text) Source #

The status of the backtrack. This property returns one of the following values:

applying - The backtrack is currently being applied to or rolled back from the DB cluster.
completed - The backtrack has successfully been applied to or rolled back from the DB cluster.
failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.
pending - The backtrack is currently pending application to or rollback from the DB cluster.

CancelExportTask

cancelExportTask_exportTaskIdentifier :: Lens' CancelExportTask Text Source #

The identifier of the snapshot export task to cancel.

exportTask_exportOnly :: Lens' ExportTask (Maybe [Text]) Source #

The data exported from the snapshot. Valid values are the following:

database - Export all the data from a specified database.
database.table table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
database.schema schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

exportTask_exportTaskIdentifier :: Lens' ExportTask (Maybe Text) Source #

A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is exported to.

exportTask_failureCause :: Lens' ExportTask (Maybe Text) Source #

The reason the export failed, if it failed.

exportTask_iamRoleArn :: Lens' ExportTask (Maybe Text) Source #

The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.

exportTask_kmsKeyId :: Lens' ExportTask (Maybe Text) Source #

The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key.

exportTask_percentProgress :: Lens' ExportTask (Maybe Int) Source #

The progress of the snapshot export task as a percentage.

exportTask_s3Bucket :: Lens' ExportTask (Maybe Text) Source #

The Amazon S3 bucket that the snapshot is exported to.

exportTask_s3Prefix :: Lens' ExportTask (Maybe Text) Source #

The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.

exportTask_snapshotTime :: Lens' ExportTask (Maybe UTCTime) Source #

The time that the snapshot was created.

exportTask_sourceArn :: Lens' ExportTask (Maybe Text) Source #

The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

exportTask_sourceType :: Lens' ExportTask (Maybe ExportSourceType) Source #

The type of source for the export.

exportTask_status :: Lens' ExportTask (Maybe Text) Source #

The progress status of the export task.

exportTask_taskEndTime :: Lens' ExportTask (Maybe UTCTime) Source #

The time that the snapshot export task completed.

exportTask_taskStartTime :: Lens' ExportTask (Maybe UTCTime) Source #

The time that the snapshot export task started.

exportTask_totalExtractedDataInGB :: Lens' ExportTask (Maybe Int) Source #

The total amount of data exported, in gigabytes.

exportTask_warningMessage :: Lens' ExportTask (Maybe Text) Source #

A warning about the snapshot export task.

CopyDBClusterParameterGroup

copyDBClusterParameterGroup_tags :: Lens' CopyDBClusterParameterGroup (Maybe [Tag]) Source #

Undocumented member.

copyDBClusterParameterGroup_sourceDBClusterParameterGroupIdentifier :: Lens' CopyDBClusterParameterGroup Text Source #

The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide.

Constraints:

Must specify a valid DB cluster parameter group.

copyDBClusterParameterGroup_targetDBClusterParameterGroupIdentifier :: Lens' CopyDBClusterParameterGroup Text Source #

The identifier for the copied DB cluster parameter group.

Constraints:

Can't be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster-param-group1

copyDBClusterParameterGroup_targetDBClusterParameterGroupDescription :: Lens' CopyDBClusterParameterGroup Text Source #

A description for the copied DB cluster parameter group.

copyDBClusterParameterGroupResponse_dbClusterParameterGroup :: Lens' CopyDBClusterParameterGroupResponse (Maybe DBClusterParameterGroup) Source #

Undocumented member.

copyDBClusterParameterGroupResponse_httpStatus :: Lens' CopyDBClusterParameterGroupResponse Int Source #

The response's http status code.

CopyDBClusterSnapshot

copyDBClusterSnapshot_copyTags :: Lens' CopyDBClusterSnapshot (Maybe Bool) Source #

A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.

copyDBClusterSnapshot_destinationRegion :: Lens' CopyDBClusterSnapshot (Maybe Text) Source #

Pseudo-parameter used when populating the PreSignedUrl of a cross-region CopyDBClusterSnapshot request. To replicate from region SRC to region DST, send a request to region DST. In that request, pass a PreSignedUrl for region SRC with DestinationRegion set to region DST.

copyDBClusterSnapshot_kmsKeyId :: Lens' CopyDBClusterSnapshot (Maybe Text) Source #

The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key.

If you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS key. If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.

If you copy an encrypted DB cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId.

To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.

If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

copyDBClusterSnapshot_preSignedUrl :: Lens' CopyDBClusterSnapshot (Maybe Text) Source #

When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API operation in the Amazon Web Services Region that contains the source DB cluster snapshot to copy. Use the PreSignedUrl parameter when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify PreSignedUrl when copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.

The presigned URL must be a valid request for the CopyDBClusterSnapshot API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request must contain the following parameter values:

KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.
SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.

copyDBClusterSnapshot_tags :: Lens' CopyDBClusterSnapshot (Maybe [Tag]) Source #

Undocumented member.

copyDBClusterSnapshot_sourceDBClusterSnapshotIdentifier :: Lens' CopyDBClusterSnapshot Text Source #

The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.

You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.

Constraints:

Must specify a valid system snapshot in the "available" state.
If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier.
If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.

Example: my-cluster-snapshot1

copyDBClusterSnapshot_targetDBClusterSnapshotIdentifier :: Lens' CopyDBClusterSnapshot Text Source #

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive.

Constraints:

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

Example: my-cluster-snapshot2

copyDBClusterSnapshotResponse_dbClusterSnapshot :: Lens' CopyDBClusterSnapshotResponse (Maybe DBClusterSnapshot) Source #

Undocumented member.

copyDBClusterSnapshotResponse_httpStatus :: Lens' CopyDBClusterSnapshotResponse Int Source #

The response's http status code.

CopyDBParameterGroup

copyDBParameterGroup_tags :: Lens' CopyDBParameterGroup (Maybe [Tag]) Source #

Undocumented member.

copyDBParameterGroup_sourceDBParameterGroupIdentifier :: Lens' CopyDBParameterGroup Text Source #

The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

Constraints:

Must specify a valid DB parameter group.

copyDBParameterGroup_targetDBParameterGroupIdentifier :: Lens' CopyDBParameterGroup Text Source #

The identifier for the copied DB parameter group.

Constraints:

Can't be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

Example: my-db-parameter-group

copyDBParameterGroup_targetDBParameterGroupDescription :: Lens' CopyDBParameterGroup Text Source #

A description for the copied DB parameter group.

copyDBParameterGroupResponse_dbParameterGroup :: Lens' CopyDBParameterGroupResponse (Maybe DBParameterGroup) Source #

Undocumented member.

copyDBParameterGroupResponse_httpStatus :: Lens' CopyDBParameterGroupResponse Int Source #

The response's http status code.

CopyDBSnapshot

copyDBSnapshot_copyOptionGroup :: Lens' CopyDBSnapshot (Maybe Bool) Source #

A value that indicates whether to copy the DB option group associated with the source DB snapshot to the target Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with cross-account snapshot copy calls.

copyDBSnapshot_copyTags :: Lens' CopyDBSnapshot (Maybe Bool) Source #

A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags aren't copied.

copyDBSnapshot_destinationRegion :: Lens' CopyDBSnapshot (Maybe Text) Source #

Pseudo-parameter used when populating the PreSignedUrl of a cross-region CopyDBSnapshot request. To replicate from region SRC to region DST, send a request to region DST. In that request, pass a PreSignedUrl for region SRC with DestinationRegion set to region DST.

copyDBSnapshot_kmsKeyId :: Lens' CopyDBSnapshot (Maybe Text) Source #

The Amazon Web Services KMS key identifier for an encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you copy an encrypted DB snapshot from your Amazon Web Services account, you can specify a value for this parameter to encrypt the copy with a new KMS key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot.

If you copy an encrypted DB snapshot that is shared from another Amazon Web Services account, then you must specify a value for this parameter.

If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.

If you copy an encrypted snapshot to a different Amazon Web Services Region, then you must specify an Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.

copyDBSnapshot_optionGroupName :: Lens' CopyDBSnapshot (Maybe Text) Source #

The name of an option group to associate with the copy of the snapshot.

Specify this option if you are copying a snapshot from one Amazon Web Services Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across Amazon Web Services Regions. For more information, see Option group considerations in the Amazon RDS User Guide.

copyDBSnapshot_preSignedUrl :: Lens' CopyDBSnapshot (Maybe Text) Source #

When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API operation in the source Amazon Web Services Region that contains the source DB snapshot to copy.

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.

You must specify this parameter when you copy an encrypted DB snapshot from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same Amazon Web Services Region.

The presigned URL must be a valid request for the CopyDBClusterSnapshot API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request must contain the following parameter values:

DestinationRegion - The Amazon Web Services Region that the encrypted DB snapshot is copied to. This Amazon Web Services Region is the same one where the CopyDBSnapshot operation is called that contains this presigned URL.
For example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the CopyDBSnapshot operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CopyDBSnapshot operation in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.
KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBSnapshot operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.

copyDBSnapshot_tags :: Lens' CopyDBSnapshot (Maybe [Tag]) Source #

Undocumented member.

copyDBSnapshot_targetCustomAvailabilityZone :: Lens' CopyDBSnapshot (Maybe Text) Source #

The external custom Availability Zone (CAZ) identifier for the target CAZ.

Example: rds-caz-aiqhTgQv.

copyDBSnapshot_sourceDBSnapshotIdentifier :: Lens' CopyDBSnapshot Text Source #

The identifier for the source DB snapshot.

If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805.

If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

If you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Web Services Region.

Constraints:

Must specify a valid system snapshot in the "available" state.

Example: rds:mydb-2012-04-02-00-01

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805

copyDBSnapshot_targetDBSnapshotIdentifier :: Lens' CopyDBSnapshot Text Source #

The identifier for the copy of the snapshot.

Constraints:

Can't be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

Example: my-db-snapshot

copyDBSnapshotResponse_dbSnapshot :: Lens' CopyDBSnapshotResponse (Maybe DBSnapshot) Source #

Undocumented member.

copyDBSnapshotResponse_httpStatus :: Lens' CopyDBSnapshotResponse Int Source #

The response's http status code.

CopyOptionGroup

copyOptionGroup_tags :: Lens' CopyOptionGroup (Maybe [Tag]) Source #

Undocumented member.

copyOptionGroup_sourceOptionGroupIdentifier :: Lens' CopyOptionGroup Text Source #

The identifier for the source option group.

Constraints:

Must specify a valid option group.

copyOptionGroup_targetOptionGroupIdentifier :: Lens' CopyOptionGroup Text Source #

The identifier for the copied option group.

Constraints:

Can't be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

Example: my-option-group

copyOptionGroup_targetOptionGroupDescription :: Lens' CopyOptionGroup Text Source #

The description for the copied option group.

copyOptionGroupResponse_optionGroup :: Lens' CopyOptionGroupResponse (Maybe OptionGroup) Source #

Undocumented member.

copyOptionGroupResponse_httpStatus :: Lens' CopyOptionGroupResponse Int Source #

The response's http status code.

CreateBlueGreenDeployment

createBlueGreenDeployment_tags :: Lens' CreateBlueGreenDeployment (Maybe [Tag]) Source #

Tags to assign to the blue/green deployment.

createBlueGreenDeployment_targetDBClusterParameterGroupName :: Lens' CreateBlueGreenDeployment (Maybe Text) Source #

The DB cluster parameter group associated with the Aurora DB cluster in the green environment.

To test parameter changes, specify a DB cluster parameter group that is different from the one associated with the source DB cluster.

createBlueGreenDeployment_targetDBParameterGroupName :: Lens' CreateBlueGreenDeployment (Maybe Text) Source #

The DB parameter group associated with the DB instance in the green environment.

To test parameter changes, specify a DB parameter group that is different from the one associated with the source DB instance.

createBlueGreenDeployment_targetEngineVersion :: Lens' CreateBlueGreenDeployment (Maybe Text) Source #

The engine version of the database in the green environment.

Specify the engine version to upgrade to in the green environment.

createBlueGreenDeployment_blueGreenDeploymentName :: Lens' CreateBlueGreenDeployment Text Source #

The name of the blue/green deployment.

Constraints:

Can't be the same as an existing blue/green deployment name in the same account and Amazon Web Services Region.

createBlueGreenDeployment_source :: Lens' CreateBlueGreenDeployment Text Source #

The Amazon Resource Name (ARN) of the source production database.

Specify the database that you want to clone. The blue/green deployment creates this database in the green environment. You can make updates to the database in the green environment, such as an engine version upgrade. When you are ready, you can switch the database in the green environment to be the production database.

createBlueGreenDeploymentResponse_blueGreenDeployment :: Lens' CreateBlueGreenDeploymentResponse (Maybe BlueGreenDeployment) Source #

Undocumented member.

createBlueGreenDeploymentResponse_httpStatus :: Lens' CreateBlueGreenDeploymentResponse Int Source #

The response's http status code.

CreateCustomDBEngineVersion

createCustomDBEngineVersion_databaseInstallationFilesS3BucketName :: Lens' CreateCustomDBEngineVersion (Maybe Text) Source #

The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is my-custom-installation-files.

createCustomDBEngineVersion_databaseInstallationFilesS3Prefix :: Lens' CreateCustomDBEngineVersion (Maybe Text) Source #

The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is 123456789012/cev1. If this setting isn't specified, no prefix is assumed.

createCustomDBEngineVersion_description :: Lens' CreateCustomDBEngineVersion (Maybe Text) Source #

An optional description of your CEV.

createCustomDBEngineVersion_imageId :: Lens' CreateCustomDBEngineVersion (Maybe Text) Source #

The ID of the AMI. An AMI ID is required to create a CEV for RDS Custom for SQL Server.

createCustomDBEngineVersion_kmsKeyId :: Lens' CreateCustomDBEngineVersion (Maybe Text) Source #

The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS.

If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in Creating a symmetric encryption KMS key in the Amazon Web Services Key Management Service Developer Guide.

You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.

createCustomDBEngineVersion_manifest :: Lens' CreateCustomDBEngineVersion (Maybe Text) Source #

The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.

The following JSON fields are valid:

MediaImportTemplateVersion: Version of the CEV manifest. The date is in the format YYYY-MM-DD.
databaseInstallationFileNames: Ordered list of installation files for the CEV.
opatchFileNames: Ordered list of OPatch installers used for the Oracle DB engine.
psuRuPatchFileNames: The PSU and RU patches for this CEV.
OtherPatchFileNames: The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches.

For more information, see Creating the CEV manifest in the Amazon RDS User Guide.

createCustomDBEngineVersion_tags :: Lens' CreateCustomDBEngineVersion (Maybe [Tag]) Source #

Undocumented member.

createCustomDBEngineVersion_engine :: Lens' CreateCustomDBEngineVersion Text Source #

The database engine to use for your custom engine version (CEV). The only supported value is custom-oracle-ee.

createCustomDBEngineVersion_engineVersion :: Lens' CreateCustomDBEngineVersion Text Source #

The name of your CEV. The name format is 19.customized_string. For example, a valid CEV name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region.

dbEngineVersion_createTime :: Lens' DBEngineVersion (Maybe UTCTime) Source #

The creation time of the DB engine version.

dbEngineVersion_customDBEngineVersionManifest :: Lens' DBEngineVersion (Maybe Text) Source #

JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide.

dbEngineVersion_dbEngineDescription :: Lens' DBEngineVersion (Maybe Text) Source #

The description of the database engine.

dbEngineVersion_dbEngineMediaType :: Lens' DBEngineVersion (Maybe Text) Source #

A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.

dbEngineVersion_dbEngineVersionArn :: Lens' DBEngineVersion (Maybe Text) Source #

The ARN of the custom engine version.

dbEngineVersion_dbEngineVersionDescription :: Lens' DBEngineVersion (Maybe Text) Source #

The description of the database engine version.

dbEngineVersion_dbParameterGroupFamily :: Lens' DBEngineVersion (Maybe Text) Source #

The name of the DB parameter group family for the database engine.

dbEngineVersion_databaseInstallationFilesS3BucketName :: Lens' DBEngineVersion (Maybe Text) Source #

The name of the Amazon S3 bucket that contains your database installation files.

dbEngineVersion_databaseInstallationFilesS3Prefix :: Lens' DBEngineVersion (Maybe Text) Source #

The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.

dbEngineVersion_defaultCharacterSet :: Lens' DBEngineVersion (Maybe CharacterSet) Source #

The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.

dbEngineVersion_engine :: Lens' DBEngineVersion (Maybe Text) Source #

The name of the database engine.

dbEngineVersion_engineVersion :: Lens' DBEngineVersion (Maybe Text) Source #

The version number of the database engine.

dbEngineVersion_exportableLogTypes :: Lens' DBEngineVersion (Maybe [Text]) Source #

The types of logs that the database engine has available for export to CloudWatch Logs.

dbEngineVersion_image :: Lens' DBEngineVersion (Maybe CustomDBEngineVersionAMI) Source #

The EC2 image

dbEngineVersion_kmsKeyId :: Lens' DBEngineVersion (Maybe Text) Source #

The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.

dbEngineVersion_majorEngineVersion :: Lens' DBEngineVersion (Maybe Text) Source #

The major engine version of the CEV.

dbEngineVersion_status :: Lens' DBEngineVersion (Maybe Text) Source #

The status of the DB engine version, either available or deprecated.

dbEngineVersion_supportedCACertificateIdentifiers :: Lens' DBEngineVersion (Maybe [Text]) Source #

A list of the supported CA certificate identifiers.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

dbEngineVersion_supportedCharacterSets :: Lens' DBEngineVersion (Maybe [CharacterSet]) Source #

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.

dbEngineVersion_supportedEngineModes :: Lens' DBEngineVersion (Maybe [Text]) Source #

A list of the supported DB engine modes.

dbEngineVersion_supportedFeatureNames :: Lens' DBEngineVersion (Maybe [Text]) Source #

A list of features supported by the DB engine.

The supported features vary by DB engine and DB engine version.

To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:

aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>

For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:

aws rds describe-db-engine-versions --engine postgres --engine-version 13.3

The supported features are listed under SupportedFeatureNames in the output.

dbEngineVersion_supportedNcharCharacterSets :: Lens' DBEngineVersion (Maybe [CharacterSet]) Source #

A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.

dbEngineVersion_supportedTimezones :: Lens' DBEngineVersion (Maybe [Timezone]) Source #

A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

dbEngineVersion_supportsBabelfish :: Lens' DBEngineVersion (Maybe Bool) Source #

A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.

dbEngineVersion_supportsCertificateRotationWithoutRestart :: Lens' DBEngineVersion (Maybe Bool) Source #

A value that indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.

dbEngineVersion_supportsGlobalDatabases :: Lens' DBEngineVersion (Maybe Bool) Source #

A value that indicates whether you can use Aurora global databases with a specific DB engine version.

dbEngineVersion_supportsLogExportsToCloudwatchLogs :: Lens' DBEngineVersion (Maybe Bool) Source #

A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

dbEngineVersion_supportsParallelQuery :: Lens' DBEngineVersion (Maybe Bool) Source #

A value that indicates whether you can use Aurora parallel query with a specific DB engine version.

dbEngineVersion_supportsReadReplica :: Lens' DBEngineVersion (Maybe Bool) Source #

Indicates whether the database engine version supports read replicas.

dbEngineVersion_tagList :: Lens' DBEngineVersion (Maybe [Tag]) Source #

Undocumented member.

dbEngineVersion_validUpgradeTarget :: Lens' DBEngineVersion (Maybe [UpgradeTarget]) Source #

A list of engine versions that this database engine version can be upgraded to.

CreateDBCluster

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

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

This setting is required to create a Multi-AZ DB cluster.

Valid for: Multi-AZ DB clusters only

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

A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.

Valid for: Multi-AZ DB clusters only

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

A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.

For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

createDBCluster_backtrackWindow :: 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).

Valid for: Aurora MySQL DB clusters only

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

The number of days for which automated backups are retained.

Default: 1

Constraints:

Must be a value from 1 to 35

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

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

Valid for: Aurora DB clusters only

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

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.

This setting is required to create a Multi-AZ DB cluster.

Valid for: Multi-AZ DB clusters only

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

The name of the DB cluster parameter group to associate with this DB cluster. If you do not specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.

Constraints:

If supplied, must match the name of an existing DB cluster parameter group.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

A DB subnet group to associate with this DB cluster.

This setting is required to create a Multi-AZ DB cluster.

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

Example: mydbsubnetgroup

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

Reserved for future use.

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

The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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 isn't enabled.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

Pseudo-parameter used when populating the PreSignedUrl of a cross-region CreateDBCluster request. To replicate from region SRC to region DST, send a request to region DST. In that request, pass a PreSignedUrl for region SRC with DestinationRegion set to region DST.

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

The Active Directory directory ID to create the DB cluster in.

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.

For more information, see Kerberos authentication in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

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

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Valid for: Aurora DB clusters only

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

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used.

RDS for MySQL

Possible values are error, general, and slowquery.

RDS for PostgreSQL

Possible values are postgresql and upgrade.

Aurora MySQL

Possible values are audit, error, general, and slowquery.

Aurora PostgreSQL

Possible value is postgresql.

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.

Valid for: Aurora DB clusters only

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

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint is disabled.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

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

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

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

A value that indicates whether to turn on Performance Insights for the DB cluster.

For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

Valid for: Multi-AZ DB clusters only

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

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.

The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions.

The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.

The serverless engine mode only applies for Aurora Serverless v1 DB clusters.

For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported.

Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the /Amazon Aurora User Guide/:

Valid for: Aurora DB clusters only

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

The version number of the database engine to use.

To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:

aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:

aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for RDS for MySQL, use the following command:

aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"

Aurora MySQL

For information, see MySQL on Amazon RDS Versions in the Amazon Aurora User Guide.

Aurora PostgreSQL

For information, see Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.

MySQL

For information, see MySQL on Amazon RDS Versions in the Amazon RDS User Guide.

PostgreSQL

For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.

Valid for: Aurora DB clusters only

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

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.

This setting is required to create a Multi-AZ DB cluster.

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

Valid for: Multi-AZ DB clusters only

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

The Amazon Web Services KMS key identifier for an encrypted DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

When a KMS key isn't specified in KmsKeyId:

If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the KMS key used to encrypt the source. Otherwise, Amazon RDS will use your default KMS key.
If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS will use your default KMS key.

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you must set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.

Constraints:

Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

createDBCluster_masterUserPassword :: 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.
Can't be specified if ManageMasterUserPassword is turned on.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

createDBCluster_masterUsername :: 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.
Can't be a reserved word for the chosen database engine.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

Valid for: Multi-AZ DB clusters only

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

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting up and enabling Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

Valid for: Multi-AZ DB clusters only

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

The network type of the DB cluster.

Valid values:

```
IPV4
```
```
DUAL
```

The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

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

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

DB clusters are associated with a default option group that can't be modified.

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

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

Valid for: Multi-AZ DB clusters only

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

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

7
month * 31, where month is a number of months from 1-23
731

For example, the following values are valid:

93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

Valid for: Multi-AZ DB clusters only

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

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

RDS for MySQL and Aurora MySQL

Default: 3306

Valid values: 1150-65535

RDS for PostgreSQL and Aurora PostgreSQL

Default: 5432

Valid values: 1150-65535

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another, an URL that contains a Signature Version 4 signed request for the CreateDBCluster operation to be called in the source Amazon Web Services Region where the DB cluster is replicated from. Specify PreSignedUrl only when you are performing cross-Region replication from an encrypted DB cluster.

The presigned URL must be a valid request for the CreateDBCluster API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster to copy.

The presigned URL request must contain the following parameter values:

KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the CreateDBCluster operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
DestinationRegion - The name of the Amazon Web Services 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 Amazon Web Services Region. For example, if you are copying an encrypted DB cluster from the us-west-2 Amazon Web Services 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 (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.

Valid for: Aurora DB clusters only

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. To view the time blocks available, see Backup window in the Amazon Aurora 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.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

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

Constraints: Minimum 30-minute window.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

A value that indicates whether the DB cluster is publicly accessible.

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

Valid for: Multi-AZ DB clusters only

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.

Valid for: Aurora DB clusters only

createDBCluster_scalingConfiguration :: Lens' CreateDBCluster (Maybe ScalingConfiguration) Source #

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

Valid for: Aurora DB clusters only

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

Undocumented member.

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

A value that indicates whether the DB cluster is encrypted.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

Specifies the storage type to be associated with the DB cluster.

This setting is required to create a Multi-AZ DB cluster.

Valid values: io1

When specified, a value for the Iops parameter is required.

Default: io1

Valid for: Multi-AZ DB clusters only

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

Tags to assign to the DB cluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

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

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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.
Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

Valid for: Aurora DB clusters and Multi-AZ DB clusters

createDBCluster_engine :: 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 and MySQL 8.0-compatible Aurora)
```
aurora-postgresql
```
```
mysql
```
```
postgres
```

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

Undocumented member.

createDBClusterResponse_httpStatus :: Lens' CreateDBClusterResponse Int Source #

The response's http status code.

CreateDBClusterEndpoint

createDBClusterEndpoint_excludedMembers :: Lens' CreateDBClusterEndpoint (Maybe [Text]) Source #

List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. This parameter is relevant only if the list of static members is empty.

createDBClusterEndpoint_staticMembers :: Lens' CreateDBClusterEndpoint (Maybe [Text]) Source #

List of DB instance identifiers that are part of the custom endpoint group.

createDBClusterEndpoint_tags :: Lens' CreateDBClusterEndpoint (Maybe [Tag]) Source #

The tags to be assigned to the Amazon RDS resource.

createDBClusterEndpoint_dbClusterIdentifier :: Lens' CreateDBClusterEndpoint Text Source #

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

createDBClusterEndpoint_dbClusterEndpointIdentifier :: Lens' CreateDBClusterEndpoint Text Source #

The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

createDBClusterEndpoint_endpointType :: Lens' CreateDBClusterEndpoint Text Source #

The type of the endpoint, one of: READER, WRITER, ANY.

dbClusterEndpoint_customEndpointType :: Lens' DBClusterEndpoint (Maybe Text) Source #

The type associated with a custom endpoint. One of: READER, WRITER, ANY.

dbClusterEndpoint_dbClusterEndpointArn :: Lens' DBClusterEndpoint (Maybe Text) Source #

The Amazon Resource Name (ARN) for the endpoint.

dbClusterEndpoint_dbClusterEndpointIdentifier :: Lens' DBClusterEndpoint (Maybe Text) Source #

The identifier associated with the endpoint. This parameter is stored as a lowercase string.

dbClusterEndpoint_dbClusterEndpointResourceIdentifier :: Lens' DBClusterEndpoint (Maybe Text) Source #

A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

dbClusterEndpoint_dbClusterIdentifier :: Lens' DBClusterEndpoint (Maybe Text) Source #

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

dbClusterEndpoint_endpoint :: Lens' DBClusterEndpoint (Maybe Text) Source #

The DNS address of the endpoint.

dbClusterEndpoint_endpointType :: Lens' DBClusterEndpoint (Maybe Text) Source #

The type of the endpoint. One of: READER, WRITER, CUSTOM.

dbClusterEndpoint_excludedMembers :: Lens' DBClusterEndpoint (Maybe [Text]) Source #

List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

dbClusterEndpoint_staticMembers :: Lens' DBClusterEndpoint (Maybe [Text]) Source #

List of DB instance identifiers that are part of the custom endpoint group.

dbClusterEndpoint_status :: Lens' DBClusterEndpoint (Maybe Text) Source #

The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.

CreateDBClusterParameterGroup

createDBClusterParameterGroup_tags :: Lens' CreateDBClusterParameterGroup (Maybe [Tag]) Source #

Tags to assign to the DB cluster parameter group.

createDBClusterParameterGroup_dbClusterParameterGroupName :: Lens' CreateDBClusterParameterGroup Text Source #

The name of the DB cluster parameter group.

Constraints:

Must not match the name of an existing DB cluster parameter group.

This value is stored as a lowercase string.

createDBClusterParameterGroup_dbParameterGroupFamily :: Lens' CreateDBClusterParameterGroup Text Source #

The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

Aurora MySQL

Example: aurora5.6, aurora-mysql5.7, aurora-mysql8.0

Aurora PostgreSQL

Example: aurora-postgresql9.6

RDS for MySQL

Example: mysql8.0

RDS for PostgreSQL

Example: postgres12

To list all of the available parameter group families for a DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>

For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql

The output contains duplicates.

The following are the valid DB engine values:

aurora (for MySQL 5.6-compatible Aurora)
aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
```
aurora-postgresql
```
```
mysql
```
```
postgres
```

createDBClusterParameterGroup_description :: Lens' CreateDBClusterParameterGroup Text Source #

The description for the DB cluster parameter group.

createDBClusterParameterGroupResponse_dbClusterParameterGroup :: Lens' CreateDBClusterParameterGroupResponse (Maybe DBClusterParameterGroup) Source #

Undocumented member.

createDBClusterParameterGroupResponse_httpStatus :: Lens' CreateDBClusterParameterGroupResponse Int Source #

The response's http status code.

CreateDBClusterSnapshot

createDBClusterSnapshot_tags :: Lens' CreateDBClusterSnapshot (Maybe [Tag]) Source #

The tags to be assigned to the DB cluster snapshot.

createDBClusterSnapshot_dbClusterSnapshotIdentifier :: Lens' CreateDBClusterSnapshot Text Source #

The identifier of the DB cluster snapshot. 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.
Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1-snapshot1

createDBClusterSnapshot_dbClusterIdentifier :: Lens' CreateDBClusterSnapshot Text Source #

The identifier of the DB cluster to create a snapshot for. This parameter isn't case-sensitive.

Constraints:

Must match the identifier of an existing DBCluster.

Example: my-cluster1

createDBClusterSnapshotResponse_dbClusterSnapshot :: Lens' CreateDBClusterSnapshotResponse (Maybe DBClusterSnapshot) Source #

Undocumented member.

createDBClusterSnapshotResponse_httpStatus :: Lens' CreateDBClusterSnapshotResponse Int Source #

The response's http status code.

CreateDBInstance

createDBInstance_allocatedStorage :: Lens' CreateDBInstance (Maybe Int) Source #

The amount of storage in gibibytes (GiB) to allocate for the DB instance.

Type: Integer

Amazon Aurora

Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.

Amazon RDS Custom

Constraints to the amount of storage for each storage type are the following:

General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.

MySQL

Constraints to the amount of storage for each storage type are the following:

General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.

MariaDB

Constraints to the amount of storage for each storage type are the following:

General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.

PostgreSQL

Constraints to the amount of storage for each storage type are the following:

General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.

Oracle

Constraints to the amount of storage for each storage type are the following:

General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 10 to 3072.

SQL Server

Constraints to the amount of storage for each storage type are the following:

General Purpose (SSD) storage (gp2, gp3):
- Enterprise and Standard editions: Must be an integer from 20 to 16384.
- Web and Express editions: Must be an integer from 20 to 16384.
Provisioned IOPS storage (io1):
- Enterprise and Standard editions: Must be an integer from 100 to 16384.
- Web and Express editions: Must be an integer from 100 to 16384.
Magnetic storage (standard):
- Enterprise and Standard editions: Must be an integer from 20 to 1024.
- Web and Express editions: Must be an integer from 20 to 1024.

createDBInstance_autoMinorVersionUpgrade :: Lens' CreateDBInstance (Maybe Bool) Source #

A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.

If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to false.

createDBInstance_availabilityZone :: Lens' CreateDBInstance (Maybe Text) Source #

The Availability Zone (AZ) where the database will be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.

Amazon Aurora

Each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.

createDBInstance_backupRetentionPeriod :: Lens' CreateDBInstance (Maybe Int) Source #

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Amazon Aurora

Not applicable. The retention period for automated backups is managed by the DB cluster.

Default: 1

Constraints:

Must be a value from 0 to 35
Can't be set to 0 if the DB instance is a source to read replicas
Can't be set to 0 for an RDS Custom for Oracle DB instance

createDBInstance_backupTarget :: Lens' CreateDBInstance (Maybe Text) Source #

Specifies where automated backups and manual snapshots are stored.

Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

createDBInstance_cACertificateIdentifier :: Lens' CreateDBInstance (Maybe Text) Source #

Specifies the CA certificate identifier to use for the DB instance’s server certificate.

This setting doesn't apply to RDS Custom.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

createDBInstance_characterSetName :: Lens' CreateDBInstance (Maybe Text) Source #

For supported engines, this value indicates that the DB instance should be associated with the specified CharacterSet.

This setting doesn't apply to RDS Custom. However, if you need to change the character set, you can change it on the database itself.

Amazon Aurora

Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.

createDBInstance_copyTagsToSnapshot :: Lens' CreateDBInstance (Maybe Bool) Source #

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.

createDBInstance_customIamInstanceProfile :: Lens' CreateDBInstance (Maybe Text) Source #

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

This setting is required for RDS Custom.

createDBInstance_dbClusterIdentifier :: Lens' CreateDBInstance (Maybe Text) Source #

The identifier of the DB cluster that the instance will belong to.

This setting doesn't apply to RDS Custom.

createDBInstance_dbName :: Lens' CreateDBInstance (Maybe Text) Source #

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

Must contain 1 to 64 letters or numbers.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine

MariaDB

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

Must contain 1 to 64 letters or numbers.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine

PostgreSQL

The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres is created in the DB instance.

Constraints:

Must contain 1 to 63 letters, numbers, or underscores.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine

Oracle

The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName.

Default: ORCL

Constraints:

Can't be longer than 8 characters

Amazon RDS Custom for Oracle

The Oracle System ID (SID) of the created RDS Custom DB instance. If you don't specify a value, the default value is ORCL.

Default: ORCL

Constraints:

It must contain 1 to 8 alphanumeric characters.
It must contain a letter.
It can't be a word reserved by the database engine.

Amazon RDS Custom for SQL Server

Not applicable. Must be null.

SQL Server

Not applicable. Must be null.

Amazon Aurora MySQL

The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created in the DB cluster.

Constraints:

It must contain 1 to 64 alphanumeric characters.
It can't be a word reserved by the database engine.

Amazon Aurora PostgreSQL

The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, a database named postgres is created in the DB cluster.

Constraints:

It must contain 1 to 63 alphanumeric characters.
It must begin with a letter. Subsequent characters can be letters, underscores, or digits (0 to 9).
It can't be a word reserved by the database engine.

createDBInstance_dbParameterGroupName :: Lens' CreateDBInstance (Maybe Text) Source #

The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then the default DB parameter group for the specified DB engine and version is used.

This setting doesn't apply to RDS Custom.

Constraints:

It must be 1 to 255 letters, numbers, or hyphens.
The first character must be a letter.
It can't end with a hyphen or contain two consecutive hyphens.

createDBInstance_dbSecurityGroups :: Lens' CreateDBInstance (Maybe [Text]) Source #

A list of DB security groups to associate with this DB instance.

This setting applies to the legacy EC2-Classic platform, which is no longer used to create new DB instances. Use the VpcSecurityGroupIds setting instead.

createDBInstance_dbSubnetGroupName :: Lens' CreateDBInstance (Maybe Text) Source #

A DB subnet group to associate with this DB instance.

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

Example: mydbsubnetgroup

createDBInstance_deletionProtection :: Lens' CreateDBInstance (Maybe Bool) Source #

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.

Amazon Aurora

Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see CreateDBCluster. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.

createDBInstance_domain :: Lens' CreateDBInstance (Maybe Text) Source #

The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable. The domain is managed by the DB cluster.

createDBInstance_domainIAMRoleName :: Lens' CreateDBInstance (Maybe Text) Source #

Specify the name of the IAM role to be used when making API calls to the Directory Service.

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable. The domain is managed by the DB cluster.

createDBInstance_enableCloudwatchLogsExports :: Lens' CreateDBInstance (Maybe [Text]) Source #

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. CloudWatch Logs exports are managed by the DB cluster.

RDS Custom

Not applicable.

MariaDB

Possible values are audit, error, general, and slowquery.

Microsoft SQL Server

Possible values are agent and error.

MySQL

Possible values are audit, error, general, and slowquery.

Oracle

Possible values are alert, audit, listener, trace, and oemagent.

PostgreSQL

Possible values are postgresql and upgrade.

createDBInstance_enableCustomerOwnedIp :: Lens' CreateDBInstance (Maybe Bool) Source #

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

createDBInstance_enableIAMDatabaseAuthentication :: Lens' CreateDBInstance (Maybe Bool) Source #

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.

createDBInstance_enablePerformanceInsights :: Lens' CreateDBInstance (Maybe Bool) Source #

A value that indicates whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

This setting doesn't apply to RDS Custom.

createDBInstance_engineVersion :: Lens' CreateDBInstance (Maybe Text) Source #

The version number of the database engine to use.

For a list of valid engine versions, use the DescribeDBEngineVersions operation.

The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every Amazon Web Services Region.

Amazon Aurora

Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.

Amazon RDS Custom for Oracle

A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV name has the following format: 19.customized_string. A valid CEV name is 19.my_cev1. For more information, see Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.

Amazon RDS Custom for SQL Server

See RDS Custom for SQL Server general requirements in the Amazon RDS User Guide.

MariaDB

For information, see MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.

Microsoft SQL Server

For information, see Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide.

MySQL

For information, see MySQL on Amazon RDS Versions in the Amazon RDS User Guide.

Oracle

For information, see Oracle Database Engine Release Notes in the Amazon RDS User Guide.

PostgreSQL

For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.

createDBInstance_iops :: Lens' CreateDBInstance (Maybe Int) Source #

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid IOPS values, see Amazon RDS DB instance storage in the Amazon RDS User Guide.

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.

Amazon Aurora

Not applicable. Storage is managed by the DB cluster.

createDBInstance_kmsKeyId :: Lens' CreateDBInstance (Maybe Text) Source #

The Amazon Web Services KMS key identifier for an encrypted DB instance.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

Amazon Aurora

Not applicable. The Amazon Web Services KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.

If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

Amazon RDS Custom

A KMS key is required for RDS Custom instances. For most RDS engines, if you leave this parameter empty while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom doesn't use the default key when this parameter is empty. You must explicitly specify a key.

createDBInstance_licenseModel :: Lens' CreateDBInstance (Maybe Text) Source #

License model information for this DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable.

createDBInstance_manageMasterUserPassword :: Lens' CreateDBInstance (Maybe Bool) Source #

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.

Constraints:

Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.

createDBInstance_masterUserPassword :: Lens' CreateDBInstance (Maybe Text) Source #

The password for the master user. The password can include any printable ASCII character except "/", """, or "@".

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster.

Constraints: Can't be specified if ManageMasterUserPassword is turned on.

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

createDBInstance_masterUserSecretKmsKeyId :: Lens' CreateDBInstance (Maybe Text) Source #

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

createDBInstance_masterUsername :: Lens' CreateDBInstance (Maybe Text) Source #

The name for the master user.

Amazon Aurora

Not applicable. The name for the master user is managed by the DB cluster.

Amazon RDS

Constraints:

Required.
Must be 1 to 16 letters, numbers, or underscores.
First character must be a letter.
Can't be a reserved word for the chosen database engine.

createDBInstance_maxAllocatedStorage :: Lens' CreateDBInstance (Maybe Int) Source #

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable. Storage is managed by the DB cluster.

createDBInstance_monitoringInterval :: Lens' CreateDBInstance (Maybe Int) Source #

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0.

This setting doesn't apply to RDS Custom.

Valid Values: 0, 1, 5, 10, 15, 30, 60

createDBInstance_monitoringRoleArn :: Lens' CreateDBInstance (Maybe Text) Source #

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

This setting doesn't apply to RDS Custom.

createDBInstance_multiAZ :: Lens' CreateDBInstance (Maybe Bool) Source #

A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable. DB instance Availability Zones (AZs) are managed by the DB cluster.

createDBInstance_ncharCharacterSetName :: Lens' CreateDBInstance (Maybe Text) Source #

The name of the NCHAR character set for the Oracle DB instance.

This parameter doesn't apply to RDS Custom.

createDBInstance_networkType :: Lens' CreateDBInstance (Maybe Text) Source #

The network type of the DB instance.

Valid values:

```
IPV4
```
```
DUAL
```

The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

createDBInstance_optionGroupName :: Lens' CreateDBInstance (Maybe Text) Source #

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

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance after it is associated with a DB instance.

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable.

createDBInstance_performanceInsightsKMSKeyId :: Lens' CreateDBInstance (Maybe Text) Source #

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

This setting doesn't apply to RDS Custom.

createDBInstance_performanceInsightsRetentionPeriod :: Lens' CreateDBInstance (Maybe Int) Source #

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

7
month * 31, where month is a number of months from 1-23
731

For example, the following values are valid:

93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

This setting doesn't apply to RDS Custom.

createDBInstance_port :: Lens' CreateDBInstance (Maybe Int) Source #

The port number on which the database accepts connections.

MySQL

Default: 3306

Valid values: 1150-65535

Type: Integer

MariaDB

Default: 3306

Valid values: 1150-65535

Type: Integer

PostgreSQL

Default: 5432

Valid values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid values: 1150-65535

SQL Server

Default: 1433

Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156.

Amazon Aurora

Default: 3306

Valid values: 1150-65535

Type: Integer

createDBInstance_preferredBackupWindow :: Lens' CreateDBInstance (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. For more information, see Backup window in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster.

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.

createDBInstance_preferredMaintenanceWindow :: Lens' CreateDBInstance (Maybe Text) Source #

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.

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.

createDBInstance_processorFeatures :: Lens' CreateDBInstance (Maybe [ProcessorFeature]) Source #

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable.

createDBInstance_promotionTier :: Lens' CreateDBInstance (Maybe Int) Source #

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

This setting doesn't apply to RDS Custom.

Default: 1

Valid Values: 0 - 15

createDBInstance_publiclyAccessible :: Lens' CreateDBInstance (Maybe Bool) Source #

A value that indicates whether the DB instance is publicly accessible.

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB instance is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB instance is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB instance is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB instance is public.

createDBInstance_storageEncrypted :: Lens' CreateDBInstance (Maybe Bool) Source #

A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

For RDS Custom instances, either set this parameter to true or leave it unset. If you set this parameter to false, RDS reports an error.

Amazon Aurora

Not applicable. The encryption for DB instances is managed by the DB cluster.

createDBInstance_storageThroughput :: Lens' CreateDBInstance (Maybe Int) Source #

Specifies the storage throughput value for the DB instance.

This setting applies only to the gp3 storage type.

This setting doesn't apply to RDS Custom or Amazon Aurora.

createDBInstance_storageType :: Lens' CreateDBInstance (Maybe Text) Source #

Specifies the storage type to be associated with the DB instance.

Valid values: gp2 | gp3 | io1 | standard

If you specify io1 or gp3, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise gp2

Amazon Aurora

Not applicable. Storage is managed by the DB cluster.

createDBInstance_tags :: Lens' CreateDBInstance (Maybe [Tag]) Source #

Tags to assign to the DB instance.

createDBInstance_tdeCredentialArn :: Lens' CreateDBInstance (Maybe Text) Source #

The ARN from the key store with which to associate the instance for TDE encryption.

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable.

createDBInstance_tdeCredentialPassword :: Lens' CreateDBInstance (Maybe Text) Source #

The password for the given ARN from the key store in order to access the device.

This setting doesn't apply to RDS Custom.

createDBInstance_timezone :: Lens' CreateDBInstance (Maybe Text) Source #

The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.

createDBInstance_vpcSecurityGroupIds :: Lens' CreateDBInstance (Maybe [Text]) Source #

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

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

createDBInstance_dbInstanceIdentifier :: Lens' CreateDBInstance Text Source #

The DB instance 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.
Can't end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

createDBInstance_dbInstanceClass :: Lens' CreateDBInstance Text Source #

The compute and memory capacity of the DB instance, for example db.m5.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide.

createDBInstance_engine :: Lens' CreateDBInstance Text Source #

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

Not every database engine is available for every Amazon Web Services Region.

Valid Values:

aurora (for MySQL 5.6-compatible Aurora)
aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
```
aurora-postgresql
```

custom-oracle-ee (for RDS Custom for Oracle instances)

custom-sqlserver-ee (for RDS Custom for SQL Server instances)

custom-sqlserver-se (for RDS Custom for SQL Server instances)

custom-sqlserver-web (for RDS Custom for SQL Server instances)

```
mariadb
```
```
mysql
```
```
oracle-ee
```
```
oracle-ee-cdb
```
```
oracle-se2
```
```
oracle-se2-cdb
```
```
postgres
```
```
sqlserver-ee
```
```
sqlserver-se
```
```
sqlserver-ex
```
```
sqlserver-web
```

createDBInstanceResponse_dbInstance :: Lens' CreateDBInstanceResponse (Maybe DBInstance) Source #

Undocumented member.

createDBInstanceResponse_httpStatus :: Lens' CreateDBInstanceResponse Int Source #

The response's http status code.

CreateDBInstanceReadReplica

createDBInstanceReadReplica_autoMinorVersionUpgrade :: Lens' CreateDBInstanceReadReplica (Maybe Bool) Source #

A value that indicates whether minor engine upgrades are applied automatically to the read replica during the maintenance window.

This setting doesn't apply to RDS Custom.

Default: Inherits from the source DB instance

createDBInstanceReadReplica_availabilityZone :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

The Availability Zone (AZ) where the read replica will be created.

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

Example: us-east-1d

createDBInstanceReadReplica_copyTagsToSnapshot :: Lens' CreateDBInstanceReadReplica (Maybe Bool) Source #

A value that indicates whether to copy all tags from the read replica to snapshots of the read replica. By default, tags are not copied.

createDBInstanceReadReplica_customIamInstanceProfile :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

This setting is required for RDS Custom.

createDBInstanceReadReplica_dbInstanceClass :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

The compute and memory capacity of the read replica, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Default: Inherits from the source DB instance.

createDBInstanceReadReplica_dbParameterGroupName :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

The name of the DB parameter group to associate with this DB instance.

If you do not specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of source DB instance for a same Region read replica, or the default DBParameterGroup for the specified DB engine for a cross-Region read replica.

Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. It isn't supported for RDS Custom.

Constraints:

Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

createDBInstanceReadReplica_dbSubnetGroupName :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.

Constraints:

Can only be specified if the source DB instance identifier specifies a DB instance in another Amazon Web Services Region.
If supplied, must match the name of an existing DBSubnetGroup.
The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.
All read replicas in one Amazon Web Services Region that are created from the same source DB instance must either:>
- Specify DB subnet groups from the same VPC. All these read replicas are created in the same VPC.
- Not specify a DB subnet group. All these read replicas are created outside of any VPC.

Example: mydbsubnetgroup

createDBInstanceReadReplica_deletionProtection :: Lens' CreateDBInstanceReadReplica (Maybe Bool) Source #

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.

createDBInstanceReadReplica_destinationRegion :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

Pseudo-parameter used when populating the PreSignedUrl of a cross-region CreateDBInstanceReadReplica request. To replicate from region SRC to region DST, send a request to region DST. In that request, pass a PreSignedUrl for region SRC with DestinationRegion set to region DST.

createDBInstanceReadReplica_domain :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

This setting doesn't apply to RDS Custom.

createDBInstanceReadReplica_domainIAMRoleName :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

Specify the name of the IAM role to be used when making API calls to the Directory Service.

This setting doesn't apply to RDS Custom.

createDBInstanceReadReplica_enableCloudwatchLogsExports :: Lens' CreateDBInstanceReadReplica (Maybe [Text]) Source #

The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

This setting doesn't apply to RDS Custom.

createDBInstanceReadReplica_enableCustomerOwnedIp :: Lens' CreateDBInstanceReadReplica (Maybe Bool) Source #

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts read replica.

A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the read replica from outside of its virtual private cloud (VPC) on your local network.

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

createDBInstanceReadReplica_enableIAMDatabaseAuthentication :: Lens' CreateDBInstanceReadReplica (Maybe Bool) Source #

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

This setting doesn't apply to RDS Custom.

createDBInstanceReadReplica_enablePerformanceInsights :: Lens' CreateDBInstanceReadReplica (Maybe Bool) Source #

A value that indicates whether to enable Performance Insights for the read replica.

For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

This setting doesn't apply to RDS Custom.

createDBInstanceReadReplica_iops :: Lens' CreateDBInstanceReadReplica (Maybe Int) Source #

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

createDBInstanceReadReplica_kmsKeyId :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

The Amazon Web Services KMS key identifier for an encrypted read replica.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance, then do not specify a value for this parameter. A read replica in the same Amazon Web Services Region is always encrypted with the same KMS key as the source DB instance.

If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.

You can't create an encrypted read replica from an unencrypted DB instance.

This setting doesn't apply to RDS Custom, which uses the same KMS key as the primary replica.

createDBInstanceReadReplica_maxAllocatedStorage :: Lens' CreateDBInstanceReadReplica (Maybe Int) Source #

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.

createDBInstanceReadReplica_monitoringInterval :: Lens' CreateDBInstanceReadReplica (Maybe Int) Source #

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

This setting doesn't apply to RDS Custom.

Valid Values: 0, 1, 5, 10, 15, 30, 60

createDBInstanceReadReplica_monitoringRoleArn :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

This setting doesn't apply to RDS Custom.

createDBInstanceReadReplica_multiAZ :: Lens' CreateDBInstanceReadReplica (Maybe Bool) Source #

A value that indicates whether the read replica is in a Multi-AZ deployment.

You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your read replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.

This setting doesn't apply to RDS Custom.

createDBInstanceReadReplica_networkType :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

The network type of the DB instance.

Valid values:

```
IPV4
```
```
DUAL
```

The network type is determined by the DBSubnetGroup specified for read replica. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

createDBInstanceReadReplica_optionGroupName :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.

For SQL Server, you must use the option group associated with the source instance.

This setting doesn't apply to RDS Custom.

createDBInstanceReadReplica_performanceInsightsKMSKeyId :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

This setting doesn't apply to RDS Custom.

createDBInstanceReadReplica_performanceInsightsRetentionPeriod :: Lens' CreateDBInstanceReadReplica (Maybe Int) Source #

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

7
month * 31, where month is a number of months from 1-23
731

For example, the following values are valid:

93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

This setting doesn't apply to RDS Custom.

createDBInstanceReadReplica_port :: Lens' CreateDBInstanceReadReplica (Maybe Int) Source #

The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

createDBInstanceReadReplica_preSignedUrl :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API operation in the source Amazon Web Services Region that contains the source DB instance.

This setting applies only to Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.

You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web Services Region.

The presigned URL must be a valid request for the CreateDBInstanceReadReplica API operation that can run in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:

DestinationRegion - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica operation is called that contains this presigned URL.
For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica operation in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.
KmsKeyId - The KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.

SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server doesn't support cross-Region read replicas.

This setting doesn't apply to RDS Custom.

createDBInstanceReadReplica_processorFeatures :: Lens' CreateDBInstanceReadReplica (Maybe [ProcessorFeature]) Source #

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

This setting doesn't apply to RDS Custom.

createDBInstanceReadReplica_publiclyAccessible :: Lens' CreateDBInstanceReadReplica (Maybe Bool) Source #

A value that indicates whether the DB instance is publicly accessible.

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

createDBInstanceReadReplica_replicaMode :: Lens' CreateDBInstanceReadReplica (Maybe ReplicaMode) Source #

The open mode of the replica database: mounted or read-only.

This parameter is only supported for Oracle DB instances.

Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload.

You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

For RDS Custom, you must specify this parameter and set it to mounted. The value won't be set by default. After replica creation, you can manage the open mode manually.

createDBInstanceReadReplica_storageThroughput :: Lens' CreateDBInstanceReadReplica (Maybe Int) Source #

Specifies the storage throughput value for the read replica.

This setting doesn't apply to RDS Custom or Amazon Aurora.

createDBInstanceReadReplica_storageType :: Lens' CreateDBInstanceReadReplica (Maybe Text) Source #

Specifies the storage type to be associated with the read replica.

Valid values: gp2 | gp3 | io1 | standard

If you specify io1 or gp3, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise gp2

createDBInstanceReadReplica_tags :: Lens' CreateDBInstanceReadReplica (Maybe [Tag]) Source #

Undocumented member.

createDBInstanceReadReplica_useDefaultProcessorFeatures :: Lens' CreateDBInstanceReadReplica (Maybe Bool) Source #

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

This setting doesn't apply to RDS Custom.

createDBInstanceReadReplica_vpcSecurityGroupIds :: Lens' CreateDBInstanceReadReplica (Maybe [Text]) Source #

A list of Amazon EC2 VPC security groups to associate with the read replica.

This setting doesn't apply to RDS Custom.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

createDBInstanceReadReplica_dbInstanceIdentifier :: Lens' CreateDBInstanceReadReplica Text Source #

The DB instance identifier of the read replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.

createDBInstanceReadReplica_sourceDBInstanceIdentifier :: Lens' CreateDBInstanceReadReplica Text Source #

The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to five read replicas.

Constraints:

Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance.
Can specify a DB instance that is a MySQL read replica only if the source is running MySQL 5.6 or later.
For the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the Amazon RDS User Guide.
For the limitations of SQL Server read replicas, see Read Replica Limitations with Microsoft SQL Server in the Amazon RDS User Guide.
Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-Region replication).
The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.
If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier.
If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply to SQL Server or RDS Custom, which don't support cross-Region replicas.

createDBInstanceReadReplicaResponse_dbInstance :: Lens' CreateDBInstanceReadReplicaResponse (Maybe DBInstance) Source #

Undocumented member.

createDBInstanceReadReplicaResponse_httpStatus :: Lens' CreateDBInstanceReadReplicaResponse Int Source #

The response's http status code.

CreateDBParameterGroup

createDBParameterGroup_tags :: Lens' CreateDBParameterGroup (Maybe [Tag]) Source #

Tags to assign to the DB parameter group.

createDBParameterGroup_dbParameterGroupName :: Lens' CreateDBParameterGroup Text Source #

The name of the DB parameter group.

Constraints:

Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

This value is stored as a lowercase string.

createDBParameterGroup_dbParameterGroupFamily :: Lens' CreateDBParameterGroup Text Source #

The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

To list all of the available parameter group families for a DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>

For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql

The output contains duplicates.

The following are the valid DB engine values:

aurora (for MySQL 5.6-compatible Aurora)
aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
```
aurora-postgresql
```
```
mariadb
```
```
mysql
```
```
oracle-ee
```
```
oracle-ee-cdb
```
```
oracle-se2
```
```
oracle-se2-cdb
```
```
postgres
```
```
sqlserver-ee
```
```
sqlserver-se
```
```
sqlserver-ex
```
```
sqlserver-web
```

createDBParameterGroup_description :: Lens' CreateDBParameterGroup Text Source #

The description for the DB parameter group.

createDBParameterGroupResponse_dbParameterGroup :: Lens' CreateDBParameterGroupResponse (Maybe DBParameterGroup) Source #

Undocumented member.

createDBParameterGroupResponse_httpStatus :: Lens' CreateDBParameterGroupResponse Int Source #

The response's http status code.

CreateDBProxy

createDBProxy_debugLogging :: Lens' CreateDBProxy (Maybe Bool) Source #

Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.

createDBProxy_idleClientTimeout :: Lens' CreateDBProxy (Maybe Int) Source #

The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.

createDBProxy_requireTLS :: Lens' CreateDBProxy (Maybe Bool) Source #

A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.

createDBProxy_tags :: Lens' CreateDBProxy (Maybe [Tag]) Source #

An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

createDBProxy_vpcSecurityGroupIds :: Lens' CreateDBProxy (Maybe [Text]) Source #

One or more VPC security group IDs to associate with the new proxy.

createDBProxy_dbProxyName :: Lens' CreateDBProxy Text Source #

The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

createDBProxy_engineFamily :: Lens' CreateDBProxy EngineFamily Source #

The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL. For RDS for Microsoft SQL Server, specify SQLSERVER.

createDBProxy_auth :: Lens' CreateDBProxy [UserAuthConfig] Source #

The authorization mechanism that the proxy uses.

createDBProxy_roleArn :: Lens' CreateDBProxy Text Source #

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

createDBProxy_vpcSubnetIds :: Lens' CreateDBProxy [Text] Source #

One or more VPC subnet IDs to associate with the new proxy.

createDBProxyResponse_dbProxy :: Lens' CreateDBProxyResponse (Maybe DBProxy) Source #

The DBProxy structure corresponding to the new proxy.

createDBProxyResponse_httpStatus :: Lens' CreateDBProxyResponse Int Source #

The response's http status code.

CreateDBProxyEndpoint

createDBProxyEndpoint_tags :: Lens' CreateDBProxyEndpoint (Maybe [Tag]) Source #

Undocumented member.

createDBProxyEndpoint_targetRole :: Lens' CreateDBProxyEndpoint (Maybe DBProxyEndpointTargetRole) Source #

A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE.

createDBProxyEndpoint_vpcSecurityGroupIds :: Lens' CreateDBProxyEndpoint (Maybe [Text]) Source #

The VPC security group IDs for the DB proxy endpoint that you create. You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.

createDBProxyEndpoint_dbProxyName :: Lens' CreateDBProxyEndpoint Text Source #

The name of the DB proxy associated with the DB proxy endpoint that you create.

createDBProxyEndpoint_dbProxyEndpointName :: Lens' CreateDBProxyEndpoint Text Source #

The name of the DB proxy endpoint to create.

createDBProxyEndpoint_vpcSubnetIds :: Lens' CreateDBProxyEndpoint [Text] Source #

The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a different set of subnet IDs than for the original DB proxy.

createDBProxyEndpointResponse_dbProxyEndpoint :: Lens' CreateDBProxyEndpointResponse (Maybe DBProxyEndpoint) Source #

The DBProxyEndpoint object that is created by the API operation. The DB proxy endpoint that you create might provide capabilities such as read/write or read-only operations, or using a different VPC than the proxy's default VPC.

createDBProxyEndpointResponse_httpStatus :: Lens' CreateDBProxyEndpointResponse Int Source #

The response's http status code.

CreateDBSecurityGroup

createDBSecurityGroup_tags :: Lens' CreateDBSecurityGroup (Maybe [Tag]) Source #

Tags to assign to the DB security group.

createDBSecurityGroup_dbSecurityGroupName :: Lens' CreateDBSecurityGroup Text Source #

The name for the DB security group. This value is stored as a lowercase string.

Constraints:

Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Must not be "Default"

Example: mysecuritygroup

createDBSecurityGroup_dbSecurityGroupDescription :: Lens' CreateDBSecurityGroup Text Source #

The description for the DB security group.

createDBSecurityGroupResponse_dbSecurityGroup :: Lens' CreateDBSecurityGroupResponse (Maybe DBSecurityGroup) Source #

Undocumented member.

createDBSecurityGroupResponse_httpStatus :: Lens' CreateDBSecurityGroupResponse Int Source #

The response's http status code.

CreateDBSnapshot

createDBSnapshot_tags :: Lens' CreateDBSnapshot (Maybe [Tag]) Source #

Undocumented member.

createDBSnapshot_dbSnapshotIdentifier :: Lens' CreateDBSnapshot Text Source #

The identifier for the DB snapshot.

Constraints:

Can't be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

createDBSnapshot_dbInstanceIdentifier :: Lens' CreateDBSnapshot Text Source #

The identifier of the DB instance that you want to create the snapshot of.

Constraints:

Must match the identifier of an existing DBInstance.

createDBSnapshotResponse_dbSnapshot :: Lens' CreateDBSnapshotResponse (Maybe DBSnapshot) Source #

Undocumented member.

createDBSnapshotResponse_httpStatus :: Lens' CreateDBSnapshotResponse Int Source #

The response's http status code.

CreateDBSubnetGroup

createDBSubnetGroup_tags :: Lens' CreateDBSubnetGroup (Maybe [Tag]) Source #

Tags to assign to the DB subnet group.

createDBSubnetGroup_dbSubnetGroupName :: Lens' CreateDBSubnetGroup Text Source #

The name for the DB subnet group. This value is stored as a lowercase string.

Constraints:

Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.
Must not be default.
First character must be a letter.

Example: mydbsubnetgroup

createDBSubnetGroup_dbSubnetGroupDescription :: Lens' CreateDBSubnetGroup Text Source #

The description for the DB subnet group.

createDBSubnetGroup_subnetIds :: Lens' CreateDBSubnetGroup [Text] Source #

The EC2 Subnet IDs for the DB subnet group.

createDBSubnetGroupResponse_dbSubnetGroup :: Lens' CreateDBSubnetGroupResponse (Maybe DBSubnetGroup) Source #

Undocumented member.

createDBSubnetGroupResponse_httpStatus :: Lens' CreateDBSubnetGroupResponse Int Source #

The response's http status code.

CreateEventSubscription

createEventSubscription_enabled :: Lens' CreateEventSubscription (Maybe Bool) Source #

A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.

createEventSubscription_eventCategories :: Lens' CreateEventSubscription (Maybe [Text]) Source #

A list of event categories for a particular source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide . You can also see this list by using the DescribeEventCategories operation.

createEventSubscription_sourceIds :: Lens' CreateEventSubscription (Maybe [Text]) Source #

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.

Constraints:

If SourceIds are supplied, SourceType must also be provided.
If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
If the source type is an RDS Proxy, a DBProxyName value must be supplied.

createEventSubscription_sourceType :: Lens' CreateEventSubscription (Maybe Text) Source #

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.

createEventSubscription_tags :: Lens' CreateEventSubscription (Maybe [Tag]) Source #

Undocumented member.

createEventSubscription_subscriptionName :: Lens' CreateEventSubscription Text Source #

The name of the subscription.

Constraints: The name must be less than 255 characters.

createEventSubscription_snsTopicArn :: Lens' CreateEventSubscription Text Source #

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

createEventSubscriptionResponse_eventSubscription :: Lens' CreateEventSubscriptionResponse (Maybe EventSubscription) Source #

Undocumented member.

createEventSubscriptionResponse_httpStatus :: Lens' CreateEventSubscriptionResponse Int Source #

The response's http status code.

CreateGlobalCluster

createGlobalCluster_databaseName :: Lens' CreateGlobalCluster (Maybe Text) Source #

The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon Aurora will not create a database in the global database cluster you are creating.

createGlobalCluster_deletionProtection :: Lens' CreateGlobalCluster (Maybe Bool) Source #

The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.

createGlobalCluster_engine :: Lens' CreateGlobalCluster (Maybe Text) Source #

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

createGlobalCluster_engineVersion :: Lens' CreateGlobalCluster (Maybe Text) Source #

The engine version of the Aurora global database.

createGlobalCluster_globalClusterIdentifier :: Lens' CreateGlobalCluster (Maybe Text) Source #

The cluster identifier of the new global database cluster.

createGlobalCluster_sourceDBClusterIdentifier :: Lens' CreateGlobalCluster (Maybe Text) Source #

The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional.

createGlobalCluster_storageEncrypted :: Lens' CreateGlobalCluster (Maybe Bool) Source #

The storage encryption setting for the new global database cluster.

createGlobalClusterResponse_globalCluster :: Lens' CreateGlobalClusterResponse (Maybe GlobalCluster) Source #

Undocumented member.

createGlobalClusterResponse_httpStatus :: Lens' CreateGlobalClusterResponse Int Source #

The response's http status code.

CreateOptionGroup

createOptionGroup_tags :: Lens' CreateOptionGroup (Maybe [Tag]) Source #

Tags to assign to the option group.

createOptionGroup_optionGroupName :: Lens' CreateOptionGroup Text Source #

Specifies the name of the option group to be created.

Constraints:

Must be 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

Example: myoptiongroup

createOptionGroup_engineName :: Lens' CreateOptionGroup Text Source #

Specifies the name of the engine that this option group should be associated with.

Valid Values:

```
mariadb
```
```
mysql
```
```
oracle-ee
```
```
oracle-ee-cdb
```
```
oracle-se2
```
```
oracle-se2-cdb
```
```
postgres
```
```
sqlserver-ee
```
```
sqlserver-se
```
```
sqlserver-ex
```
```
sqlserver-web
```

createOptionGroup_majorEngineVersion :: Lens' CreateOptionGroup Text Source #

Specifies the major version of the engine that this option group should be associated with.

createOptionGroup_optionGroupDescription :: Lens' CreateOptionGroup Text Source #

The description of the option group.

createOptionGroupResponse_optionGroup :: Lens' CreateOptionGroupResponse (Maybe OptionGroup) Source #

Undocumented member.

createOptionGroupResponse_httpStatus :: Lens' CreateOptionGroupResponse Int Source #

The response's http status code.

DeleteBlueGreenDeployment

deleteBlueGreenDeployment_deleteTarget :: Lens' DeleteBlueGreenDeployment (Maybe Bool) Source #

A value that indicates whether to delete the resources in the green environment.

deleteBlueGreenDeployment_blueGreenDeploymentIdentifier :: Lens' DeleteBlueGreenDeployment Text Source #

The blue/green deployment identifier of the deployment to be deleted. This parameter isn't case-sensitive.

Constraints:

Must match an existing blue/green deployment identifier.

deleteBlueGreenDeploymentResponse_blueGreenDeployment :: Lens' DeleteBlueGreenDeploymentResponse (Maybe BlueGreenDeployment) Source #

Undocumented member.

deleteBlueGreenDeploymentResponse_httpStatus :: Lens' DeleteBlueGreenDeploymentResponse Int Source #

The response's http status code.

DeleteCustomDBEngineVersion

deleteCustomDBEngineVersion_engine :: Lens' DeleteCustomDBEngineVersion Text Source #

The database engine. The only supported engine is custom-oracle-ee.

deleteCustomDBEngineVersion_engineVersion :: Lens' DeleteCustomDBEngineVersion Text Source #

The custom engine version (CEV) for your DB instance. This option is required for RDS Custom, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.

dbEngineVersion_createTime :: Lens' DBEngineVersion (Maybe UTCTime) Source #

The creation time of the DB engine version.

dbEngineVersion_customDBEngineVersionManifest :: Lens' DBEngineVersion (Maybe Text) Source #

JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide.

dbEngineVersion_dbEngineDescription :: Lens' DBEngineVersion (Maybe Text) Source #

The description of the database engine.

dbEngineVersion_dbEngineMediaType :: Lens' DBEngineVersion (Maybe Text) Source #

A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.

dbEngineVersion_dbEngineVersionArn :: Lens' DBEngineVersion (Maybe Text) Source #

The ARN of the custom engine version.

dbEngineVersion_dbEngineVersionDescription :: Lens' DBEngineVersion (Maybe Text) Source #

The description of the database engine version.

dbEngineVersion_dbParameterGroupFamily :: Lens' DBEngineVersion (Maybe Text) Source #

The name of the DB parameter group family for the database engine.

dbEngineVersion_databaseInstallationFilesS3BucketName :: Lens' DBEngineVersion (Maybe Text) Source #

The name of the Amazon S3 bucket that contains your database installation files.

dbEngineVersion_databaseInstallationFilesS3Prefix :: Lens' DBEngineVersion (Maybe Text) Source #

The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.

dbEngineVersion_defaultCharacterSet :: Lens' DBEngineVersion (Maybe CharacterSet) Source #

The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.

dbEngineVersion_engine :: Lens' DBEngineVersion (Maybe Text) Source #

The name of the database engine.

dbEngineVersion_engineVersion :: Lens' DBEngineVersion (Maybe Text) Source #

The version number of the database engine.

dbEngineVersion_exportableLogTypes :: Lens' DBEngineVersion (Maybe [Text]) Source #

The types of logs that the database engine has available for export to CloudWatch Logs.

dbEngineVersion_image :: Lens' DBEngineVersion (Maybe CustomDBEngineVersionAMI) Source #

The EC2 image

dbEngineVersion_kmsKeyId :: Lens' DBEngineVersion (Maybe Text) Source #

The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.

dbEngineVersion_majorEngineVersion :: Lens' DBEngineVersion (Maybe Text) Source #

The major engine version of the CEV.

dbEngineVersion_status :: Lens' DBEngineVersion (Maybe Text) Source #

The status of the DB engine version, either available or deprecated.

dbEngineVersion_supportedCACertificateIdentifiers :: Lens' DBEngineVersion (Maybe [Text]) Source #

A list of the supported CA certificate identifiers.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

dbEngineVersion_supportedCharacterSets :: Lens' DBEngineVersion (Maybe [CharacterSet]) Source #

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.

dbEngineVersion_supportedEngineModes :: Lens' DBEngineVersion (Maybe [Text]) Source #

A list of the supported DB engine modes.

dbEngineVersion_supportedFeatureNames :: Lens' DBEngineVersion (Maybe [Text]) Source #

A list of features supported by the DB engine.

The supported features vary by DB engine and DB engine version.

To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:

aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>

For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:

aws rds describe-db-engine-versions --engine postgres --engine-version 13.3

The supported features are listed under SupportedFeatureNames in the output.

dbEngineVersion_supportedNcharCharacterSets :: Lens' DBEngineVersion (Maybe [CharacterSet]) Source #

A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.

dbEngineVersion_supportedTimezones :: Lens' DBEngineVersion (Maybe [Timezone]) Source #

A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

dbEngineVersion_supportsBabelfish :: Lens' DBEngineVersion (Maybe Bool) Source #

A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.

dbEngineVersion_supportsCertificateRotationWithoutRestart :: Lens' DBEngineVersion (Maybe Bool) Source #

A value that indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.

dbEngineVersion_supportsGlobalDatabases :: Lens' DBEngineVersion (Maybe Bool) Source #

A value that indicates whether you can use Aurora global databases with a specific DB engine version.

dbEngineVersion_supportsLogExportsToCloudwatchLogs :: Lens' DBEngineVersion (Maybe Bool) Source #

A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

dbEngineVersion_supportsParallelQuery :: Lens' DBEngineVersion (Maybe Bool) Source #

A value that indicates whether you can use Aurora parallel query with a specific DB engine version.

dbEngineVersion_supportsReadReplica :: Lens' DBEngineVersion (Maybe Bool) Source #

Indicates whether the database engine version supports read replicas.

dbEngineVersion_tagList :: Lens' DBEngineVersion (Maybe [Tag]) Source #

Undocumented member.

dbEngineVersion_validUpgradeTarget :: Lens' DBEngineVersion (Maybe [UpgradeTarget]) Source #

A list of engine versions that this database engine version can be upgraded to.

DeleteDBCluster

deleteDBCluster_finalDBSnapshotIdentifier :: Lens' DeleteDBCluster (Maybe Text) Source #

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.

Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter results in an error.

Constraints:

Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

deleteDBCluster_skipFinalSnapshot :: Lens' DeleteDBCluster (Maybe Bool) Source #

A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. By default, this parameter is disabled.

You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.

deleteDBCluster_dbClusterIdentifier :: Lens' DeleteDBCluster Text Source #

The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.

Constraints:

Must match an existing DBClusterIdentifier.

deleteDBClusterResponse_dbCluster :: Lens' DeleteDBClusterResponse (Maybe DBCluster) Source #

Undocumented member.

deleteDBClusterResponse_httpStatus :: Lens' DeleteDBClusterResponse Int Source #

The response's http status code.

DeleteDBClusterEndpoint

deleteDBClusterEndpoint_dbClusterEndpointIdentifier :: Lens' DeleteDBClusterEndpoint Text Source #

The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.

dbClusterEndpoint_customEndpointType :: Lens' DBClusterEndpoint (Maybe Text) Source #

The type associated with a custom endpoint. One of: READER, WRITER, ANY.

dbClusterEndpoint_dbClusterEndpointArn :: Lens' DBClusterEndpoint (Maybe Text) Source #

The Amazon Resource Name (ARN) for the endpoint.

dbClusterEndpoint_dbClusterEndpointIdentifier :: Lens' DBClusterEndpoint (Maybe Text) Source #

The identifier associated with the endpoint. This parameter is stored as a lowercase string.

dbClusterEndpoint_dbClusterEndpointResourceIdentifier :: Lens' DBClusterEndpoint (Maybe Text) Source #

A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

dbClusterEndpoint_dbClusterIdentifier :: Lens' DBClusterEndpoint (Maybe Text) Source #

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

dbClusterEndpoint_endpoint :: Lens' DBClusterEndpoint (Maybe Text) Source #

The DNS address of the endpoint.

dbClusterEndpoint_endpointType :: Lens' DBClusterEndpoint (Maybe Text) Source #

The type of the endpoint. One of: READER, WRITER, CUSTOM.

dbClusterEndpoint_excludedMembers :: Lens' DBClusterEndpoint (Maybe [Text]) Source #

List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

dbClusterEndpoint_staticMembers :: Lens' DBClusterEndpoint (Maybe [Text]) Source #

List of DB instance identifiers that are part of the custom endpoint group.

dbClusterEndpoint_status :: Lens' DBClusterEndpoint (Maybe Text) Source #

The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.

DeleteDBClusterParameterGroup

deleteDBClusterParameterGroup_dbClusterParameterGroupName :: Lens' DeleteDBClusterParameterGroup Text Source #

The name of the DB cluster parameter group.

Constraints:

Must be the name of an existing DB cluster parameter group.
You can't delete a default DB cluster parameter group.
Can't be associated with any DB clusters.

DeleteDBClusterSnapshot

deleteDBClusterSnapshot_dbClusterSnapshotIdentifier :: Lens' DeleteDBClusterSnapshot Text Source #

The identifier of the DB cluster snapshot to delete.

Constraints: Must be the name of an existing DB cluster snapshot in the available state.

deleteDBClusterSnapshotResponse_dbClusterSnapshot :: Lens' DeleteDBClusterSnapshotResponse (Maybe DBClusterSnapshot) Source #

Undocumented member.

deleteDBClusterSnapshotResponse_httpStatus :: Lens' DeleteDBClusterSnapshotResponse Int Source #

The response's http status code.

DeleteDBInstance

deleteDBInstance_deleteAutomatedBackups :: Lens' DeleteDBInstance (Maybe Bool) Source #

A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.

deleteDBInstance_finalDBSnapshotIdentifier :: Lens' DeleteDBInstance (Maybe Text) Source #

The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.

This setting doesn't apply to RDS Custom.

Constraints:

Must be 1 to 255 letters or numbers.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Can't be specified when deleting a read replica.

deleteDBInstance_skipFinalSnapshot :: Lens' DeleteDBInstance (Maybe Bool) Source #

A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance. If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB snapshot is created.

If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.

When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, RDS can delete the instance only if you enable this parameter.

If you delete a read replica or an RDS Custom instance, you must enable this setting.

This setting is required for RDS Custom.

deleteDBInstance_dbInstanceIdentifier :: Lens' DeleteDBInstance Text Source #

The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

Constraints:

Must match the name of an existing DB instance.

deleteDBInstanceResponse_dbInstance :: Lens' DeleteDBInstanceResponse (Maybe DBInstance) Source #

Undocumented member.

deleteDBInstanceResponse_httpStatus :: Lens' DeleteDBInstanceResponse Int Source #

The response's http status code.

DeleteDBInstanceAutomatedBackup

deleteDBInstanceAutomatedBackup_dbInstanceAutomatedBackupsArn :: Lens' DeleteDBInstanceAutomatedBackup (Maybe Text) Source #

The Amazon Resource Name (ARN) of the automated backups to delete, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

This setting doesn't apply to RDS Custom.

deleteDBInstanceAutomatedBackup_dbiResourceId :: Lens' DeleteDBInstanceAutomatedBackup (Maybe Text) Source #

The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

deleteDBInstanceAutomatedBackupResponse_dbInstanceAutomatedBackup :: Lens' DeleteDBInstanceAutomatedBackupResponse (Maybe DBInstanceAutomatedBackup) Source #

Undocumented member.

deleteDBInstanceAutomatedBackupResponse_httpStatus :: Lens' DeleteDBInstanceAutomatedBackupResponse Int Source #

The response's http status code.

DeleteDBParameterGroup

deleteDBParameterGroup_dbParameterGroupName :: Lens' DeleteDBParameterGroup Text Source #

The name of the DB parameter group.

Constraints:

Must be the name of an existing DB parameter group
You can't delete a default DB parameter group
Can't be associated with any DB instances

DeleteDBProxy

deleteDBProxy_dbProxyName :: Lens' DeleteDBProxy Text Source #

The name of the DB proxy to delete.

deleteDBProxyResponse_dbProxy :: Lens' DeleteDBProxyResponse (Maybe DBProxy) Source #

The data structure representing the details of the DB proxy that you delete.

deleteDBProxyResponse_httpStatus :: Lens' DeleteDBProxyResponse Int Source #

The response's http status code.

DeleteDBProxyEndpoint

deleteDBProxyEndpoint_dbProxyEndpointName :: Lens' DeleteDBProxyEndpoint Text Source #

The name of the DB proxy endpoint to delete.

deleteDBProxyEndpointResponse_dbProxyEndpoint :: Lens' DeleteDBProxyEndpointResponse (Maybe DBProxyEndpoint) Source #

The data structure representing the details of the DB proxy endpoint that you delete.

deleteDBProxyEndpointResponse_httpStatus :: Lens' DeleteDBProxyEndpointResponse Int Source #

The response's http status code.

DeleteDBSecurityGroup

deleteDBSecurityGroup_dbSecurityGroupName :: Lens' DeleteDBSecurityGroup Text Source #

The name of the DB security group to delete.

You can't delete the default DB security group.

Constraints:

Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Must not be "Default"

DeleteDBSnapshot

deleteDBSnapshot_dbSnapshotIdentifier :: Lens' DeleteDBSnapshot Text Source #

The DB snapshot identifier.

Constraints: Must be the name of an existing DB snapshot in the available state.

deleteDBSnapshotResponse_dbSnapshot :: Lens' DeleteDBSnapshotResponse (Maybe DBSnapshot) Source #

Undocumented member.

deleteDBSnapshotResponse_httpStatus :: Lens' DeleteDBSnapshotResponse Int Source #

The response's http status code.

DeleteDBSubnetGroup

deleteDBSubnetGroup_dbSubnetGroupName :: Lens' DeleteDBSubnetGroup Text Source #

The name of the database subnet group to delete.

You can't delete the default subnet group.

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

Example: mydbsubnetgroup

DeleteEventSubscription

deleteEventSubscription_subscriptionName :: Lens' DeleteEventSubscription Text Source #

The name of the RDS event notification subscription you want to delete.

deleteEventSubscriptionResponse_eventSubscription :: Lens' DeleteEventSubscriptionResponse (Maybe EventSubscription) Source #

Undocumented member.

deleteEventSubscriptionResponse_httpStatus :: Lens' DeleteEventSubscriptionResponse Int Source #

The response's http status code.

DeleteGlobalCluster

deleteGlobalCluster_globalClusterIdentifier :: Lens' DeleteGlobalCluster Text Source #

The cluster identifier of the global database cluster being deleted.

deleteGlobalClusterResponse_globalCluster :: Lens' DeleteGlobalClusterResponse (Maybe GlobalCluster) Source #

Undocumented member.

deleteGlobalClusterResponse_httpStatus :: Lens' DeleteGlobalClusterResponse Int Source #

The response's http status code.

DeleteOptionGroup

deleteOptionGroup_optionGroupName :: Lens' DeleteOptionGroup Text Source #

The name of the option group to be deleted.

You can't delete default option groups.

DeregisterDBProxyTargets

deregisterDBProxyTargets_dbClusterIdentifiers :: Lens' DeregisterDBProxyTargets (Maybe [Text]) Source #

One or more DB cluster identifiers.

deregisterDBProxyTargets_dbInstanceIdentifiers :: Lens' DeregisterDBProxyTargets (Maybe [Text]) Source #

One or more DB instance identifiers.

deregisterDBProxyTargets_targetGroupName :: Lens' DeregisterDBProxyTargets (Maybe Text) Source #

The identifier of the DBProxyTargetGroup.

deregisterDBProxyTargets_dbProxyName :: Lens' DeregisterDBProxyTargets Text Source #

The identifier of the DBProxy that is associated with the DBProxyTargetGroup.

deregisterDBProxyTargetsResponse_httpStatus :: Lens' DeregisterDBProxyTargetsResponse Int Source #

The response's http status code.

DescribeAccountAttributes

describeAccountAttributesResponse_accountQuotas :: Lens' DescribeAccountAttributesResponse (Maybe [AccountQuota]) Source #

A list of AccountQuota objects. Within this list, each quota has a name, a count of usage toward the quota maximum, and a maximum value for the quota.

describeAccountAttributesResponse_httpStatus :: Lens' DescribeAccountAttributesResponse Int Source #

The response's http status code.

DescribeBlueGreenDeployments

describeBlueGreenDeployments_blueGreenDeploymentIdentifier :: Lens' DescribeBlueGreenDeployments (Maybe Text) Source #

The blue/green deployment identifier. If this parameter is specified, information from only the specific blue/green deployment is returned. This parameter isn't case-sensitive.

Constraints:

If supplied, must match an existing blue/green deployment identifier.

describeBlueGreenDeployments_filters :: Lens' DescribeBlueGreenDeployments (Maybe [Filter]) Source #

A filter that specifies one or more blue/green deployments to describe.

Supported filters:

blue-green-deployment-identifier - Accepts system-generated identifiers for blue/green deployments. The results list only includes information about the blue/green deployments with the specified identifiers.
blue-green-deployment-name - Accepts user-supplied names for blue/green deployments. The results list only includes information about the blue/green deployments with the specified names.
source - Accepts source databases for a blue/green deployment. The results list only includes information about the blue/green deployments with the specified source databases.
target - Accepts target databases for a blue/green deployment. The results list only includes information about the blue/green deployments with the specified target databases.

describeBlueGreenDeployments_marker :: Lens' DescribeBlueGreenDeployments (Maybe Text) Source #

An optional pagination token provided by a previous DescribeBlueGreenDeployments request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeBlueGreenDeployments_maxRecords :: Lens' DescribeBlueGreenDeployments (Maybe Natural) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeBlueGreenDeploymentsResponse_blueGreenDeployments :: Lens' DescribeBlueGreenDeploymentsResponse (Maybe [BlueGreenDeployment]) Source #

Contains a list of blue/green deployments for the user.

describeBlueGreenDeploymentsResponse_marker :: Lens' DescribeBlueGreenDeploymentsResponse (Maybe Text) Source #

A pagination token that can be used in a later DescribeBlueGreenDeployments request.

describeBlueGreenDeploymentsResponse_httpStatus :: Lens' DescribeBlueGreenDeploymentsResponse Int Source #

The response's http status code.

DescribeCertificates

describeCertificates_certificateIdentifier :: Lens' DescribeCertificates (Maybe Text) Source #

The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive.

Constraints:

Must match an existing CertificateIdentifier.

describeCertificates_filters :: Lens' DescribeCertificates (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeCertificates_marker :: Lens' DescribeCertificates (Maybe Text) Source #

An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeCertificates_maxRecords :: Lens' DescribeCertificates (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeCertificatesResponse_certificates :: Lens' DescribeCertificatesResponse (Maybe [Certificate]) Source #

The list of Certificate objects for the Amazon Web Services account.

describeCertificatesResponse_marker :: Lens' DescribeCertificatesResponse (Maybe Text) Source #

An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

describeCertificatesResponse_httpStatus :: Lens' DescribeCertificatesResponse Int Source #

The response's http status code.

DescribeDBClusterBacktracks

describeDBClusterBacktracks_backtrackIdentifier :: Lens' DescribeDBClusterBacktracks (Maybe Text) Source #

If specified, this value is the backtrack identifier of the backtrack to be described.

Constraints:

Must contain a valid universally unique identifier (UUID). For more information about UUIDs, see A Universally Unique Identifier (UUID) URN Namespace.

Example: 123e4567-e89b-12d3-a456-426655440000

describeDBClusterBacktracks_filters :: Lens' DescribeDBClusterBacktracks (Maybe [Filter]) Source #

A filter that specifies one or more DB clusters to describe. Supported filters include the following:

db-cluster-backtrack-id - Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers.
db-cluster-backtrack-status - Accepts any of the following backtrack status values:
- ```
applying
```
- ```
completed
```
- ```
failed
```
- ```
pending
```
The results list includes information about only the backtracks identified by these values.

describeDBClusterBacktracks_marker :: Lens' DescribeDBClusterBacktracks (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBClusterBacktracks request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBClusterBacktracks_maxRecords :: Lens' DescribeDBClusterBacktracks (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBClusterBacktracks_dbClusterIdentifier :: Lens' DescribeDBClusterBacktracks Text Source #

The DB cluster identifier of the DB cluster to be described. 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.
Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

describeDBClusterBacktracksResponse_dbClusterBacktracks :: Lens' DescribeDBClusterBacktracksResponse (Maybe [DBClusterBacktrack]) Source #

Contains a list of backtracks for the user.

describeDBClusterBacktracksResponse_marker :: Lens' DescribeDBClusterBacktracksResponse (Maybe Text) Source #

A pagination token that can be used in a later DescribeDBClusterBacktracks request.

describeDBClusterBacktracksResponse_httpStatus :: Lens' DescribeDBClusterBacktracksResponse Int Source #

The response's http status code.

DescribeDBClusterEndpoints

describeDBClusterEndpoints_dbClusterEndpointIdentifier :: Lens' DescribeDBClusterEndpoints (Maybe Text) Source #

The identifier of the endpoint to describe. This parameter is stored as a lowercase string.

describeDBClusterEndpoints_dbClusterIdentifier :: Lens' DescribeDBClusterEndpoints (Maybe Text) Source #

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

describeDBClusterEndpoints_filters :: Lens' DescribeDBClusterEndpoints (Maybe [Filter]) Source #

A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, inactive, modifying.

describeDBClusterEndpoints_marker :: Lens' DescribeDBClusterEndpoints (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBClusterEndpoints_maxRecords :: Lens' DescribeDBClusterEndpoints (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBClusterEndpointsResponse_dbClusterEndpoints :: Lens' DescribeDBClusterEndpointsResponse (Maybe [DBClusterEndpoint]) Source #

Contains the details of the endpoints associated with the cluster and matching any filter conditions.

describeDBClusterEndpointsResponse_marker :: Lens' DescribeDBClusterEndpointsResponse (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBClusterEndpointsResponse_httpStatus :: Lens' DescribeDBClusterEndpointsResponse Int Source #

The response's http status code.

DescribeDBClusterParameterGroups

describeDBClusterParameterGroups_dbClusterParameterGroupName :: Lens' DescribeDBClusterParameterGroups (Maybe Text) Source #

The name of a specific DB cluster parameter group to return details for.

Constraints:

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

describeDBClusterParameterGroups_filters :: Lens' DescribeDBClusterParameterGroups (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeDBClusterParameterGroups_marker :: Lens' DescribeDBClusterParameterGroups (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBClusterParameterGroups_maxRecords :: Lens' DescribeDBClusterParameterGroups (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBClusterParameterGroupsResponse_dbClusterParameterGroups :: Lens' DescribeDBClusterParameterGroupsResponse (Maybe [DBClusterParameterGroup]) Source #

A list of DB cluster parameter groups.

describeDBClusterParameterGroupsResponse_marker :: Lens' DescribeDBClusterParameterGroupsResponse (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBClusterParameterGroupsResponse_httpStatus :: Lens' DescribeDBClusterParameterGroupsResponse Int Source #

The response's http status code.

DescribeDBClusterParameters

describeDBClusterParameters_filters :: Lens' DescribeDBClusterParameters (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeDBClusterParameters_marker :: Lens' DescribeDBClusterParameters (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBClusterParameters_maxRecords :: Lens' DescribeDBClusterParameters (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBClusterParameters_source :: Lens' DescribeDBClusterParameters (Maybe Text) Source #

A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

describeDBClusterParameters_dbClusterParameterGroupName :: Lens' DescribeDBClusterParameters Text Source #

The name of a specific DB cluster parameter group to return parameter details for.

Constraints:

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

describeDBClusterParametersResponse_marker :: Lens' DescribeDBClusterParametersResponse (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBClusterParametersResponse_parameters :: Lens' DescribeDBClusterParametersResponse (Maybe [Parameter]) Source #

Provides a list of parameters for the DB cluster parameter group.

describeDBClusterParametersResponse_httpStatus :: Lens' DescribeDBClusterParametersResponse Int Source #

The response's http status code.

DescribeDBClusterSnapshotAttributes

describeDBClusterSnapshotAttributes_dbClusterSnapshotIdentifier :: Lens' DescribeDBClusterSnapshotAttributes Text Source #

The identifier for the DB cluster snapshot to describe the attributes for.

describeDBClusterSnapshotAttributesResponse_dbClusterSnapshotAttributesResult :: Lens' DescribeDBClusterSnapshotAttributesResponse (Maybe DBClusterSnapshotAttributesResult) Source #

Undocumented member.

describeDBClusterSnapshotAttributesResponse_httpStatus :: Lens' DescribeDBClusterSnapshotAttributesResponse Int Source #

The response's http status code.

DescribeDBClusterSnapshots

describeDBClusterSnapshots_dbClusterIdentifier :: Lens' DescribeDBClusterSnapshots (Maybe Text) Source #

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive.

Constraints:

If supplied, must match the identifier of an existing DBCluster.

describeDBClusterSnapshots_dbClusterSnapshotIdentifier :: Lens' DescribeDBClusterSnapshots (Maybe Text) Source #

A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

If supplied, must match the identifier of an existing DBClusterSnapshot.
If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

describeDBClusterSnapshots_filters :: Lens' DescribeDBClusterSnapshots (Maybe [Filter]) Source #

A filter that specifies one or more DB cluster snapshots to describe.

Supported filters:

db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.
snapshot-type - Accepts types of DB cluster snapshots.
engine - Accepts names of database engines.

describeDBClusterSnapshots_includePublic :: Lens' DescribeDBClusterSnapshots (Maybe Bool) Source #

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

describeDBClusterSnapshots_includeShared :: Lens' DescribeDBClusterSnapshots (Maybe Bool) Source #

A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.

You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.

describeDBClusterSnapshots_marker :: Lens' DescribeDBClusterSnapshots (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBClusterSnapshots_maxRecords :: Lens' DescribeDBClusterSnapshots (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBClusterSnapshots_snapshotType :: Lens' DescribeDBClusterSnapshots (Maybe Text) Source #

The type of DB cluster snapshots to be returned. You can specify one of the following values:

automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.
manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.
shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.
public - Return all DB cluster snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic parameter.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

describeDBClusterSnapshotsResponse_dbClusterSnapshots :: Lens' DescribeDBClusterSnapshotsResponse (Maybe [DBClusterSnapshot]) Source #

Provides a list of DB cluster snapshots for the user.

describeDBClusterSnapshotsResponse_marker :: Lens' DescribeDBClusterSnapshotsResponse (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBClusterSnapshotsResponse_httpStatus :: Lens' DescribeDBClusterSnapshotsResponse Int Source #

The response's http status code.

DescribeDBClusters

describeDBClusters_dbClusterIdentifier :: Lens' DescribeDBClusters (Maybe Text) Source #

The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

Constraints:

If supplied, must match an existing DBClusterIdentifier.

describeDBClusters_filters :: Lens' DescribeDBClusters (Maybe [Filter]) Source #

A filter that specifies one or more DB clusters to describe.

Supported filters:

clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.
domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.
engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.

describeDBClusters_includeShared :: Lens' DescribeDBClusters (Maybe Bool) Source #

Optional Boolean parameter that specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.

describeDBClusters_marker :: Lens' DescribeDBClusters (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBClusters_maxRecords :: Lens' DescribeDBClusters (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBClustersResponse_dbClusters :: Lens' DescribeDBClustersResponse (Maybe [DBCluster]) Source #

Contains a list of DB clusters for the user.

describeDBClustersResponse_marker :: Lens' DescribeDBClustersResponse (Maybe Text) Source #

A pagination token that can be used in a later DescribeDBClusters request.

describeDBClustersResponse_httpStatus :: Lens' DescribeDBClustersResponse Int Source #

The response's http status code.

DescribeDBEngineVersions

describeDBEngineVersions_dbParameterGroupFamily :: Lens' DescribeDBEngineVersions (Maybe Text) Source #

The name of a specific DB parameter group family to return details for.

Constraints:

If supplied, must match an existing DBParameterGroupFamily.

describeDBEngineVersions_defaultOnly :: Lens' DescribeDBEngineVersions (Maybe Bool) Source #

A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.

describeDBEngineVersions_engine :: Lens' DescribeDBEngineVersions (Maybe Text) Source #

The database engine to return.

Valid Values:

aurora (for MySQL 5.6-compatible Aurora)
aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
```
aurora-postgresql
```
```
mariadb
```
```
mysql
```
```
oracle-ee
```
```
oracle-ee-cdb
```
```
oracle-se2
```
```
oracle-se2-cdb
```
```
postgres
```
```
sqlserver-ee
```
```
sqlserver-se
```
```
sqlserver-ex
```
```
sqlserver-web
```

describeDBEngineVersions_engineVersion :: Lens' DescribeDBEngineVersions (Maybe Text) Source #

The database engine version to return.

Example: 5.1.49

describeDBEngineVersions_filters :: Lens' DescribeDBEngineVersions (Maybe [Filter]) Source #

A filter that specifies one or more DB engine versions to describe.

Supported filters:

db-parameter-group-family - Accepts parameter groups family names. The results list only includes information about the DB engine versions for these parameter group families.
engine - Accepts engine names. The results list only includes information about the DB engine versions for these engines.
engine-mode - Accepts DB engine modes. The results list only includes information about the DB engine versions for these engine modes. Valid DB engine modes are the following:
- ```
global
```
- ```
multimaster
```
- ```
parallelquery
```
- ```
provisioned
```
- ```
serverless
```
engine-version - Accepts engine versions. The results list only includes information about the DB engine versions for these engine versions.
status - Accepts engine version statuses. The results list only includes information about the DB engine versions for these statuses. Valid statuses are the following:
- ```
available
```
- ```
deprecated
```

describeDBEngineVersions_includeAll :: Lens' DescribeDBEngineVersions (Maybe Bool) Source #

A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.

describeDBEngineVersions_listSupportedCharacterSets :: Lens' DescribeDBEngineVersions (Maybe Bool) Source #

A value that indicates whether to list the supported character sets for each engine version.

If this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets to true, RDS Custom returns no results.

describeDBEngineVersions_listSupportedTimezones :: Lens' DescribeDBEngineVersions (Maybe Bool) Source #

A value that indicates whether to list the supported time zones for each engine version.

If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones to true, RDS Custom returns no results.

describeDBEngineVersions_marker :: Lens' DescribeDBEngineVersions (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBEngineVersions_maxRecords :: Lens' DescribeDBEngineVersions (Maybe Int) Source #

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBEngineVersionsResponse_dbEngineVersions :: Lens' DescribeDBEngineVersionsResponse (Maybe [DBEngineVersion]) Source #

A list of DBEngineVersion elements.

describeDBEngineVersionsResponse_marker :: Lens' DescribeDBEngineVersionsResponse (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBEngineVersionsResponse_httpStatus :: Lens' DescribeDBEngineVersionsResponse Int Source #

The response's http status code.

DescribeDBInstanceAutomatedBackups

describeDBInstanceAutomatedBackups_dbInstanceAutomatedBackupsArn :: Lens' DescribeDBInstanceAutomatedBackups (Maybe Text) Source #

The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

This setting doesn't apply to RDS Custom.

describeDBInstanceAutomatedBackups_dbInstanceIdentifier :: Lens' DescribeDBInstanceAutomatedBackups (Maybe Text) Source #

(Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance' automated backup. This parameter isn't case-sensitive.

describeDBInstanceAutomatedBackups_dbiResourceId :: Lens' DescribeDBInstanceAutomatedBackups (Maybe Text) Source #

The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.

describeDBInstanceAutomatedBackups_filters :: Lens' DescribeDBInstanceAutomatedBackups (Maybe [Filter]) Source #

A filter that specifies which resources to return based on status.

Supported filters are the following:

```
status
```
- active - automated backups for current instances
- retained - automated backups for deleted instances and after backup replication is stopped
- creating - automated backups that are waiting for the first automated snapshot to be available
db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs.
dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.

Returns all resources by default. The status for each resource is specified in the response.

describeDBInstanceAutomatedBackups_marker :: Lens' DescribeDBInstanceAutomatedBackups (Maybe Text) Source #

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

describeDBInstanceAutomatedBackups_maxRecords :: Lens' DescribeDBInstanceAutomatedBackups (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

describeDBInstanceAutomatedBackupsResponse_dbInstanceAutomatedBackups :: Lens' DescribeDBInstanceAutomatedBackupsResponse (Maybe [DBInstanceAutomatedBackup]) Source #

A list of DBInstanceAutomatedBackup instances.

describeDBInstanceAutomatedBackupsResponse_marker :: Lens' DescribeDBInstanceAutomatedBackupsResponse (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBInstanceAutomatedBackupsResponse_httpStatus :: Lens' DescribeDBInstanceAutomatedBackupsResponse Int Source #

The response's http status code.

DescribeDBInstances

describeDBInstances_dbInstanceIdentifier :: Lens' DescribeDBInstances (Maybe Text) Source #

The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.

Constraints:

If supplied, must match the identifier of an existing DBInstance.

describeDBInstances_filters :: Lens' DescribeDBInstances (Maybe [Filter]) Source #

A filter that specifies one or more DB instances to describe.

Supported filters:

db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs.
db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs.
dbi-resource-id - Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers.
domain - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.
engine - Accepts engine names. The results list only includes information about the DB instances for these engines.

describeDBInstances_marker :: Lens' DescribeDBInstances (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBInstances_maxRecords :: Lens' DescribeDBInstances (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBInstancesResponse_dbInstances :: Lens' DescribeDBInstancesResponse (Maybe [DBInstance]) Source #

A list of DBInstance instances.

describeDBInstancesResponse_marker :: Lens' DescribeDBInstancesResponse (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

describeDBInstancesResponse_httpStatus :: Lens' DescribeDBInstancesResponse Int Source #

The response's http status code.

DescribeDBLogFiles

describeDBLogFiles_fileLastWritten :: Lens' DescribeDBLogFiles (Maybe Integer) Source #

Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

describeDBLogFiles_fileSize :: Lens' DescribeDBLogFiles (Maybe Integer) Source #

Filters the available log files for files larger than the specified size.

describeDBLogFiles_filenameContains :: Lens' DescribeDBLogFiles (Maybe Text) Source #

Filters the available log files for log file names that contain the specified string.

describeDBLogFiles_filters :: Lens' DescribeDBLogFiles (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeDBLogFiles_marker :: Lens' DescribeDBLogFiles (Maybe Text) Source #

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

describeDBLogFiles_maxRecords :: Lens' DescribeDBLogFiles (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

describeDBLogFiles_dbInstanceIdentifier :: Lens' DescribeDBLogFiles Text Source #

The customer-assigned name of the DB instance that contains the log files you want to list.

Constraints:

Must match the identifier of an existing DBInstance.

describeDBLogFilesResponse_describeDBLogFiles :: Lens' DescribeDBLogFilesResponse (Maybe [DescribeDBLogFilesDetails]) Source #

The DB log files returned.

describeDBLogFilesResponse_marker :: Lens' DescribeDBLogFilesResponse (Maybe Text) Source #

A pagination token that can be used in a later DescribeDBLogFiles request.

describeDBLogFilesResponse_httpStatus :: Lens' DescribeDBLogFilesResponse Int Source #

The response's http status code.

DescribeDBParameterGroups

describeDBParameterGroups_dbParameterGroupName :: Lens' DescribeDBParameterGroups (Maybe Text) Source #

The name of a specific DB parameter group to return details for.

Constraints:

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

describeDBParameterGroups_filters :: Lens' DescribeDBParameterGroups (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeDBParameterGroups_marker :: Lens' DescribeDBParameterGroups (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBParameterGroups_maxRecords :: Lens' DescribeDBParameterGroups (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBParameterGroupsResponse_dbParameterGroups :: Lens' DescribeDBParameterGroupsResponse (Maybe [DBParameterGroup]) Source #

A list of DBParameterGroup instances.

describeDBParameterGroupsResponse_marker :: Lens' DescribeDBParameterGroupsResponse (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBParameterGroupsResponse_httpStatus :: Lens' DescribeDBParameterGroupsResponse Int Source #

The response's http status code.

DescribeDBParameters

describeDBParameters_filters :: Lens' DescribeDBParameters (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeDBParameters_marker :: Lens' DescribeDBParameters (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBParameters_maxRecords :: Lens' DescribeDBParameters (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBParameters_source :: Lens' DescribeDBParameters (Maybe Text) Source #

The parameter types to return.

Default: All parameter types returned

Valid Values: user | system | engine-default

describeDBParameters_dbParameterGroupName :: Lens' DescribeDBParameters Text Source #

The name of a specific DB parameter group to return details for.

Constraints:

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

describeDBParametersResponse_marker :: Lens' DescribeDBParametersResponse (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBParametersResponse_parameters :: Lens' DescribeDBParametersResponse (Maybe [Parameter]) Source #

A list of Parameter values.

describeDBParametersResponse_httpStatus :: Lens' DescribeDBParametersResponse Int Source #

The response's http status code.

DescribeDBProxies

describeDBProxies_dbProxyName :: Lens' DescribeDBProxies (Maybe Text) Source #

The name of the DB proxy. If you omit this parameter, the output includes information about all DB proxies owned by your Amazon Web Services account ID.

describeDBProxies_filters :: Lens' DescribeDBProxies (Maybe [Filter]) Source #

This parameter is not currently supported.

describeDBProxies_marker :: Lens' DescribeDBProxies (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBProxies_maxRecords :: Lens' DescribeDBProxies (Maybe Natural) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBProxiesResponse_dbProxies :: Lens' DescribeDBProxiesResponse (Maybe [DBProxy]) Source #

A return value representing an arbitrary number of DBProxy data structures.

describeDBProxiesResponse_marker :: Lens' DescribeDBProxiesResponse (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBProxiesResponse_httpStatus :: Lens' DescribeDBProxiesResponse Int Source #

The response's http status code.

DescribeDBProxyEndpoints

describeDBProxyEndpoints_dbProxyEndpointName :: Lens' DescribeDBProxyEndpoints (Maybe Text) Source #

The name of a DB proxy endpoint to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with the specified proxy.

describeDBProxyEndpoints_dbProxyName :: Lens' DescribeDBProxyEndpoints (Maybe Text) Source #

The name of the DB proxy whose endpoints you want to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with all your DB proxies.

describeDBProxyEndpoints_filters :: Lens' DescribeDBProxyEndpoints (Maybe [Filter]) Source #

This parameter is not currently supported.

describeDBProxyEndpoints_marker :: Lens' DescribeDBProxyEndpoints (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBProxyEndpoints_maxRecords :: Lens' DescribeDBProxyEndpoints (Maybe Natural) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBProxyEndpointsResponse_dbProxyEndpoints :: Lens' DescribeDBProxyEndpointsResponse (Maybe [DBProxyEndpoint]) Source #

The list of ProxyEndpoint objects returned by the API operation.

describeDBProxyEndpointsResponse_marker :: Lens' DescribeDBProxyEndpointsResponse (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBProxyEndpointsResponse_httpStatus :: Lens' DescribeDBProxyEndpointsResponse Int Source #

The response's http status code.

DescribeDBProxyTargetGroups

describeDBProxyTargetGroups_filters :: Lens' DescribeDBProxyTargetGroups (Maybe [Filter]) Source #

This parameter is not currently supported.

describeDBProxyTargetGroups_marker :: Lens' DescribeDBProxyTargetGroups (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBProxyTargetGroups_maxRecords :: Lens' DescribeDBProxyTargetGroups (Maybe Natural) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBProxyTargetGroups_targetGroupName :: Lens' DescribeDBProxyTargetGroups (Maybe Text) Source #

The identifier of the DBProxyTargetGroup to describe.

describeDBProxyTargetGroups_dbProxyName :: Lens' DescribeDBProxyTargetGroups Text Source #

The identifier of the DBProxy associated with the target group.

describeDBProxyTargetGroupsResponse_marker :: Lens' DescribeDBProxyTargetGroupsResponse (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBProxyTargetGroupsResponse_targetGroups :: Lens' DescribeDBProxyTargetGroupsResponse (Maybe [DBProxyTargetGroup]) Source #

An arbitrary number of DBProxyTargetGroup objects, containing details of the corresponding target groups.

describeDBProxyTargetGroupsResponse_httpStatus :: Lens' DescribeDBProxyTargetGroupsResponse Int Source #

The response's http status code.

DescribeDBProxyTargets

describeDBProxyTargets_filters :: Lens' DescribeDBProxyTargets (Maybe [Filter]) Source #

This parameter is not currently supported.

describeDBProxyTargets_marker :: Lens' DescribeDBProxyTargets (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBProxyTargets_maxRecords :: Lens' DescribeDBProxyTargets (Maybe Natural) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBProxyTargets_targetGroupName :: Lens' DescribeDBProxyTargets (Maybe Text) Source #

The identifier of the DBProxyTargetGroup to describe.

describeDBProxyTargets_dbProxyName :: Lens' DescribeDBProxyTargets Text Source #

The identifier of the DBProxyTarget to describe.

describeDBProxyTargetsResponse_marker :: Lens' DescribeDBProxyTargetsResponse (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBProxyTargetsResponse_targets :: Lens' DescribeDBProxyTargetsResponse (Maybe [DBProxyTarget]) Source #

An arbitrary number of DBProxyTarget objects, containing details of the corresponding targets.

describeDBProxyTargetsResponse_httpStatus :: Lens' DescribeDBProxyTargetsResponse Int Source #

The response's http status code.

DescribeDBSecurityGroups

describeDBSecurityGroups_dbSecurityGroupName :: Lens' DescribeDBSecurityGroups (Maybe Text) Source #

The name of the DB security group to return details for.

describeDBSecurityGroups_filters :: Lens' DescribeDBSecurityGroups (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeDBSecurityGroups_marker :: Lens' DescribeDBSecurityGroups (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBSecurityGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBSecurityGroups_maxRecords :: Lens' DescribeDBSecurityGroups (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBSecurityGroupsResponse_dbSecurityGroups :: Lens' DescribeDBSecurityGroupsResponse (Maybe [DBSecurityGroup]) Source #

A list of DBSecurityGroup instances.

describeDBSecurityGroupsResponse_marker :: Lens' DescribeDBSecurityGroupsResponse (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBSecurityGroupsResponse_httpStatus :: Lens' DescribeDBSecurityGroupsResponse Int Source #

The response's http status code.

DescribeDBSnapshotAttributes

describeDBSnapshotAttributes_dbSnapshotIdentifier :: Lens' DescribeDBSnapshotAttributes Text Source #

The identifier for the DB snapshot to describe the attributes for.

describeDBSnapshotAttributesResponse_dbSnapshotAttributesResult :: Lens' DescribeDBSnapshotAttributesResponse (Maybe DBSnapshotAttributesResult) Source #

Undocumented member.

describeDBSnapshotAttributesResponse_httpStatus :: Lens' DescribeDBSnapshotAttributesResponse Int Source #

The response's http status code.

DescribeDBSnapshots

describeDBSnapshots_dbInstanceIdentifier :: Lens' DescribeDBSnapshots (Maybe Text) Source #

The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn't case-sensitive.

Constraints:

If supplied, must match the identifier of an existing DBInstance.

describeDBSnapshots_dbSnapshotIdentifier :: Lens' DescribeDBSnapshots (Maybe Text) Source #

A specific DB snapshot identifier to describe. This value is stored as a lowercase string.

Constraints:

If supplied, must match the identifier of an existing DBSnapshot.
If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

describeDBSnapshots_dbiResourceId :: Lens' DescribeDBSnapshots (Maybe Text) Source #

A specific DB resource ID to describe.

describeDBSnapshots_filters :: Lens' DescribeDBSnapshots (Maybe [Filter]) Source #

A filter that specifies one or more DB snapshots to describe.

Supported filters:

db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).
db-snapshot-id - Accepts DB snapshot identifiers.
dbi-resource-id - Accepts identifiers of source DB instances.
snapshot-type - Accepts types of DB snapshots.
engine - Accepts names of database engines.

describeDBSnapshots_includePublic :: Lens' DescribeDBSnapshots (Maybe Bool) Source #

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

This setting doesn't apply to RDS Custom.

describeDBSnapshots_includeShared :: Lens' DescribeDBSnapshots (Maybe Bool) Source #

A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.

You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.

This setting doesn't apply to RDS Custom.

describeDBSnapshots_marker :: Lens' DescribeDBSnapshots (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBSnapshots_maxRecords :: Lens' DescribeDBSnapshots (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBSnapshots_snapshotType :: Lens' DescribeDBSnapshots (Maybe Text) Source #

The type of snapshots to be returned. You can specify one of the following values:

automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.
manual - Return all DB snapshots that have been taken by my Amazon Web Services account.
shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.
public - Return all DB snapshots that have been marked as public.
awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.
For information about Amazon Web Services Backup, see the Amazon Web Services Backup Developer Guide.
The awsbackup type does not apply to Aurora.

If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

describeDBSnapshotsResponse_dbSnapshots :: Lens' DescribeDBSnapshotsResponse (Maybe [DBSnapshot]) Source #

A list of DBSnapshot instances.

describeDBSnapshotsResponse_marker :: Lens' DescribeDBSnapshotsResponse (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBSnapshotsResponse_httpStatus :: Lens' DescribeDBSnapshotsResponse Int Source #

The response's http status code.

DescribeDBSubnetGroups

describeDBSubnetGroups_dbSubnetGroupName :: Lens' DescribeDBSubnetGroups (Maybe Text) Source #

The name of the DB subnet group to return details for.

describeDBSubnetGroups_filters :: Lens' DescribeDBSubnetGroups (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeDBSubnetGroups_marker :: Lens' DescribeDBSubnetGroups (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBSubnetGroups_maxRecords :: Lens' DescribeDBSubnetGroups (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBSubnetGroupsResponse_dbSubnetGroups :: Lens' DescribeDBSubnetGroupsResponse (Maybe [DBSubnetGroup]) Source #

A list of DBSubnetGroup instances.

describeDBSubnetGroupsResponse_marker :: Lens' DescribeDBSubnetGroupsResponse (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBSubnetGroupsResponse_httpStatus :: Lens' DescribeDBSubnetGroupsResponse Int Source #

The response's http status code.

DescribeEngineDefaultClusterParameters

describeEngineDefaultClusterParameters_filters :: Lens' DescribeEngineDefaultClusterParameters (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeEngineDefaultClusterParameters_marker :: Lens' DescribeEngineDefaultClusterParameters (Maybe Text) Source #

An optional pagination token provided by a previous DescribeEngineDefaultClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeEngineDefaultClusterParameters_maxRecords :: Lens' DescribeEngineDefaultClusterParameters (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeEngineDefaultClusterParameters_dbParameterGroupFamily :: Lens' DescribeEngineDefaultClusterParameters Text Source #

The name of the DB cluster parameter group family to return engine parameter information for.

describeEngineDefaultClusterParametersResponse_engineDefaults :: Lens' DescribeEngineDefaultClusterParametersResponse (Maybe EngineDefaults) Source #

Undocumented member.

describeEngineDefaultClusterParametersResponse_httpStatus :: Lens' DescribeEngineDefaultClusterParametersResponse Int Source #

The response's http status code.

DescribeEngineDefaultParameters

describeEngineDefaultParameters_filters :: Lens' DescribeEngineDefaultParameters (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeEngineDefaultParameters_marker :: Lens' DescribeEngineDefaultParameters (Maybe Text) Source #

An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeEngineDefaultParameters_maxRecords :: Lens' DescribeEngineDefaultParameters (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeEngineDefaultParameters_dbParameterGroupFamily :: Lens' DescribeEngineDefaultParameters Text Source #

The name of the DB parameter group family.

Valid Values:

```
aurora5.6
```
```
aurora-mysql5.7
```
```
aurora-mysql8.0
```
```
aurora-postgresql10
```
```
aurora-postgresql11
```
```
aurora-postgresql12
```
```
aurora-postgresql13
```
```
aurora-postgresql14
```
```
custom-oracle-ee-19
```
```
mariadb10.2
```
```
mariadb10.3
```
```
mariadb10.4
```
```
mariadb10.5
```
```
mariadb10.6
```
```
mysql5.7
```
```
mysql8.0
```
```
oracle-ee-19
```
```
oracle-ee-cdb-19
```
```
oracle-ee-cdb-21
```
```
oracle-se2-19
```
```
oracle-se2-cdb-19
```
```
oracle-se2-cdb-21
```
```
postgres10
```
```
postgres11
```
```
postgres12
```
```
postgres13
```
```
postgres14
```
```
sqlserver-ee-11.0
```
```
sqlserver-ee-12.0
```
```
sqlserver-ee-13.0
```
```
sqlserver-ee-14.0
```
```
sqlserver-ee-15.0
```
```
sqlserver-ex-11.0
```
```
sqlserver-ex-12.0
```
```
sqlserver-ex-13.0
```
```
sqlserver-ex-14.0
```
```
sqlserver-ex-15.0
```
```
sqlserver-se-11.0
```
```
sqlserver-se-12.0
```
```
sqlserver-se-13.0
```
```
sqlserver-se-14.0
```
```
sqlserver-se-15.0
```
```
sqlserver-web-11.0
```
```
sqlserver-web-12.0
```
```
sqlserver-web-13.0
```
```
sqlserver-web-14.0
```
```
sqlserver-web-15.0
```

describeEngineDefaultParametersResponse_httpStatus :: Lens' DescribeEngineDefaultParametersResponse Int Source #

The response's http status code.

describeEngineDefaultParametersResponse_engineDefaults :: Lens' DescribeEngineDefaultParametersResponse EngineDefaults Source #

Undocumented member.

DescribeEventCategories

describeEventCategories_filters :: Lens' DescribeEventCategories (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeEventCategories_sourceType :: Lens' DescribeEventCategories (Maybe Text) Source #

The type of source that is generating the events. For RDS Proxy events, specify db-proxy.

describeEventCategoriesResponse_eventCategoriesMapList :: Lens' DescribeEventCategoriesResponse (Maybe [EventCategoriesMap]) Source #

A list of EventCategoriesMap data types.

describeEventCategoriesResponse_httpStatus :: Lens' DescribeEventCategoriesResponse Int Source #

The response's http status code.

DescribeEventSubscriptions

describeEventSubscriptions_filters :: Lens' DescribeEventSubscriptions (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeEventSubscriptions_marker :: Lens' DescribeEventSubscriptions (Maybe Text) Source #

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

describeEventSubscriptions_maxRecords :: Lens' DescribeEventSubscriptions (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeEventSubscriptions_subscriptionName :: Lens' DescribeEventSubscriptions (Maybe Text) Source #

The name of the RDS event notification subscription you want to describe.

describeEventSubscriptionsResponse_eventSubscriptionsList :: Lens' DescribeEventSubscriptionsResponse (Maybe [EventSubscription]) Source #

A list of EventSubscriptions data types.

describeEventSubscriptionsResponse_marker :: Lens' DescribeEventSubscriptionsResponse (Maybe Text) Source #

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeEventSubscriptionsResponse_httpStatus :: Lens' DescribeEventSubscriptionsResponse Int Source #

The response's http status code.

DescribeEvents

describeEvents_duration :: Lens' DescribeEvents (Maybe Int) Source #

The number of minutes to retrieve events for.

Default: 60

describeEvents_endTime :: Lens' DescribeEvents (Maybe UTCTime) Source #

The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

describeEvents_eventCategories :: Lens' DescribeEvents (Maybe [Text]) Source #

A list of event categories that trigger notifications for a event notification subscription.

describeEvents_filters :: Lens' DescribeEvents (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeEvents_marker :: Lens' DescribeEvents (Maybe Text) Source #

An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeEvents_maxRecords :: Lens' DescribeEvents (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeEvents_sourceIdentifier :: Lens' DescribeEvents (Maybe Text) Source #

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

Constraints:

If SourceIdentifier is supplied, SourceType must also be provided.
If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
If the source type is an RDS Proxy, a DBProxyName value must be supplied.
Can't end with a hyphen or contain two consecutive hyphens.

describeEvents_sourceType :: Lens' DescribeEvents (Maybe SourceType) Source #

The event source to retrieve events for. If no value is specified, all events are returned.

describeEvents_startTime :: Lens' DescribeEvents (Maybe UTCTime) Source #

The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

describeEventsResponse_events :: Lens' DescribeEventsResponse (Maybe [Event]) Source #

A list of Event instances.

describeEventsResponse_marker :: Lens' DescribeEventsResponse (Maybe Text) Source #

An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeEventsResponse_httpStatus :: Lens' DescribeEventsResponse Int Source #

The response's http status code.

DescribeExportTasks

describeExportTasks_exportTaskIdentifier :: Lens' DescribeExportTasks (Maybe Text) Source #

The identifier of the snapshot export task to be described.

describeExportTasks_filters :: Lens' DescribeExportTasks (Maybe [Filter]) Source #

Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.

Supported filters include the following:

export-task-identifier - An identifier for the snapshot export task.
s3-bucket - The Amazon S3 bucket the snapshot is exported to.
source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3
status - The status of the export task. Must be lowercase. Valid statuses are the following:
- ```
canceled
```
- ```
canceling
```
- ```
complete
```
- ```
failed
```
- ```
in_progress
```
- ```
starting
```

describeExportTasks_marker :: Lens' DescribeExportTasks (Maybe Text) Source #

An optional pagination token provided by a previous DescribeExportTasks request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

describeExportTasks_maxRecords :: Lens' DescribeExportTasks (Maybe Natural) Source #

The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later DescribeExportTasks request to retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeExportTasks_sourceArn :: Lens' DescribeExportTasks (Maybe Text) Source #

The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

describeExportTasks_sourceType :: Lens' DescribeExportTasks (Maybe ExportSourceType) Source #

The type of source for the export.

describeExportTasksResponse_exportTasks :: Lens' DescribeExportTasksResponse (Maybe [ExportTask]) Source #

Information about an export of a snapshot to Amazon S3.

describeExportTasksResponse_marker :: Lens' DescribeExportTasksResponse (Maybe Text) Source #

A pagination token that can be used in a later DescribeExportTasks request. A marker is used for pagination to identify the location to begin output for the next response of DescribeExportTasks.

describeExportTasksResponse_httpStatus :: Lens' DescribeExportTasksResponse Int Source #

The response's http status code.

DescribeGlobalClusters

describeGlobalClusters_filters :: Lens' DescribeGlobalClusters (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeGlobalClusters_globalClusterIdentifier :: Lens' DescribeGlobalClusters (Maybe Text) Source #

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

Constraints:

If supplied, must match an existing DBClusterIdentifier.

describeGlobalClusters_marker :: Lens' DescribeGlobalClusters (Maybe Text) Source #

An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeGlobalClusters_maxRecords :: Lens' DescribeGlobalClusters (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeGlobalClustersResponse_globalClusters :: Lens' DescribeGlobalClustersResponse (Maybe [GlobalCluster]) Source #

The list of global clusters returned by this request.

describeGlobalClustersResponse_marker :: Lens' DescribeGlobalClustersResponse (Maybe Text) Source #

An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeGlobalClustersResponse_httpStatus :: Lens' DescribeGlobalClustersResponse Int Source #

The response's http status code.

DescribeOptionGroupOptions

describeOptionGroupOptions_filters :: Lens' DescribeOptionGroupOptions (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeOptionGroupOptions_majorEngineVersion :: Lens' DescribeOptionGroupOptions (Maybe Text) Source #

If specified, filters the results to include only options for the specified major engine version.

describeOptionGroupOptions_marker :: Lens' DescribeOptionGroupOptions (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeOptionGroupOptions_maxRecords :: Lens' DescribeOptionGroupOptions (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeOptionGroupOptions_engineName :: Lens' DescribeOptionGroupOptions Text Source #

A required parameter. Options available for the given engine name are described.

Valid Values:

```
mariadb
```
```
mysql
```
```
oracle-ee
```
```
oracle-ee-cdb
```
```
oracle-se2
```
```
oracle-se2-cdb
```
```
postgres
```
```
sqlserver-ee
```
```
sqlserver-se
```
```
sqlserver-ex
```
```
sqlserver-web
```

describeOptionGroupOptionsResponse_marker :: Lens' DescribeOptionGroupOptionsResponse (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeOptionGroupOptionsResponse_optionGroupOptions :: Lens' DescribeOptionGroupOptionsResponse (Maybe [OptionGroupOption]) Source #

Undocumented member.

describeOptionGroupOptionsResponse_httpStatus :: Lens' DescribeOptionGroupOptionsResponse Int Source #

The response's http status code.

DescribeOptionGroups

describeOptionGroups_engineName :: Lens' DescribeOptionGroups (Maybe Text) Source #

Filters the list of option groups to only include groups associated with a specific database engine.

Valid Values:

```
mariadb
```
```
mysql
```
```
oracle-ee
```
```
oracle-ee-cdb
```
```
oracle-se2
```
```
oracle-se2-cdb
```
```
postgres
```
```
sqlserver-ee
```
```
sqlserver-se
```
```
sqlserver-ex
```
```
sqlserver-web
```

describeOptionGroups_filters :: Lens' DescribeOptionGroups (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeOptionGroups_majorEngineVersion :: Lens' DescribeOptionGroups (Maybe Text) Source #

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

describeOptionGroups_marker :: Lens' DescribeOptionGroups (Maybe Text) Source #

An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeOptionGroups_maxRecords :: Lens' DescribeOptionGroups (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeOptionGroups_optionGroupName :: Lens' DescribeOptionGroups (Maybe Text) Source #

The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

describeOptionGroupsResponse_marker :: Lens' DescribeOptionGroupsResponse (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeOptionGroupsResponse_optionGroupsList :: Lens' DescribeOptionGroupsResponse (Maybe [OptionGroup]) Source #

List of option groups.

describeOptionGroupsResponse_httpStatus :: Lens' DescribeOptionGroupsResponse Int Source #

The response's http status code.

DescribeOrderableDBInstanceOptions

describeOrderableDBInstanceOptions_availabilityZoneGroup :: Lens' DescribeOrderableDBInstanceOptions (Maybe Text) Source #

The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.

Omit this parameter to show the available offerings in the specified Amazon Web Services Region.

This setting doesn't apply to RDS Custom.

describeOrderableDBInstanceOptions_dbInstanceClass :: Lens' DescribeOrderableDBInstanceOptions (Maybe Text) Source #

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

describeOrderableDBInstanceOptions_engineVersion :: Lens' DescribeOrderableDBInstanceOptions (Maybe Text) Source #

The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

describeOrderableDBInstanceOptions_filters :: Lens' DescribeOrderableDBInstanceOptions (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeOrderableDBInstanceOptions_licenseModel :: Lens' DescribeOrderableDBInstanceOptions (Maybe Text) Source #

The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.

RDS Custom supports only the BYOL licensing model.

describeOrderableDBInstanceOptions_marker :: Lens' DescribeOrderableDBInstanceOptions (Maybe Text) Source #

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeOrderableDBInstanceOptions_maxRecords :: Lens' DescribeOrderableDBInstanceOptions (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 10000.

describeOrderableDBInstanceOptions_vpc :: Lens' DescribeOrderableDBInstanceOptions (Maybe Bool) Source #

A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.

RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.

describeOrderableDBInstanceOptions_engine :: Lens' DescribeOrderableDBInstanceOptions Text Source #

The name of the engine to retrieve DB instance options for.

Valid Values:

aurora (for MySQL 5.6-compatible Aurora)
aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
```
aurora-postgresql
```
```
mariadb
```
```
mysql
```
```
oracle-ee
```
```
oracle-ee-cdb
```
```
oracle-se2
```
```
oracle-se2-cdb
```
```
postgres
```
```
sqlserver-ee
```
```
sqlserver-se
```
```
sqlserver-ex
```
```
sqlserver-web
```

describeOrderableDBInstanceOptionsResponse_marker :: Lens' DescribeOrderableDBInstanceOptionsResponse (Maybe Text) Source #

An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeOrderableDBInstanceOptionsResponse_orderableDBInstanceOptions :: Lens' DescribeOrderableDBInstanceOptionsResponse (Maybe [OrderableDBInstanceOption]) Source #

An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

describeOrderableDBInstanceOptionsResponse_httpStatus :: Lens' DescribeOrderableDBInstanceOptionsResponse Int Source #

The response's http status code.

DescribePendingMaintenanceActions

describePendingMaintenanceActions_filters :: Lens' DescribePendingMaintenanceActions (Maybe [Filter]) Source #

A filter that specifies one or more resources to return pending maintenance actions for.

Supported filters:

db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes pending maintenance actions for the DB clusters identified by these ARNs.
db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list only includes pending maintenance actions for the DB instances identified by these ARNs.

describePendingMaintenanceActions_marker :: Lens' DescribePendingMaintenanceActions (Maybe Text) Source #

An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.

describePendingMaintenanceActions_maxRecords :: Lens' DescribePendingMaintenanceActions (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describePendingMaintenanceActions_resourceIdentifier :: Lens' DescribePendingMaintenanceActions (Maybe Text) Source #

The ARN of a resource to return pending maintenance actions for.

describePendingMaintenanceActionsResponse_marker :: Lens' DescribePendingMaintenanceActionsResponse (Maybe Text) Source #

An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.

describePendingMaintenanceActionsResponse_pendingMaintenanceActions :: Lens' DescribePendingMaintenanceActionsResponse (Maybe [ResourcePendingMaintenanceActions]) Source #

A list of the pending maintenance actions for the resource.

describePendingMaintenanceActionsResponse_httpStatus :: Lens' DescribePendingMaintenanceActionsResponse Int Source #

The response's http status code.

DescribeReservedDBInstances

describeReservedDBInstances_dbInstanceClass :: Lens' DescribeReservedDBInstances (Maybe Text) Source #

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

describeReservedDBInstances_duration :: Lens' DescribeReservedDBInstances (Maybe Text) Source #

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

describeReservedDBInstances_filters :: Lens' DescribeReservedDBInstances (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeReservedDBInstances_leaseId :: Lens' DescribeReservedDBInstances (Maybe Text) Source #

The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.

Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

describeReservedDBInstances_marker :: Lens' DescribeReservedDBInstances (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeReservedDBInstances_maxRecords :: Lens' DescribeReservedDBInstances (Maybe Int) Source #

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeReservedDBInstances_multiAZ :: Lens' DescribeReservedDBInstances (Maybe Bool) Source #

A value that indicates whether to show only those reservations that support Multi-AZ.

describeReservedDBInstances_offeringType :: Lens' DescribeReservedDBInstances (Maybe Text) Source #

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

describeReservedDBInstances_productDescription :: Lens' DescribeReservedDBInstances (Maybe Text) Source #

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

describeReservedDBInstances_reservedDBInstanceId :: Lens' DescribeReservedDBInstances (Maybe Text) Source #

The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

describeReservedDBInstances_reservedDBInstancesOfferingId :: Lens' DescribeReservedDBInstances (Maybe Text) Source #

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

describeReservedDBInstancesResponse_marker :: Lens' DescribeReservedDBInstancesResponse (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeReservedDBInstancesResponse_reservedDBInstances :: Lens' DescribeReservedDBInstancesResponse (Maybe [ReservedDBInstance]) Source #

A list of reserved DB instances.

describeReservedDBInstancesResponse_httpStatus :: Lens' DescribeReservedDBInstancesResponse Int Source #

The response's http status code.

DescribeReservedDBInstancesOfferings

describeReservedDBInstancesOfferings_dbInstanceClass :: Lens' DescribeReservedDBInstancesOfferings (Maybe Text) Source #

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

describeReservedDBInstancesOfferings_duration :: Lens' DescribeReservedDBInstancesOfferings (Maybe Text) Source #

Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

describeReservedDBInstancesOfferings_filters :: Lens' DescribeReservedDBInstancesOfferings (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeReservedDBInstancesOfferings_marker :: Lens' DescribeReservedDBInstancesOfferings (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeReservedDBInstancesOfferings_maxRecords :: Lens' DescribeReservedDBInstancesOfferings (Maybe Int) Source #

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeReservedDBInstancesOfferings_multiAZ :: Lens' DescribeReservedDBInstancesOfferings (Maybe Bool) Source #

A value that indicates whether to show only those reservations that support Multi-AZ.

describeReservedDBInstancesOfferings_offeringType :: Lens' DescribeReservedDBInstancesOfferings (Maybe Text) Source #

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

describeReservedDBInstancesOfferings_productDescription :: Lens' DescribeReservedDBInstancesOfferings (Maybe Text) Source #

Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.

The results show offerings that partially match the filter value.

describeReservedDBInstancesOfferings_reservedDBInstancesOfferingId :: Lens' DescribeReservedDBInstancesOfferings (Maybe Text) Source #

The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

describeReservedDBInstancesOfferingsResponse_marker :: Lens' DescribeReservedDBInstancesOfferingsResponse (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeReservedDBInstancesOfferingsResponse_reservedDBInstancesOfferings :: Lens' DescribeReservedDBInstancesOfferingsResponse (Maybe [ReservedDBInstancesOffering]) Source #

A list of reserved DB instance offerings.

describeReservedDBInstancesOfferingsResponse_httpStatus :: Lens' DescribeReservedDBInstancesOfferingsResponse Int Source #

The response's http status code.

DescribeSourceRegions

describeSourceRegions_filters :: Lens' DescribeSourceRegions (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeSourceRegions_marker :: Lens' DescribeSourceRegions (Maybe Text) Source #

An optional pagination token provided by a previous DescribeSourceRegions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeSourceRegions_maxRecords :: Lens' DescribeSourceRegions (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeSourceRegions_regionName :: Lens' DescribeSourceRegions (Maybe Text) Source #

The source Amazon Web Services Region name. For example, us-east-1.

Constraints:

Must specify a valid Amazon Web Services Region name.

describeSourceRegionsResponse_marker :: Lens' DescribeSourceRegionsResponse (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeSourceRegionsResponse_sourceRegions :: Lens' DescribeSourceRegionsResponse (Maybe [SourceRegion]) Source #

A list of SourceRegion instances that contains each source Amazon Web Services Region that the current Amazon Web Services Region can get a read replica or a DB snapshot from.

describeSourceRegionsResponse_httpStatus :: Lens' DescribeSourceRegionsResponse Int Source #

The response's http status code.

DescribeValidDBInstanceModifications

describeValidDBInstanceModifications_dbInstanceIdentifier :: Lens' DescribeValidDBInstanceModifications Text Source #

The customer identifier or the ARN of your DB instance.

describeValidDBInstanceModificationsResponse_validDBInstanceModificationsMessage :: Lens' DescribeValidDBInstanceModificationsResponse (Maybe ValidDBInstanceModificationsMessage) Source #

Undocumented member.

describeValidDBInstanceModificationsResponse_httpStatus :: Lens' DescribeValidDBInstanceModificationsResponse Int Source #

The response's http status code.

DownloadDBLogFilePortion

downloadDBLogFilePortion_marker :: Lens' DownloadDBLogFilePortion (Maybe Text) Source #

The pagination token provided in the previous request or "0". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.

downloadDBLogFilePortion_numberOfLines :: Lens' DownloadDBLogFilePortion (Maybe Int) Source #

The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.

If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.

If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first.
If NumberOfLines is specified and Marker isn't specified, then the most recent lines from the end of the log file are returned.
If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned.
You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.

downloadDBLogFilePortion_dbInstanceIdentifier :: Lens' DownloadDBLogFilePortion Text Source #

The customer-assigned name of the DB instance that contains the log files you want to list.

Constraints:

Must match the identifier of an existing DBInstance.

downloadDBLogFilePortion_logFileName :: Lens' DownloadDBLogFilePortion Text Source #

The name of the log file to be downloaded.

downloadDBLogFilePortionResponse_additionalDataPending :: Lens' DownloadDBLogFilePortionResponse (Maybe Bool) Source #

Boolean value that if true, indicates there is more data to be downloaded.

downloadDBLogFilePortionResponse_logFileData :: Lens' DownloadDBLogFilePortionResponse (Maybe Text) Source #

Entries from the specified log file.

downloadDBLogFilePortionResponse_marker :: Lens' DownloadDBLogFilePortionResponse (Maybe Text) Source #

A pagination token that can be used in a later DownloadDBLogFilePortion request.

downloadDBLogFilePortionResponse_httpStatus :: Lens' DownloadDBLogFilePortionResponse Int Source #

The response's http status code.

FailoverDBCluster

failoverDBCluster_targetDBInstanceIdentifier :: Lens' FailoverDBCluster (Maybe Text) Source #

The name of the DB instance to promote to the primary DB instance.

Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster, for example mydbcluster-replica1.

This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.

failoverDBCluster_dbClusterIdentifier :: Lens' FailoverDBCluster Text Source #

A DB cluster identifier to force a failover for. This parameter isn't case-sensitive.

Constraints:

Must match the identifier of an existing DBCluster.

failoverDBClusterResponse_dbCluster :: Lens' FailoverDBClusterResponse (Maybe DBCluster) Source #

Undocumented member.

failoverDBClusterResponse_httpStatus :: Lens' FailoverDBClusterResponse Int Source #

The response's http status code.

FailoverGlobalCluster

failoverGlobalCluster_globalClusterIdentifier :: Lens' FailoverGlobalCluster Text Source #

Identifier of the Aurora global database (GlobalCluster) that should be failed over. The identifier is the unique key assigned by the user when the Aurora global database was created. In other words, it's the name of the Aurora global database that you want to fail over.

Constraints:

Must match the identifier of an existing GlobalCluster (Aurora global database).

failoverGlobalCluster_targetDbClusterIdentifier :: Lens' FailoverGlobalCluster Text Source #

Identifier of the secondary Aurora DB cluster that you want to promote to primary for the Aurora global database (GlobalCluster.) Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services Region.

failoverGlobalClusterResponse_globalCluster :: Lens' FailoverGlobalClusterResponse (Maybe GlobalCluster) Source #

Undocumented member.

failoverGlobalClusterResponse_httpStatus :: Lens' FailoverGlobalClusterResponse Int Source #

The response's http status code.

ListTagsForResource

listTagsForResource_filters :: Lens' ListTagsForResource (Maybe [Filter]) Source #

This parameter isn't currently supported.

listTagsForResource_resourceName :: Lens' ListTagsForResource Text Source #

The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

listTagsForResourceResponse_tagList :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #

List of tags returned by the ListTagsForResource operation.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

ModifyActivityStream

modifyActivityStream_auditPolicyState :: Lens' ModifyActivityStream (Maybe AuditPolicyState) Source #

The audit policy state. When a policy is unlocked, it is read/write. When it is locked, it is read-only. You can edit your audit policy only when the activity stream is unlocked or stopped.

modifyActivityStream_resourceArn :: Lens' ModifyActivityStream (Maybe Text) Source #

The Amazon Resource Name (ARN) of the RDS for Oracle DB instance, for example, arn:aws:rds:us-east-1:12345667890:instance:my-orcl-db.

modifyActivityStreamResponse_engineNativeAuditFieldsIncluded :: Lens' ModifyActivityStreamResponse (Maybe Bool) Source #

Indicates whether engine-native audit fields are included in the database activity stream.

modifyActivityStreamResponse_kinesisStreamName :: Lens' ModifyActivityStreamResponse (Maybe Text) Source #

The name of the Amazon Kinesis data stream to be used for the database activity stream.

modifyActivityStreamResponse_kmsKeyId :: Lens' ModifyActivityStreamResponse (Maybe Text) Source #

The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.

modifyActivityStreamResponse_mode :: Lens' ModifyActivityStreamResponse (Maybe ActivityStreamMode) Source #

The mode of the database activity stream.

modifyActivityStreamResponse_policyStatus :: Lens' ModifyActivityStreamResponse (Maybe ActivityStreamPolicyStatus) Source #

The status of the modification to the policy state of the database activity stream.

modifyActivityStreamResponse_status :: Lens' ModifyActivityStreamResponse (Maybe ActivityStreamStatus) Source #

The status of the modification to the database activity stream.

modifyActivityStreamResponse_httpStatus :: Lens' ModifyActivityStreamResponse Int Source #

The response's http status code.

ModifyCertificates

modifyCertificates_certificateIdentifier :: Lens' ModifyCertificates (Maybe Text) Source #

The new default certificate identifier to override the current one with.

To determine the valid values, use the describe-certificates CLI command or the DescribeCertificates API operation.

modifyCertificates_removeCustomerOverride :: Lens' ModifyCertificates (Maybe Bool) Source #

A value that indicates whether to remove the override for the default certificate. If the override is removed, the default certificate is the system default.

modifyCertificatesResponse_certificate :: Lens' ModifyCertificatesResponse (Maybe Certificate) Source #

Undocumented member.

modifyCertificatesResponse_httpStatus :: Lens' ModifyCertificatesResponse Int Source #

The response's http status code.

ModifyCurrentDBClusterCapacity

modifyCurrentDBClusterCapacity_capacity :: Lens' ModifyCurrentDBClusterCapacity (Maybe Int) Source #

The DB cluster capacity.

When you change the capacity of a paused Aurora Serverless v1 DB cluster, it automatically resumes.

Constraints:

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

modifyCurrentDBClusterCapacity_secondsBeforeTimeout :: Lens' ModifyCurrentDBClusterCapacity (Maybe Int) Source #

The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.

Specify a value between 10 and 600 seconds.

modifyCurrentDBClusterCapacity_timeoutAction :: Lens' ModifyCurrentDBClusterCapacity (Maybe Text) Source #

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.

modifyCurrentDBClusterCapacity_dbClusterIdentifier :: Lens' ModifyCurrentDBClusterCapacity Text Source #

The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

Constraints:

Must match the identifier of an existing DB cluster.

modifyCurrentDBClusterCapacityResponse_currentCapacity :: Lens' ModifyCurrentDBClusterCapacityResponse (Maybe Int) Source #

The current capacity of the DB cluster.

modifyCurrentDBClusterCapacityResponse_dbClusterIdentifier :: Lens' ModifyCurrentDBClusterCapacityResponse (Maybe Text) Source #

A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

modifyCurrentDBClusterCapacityResponse_pendingCapacity :: Lens' ModifyCurrentDBClusterCapacityResponse (Maybe Int) Source #

A value that specifies the capacity that the DB cluster scales to next.

modifyCurrentDBClusterCapacityResponse_secondsBeforeTimeout :: Lens' ModifyCurrentDBClusterCapacityResponse (Maybe Int) Source #

The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.

modifyCurrentDBClusterCapacityResponse_timeoutAction :: Lens' ModifyCurrentDBClusterCapacityResponse (Maybe Text) Source #

The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange.

modifyCurrentDBClusterCapacityResponse_httpStatus :: Lens' ModifyCurrentDBClusterCapacityResponse Int Source #

The response's http status code.

ModifyCustomDBEngineVersion

modifyCustomDBEngineVersion_description :: Lens' ModifyCustomDBEngineVersion (Maybe Text) Source #

An optional description of your CEV.

modifyCustomDBEngineVersion_status :: Lens' ModifyCustomDBEngineVersion (Maybe CustomEngineVersionStatus) Source #

The availability status to be assigned to the CEV. Valid values are as follows:

available: You can use this CEV to create a new RDS Custom DB instance.
inactive: You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can't patch or create new instances with this CEV.

You can change any status to any status. A typical reason to change status is to prevent the accidental use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status of your CEV from available to inactive, and from inactive back to available. To change the availability status of the CEV, it must not currently be in use by an RDS Custom instance, snapshot, or automated backup.

modifyCustomDBEngineVersion_engine :: Lens' ModifyCustomDBEngineVersion Text Source #

The DB engine. The only supported value is custom-oracle-ee.

modifyCustomDBEngineVersion_engineVersion :: Lens' ModifyCustomDBEngineVersion Text Source #

The custom engine version (CEV) that you want to modify. This option is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.

dbEngineVersion_createTime :: Lens' DBEngineVersion (Maybe UTCTime) Source #

The creation time of the DB engine version.

dbEngineVersion_customDBEngineVersionManifest :: Lens' DBEngineVersion (Maybe Text) Source #

JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide.

dbEngineVersion_dbEngineDescription :: Lens' DBEngineVersion (Maybe Text) Source #

The description of the database engine.

dbEngineVersion_dbEngineMediaType :: Lens' DBEngineVersion (Maybe Text) Source #

A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.

dbEngineVersion_dbEngineVersionArn :: Lens' DBEngineVersion (Maybe Text) Source #

The ARN of the custom engine version.

dbEngineVersion_dbEngineVersionDescription :: Lens' DBEngineVersion (Maybe Text) Source #

The description of the database engine version.

dbEngineVersion_dbParameterGroupFamily :: Lens' DBEngineVersion (Maybe Text) Source #

The name of the DB parameter group family for the database engine.

dbEngineVersion_databaseInstallationFilesS3BucketName :: Lens' DBEngineVersion (Maybe Text) Source #

The name of the Amazon S3 bucket that contains your database installation files.

dbEngineVersion_databaseInstallationFilesS3Prefix :: Lens' DBEngineVersion (Maybe Text) Source #

The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.

dbEngineVersion_defaultCharacterSet :: Lens' DBEngineVersion (Maybe CharacterSet) Source #

The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.

dbEngineVersion_engine :: Lens' DBEngineVersion (Maybe Text) Source #

The name of the database engine.

dbEngineVersion_engineVersion :: Lens' DBEngineVersion (Maybe Text) Source #

The version number of the database engine.

dbEngineVersion_exportableLogTypes :: Lens' DBEngineVersion (Maybe [Text]) Source #

The types of logs that the database engine has available for export to CloudWatch Logs.

dbEngineVersion_image :: Lens' DBEngineVersion (Maybe CustomDBEngineVersionAMI) Source #

The EC2 image

dbEngineVersion_kmsKeyId :: Lens' DBEngineVersion (Maybe Text) Source #

The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.

dbEngineVersion_majorEngineVersion :: Lens' DBEngineVersion (Maybe Text) Source #

The major engine version of the CEV.

dbEngineVersion_status :: Lens' DBEngineVersion (Maybe Text) Source #

The status of the DB engine version, either available or deprecated.

dbEngineVersion_supportedCACertificateIdentifiers :: Lens' DBEngineVersion (Maybe [Text]) Source #

A list of the supported CA certificate identifiers.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

dbEngineVersion_supportedCharacterSets :: Lens' DBEngineVersion (Maybe [CharacterSet]) Source #

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.

dbEngineVersion_supportedEngineModes :: Lens' DBEngineVersion (Maybe [Text]) Source #

A list of the supported DB engine modes.

dbEngineVersion_supportedFeatureNames :: Lens' DBEngineVersion (Maybe [Text]) Source #

A list of features supported by the DB engine.

The supported features vary by DB engine and DB engine version.

To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:

aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>

For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:

aws rds describe-db-engine-versions --engine postgres --engine-version 13.3

The supported features are listed under SupportedFeatureNames in the output.

dbEngineVersion_supportedNcharCharacterSets :: Lens' DBEngineVersion (Maybe [CharacterSet]) Source #

A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.

dbEngineVersion_supportedTimezones :: Lens' DBEngineVersion (Maybe [Timezone]) Source #

A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

dbEngineVersion_supportsBabelfish :: Lens' DBEngineVersion (Maybe Bool) Source #

A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.

dbEngineVersion_supportsCertificateRotationWithoutRestart :: Lens' DBEngineVersion (Maybe Bool) Source #

A value that indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.

dbEngineVersion_supportsGlobalDatabases :: Lens' DBEngineVersion (Maybe Bool) Source #

A value that indicates whether you can use Aurora global databases with a specific DB engine version.

dbEngineVersion_supportsLogExportsToCloudwatchLogs :: Lens' DBEngineVersion (Maybe Bool) Source #

A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

dbEngineVersion_supportsParallelQuery :: Lens' DBEngineVersion (Maybe Bool) Source #

A value that indicates whether you can use Aurora parallel query with a specific DB engine version.

dbEngineVersion_supportsReadReplica :: Lens' DBEngineVersion (Maybe Bool) Source #

Indicates whether the database engine version supports read replicas.

dbEngineVersion_tagList :: Lens' DBEngineVersion (Maybe [Tag]) Source #

Undocumented member.

dbEngineVersion_validUpgradeTarget :: Lens' DBEngineVersion (Maybe [UpgradeTarget]) Source #

A list of engine versions that this database engine version can be upgraded to.

ModifyDBCluster

modifyDBCluster_allocatedStorage :: Lens' ModifyDBCluster (Maybe Int) Source #

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

Type: Integer

Valid for: Multi-AZ DB clusters only

modifyDBCluster_allowMajorVersionUpgrade :: Lens' ModifyDBCluster (Maybe Bool) Source #

A value that indicates whether major version upgrades are allowed.

Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.

Valid for: Aurora DB clusters only

modifyDBCluster_applyImmediately :: Lens' ModifyDBCluster (Maybe Bool) Source #

A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window.

The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

By default, this parameter is disabled.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

modifyDBCluster_autoMinorVersionUpgrade :: Lens' ModifyDBCluster (Maybe Bool) Source #

A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.

Valid for: Multi-AZ DB clusters only

modifyDBCluster_backtrackWindow :: Lens' ModifyDBCluster (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).

Valid for: Aurora MySQL DB clusters only

modifyDBCluster_backupRetentionPeriod :: Lens' ModifyDBCluster (Maybe Int) Source #

The number of days for which automated backups are retained. Specify a minimum value of 1.

Default: 1

Constraints:

Must be a value from 1 to 35

Valid for: Aurora DB clusters and Multi-AZ DB clusters

modifyDBCluster_cloudwatchLogsExportConfiguration :: Lens' ModifyDBCluster (Maybe CloudwatchLogsExportConfiguration) Source #

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. The values in the list depend on the DB engine being used.

RDS for MySQL

Possible values are error, general, and slowquery.

RDS for PostgreSQL

Possible values are postgresql and upgrade.

Aurora MySQL

Possible values are audit, error, general, and slowquery.

Aurora PostgreSQL

Possible value is postgresql.

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

modifyDBCluster_copyTagsToSnapshot :: Lens' ModifyDBCluster (Maybe Bool) Source #

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

modifyDBCluster_dbClusterInstanceClass :: Lens' ModifyDBCluster (Maybe Text) Source #

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

For the full list of DB instance classes and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Valid for: Multi-AZ DB clusters only

modifyDBCluster_dbClusterParameterGroupName :: Lens' ModifyDBCluster (Maybe Text) Source #

The name of the DB cluster parameter group to use for the DB cluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

modifyDBCluster_dbInstanceParameterGroupName :: Lens' ModifyDBCluster (Maybe Text) Source #

The name of the DB parameter group to apply to all instances of the DB cluster.

When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.

Default: The existing name setting

Constraints:

The DB parameter group must be in the same DB parameter group family as this DB cluster.
The DBInstanceParameterGroupName parameter is valid in combination with the AllowMajorVersionUpgrade parameter for a major version upgrade only.

Valid for: Aurora DB clusters only

modifyDBCluster_deletionProtection :: Lens' ModifyDBCluster (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 isn't enabled.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

modifyDBCluster_domain :: Lens' ModifyDBCluster (Maybe Text) Source #

The Active Directory directory ID to move the DB cluster to. Specify none to remove the cluster from its current domain. The domain must be created prior to this operation.

For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

modifyDBCluster_domainIAMRoleName :: Lens' ModifyDBCluster (Maybe Text) Source #

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Valid for: Aurora DB clusters only

modifyDBCluster_enableGlobalWriteForwarding :: Lens' ModifyDBCluster (Maybe Bool) Source #

A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.

Valid for: Aurora DB clusters only

modifyDBCluster_enableHttpEndpoint :: Lens' ModifyDBCluster (Maybe Bool) Source #

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint is disabled.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

modifyDBCluster_enableIAMDatabaseAuthentication :: Lens' ModifyDBCluster (Maybe Bool) Source #

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

modifyDBCluster_enablePerformanceInsights :: Lens' ModifyDBCluster (Maybe Bool) Source #

A value that indicates whether to turn on Performance Insights for the DB cluster.

For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

Valid for: Multi-AZ DB clusters only

modifyDBCluster_engineVersion :: Lens' ModifyDBCluster (Maybe Text) Source #

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:

aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:

aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for RDS for MySQL, use the following command:

aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"

Valid for: Aurora DB clusters and Multi-AZ DB clusters

modifyDBCluster_iops :: Lens' ModifyDBCluster (Maybe Int) Source #

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

Valid for: Multi-AZ DB clusters only

modifyDBCluster_manageMasterUserPassword :: Lens' ModifyDBCluster (Maybe Bool) Source #

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can't specify MasterUserPassword.

If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. In this case, RDS deletes the secret and uses the new password for the master user specified by MasterUserPassword.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

modifyDBCluster_masterUserPassword :: Lens' ModifyDBCluster (Maybe Text) Source #

The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

Constraints:

Must contain from 8 to 41 characters.
Can't be specified if ManageMasterUserPassword is turned on.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

modifyDBCluster_masterUserSecretKmsKeyId :: Lens' ModifyDBCluster (Maybe Text) Source #

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

This setting is valid only if both of the following conditions are met:

The DB cluster doesn't manage the master user password in Amazon Web Services Secrets Manager.
If the DB cluster already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key that is used to encrypt the secret.
You are turning on ManageMasterUserPassword to manage the master user password in Amazon Web Services Secrets Manager.
If you are turning on ManageMasterUserPassword and don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

modifyDBCluster_monitoringInterval :: Lens' ModifyDBCluster (Maybe Int) Source #

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

Valid for: Multi-AZ DB clusters only

modifyDBCluster_monitoringRoleArn :: Lens' ModifyDBCluster (Maybe Text) Source #

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

Valid for: Multi-AZ DB clusters only

modifyDBCluster_networkType :: Lens' ModifyDBCluster (Maybe Text) Source #

The network type of the DB cluster.

Valid values:

```
IPV4
```
```
DUAL
```

The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

modifyDBCluster_newDBClusterIdentifier :: Lens' ModifyDBCluster (Maybe Text) Source #

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens
The first character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

Valid for: Aurora DB clusters and Multi-AZ DB clusters

modifyDBCluster_optionGroupName :: Lens' ModifyDBCluster (Maybe Text) Source #

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

DB clusters are associated with a default option group that can't be modified.

modifyDBCluster_performanceInsightsKMSKeyId :: Lens' ModifyDBCluster (Maybe Text) Source #

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

Valid for: Multi-AZ DB clusters only

modifyDBCluster_performanceInsightsRetentionPeriod :: Lens' ModifyDBCluster (Maybe Int) Source #

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

7
month * 31, where month is a number of months from 1-23
731

For example, the following values are valid:

93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

Valid for: Multi-AZ DB clusters only

modifyDBCluster_port :: Lens' ModifyDBCluster (Maybe Int) Source #

The port number on which the DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

Valid for: Aurora DB clusters only

modifyDBCluster_preferredBackupWindow :: Lens' ModifyDBCluster (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. To view the time blocks available, see Backup window in the Amazon Aurora 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.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

modifyDBCluster_preferredMaintenanceWindow :: Lens' ModifyDBCluster (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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

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

Constraints: Minimum 30-minute window.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

modifyDBCluster_rotateMasterUserPassword :: Lens' ModifyDBCluster (Maybe Bool) Source #

A value that indicates whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.

Constraints:

You must apply the change immediately when rotating the master user password.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

modifyDBCluster_scalingConfiguration :: Lens' ModifyDBCluster (Maybe ScalingConfiguration) Source #

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

Valid for: Aurora DB clusters only

modifyDBCluster_serverlessV2ScalingConfiguration :: Lens' ModifyDBCluster (Maybe ServerlessV2ScalingConfiguration) Source #

Undocumented member.

modifyDBCluster_storageType :: Lens' ModifyDBCluster (Maybe Text) Source #

Specifies the storage type to be associated with the DB cluster.

Valid values: io1

When specified, a value for the Iops parameter is required.

Default: io1

Valid for: Multi-AZ DB clusters only

modifyDBCluster_vpcSecurityGroupIds :: Lens' ModifyDBCluster (Maybe [Text]) Source #

A list of VPC security groups that the DB cluster will belong to.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

modifyDBCluster_dbClusterIdentifier :: Lens' ModifyDBCluster Text Source #

The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

Constraints: This identifier must match the identifier of an existing DB cluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

modifyDBClusterResponse_dbCluster :: Lens' ModifyDBClusterResponse (Maybe DBCluster) Source #

Undocumented member.

modifyDBClusterResponse_httpStatus :: Lens' ModifyDBClusterResponse Int Source #

The response's http status code.

ModifyDBClusterEndpoint

modifyDBClusterEndpoint_endpointType :: Lens' ModifyDBClusterEndpoint (Maybe Text) Source #

The type of the endpoint. One of: READER, WRITER, ANY.

modifyDBClusterEndpoint_excludedMembers :: Lens' ModifyDBClusterEndpoint (Maybe [Text]) Source #

List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

modifyDBClusterEndpoint_staticMembers :: Lens' ModifyDBClusterEndpoint (Maybe [Text]) Source #

List of DB instance identifiers that are part of the custom endpoint group.

modifyDBClusterEndpoint_dbClusterEndpointIdentifier :: Lens' ModifyDBClusterEndpoint Text Source #

The identifier of the endpoint to modify. This parameter is stored as a lowercase string.

dbClusterEndpoint_customEndpointType :: Lens' DBClusterEndpoint (Maybe Text) Source #

The type associated with a custom endpoint. One of: READER, WRITER, ANY.

dbClusterEndpoint_dbClusterEndpointArn :: Lens' DBClusterEndpoint (Maybe Text) Source #

The Amazon Resource Name (ARN) for the endpoint.

dbClusterEndpoint_dbClusterEndpointIdentifier :: Lens' DBClusterEndpoint (Maybe Text) Source #

The identifier associated with the endpoint. This parameter is stored as a lowercase string.

dbClusterEndpoint_dbClusterEndpointResourceIdentifier :: Lens' DBClusterEndpoint (Maybe Text) Source #

A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

dbClusterEndpoint_dbClusterIdentifier :: Lens' DBClusterEndpoint (Maybe Text) Source #

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

dbClusterEndpoint_endpoint :: Lens' DBClusterEndpoint (Maybe Text) Source #

The DNS address of the endpoint.

dbClusterEndpoint_endpointType :: Lens' DBClusterEndpoint (Maybe Text) Source #

The type of the endpoint. One of: READER, WRITER, CUSTOM.

dbClusterEndpoint_excludedMembers :: Lens' DBClusterEndpoint (Maybe [Text]) Source #

List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

dbClusterEndpoint_staticMembers :: Lens' DBClusterEndpoint (Maybe [Text]) Source #

List of DB instance identifiers that are part of the custom endpoint group.

dbClusterEndpoint_status :: Lens' DBClusterEndpoint (Maybe Text) Source #

The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.

ModifyDBClusterParameterGroup

modifyDBClusterParameterGroup_dbClusterParameterGroupName :: Lens' ModifyDBClusterParameterGroup Text Source #

The name of the DB cluster parameter group to modify.

modifyDBClusterParameterGroup_parameters :: Lens' ModifyDBClusterParameterGroup [Parameter] Source #

A list of parameters in the DB cluster parameter group to modify.

Valid Values (for the application method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters.

When the application method is immediate, changes to dynamic parameters are applied immediately to the DB clusters associated with the parameter group. When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover to the DB clusters associated with the parameter group.

dbClusterParameterGroupNameMessage_dbClusterParameterGroupName :: Lens' DBClusterParameterGroupNameMessage (Maybe Text) Source #

The name of the DB cluster parameter group.

Constraints:

Must be 1 to 255 letters or numbers.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

This value is stored as a lowercase string.

ModifyDBClusterSnapshotAttribute

modifyDBClusterSnapshotAttribute_valuesToAdd :: Lens' ModifyDBClusterSnapshotAttribute (Maybe [Text]) Source #

A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.

To authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account IDs, or all to make the manual DB cluster snapshot restorable by any Amazon Web Services account. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts.

modifyDBClusterSnapshotAttribute_valuesToRemove :: Lens' ModifyDBClusterSnapshotAttribute (Maybe [Text]) Source #

A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account identifiers, or all to remove authorization for any Amazon Web Services account to copy or restore the DB cluster snapshot. If you specify all, an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot.

modifyDBClusterSnapshotAttribute_dbClusterSnapshotIdentifier :: Lens' ModifyDBClusterSnapshotAttribute Text Source #

The identifier for the DB cluster snapshot to modify the attributes for.

modifyDBClusterSnapshotAttribute_attributeName :: Lens' ModifyDBClusterSnapshotAttribute Text Source #

The name of the DB cluster snapshot attribute to modify.

To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this value to restore.

To view the list of attributes available to modify, use the DescribeDBClusterSnapshotAttributes API operation.

modifyDBClusterSnapshotAttributeResponse_dbClusterSnapshotAttributesResult :: Lens' ModifyDBClusterSnapshotAttributeResponse (Maybe DBClusterSnapshotAttributesResult) Source #

Undocumented member.

modifyDBClusterSnapshotAttributeResponse_httpStatus :: Lens' ModifyDBClusterSnapshotAttributeResponse Int Source #

The response's http status code.

ModifyDBInstance

modifyDBInstance_allocatedStorage :: Lens' ModifyDBInstance (Maybe Int) Source #

The new amount of storage in gibibytes (GiB) to allocate for the DB instance.

For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

For the valid values for allocated storage for each engine, see CreateDBInstance.

modifyDBInstance_allowMajorVersionUpgrade :: Lens' ModifyDBInstance (Maybe Bool) Source #

A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

This setting doesn't apply to RDS Custom.

Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

modifyDBInstance_applyImmediately :: Lens' ModifyDBInstance (Maybe Bool) Source #

A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.

If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance in the Amazon RDS User Guide to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to determine when the changes are applied.

modifyDBInstance_autoMinorVersionUpgrade :: Lens' ModifyDBInstance (Maybe Bool) Source #

A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window. An outage occurs when all the following conditions are met:

The automatic upgrade is enabled for the maintenance window.
A newer minor version is available.
RDS has enabled automatic patching for the engine version.

If any of the preceding conditions isn't met, RDS applies the change as soon as possible and doesn't cause an outage.

For an RDS Custom DB instance, set AutoMinorVersionUpgrade to false. Otherwise, the operation returns an error.

modifyDBInstance_automationMode :: Lens' ModifyDBInstance (Maybe AutomationMode) Source #

The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by ResumeFullAutomationModeMinutes.

modifyDBInstance_awsBackupRecoveryPointArn :: Lens' ModifyDBInstance (Maybe Text) Source #

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

This setting doesn't apply to RDS Custom.

modifyDBInstance_backupRetentionPeriod :: Lens' ModifyDBInstance (Maybe Int) Source #

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.

These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

Constraints:

It must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to read replicas. It can't be set to 0 for an RDS Custom for Oracle DB instance.
It can be specified for a MySQL read replica only if the source is running MySQL 5.6 or later.
It can be specified for a PostgreSQL read replica only if the source is running PostgreSQL 9.3.5.

modifyDBInstance_cACertificateIdentifier :: Lens' ModifyDBInstance (Maybe Text) Source #

Specifies the CA certificate identifier to use for the DB instance’s server certificate.

This setting doesn't apply to RDS Custom.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

modifyDBInstance_certificateRotationRestart :: Lens' ModifyDBInstance (Maybe Bool) Source #

A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.

By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.

Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:

For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.

This setting doesn't apply to RDS Custom.

modifyDBInstance_cloudwatchLogsExportConfiguration :: Lens' ModifyDBInstance (Maybe CloudwatchLogsExportConfiguration) Source #

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.

A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect.

This setting doesn't apply to RDS Custom.

modifyDBInstance_copyTagsToSnapshot :: Lens' ModifyDBInstance (Maybe Bool) Source #

A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see ModifyDBCluster.

modifyDBInstance_dbInstanceClass :: Lens' ModifyDBInstance (Maybe Text) Source #

The new compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and DB instance class support for RDS Custom for SQL Server.

If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless you specify ApplyImmediately in your request.

Default: Uses existing setting

modifyDBInstance_dbParameterGroupName :: Lens' ModifyDBInstance (Maybe Text) Source #

The name of the DB parameter group to apply to the DB instance.

Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn't rebooted automatically, and the parameter changes aren't applied during the next maintenance window. However, if you modify dynamic parameters in the newly associated DB parameter group, these changes are applied immediately without a reboot.

This setting doesn't apply to RDS Custom.

Default: Uses existing setting

Constraints: The DB parameter group must be in the same DB parameter group family as the DB instance.

modifyDBInstance_dbPortNumber :: Lens' ModifyDBInstance (Maybe Int) Source #

The port number on which the database accepts connections.

The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.

If you change the DBPortNumber value, your database restarts regardless of the value of the ApplyImmediately parameter.

This setting doesn't apply to RDS Custom.

MySQL

Default: 3306

Valid values: 1150-65535

MariaDB

Default: 3306

Valid values: 1150-65535

PostgreSQL

Default: 5432

Valid values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid values: 1150-65535

SQL Server

Default: 1433

Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156.

Amazon Aurora

Default: 3306

Valid values: 1150-65535

modifyDBInstance_dbSecurityGroups :: Lens' ModifyDBInstance (Maybe [Text]) Source #

A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.

This setting doesn't apply to RDS Custom.

Constraints:

If supplied, must match existing DBSecurityGroups.

modifyDBInstance_dbSubnetGroupName :: Lens' ModifyDBInstance (Maybe Text) Source #

The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable ApplyImmediately.

This parameter doesn't apply to RDS Custom.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mydbsubnetgroup

modifyDBInstance_deletionProtection :: Lens' ModifyDBInstance (Maybe Bool) Source #

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.

modifyDBInstance_domain :: Lens' ModifyDBInstance (Maybe Text) Source #

The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

This setting doesn't apply to RDS Custom.

modifyDBInstance_domainIAMRoleName :: Lens' ModifyDBInstance (Maybe Text) Source #

The name of the IAM role to use when making API calls to the Directory Service.

This setting doesn't apply to RDS Custom.

modifyDBInstance_enableCustomerOwnedIp :: Lens' ModifyDBInstance (Maybe Bool) Source #

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

modifyDBInstance_enableIAMDatabaseAuthentication :: Lens' ModifyDBInstance (Maybe Bool) Source #

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.

For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

This setting doesn't apply to RDS Custom.

modifyDBInstance_enablePerformanceInsights :: Lens' ModifyDBInstance (Maybe Bool) Source #

A value that indicates whether to enable Performance Insights for the DB instance.

For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

This setting doesn't apply to RDS Custom.

modifyDBInstance_engineVersion :: Lens' ModifyDBInstance (Maybe Text) Source #

The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.

For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

If you specify only a major version, Amazon RDS will update the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the PATCH_DB_FAILURE lifecycle.

modifyDBInstance_iops :: Lens' ModifyDBInstance (Maybe Int) Source #

The new Provisioned IOPS (I/O operations per second) value for the RDS instance.

Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Default: Uses existing setting

modifyDBInstance_licenseModel :: Lens' ModifyDBInstance (Maybe Text) Source #

The license model for the DB instance.

This setting doesn't apply to RDS Custom.

Valid values: license-included | bring-your-own-license | general-public-license

modifyDBInstance_manageMasterUserPassword :: Lens' ModifyDBInstance (Maybe Bool) Source #

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can't specify MasterUserPassword.

If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. In this case, RDS deletes the secret and uses the new password for the master user specified by MasterUserPassword.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.

Constraints:

Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.

modifyDBInstance_masterUserPassword :: Lens' ModifyDBInstance (Maybe Text) Source #

The new password for the master user. The password can include any printable ASCII character except "/", """, or "@".

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

Constraints: Can't be specified if ManageMasterUserPassword is turned on.

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Amazon RDS API operations never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.

modifyDBInstance_masterUserSecretKmsKeyId :: Lens' ModifyDBInstance (Maybe Text) Source #

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

This setting is valid only if both of the following conditions are met:

The DB instance doesn't manage the master user password in Amazon Web Services Secrets Manager.
If the DB instance already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key used to encrypt the secret.
You are turning on ManageMasterUserPassword to manage the master user password in Amazon Web Services Secrets Manager.
If you are turning on ManageMasterUserPassword and don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

modifyDBInstance_maxAllocatedStorage :: Lens' ModifyDBInstance (Maybe Int) Source #

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.

This setting doesn't apply to RDS Custom.

modifyDBInstance_monitoringInterval :: Lens' ModifyDBInstance (Maybe Int) Source #

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0, which is the default.

If MonitoringRoleArn is specified, set MonitoringInterval to a value other than 0.

This setting doesn't apply to RDS Custom.

Valid Values: 0, 1, 5, 10, 15, 30, 60

modifyDBInstance_monitoringRoleArn :: Lens' ModifyDBInstance (Maybe Text) Source #

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

This setting doesn't apply to RDS Custom.

modifyDBInstance_multiAZ :: Lens' ModifyDBInstance (Maybe Bool) Source #

A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.

This setting doesn't apply to RDS Custom.

modifyDBInstance_networkType :: Lens' ModifyDBInstance (Maybe Text) Source #

The network type of the DB instance.

Valid values:

```
IPV4
```
```
DUAL
```

The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

modifyDBInstance_newDBInstanceIdentifier :: Lens' ModifyDBInstance (Maybe Text) Source #

The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.

This setting doesn't apply to RDS Custom.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

modifyDBInstance_optionGroupName :: Lens' ModifyDBInstance (Maybe Text) Source #

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

Changing this parameter doesn't result in an outage, with one exception. If the parameter change results in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which new connections are rejected but existing connections aren't interrupted.

The change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance.

This setting doesn't apply to RDS Custom.

modifyDBInstance_performanceInsightsKMSKeyId :: Lens' ModifyDBInstance (Maybe Text) Source #

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

This setting doesn't apply to RDS Custom.

modifyDBInstance_performanceInsightsRetentionPeriod :: Lens' ModifyDBInstance (Maybe Int) Source #

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

7
month * 31, where month is a number of months from 1-23
731

For example, the following values are valid:

93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

This setting doesn't apply to RDS Custom.

modifyDBInstance_preferredBackupWindow :: Lens' ModifyDBInstance (Maybe Text) Source #

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

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

modifyDBInstance_preferredMaintenanceWindow :: Lens' ModifyDBInstance (Maybe Text) Source #

The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.

Default: Uses existing setting

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

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

modifyDBInstance_processorFeatures :: Lens' ModifyDBInstance (Maybe [ProcessorFeature]) Source #

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

This setting doesn't apply to RDS Custom.

modifyDBInstance_promotionTier :: Lens' ModifyDBInstance (Maybe Int) Source #

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

This setting doesn't apply to RDS Custom.

Default: 1

Valid Values: 0 - 15

modifyDBInstance_publiclyAccessible :: Lens' ModifyDBInstance (Maybe Bool) Source #

A value that indicates whether the DB instance is publicly accessible.

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.

Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.

modifyDBInstance_replicaMode :: Lens' ModifyDBInstance (Maybe ReplicaMode) Source #

A value that sets the open mode of a replica database to either mounted or read-only.

Currently, this parameter is only supported for Oracle DB instances.

Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

This setting doesn't apply to RDS Custom.

modifyDBInstance_resumeFullAutomationModeMinutes :: Lens' ModifyDBInstance (Maybe Int) Source #

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

modifyDBInstance_rotateMasterUserPassword :: Lens' ModifyDBInstance (Maybe Bool) Source #

A value that indicates whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.

Constraints:

You must apply the change immediately when rotating the master user password.

modifyDBInstance_storageThroughput :: Lens' ModifyDBInstance (Maybe Int) Source #

Specifies the storage throughput value for the DB instance.

This setting applies only to the gp3 storage type.

This setting doesn't apply to RDS Custom or Amazon Aurora.

modifyDBInstance_storageType :: Lens' ModifyDBInstance (Maybe Text) Source #

Specifies the storage type to be associated with the DB instance.

If you specify Provisioned IOPS (io1), you must also include a value for the Iops parameter.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.

Valid values: gp2 | gp3 | io1 | standard

Default: io1 if the Iops parameter is specified, otherwise gp2

modifyDBInstance_tdeCredentialArn :: Lens' ModifyDBInstance (Maybe Text) Source #

The ARN from the key store with which to associate the instance for TDE encryption.

This setting doesn't apply to RDS Custom.

modifyDBInstance_tdeCredentialPassword :: Lens' ModifyDBInstance (Maybe Text) Source #

The password for the given ARN from the key store in order to access the device.

This setting doesn't apply to RDS Custom.

modifyDBInstance_useDefaultProcessorFeatures :: Lens' ModifyDBInstance (Maybe Bool) Source #

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

This setting doesn't apply to RDS Custom.

modifyDBInstance_vpcSecurityGroupIds :: Lens' ModifyDBInstance (Maybe [Text]) Source #

A list of Amazon EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

If supplied, must match existing VpcSecurityGroupIds.

modifyDBInstance_dbInstanceIdentifier :: Lens' ModifyDBInstance Text Source #

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

Must match the identifier of an existing DBInstance.

modifyDBInstanceResponse_dbInstance :: Lens' ModifyDBInstanceResponse (Maybe DBInstance) Source #

Undocumented member.

modifyDBInstanceResponse_httpStatus :: Lens' ModifyDBInstanceResponse Int Source #

The response's http status code.

ModifyDBParameterGroup

modifyDBParameterGroup_dbParameterGroupName :: Lens' ModifyDBParameterGroup Text Source #

The name of the DB parameter group.

Constraints:

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

modifyDBParameterGroup_parameters :: Lens' ModifyDBParameterGroup [Parameter] Source #

An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.

Valid Values (for the application method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters.

When the application method is immediate, changes to dynamic parameters are applied immediately to the DB instances associated with the parameter group.

When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover to the DB instances associated with the parameter group.

You can't use pending-reboot with dynamic parameters on RDS for SQL Server DB instances. Use immediate.

For more information on modifying DB parameters, see Working with DB parameter groups in the Amazon RDS User Guide.

dbParameterGroupNameMessage_dbParameterGroupName :: Lens' DBParameterGroupNameMessage (Maybe Text) Source #

The name of the DB parameter group.

ModifyDBProxy

modifyDBProxy_auth :: Lens' ModifyDBProxy (Maybe [UserAuthConfig]) Source #

The new authentication settings for the DBProxy.

modifyDBProxy_debugLogging :: Lens' ModifyDBProxy (Maybe Bool) Source #

Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.

modifyDBProxy_idleClientTimeout :: Lens' ModifyDBProxy (Maybe Int) Source #

The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.

modifyDBProxy_newDBProxyName :: Lens' ModifyDBProxy (Maybe Text) Source #

The new identifier for the DBProxy. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

modifyDBProxy_requireTLS :: Lens' ModifyDBProxy (Maybe Bool) Source #

Whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn't use TLS.

modifyDBProxy_roleArn :: Lens' ModifyDBProxy (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

modifyDBProxy_securityGroups :: Lens' ModifyDBProxy (Maybe [Text]) Source #

The new list of security groups for the DBProxy.

modifyDBProxy_dbProxyName :: Lens' ModifyDBProxy Text Source #

The identifier for the DBProxy to modify.

modifyDBProxyResponse_dbProxy :: Lens' ModifyDBProxyResponse (Maybe DBProxy) Source #

The DBProxy object representing the new settings for the proxy.

modifyDBProxyResponse_httpStatus :: Lens' ModifyDBProxyResponse Int Source #

The response's http status code.

ModifyDBProxyEndpoint

modifyDBProxyEndpoint_newDBProxyEndpointName :: Lens' ModifyDBProxyEndpoint (Maybe Text) Source #

The new identifier for the DBProxyEndpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

modifyDBProxyEndpoint_vpcSecurityGroupIds :: Lens' ModifyDBProxyEndpoint (Maybe [Text]) Source #

The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint uses a different VPC than the original proxy, you also specify a different set of security group IDs than for the original proxy.

modifyDBProxyEndpoint_dbProxyEndpointName :: Lens' ModifyDBProxyEndpoint Text Source #

The name of the DB proxy sociated with the DB proxy endpoint that you want to modify.

modifyDBProxyEndpointResponse_dbProxyEndpoint :: Lens' ModifyDBProxyEndpointResponse (Maybe DBProxyEndpoint) Source #

The DBProxyEndpoint object representing the new settings for the DB proxy endpoint.

modifyDBProxyEndpointResponse_httpStatus :: Lens' ModifyDBProxyEndpointResponse Int Source #

The response's http status code.

ModifyDBProxyTargetGroup

modifyDBProxyTargetGroup_connectionPoolConfig :: Lens' ModifyDBProxyTargetGroup (Maybe ConnectionPoolConfiguration) Source #

The settings that determine the size and behavior of the connection pool for the target group.

modifyDBProxyTargetGroup_newName :: Lens' ModifyDBProxyTargetGroup (Maybe Text) Source #

The new name for the modified DBProxyTarget. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

modifyDBProxyTargetGroup_targetGroupName :: Lens' ModifyDBProxyTargetGroup Text Source #

The name of the target group to modify.

modifyDBProxyTargetGroup_dbProxyName :: Lens' ModifyDBProxyTargetGroup Text Source #

The name of the proxy.

modifyDBProxyTargetGroupResponse_dbProxyTargetGroup :: Lens' ModifyDBProxyTargetGroupResponse (Maybe DBProxyTargetGroup) Source #

The settings of the modified DBProxyTarget.

modifyDBProxyTargetGroupResponse_httpStatus :: Lens' ModifyDBProxyTargetGroupResponse Int Source #

The response's http status code.

ModifyDBSnapshot

modifyDBSnapshot_engineVersion :: Lens' ModifyDBSnapshot (Maybe Text) Source #

The engine version to upgrade the DB snapshot to.

The following are the database engines and engine versions that are available when you upgrade a DB snapshot.

MySQL

5.5.46 (supported for 5.1 DB snapshots)

Oracle

12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)
11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)
11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)

PostgreSQL

For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading the PostgreSQL DB Engine for Amazon RDS.

modifyDBSnapshot_optionGroupName :: Lens' ModifyDBSnapshot (Maybe Text) Source #

The option group to identify with the upgraded DB snapshot.

You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see Option group considerations in the Amazon RDS User Guide.

modifyDBSnapshot_dbSnapshotIdentifier :: Lens' ModifyDBSnapshot Text Source #

The identifier of the DB snapshot to modify.

modifyDBSnapshotResponse_dbSnapshot :: Lens' ModifyDBSnapshotResponse (Maybe DBSnapshot) Source #

Undocumented member.

modifyDBSnapshotResponse_httpStatus :: Lens' ModifyDBSnapshotResponse Int Source #

The response's http status code.

ModifyDBSnapshotAttribute

modifyDBSnapshotAttribute_valuesToAdd :: Lens' ModifyDBSnapshotAttribute (Maybe [Text]) Source #

A list of DB snapshot attributes to add to the attribute specified by AttributeName.

To authorize other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account IDs, or all to make the manual DB snapshot restorable by any Amazon Web Services account. Do not add the all value for any manual DB snapshots that contain private information that you don't want available to all Amazon Web Services accounts.

modifyDBSnapshotAttribute_valuesToRemove :: Lens' ModifyDBSnapshotAttribute (Maybe [Text]) Source #

A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account identifiers, or all to remove authorization for any Amazon Web Services account to copy or restore the DB snapshot. If you specify all, an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore the manual DB snapshot.

modifyDBSnapshotAttribute_dbSnapshotIdentifier :: Lens' ModifyDBSnapshotAttribute Text Source #

The identifier for the DB snapshot to modify the attributes for.

modifyDBSnapshotAttribute_attributeName :: Lens' ModifyDBSnapshotAttribute Text Source #

The name of the DB snapshot attribute to modify.

To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, set this value to restore.

To view the list of attributes available to modify, use the DescribeDBSnapshotAttributes API operation.

modifyDBSnapshotAttributeResponse_dbSnapshotAttributesResult :: Lens' ModifyDBSnapshotAttributeResponse (Maybe DBSnapshotAttributesResult) Source #

Undocumented member.

modifyDBSnapshotAttributeResponse_httpStatus :: Lens' ModifyDBSnapshotAttributeResponse Int Source #

The response's http status code.

ModifyDBSubnetGroup

modifyDBSubnetGroup_dbSubnetGroupDescription :: Lens' ModifyDBSubnetGroup (Maybe Text) Source #

The description for the DB subnet group.

modifyDBSubnetGroup_dbSubnetGroupName :: Lens' ModifyDBSubnetGroup Text Source #

The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group.

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

Example: mydbsubnetgroup

modifyDBSubnetGroup_subnetIds :: Lens' ModifyDBSubnetGroup [Text] Source #

The EC2 subnet IDs for the DB subnet group.

modifyDBSubnetGroupResponse_dbSubnetGroup :: Lens' ModifyDBSubnetGroupResponse (Maybe DBSubnetGroup) Source #

Undocumented member.

modifyDBSubnetGroupResponse_httpStatus :: Lens' ModifyDBSubnetGroupResponse Int Source #

The response's http status code.

ModifyEventSubscription

modifyEventSubscription_enabled :: Lens' ModifyEventSubscription (Maybe Bool) Source #

A value that indicates whether to activate the subscription.

modifyEventSubscription_eventCategories :: Lens' ModifyEventSubscription (Maybe [Text]) Source #

A list of event categories for a source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.

modifyEventSubscription_snsTopicArn :: Lens' ModifyEventSubscription (Maybe Text) Source #

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

modifyEventSubscription_sourceType :: Lens' ModifyEventSubscription (Maybe Text) Source #

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.

modifyEventSubscription_subscriptionName :: Lens' ModifyEventSubscription Text Source #

The name of the RDS event notification subscription.

modifyEventSubscriptionResponse_eventSubscription :: Lens' ModifyEventSubscriptionResponse (Maybe EventSubscription) Source #

Undocumented member.

modifyEventSubscriptionResponse_httpStatus :: Lens' ModifyEventSubscriptionResponse Int Source #

The response's http status code.

ModifyGlobalCluster

modifyGlobalCluster_allowMajorVersionUpgrade :: Lens' ModifyGlobalCluster (Maybe Bool) Source #

A value that indicates whether major version upgrades are allowed.

Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.

If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version. Apply any custom parameter groups after completing the upgrade.

modifyGlobalCluster_deletionProtection :: Lens' ModifyGlobalCluster (Maybe Bool) Source #

Indicates if the global database cluster has deletion protection enabled. The global database cluster can't be deleted when deletion protection is enabled.

modifyGlobalCluster_engineVersion :: Lens' ModifyGlobalCluster (Maybe Text) Source #

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

aws rds describe-db-engine-versions --engine aurora --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:

aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'

To list all of the available engine versions for aurora-postgresql, use the following command:

aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'

modifyGlobalCluster_globalClusterIdentifier :: Lens' ModifyGlobalCluster (Maybe Text) Source #

The DB cluster identifier for the global cluster being modified. This parameter isn't case-sensitive.

Constraints:

Must match the identifier of an existing global database cluster.

modifyGlobalCluster_newGlobalClusterIdentifier :: Lens' ModifyGlobalCluster (Maybe Text) Source #

The new cluster identifier for the global database cluster when modifying a global database cluster. This value is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens
The first character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

modifyGlobalClusterResponse_globalCluster :: Lens' ModifyGlobalClusterResponse (Maybe GlobalCluster) Source #

Undocumented member.

modifyGlobalClusterResponse_httpStatus :: Lens' ModifyGlobalClusterResponse Int Source #

The response's http status code.

ModifyOptionGroup

modifyOptionGroup_applyImmediately :: Lens' ModifyOptionGroup (Maybe Bool) Source #

A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.

modifyOptionGroup_optionsToInclude :: Lens' ModifyOptionGroup (Maybe [OptionConfiguration]) Source #

Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.

modifyOptionGroup_optionsToRemove :: Lens' ModifyOptionGroup (Maybe [Text]) Source #

Options in this list are removed from the option group.

modifyOptionGroup_optionGroupName :: Lens' ModifyOptionGroup Text Source #

The name of the option group to be modified.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

modifyOptionGroupResponse_optionGroup :: Lens' ModifyOptionGroupResponse (Maybe OptionGroup) Source #

Undocumented member.

modifyOptionGroupResponse_httpStatus :: Lens' ModifyOptionGroupResponse Int Source #

The response's http status code.

PromoteReadReplica

promoteReadReplica_backupRetentionPeriod :: Lens' PromoteReadReplica (Maybe Int) Source #

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

Must be a value from 0 to 35.
Can't be set to 0 if the DB instance is a source to read replicas.

promoteReadReplica_preferredBackupWindow :: Lens' PromoteReadReplica (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. 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.

promoteReadReplica_dbInstanceIdentifier :: Lens' PromoteReadReplica Text Source #

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

Must match the identifier of an existing read replica DB instance.

Example: mydbinstance

promoteReadReplicaResponse_dbInstance :: Lens' PromoteReadReplicaResponse (Maybe DBInstance) Source #

Undocumented member.

promoteReadReplicaResponse_httpStatus :: Lens' PromoteReadReplicaResponse Int Source #

The response's http status code.

PromoteReadReplicaDBCluster

promoteReadReplicaDBCluster_dbClusterIdentifier :: Lens' PromoteReadReplicaDBCluster Text Source #

The identifier of the DB cluster read replica to promote. This parameter isn't case-sensitive.

Constraints:

Must match the identifier of an existing DB cluster read replica.

Example: my-cluster-replica1

promoteReadReplicaDBClusterResponse_dbCluster :: Lens' PromoteReadReplicaDBClusterResponse (Maybe DBCluster) Source #

Undocumented member.

promoteReadReplicaDBClusterResponse_httpStatus :: Lens' PromoteReadReplicaDBClusterResponse Int Source #

The response's http status code.

PurchaseReservedDBInstancesOffering

purchaseReservedDBInstancesOffering_dbInstanceCount :: Lens' PurchaseReservedDBInstancesOffering (Maybe Int) Source #

The number of instances to reserve.

Default: 1

purchaseReservedDBInstancesOffering_reservedDBInstanceId :: Lens' PurchaseReservedDBInstancesOffering (Maybe Text) Source #

Customer-specified identifier to track this reservation.

Example: myreservationID

purchaseReservedDBInstancesOffering_tags :: Lens' PurchaseReservedDBInstancesOffering (Maybe [Tag]) Source #

Undocumented member.

purchaseReservedDBInstancesOffering_reservedDBInstancesOfferingId :: Lens' PurchaseReservedDBInstancesOffering Text Source #

The ID of the Reserved DB instance offering to purchase.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

purchaseReservedDBInstancesOfferingResponse_reservedDBInstance :: Lens' PurchaseReservedDBInstancesOfferingResponse (Maybe ReservedDBInstance) Source #

Undocumented member.

purchaseReservedDBInstancesOfferingResponse_httpStatus :: Lens' PurchaseReservedDBInstancesOfferingResponse Int Source #

The response's http status code.

RebootDBCluster

rebootDBCluster_dbClusterIdentifier :: Lens' RebootDBCluster Text Source #

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

Constraints:

Must match the identifier of an existing DBCluster.

rebootDBClusterResponse_dbCluster :: Lens' RebootDBClusterResponse (Maybe DBCluster) Source #

Undocumented member.

rebootDBClusterResponse_httpStatus :: Lens' RebootDBClusterResponse Int Source #

The response's http status code.

RebootDBInstance

rebootDBInstance_forceFailover :: Lens' RebootDBInstance (Maybe Bool) Source #

A value that indicates whether the reboot is conducted through a Multi-AZ failover.

Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.

rebootDBInstance_dbInstanceIdentifier :: Lens' RebootDBInstance Text Source #

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

Constraints:

Must match the identifier of an existing DBInstance.

rebootDBInstanceResponse_dbInstance :: Lens' RebootDBInstanceResponse (Maybe DBInstance) Source #

Undocumented member.

rebootDBInstanceResponse_httpStatus :: Lens' RebootDBInstanceResponse Int Source #

The response's http status code.

RegisterDBProxyTargets

registerDBProxyTargets_dbClusterIdentifiers :: Lens' RegisterDBProxyTargets (Maybe [Text]) Source #

One or more DB cluster identifiers.

registerDBProxyTargets_dbInstanceIdentifiers :: Lens' RegisterDBProxyTargets (Maybe [Text]) Source #

One or more DB instance identifiers.

registerDBProxyTargets_targetGroupName :: Lens' RegisterDBProxyTargets (Maybe Text) Source #

The identifier of the DBProxyTargetGroup.

registerDBProxyTargets_dbProxyName :: Lens' RegisterDBProxyTargets Text Source #

The identifier of the DBProxy that is associated with the DBProxyTargetGroup.

registerDBProxyTargetsResponse_dbProxyTargets :: Lens' RegisterDBProxyTargetsResponse (Maybe [DBProxyTarget]) Source #

One or more DBProxyTarget objects that are created when you register targets with a target group.

registerDBProxyTargetsResponse_httpStatus :: Lens' RegisterDBProxyTargetsResponse Int Source #

The response's http status code.

RemoveFromGlobalCluster

removeFromGlobalCluster_dbClusterIdentifier :: Lens' RemoveFromGlobalCluster (Maybe Text) Source #

The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.

removeFromGlobalCluster_globalClusterIdentifier :: Lens' RemoveFromGlobalCluster (Maybe Text) Source #

The cluster identifier to detach from the Aurora global database cluster.

removeFromGlobalClusterResponse_globalCluster :: Lens' RemoveFromGlobalClusterResponse (Maybe GlobalCluster) Source #

Undocumented member.

removeFromGlobalClusterResponse_httpStatus :: Lens' RemoveFromGlobalClusterResponse Int Source #

The response's http status code.

RemoveRoleFromDBCluster

removeRoleFromDBCluster_featureName :: Lens' RemoveRoleFromDBCluster (Maybe Text) Source #

The name of the feature for the DB cluster that the IAM role is to be disassociated from. For information about supported feature names, see DBEngineVersion.

removeRoleFromDBCluster_dbClusterIdentifier :: Lens' RemoveRoleFromDBCluster Text Source #

The name of the DB cluster to disassociate the IAM role from.

removeRoleFromDBCluster_roleArn :: Lens' RemoveRoleFromDBCluster Text Source #

The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.

RemoveRoleFromDBInstance

removeRoleFromDBInstance_dbInstanceIdentifier :: Lens' RemoveRoleFromDBInstance Text Source #

The name of the DB instance to disassociate the IAM role from.

removeRoleFromDBInstance_roleArn :: Lens' RemoveRoleFromDBInstance Text Source #

The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance, for example, arn:aws:iam::123456789012:role/AccessRole.

removeRoleFromDBInstance_featureName :: Lens' RemoveRoleFromDBInstance Text Source #

The name of the feature for the DB instance that the IAM role is to be disassociated from. For information about supported feature names, see DBEngineVersion.

RemoveSourceIdentifierFromSubscription

removeSourceIdentifierFromSubscription_subscriptionName :: Lens' RemoveSourceIdentifierFromSubscription Text Source #

The name of the RDS event notification subscription you want to remove a source identifier from.

removeSourceIdentifierFromSubscription_sourceIdentifier :: Lens' RemoveSourceIdentifierFromSubscription Text Source #

The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.

removeSourceIdentifierFromSubscriptionResponse_eventSubscription :: Lens' RemoveSourceIdentifierFromSubscriptionResponse (Maybe EventSubscription) Source #

Undocumented member.

removeSourceIdentifierFromSubscriptionResponse_httpStatus :: Lens' RemoveSourceIdentifierFromSubscriptionResponse Int Source #

The response's http status code.

RemoveTagsFromResource

removeTagsFromResource_resourceName :: Lens' RemoveTagsFromResource Text Source #

The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

removeTagsFromResource_tagKeys :: Lens' RemoveTagsFromResource [Text] Source #

The tag key (name) of the tag to be removed.

ResetDBClusterParameterGroup

resetDBClusterParameterGroup_parameters :: Lens' ResetDBClusterParameterGroup (Maybe [Parameter]) Source #

A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is enabled.

resetDBClusterParameterGroup_resetAllParameters :: Lens' ResetDBClusterParameterGroup (Maybe Bool) Source #

A value that indicates whether to reset all parameters in the DB cluster parameter group to their default values. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.

resetDBClusterParameterGroup_dbClusterParameterGroupName :: Lens' ResetDBClusterParameterGroup Text Source #

The name of the DB cluster parameter group to reset.

dbClusterParameterGroupNameMessage_dbClusterParameterGroupName :: Lens' DBClusterParameterGroupNameMessage (Maybe Text) Source #

The name of the DB cluster parameter group.

Constraints:

Must be 1 to 255 letters or numbers.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

This value is stored as a lowercase string.

ResetDBParameterGroup

resetDBParameterGroup_parameters :: Lens' ResetDBParameterGroup (Maybe [Parameter]) Source #

To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

MySQL

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

MariaDB

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

Oracle

Valid Values (for Apply method): pending-reboot

resetDBParameterGroup_resetAllParameters :: Lens' ResetDBParameterGroup (Maybe Bool) Source #

A value that indicates whether to reset all parameters in the DB parameter group to default values. By default, all parameters in the DB parameter group are reset to default values.

resetDBParameterGroup_dbParameterGroupName :: Lens' ResetDBParameterGroup Text Source #

The name of the DB parameter group.

Constraints:

Must match the name of an existing DBParameterGroup.

dbParameterGroupNameMessage_dbParameterGroupName :: Lens' DBParameterGroupNameMessage (Maybe Text) Source #

The name of the DB parameter group.

RestoreDBClusterFromS3

restoreDBClusterFromS3_availabilityZones :: Lens' RestoreDBClusterFromS3 (Maybe [Text]) Source #

A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

restoreDBClusterFromS3_backtrackWindow :: Lens' RestoreDBClusterFromS3 (Maybe Integer) Source #

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

Default: 0

Constraints:

If specified, this value must be set to a number from 0 to 259,200 (72 hours).

restoreDBClusterFromS3_backupRetentionPeriod :: Lens' RestoreDBClusterFromS3 (Maybe Int) Source #

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

Default: 1

Constraints:

Must be a value from 1 to 35

restoreDBClusterFromS3_characterSetName :: Lens' RestoreDBClusterFromS3 (Maybe Text) Source #

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

restoreDBClusterFromS3_copyTagsToSnapshot :: Lens' RestoreDBClusterFromS3 (Maybe Bool) Source #

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

restoreDBClusterFromS3_dbClusterParameterGroupName :: Lens' RestoreDBClusterFromS3 (Maybe Text) Source #

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

Constraints:

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

restoreDBClusterFromS3_dbSubnetGroupName :: Lens' RestoreDBClusterFromS3 (Maybe Text) Source #

A DB subnet group to associate with the restored DB cluster.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mydbsubnetgroup

restoreDBClusterFromS3_databaseName :: Lens' RestoreDBClusterFromS3 (Maybe Text) Source #

The database name for the restored DB cluster.

restoreDBClusterFromS3_deletionProtection :: Lens' RestoreDBClusterFromS3 (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 isn't enabled.

restoreDBClusterFromS3_domain :: Lens' RestoreDBClusterFromS3 (Maybe Text) Source #

Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

restoreDBClusterFromS3_domainIAMRoleName :: Lens' RestoreDBClusterFromS3 (Maybe Text) Source #

Specify the name of the IAM role to be used when making API calls to the Directory Service.

restoreDBClusterFromS3_enableCloudwatchLogsExports :: Lens' RestoreDBClusterFromS3 (Maybe [Text]) Source #

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.

Aurora MySQL

Possible values are audit, error, general, and slowquery.

Aurora PostgreSQL

Possible value is postgresql.

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

restoreDBClusterFromS3_enableIAMDatabaseAuthentication :: Lens' RestoreDBClusterFromS3 (Maybe Bool) Source #

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

restoreDBClusterFromS3_engineVersion :: Lens' RestoreDBClusterFromS3 (Maybe Text) Source #

The version number of the database engine to use.

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:

aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

Aurora MySQL

Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.mysql_aurora.2.07.1, 8.0.mysql_aurora.3.02.0

restoreDBClusterFromS3_kmsKeyId :: Lens' RestoreDBClusterFromS3 (Maybe Text) Source #

The Amazon Web Services KMS key identifier for an encrypted DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

restoreDBClusterFromS3_manageMasterUserPassword :: Lens' RestoreDBClusterFromS3 (Maybe Bool) Source #

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.

Constraints:

Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.

restoreDBClusterFromS3_masterUserPassword :: Lens' RestoreDBClusterFromS3 (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.
Can't be specified if ManageMasterUserPassword is turned on.

restoreDBClusterFromS3_masterUserSecretKmsKeyId :: Lens' RestoreDBClusterFromS3 (Maybe Text) Source #

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

restoreDBClusterFromS3_networkType :: Lens' RestoreDBClusterFromS3 (Maybe Text) Source #

The network type of the DB cluster.

Valid values:

```
IPV4
```
```
DUAL
```

The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.

restoreDBClusterFromS3_optionGroupName :: Lens' RestoreDBClusterFromS3 (Maybe Text) Source #

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

Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.

restoreDBClusterFromS3_port :: Lens' RestoreDBClusterFromS3 (Maybe Int) Source #

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

Default: 3306

restoreDBClusterFromS3_preferredBackupWindow :: Lens' RestoreDBClusterFromS3 (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. To view the time blocks available, see Backup window in the Amazon Aurora 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.

restoreDBClusterFromS3_preferredMaintenanceWindow :: Lens' RestoreDBClusterFromS3 (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. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

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

Constraints: Minimum 30-minute window.

restoreDBClusterFromS3_s3Prefix :: Lens' RestoreDBClusterFromS3 (Maybe Text) Source #

The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.

restoreDBClusterFromS3_serverlessV2ScalingConfiguration :: Lens' RestoreDBClusterFromS3 (Maybe ServerlessV2ScalingConfiguration) Source #

Undocumented member.

restoreDBClusterFromS3_storageEncrypted :: Lens' RestoreDBClusterFromS3 (Maybe Bool) Source #

A value that indicates whether the restored DB cluster is encrypted.

restoreDBClusterFromS3_tags :: Lens' RestoreDBClusterFromS3 (Maybe [Tag]) Source #

Undocumented member.

restoreDBClusterFromS3_vpcSecurityGroupIds :: Lens' RestoreDBClusterFromS3 (Maybe [Text]) Source #

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

restoreDBClusterFromS3_dbClusterIdentifier :: Lens' RestoreDBClusterFromS3 Text Source #

The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.

Constraints:

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

Example: my-cluster1

restoreDBClusterFromS3_engine :: Lens' RestoreDBClusterFromS3 Text Source #

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

Valid Values: aurora (for MySQL 5.6-compatible Aurora) and aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

restoreDBClusterFromS3_masterUsername :: Lens' RestoreDBClusterFromS3 Text Source #

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

Constraints:

Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.

restoreDBClusterFromS3_sourceEngine :: Lens' RestoreDBClusterFromS3 Text Source #

The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.

Valid values: mysql

restoreDBClusterFromS3_sourceEngineVersion :: Lens' RestoreDBClusterFromS3 Text Source #

The version of the database that the backup files were created from.

MySQL versions 5.5, 5.6, and 5.7 are supported.

Example: 5.6.40, 5.7.28

restoreDBClusterFromS3_s3BucketName :: Lens' RestoreDBClusterFromS3 Text Source #

The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

restoreDBClusterFromS3_s3IngestionRoleArn :: Lens' RestoreDBClusterFromS3 Text Source #

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.

restoreDBClusterFromS3Response_dbCluster :: Lens' RestoreDBClusterFromS3Response (Maybe DBCluster) Source #

Undocumented member.

restoreDBClusterFromS3Response_httpStatus :: Lens' RestoreDBClusterFromS3Response Int Source #

The response's http status code.

RestoreDBClusterFromSnapshot

restoreDBClusterFromSnapshot_availabilityZones :: Lens' RestoreDBClusterFromSnapshot (Maybe [Text]) Source #

Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

Valid for: Aurora DB clusters only

restoreDBClusterFromSnapshot_backtrackWindow :: Lens' RestoreDBClusterFromSnapshot (Maybe Integer) Source #

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

Default: 0

Constraints:

If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Valid for: Aurora DB clusters only

restoreDBClusterFromSnapshot_copyTagsToSnapshot :: Lens' RestoreDBClusterFromSnapshot (Maybe Bool) Source #

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterFromSnapshot_dbClusterInstanceClass :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #

The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Valid for: Multi-AZ DB clusters only

restoreDBClusterFromSnapshot_dbClusterParameterGroupName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #

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

Constraints:

If supplied, must match the name of an existing default DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterFromSnapshot_dbSubnetGroupName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #

The name of the DB subnet group to use for the new DB cluster.

Constraints: If supplied, must match the name of an existing DB subnet group.

Example: mydbsubnetgroup

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterFromSnapshot_databaseName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #

The database name for the restored DB cluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterFromSnapshot_deletionProtection :: Lens' RestoreDBClusterFromSnapshot (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 isn't enabled.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterFromSnapshot_domain :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #

Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Valid for: Aurora DB clusters only

restoreDBClusterFromSnapshot_domainIAMRoleName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Valid for: Aurora DB clusters only

restoreDBClusterFromSnapshot_enableCloudwatchLogsExports :: Lens' RestoreDBClusterFromSnapshot (Maybe [Text]) Source #

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used.

RDS for MySQL

Possible values are error, general, and slowquery.

RDS for PostgreSQL

Possible values are postgresql and upgrade.

Aurora MySQL

Possible values are audit, error, general, and slowquery.

Aurora PostgreSQL

Possible value is postgresql.

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterFromSnapshot_enableIAMDatabaseAuthentication :: Lens' RestoreDBClusterFromSnapshot (Maybe Bool) Source #

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

restoreDBClusterFromSnapshot_engineMode :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

For more information, see CreateDBCluster.

Valid for: Aurora DB clusters only

restoreDBClusterFromSnapshot_engineVersion :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #

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

To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:

aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:

aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for RDS for MySQL, use the following command:

aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"

Aurora MySQL

See MySQL on Amazon RDS Versions in the Amazon Aurora User Guide.

Aurora PostgreSQL

See Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.

MySQL

See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.

PostgreSQL

See Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterFromSnapshot_iops :: Lens' RestoreDBClusterFromSnapshot (Maybe Int) Source #

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterFromSnapshot_kmsKeyId :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

When you don't specify a value for the KmsKeyId parameter, then the following occurs:

If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't encrypted, then the restored DB cluster isn't encrypted.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterFromSnapshot_networkType :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #

The network type of the DB cluster.

Valid values:

```
IPV4
```
```
DUAL
```

The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

restoreDBClusterFromSnapshot_optionGroupName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #

The name of the option group to use for the restored DB cluster.

DB clusters are associated with a default option group that can't be modified.

restoreDBClusterFromSnapshot_port :: Lens' RestoreDBClusterFromSnapshot (Maybe Int) Source #

The port number on which the new DB cluster accepts connections.

Constraints: This value must be 1150-65535

Default: The same port as the original DB cluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterFromSnapshot_publiclyAccessible :: Lens' RestoreDBClusterFromSnapshot (Maybe Bool) Source #

A value that indicates whether the DB cluster is publicly accessible.

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterFromSnapshot_scalingConfiguration :: Lens' RestoreDBClusterFromSnapshot (Maybe ScalingConfiguration) Source #

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

Valid for: Aurora DB clusters only

restoreDBClusterFromSnapshot_serverlessV2ScalingConfiguration :: Lens' RestoreDBClusterFromSnapshot (Maybe ServerlessV2ScalingConfiguration) Source #

Undocumented member.

restoreDBClusterFromSnapshot_storageType :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #

Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.

Valid values: io1

When specified, a value for the Iops parameter is required.

Default: io1

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterFromSnapshot_tags :: Lens' RestoreDBClusterFromSnapshot (Maybe [Tag]) Source #

The tags to be assigned to the restored DB cluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterFromSnapshot_vpcSecurityGroupIds :: Lens' RestoreDBClusterFromSnapshot (Maybe [Text]) Source #

A list of VPC security groups that the new DB cluster will belong to.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterFromSnapshot_dbClusterIdentifier :: Lens' RestoreDBClusterFromSnapshot Text Source #

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.

Constraints:

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

Example: my-snapshot-id

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterFromSnapshot_snapshotIdentifier :: Lens' RestoreDBClusterFromSnapshot Text Source #

The identifier for the DB snapshot or DB cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

Constraints:

Must match the identifier of an existing Snapshot.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterFromSnapshot_engine :: Lens' RestoreDBClusterFromSnapshot Text Source #

The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterFromSnapshotResponse_dbCluster :: Lens' RestoreDBClusterFromSnapshotResponse (Maybe DBCluster) Source #

Undocumented member.

restoreDBClusterFromSnapshotResponse_httpStatus :: Lens' RestoreDBClusterFromSnapshotResponse Int Source #

The response's http status code.

RestoreDBClusterToPointInTime

restoreDBClusterToPointInTime_backtrackWindow :: Lens' RestoreDBClusterToPointInTime (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).

Valid for: Aurora MySQL DB clusters only

restoreDBClusterToPointInTime_copyTagsToSnapshot :: Lens' RestoreDBClusterToPointInTime (Maybe Bool) Source #

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterToPointInTime_dbClusterInstanceClass :: Lens' RestoreDBClusterToPointInTime (Maybe Text) Source #

The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

For the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.

Valid for: Multi-AZ DB clusters only

restoreDBClusterToPointInTime_dbClusterParameterGroupName :: Lens' RestoreDBClusterToPointInTime (Maybe Text) Source #

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

Constraints:

If supplied, must match the name of an existing DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterToPointInTime_dbSubnetGroupName :: Lens' RestoreDBClusterToPointInTime (Maybe Text) Source #

The DB subnet group name to use for the new DB cluster.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mydbsubnetgroup

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterToPointInTime_deletionProtection :: Lens' RestoreDBClusterToPointInTime (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 isn't enabled.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterToPointInTime_domain :: Lens' RestoreDBClusterToPointInTime (Maybe Text) Source #

Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

restoreDBClusterToPointInTime_domainIAMRoleName :: Lens' RestoreDBClusterToPointInTime (Maybe Text) Source #

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Valid for: Aurora DB clusters only

restoreDBClusterToPointInTime_enableCloudwatchLogsExports :: Lens' RestoreDBClusterToPointInTime (Maybe [Text]) Source #

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.

RDS for MySQL

Possible values are error, general, and slowquery.

RDS for PostgreSQL

Possible values are postgresql and upgrade.

Aurora MySQL

Possible values are audit, error, general, and slowquery.

Aurora PostgreSQL

Possible value is postgresql.

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterToPointInTime_enableIAMDatabaseAuthentication :: Lens' RestoreDBClusterToPointInTime (Maybe Bool) Source #

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

restoreDBClusterToPointInTime_engineMode :: Lens' RestoreDBClusterToPointInTime (Maybe Text) Source #

The engine mode of the new cluster. Specify provisioned or serverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or an encrypted provisioned cluster.

Valid for: Aurora DB clusters only

restoreDBClusterToPointInTime_iops :: Lens' RestoreDBClusterToPointInTime (Maybe Int) Source #

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

Valid for: Multi-AZ DB clusters only

restoreDBClusterToPointInTime_kmsKeyId :: Lens' RestoreDBClusterToPointInTime (Maybe Text) Source #

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.

If you don't specify a value for the KmsKeyId parameter, then the following occurs:

If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.

If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request is rejected.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterToPointInTime_networkType :: Lens' RestoreDBClusterToPointInTime (Maybe Text) Source #

The network type of the DB cluster.

Valid values:

```
IPV4
```
```
DUAL
```

The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

restoreDBClusterToPointInTime_optionGroupName :: Lens' RestoreDBClusterToPointInTime (Maybe Text) Source #

The name of the option group for the new DB cluster.

DB clusters are associated with a default option group that can't be modified.

restoreDBClusterToPointInTime_port :: Lens' RestoreDBClusterToPointInTime (Maybe Int) Source #

The port number on which the new DB cluster accepts connections.

Constraints: A value from 1150-65535.

Default: The default port for the engine.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterToPointInTime_publiclyAccessible :: Lens' RestoreDBClusterToPointInTime (Maybe Bool) Source #

A value that indicates whether the DB cluster is publicly accessible.

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

Valid for: Multi-AZ DB clusters only

restoreDBClusterToPointInTime_restoreToTime :: Lens' RestoreDBClusterToPointInTime (Maybe UTCTime) Source #

The date and time to restore the DB cluster to.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

Must be before the latest restorable time for the DB instance
Must be specified if UseLatestRestorableTime parameter isn't provided
Can't be specified if the UseLatestRestorableTime parameter is enabled
Can't be specified if the RestoreType parameter is copy-on-write

Example: 2015-03-07T23:45:00Z

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterToPointInTime_restoreType :: Lens' RestoreDBClusterToPointInTime (Maybe Text) Source #

The type of restore to be performed. You can specify one of the following values:

full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterToPointInTime_scalingConfiguration :: Lens' RestoreDBClusterToPointInTime (Maybe ScalingConfiguration) Source #

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

Valid for: Aurora DB clusters only

restoreDBClusterToPointInTime_serverlessV2ScalingConfiguration :: Lens' RestoreDBClusterToPointInTime (Maybe ServerlessV2ScalingConfiguration) Source #

Undocumented member.

restoreDBClusterToPointInTime_storageType :: Lens' RestoreDBClusterToPointInTime (Maybe Text) Source #

Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.

Valid values: io1

When specified, a value for the Iops parameter is required.

Default: io1

Valid for: Multi-AZ DB clusters only

restoreDBClusterToPointInTime_tags :: Lens' RestoreDBClusterToPointInTime (Maybe [Tag]) Source #

Undocumented member.

restoreDBClusterToPointInTime_useLatestRestorableTime :: Lens' RestoreDBClusterToPointInTime (Maybe Bool) Source #

A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time.

Constraints: Can't be specified if RestoreToTime parameter is provided.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterToPointInTime_vpcSecurityGroupIds :: Lens' RestoreDBClusterToPointInTime (Maybe [Text]) Source #

A list of VPC security groups that the new DB cluster belongs to.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterToPointInTime_dbClusterIdentifier :: Lens' RestoreDBClusterToPointInTime Text Source #

The name of the new DB cluster to be created.

Constraints:

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

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterToPointInTime_sourceDBClusterIdentifier :: Lens' RestoreDBClusterToPointInTime Text Source #

The identifier of the source DB cluster from which to restore.

Constraints:

Must match the identifier of an existing DBCluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restoreDBClusterToPointInTimeResponse_dbCluster :: Lens' RestoreDBClusterToPointInTimeResponse (Maybe DBCluster) Source #

Undocumented member.

restoreDBClusterToPointInTimeResponse_httpStatus :: Lens' RestoreDBClusterToPointInTimeResponse Int Source #

The response's http status code.

RestoreDBInstanceFromDBSnapshot

restoreDBInstanceFromDBSnapshot_autoMinorVersionUpgrade :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Bool) Source #

A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.

If you restore an RDS Custom DB instance, you must disable this parameter.

restoreDBInstanceFromDBSnapshot_availabilityZone :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) Source #

The Availability Zone (AZ) where the DB instance will be created.

Default: A random, system-chosen Availability Zone.

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

Example: us-east-1a

restoreDBInstanceFromDBSnapshot_backupTarget :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) Source #

Specifies where automated backups and manual snapshots are stored for the restored DB instance.

Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

restoreDBInstanceFromDBSnapshot_copyTagsToSnapshot :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Bool) Source #

A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.

In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.

For more information, see Copying tags to DB instance snapshots in the Amazon RDS User Guide.

restoreDBInstanceFromDBSnapshot_customIamInstanceProfile :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) Source #

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

This setting is required for RDS Custom.

restoreDBInstanceFromDBSnapshot_dbClusterSnapshotIdentifier :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) Source #

The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

Constraints:

Must match the identifier of an existing Multi-AZ DB cluster snapshot.
Can't be specified when DBSnapshotIdentifier is specified.
Must be specified when DBSnapshotIdentifier isn't specified.
If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
Can't be the identifier of an Aurora DB cluster snapshot.
Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.

restoreDBInstanceFromDBSnapshot_dbInstanceClass :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) Source #

The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Default: The same DBInstanceClass as the original DB instance.

restoreDBInstanceFromDBSnapshot_dbName :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) Source #

The database name for the restored DB instance.

This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. It also doesn't apply to RDS Custom DB instances.

restoreDBInstanceFromDBSnapshot_dbParameterGroupName :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) Source #

The name of the DB parameter group to associate with this DB instance.

If you don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup for the specified DB engine.

This setting doesn't apply to RDS Custom.

Constraints:

If supplied, must match the name of an existing DBParameterGroup.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.

restoreDBInstanceFromDBSnapshot_dbSnapshotIdentifier :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) Source #

The identifier for the DB snapshot to restore from.

Constraints:

Must match the identifier of an existing DBSnapshot.
Can't be specified when DBClusterSnapshotIdentifier is specified.
Must be specified when DBClusterSnapshotIdentifier isn't specified.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

restoreDBInstanceFromDBSnapshot_dbSubnetGroupName :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) Source #

The DB subnet group name to use for the new instance.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mydbsubnetgroup

restoreDBInstanceFromDBSnapshot_deletionProtection :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Bool) Source #

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.

restoreDBInstanceFromDBSnapshot_domain :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) Source #

Specify the Active Directory directory ID to restore the DB instance in. The domain/ must be created prior to this operation. Currently, you can create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

This setting doesn't apply to RDS Custom.

restoreDBInstanceFromDBSnapshot_domainIAMRoleName :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) Source #

Specify the name of the IAM role to be used when making API calls to the Directory Service.

This setting doesn't apply to RDS Custom.

restoreDBInstanceFromDBSnapshot_enableCloudwatchLogsExports :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe [Text]) Source #

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

This setting doesn't apply to RDS Custom.

restoreDBInstanceFromDBSnapshot_enableCustomerOwnedIp :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Bool) Source #

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

This setting doesn't apply to RDS Custom.

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

restoreDBInstanceFromDBSnapshot_enableIAMDatabaseAuthentication :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Bool) Source #

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

This setting doesn't apply to RDS Custom.

restoreDBInstanceFromDBSnapshot_engine :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) Source #

The database engine to use for the new instance.

This setting doesn't apply to RDS Custom.

Default: The same as source

Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

Valid Values:

```
mariadb
```
```
mysql
```
```
oracle-ee
```
```
oracle-ee-cdb
```
```
oracle-se2
```
```
oracle-se2-cdb
```
```
postgres
```
```
sqlserver-ee
```
```
sqlserver-se
```
```
sqlserver-ex
```
```
sqlserver-web
```

restoreDBInstanceFromDBSnapshot_iops :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Int) Source #

Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn't specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.

The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.

Constraints: Must be an integer greater than 1000.

restoreDBInstanceFromDBSnapshot_licenseModel :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) Source #

License model information for the restored DB instance.

This setting doesn't apply to RDS Custom.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

restoreDBInstanceFromDBSnapshot_multiAZ :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Bool) Source #

A value that indicates whether the DB instance is a Multi-AZ deployment.

This setting doesn't apply to RDS Custom.

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

restoreDBInstanceFromDBSnapshot_networkType :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) Source #

The network type of the DB instance.

Valid values:

```
IPV4
```
```
DUAL
```

The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

restoreDBInstanceFromDBSnapshot_optionGroupName :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) Source #

The name of the option group to be used for the restored DB instance.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance.

This setting doesn't apply to RDS Custom.

restoreDBInstanceFromDBSnapshot_port :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Int) Source #

The port number on which the database accepts connections.

Default: The same port as the original DB instance

Constraints: Value must be 1150-65535

restoreDBInstanceFromDBSnapshot_processorFeatures :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe [ProcessorFeature]) Source #

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

This setting doesn't apply to RDS Custom.

restoreDBInstanceFromDBSnapshot_publiclyAccessible :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Bool) Source #

A value that indicates whether the DB instance is publicly accessible.

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

restoreDBInstanceFromDBSnapshot_storageThroughput :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Int) Source #

Specifies the storage throughput value for the DB instance.

This setting doesn't apply to RDS Custom or Amazon Aurora.

restoreDBInstanceFromDBSnapshot_storageType :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) Source #

Specifies the storage type to be associated with the DB instance.

Valid values: gp2 | gp3 | io1 | standard

If you specify io1 or gp3, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise gp2

restoreDBInstanceFromDBSnapshot_tags :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe [Tag]) Source #

Undocumented member.

restoreDBInstanceFromDBSnapshot_tdeCredentialArn :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) Source #

The ARN from the key store with which to associate the instance for TDE encryption.

This setting doesn't apply to RDS Custom.

restoreDBInstanceFromDBSnapshot_tdeCredentialPassword :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) Source #

The password for the given ARN from the key store in order to access the device.

This setting doesn't apply to RDS Custom.

restoreDBInstanceFromDBSnapshot_useDefaultProcessorFeatures :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Bool) Source #

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

This setting doesn't apply to RDS Custom.

restoreDBInstanceFromDBSnapshot_vpcSecurityGroupIds :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe [Text]) Source #

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

Default: The default EC2 VPC security group for the DB subnet group's VPC.

restoreDBInstanceFromDBSnapshot_dbInstanceIdentifier :: Lens' RestoreDBInstanceFromDBSnapshot Text Source #

Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.

Constraints:

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

Example: my-snapshot-id

restoreDBInstanceFromDBSnapshotResponse_dbInstance :: Lens' RestoreDBInstanceFromDBSnapshotResponse (Maybe DBInstance) Source #

Undocumented member.

restoreDBInstanceFromDBSnapshotResponse_httpStatus :: Lens' RestoreDBInstanceFromDBSnapshotResponse Int Source #

The response's http status code.

RestoreDBInstanceFromS3

restoreDBInstanceFromS3_allocatedStorage :: Lens' RestoreDBInstanceFromS3 (Maybe Int) Source #

The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.

Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth.

restoreDBInstanceFromS3_autoMinorVersionUpgrade :: Lens' RestoreDBInstanceFromS3 (Maybe Bool) Source #

A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.

restoreDBInstanceFromS3_availabilityZone :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

The Availability Zone that the DB instance is created in. For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.

restoreDBInstanceFromS3_backupRetentionPeriod :: Lens' RestoreDBInstanceFromS3 (Maybe Int) Source #

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see CreateDBInstance.

restoreDBInstanceFromS3_copyTagsToSnapshot :: Lens' RestoreDBInstanceFromS3 (Maybe Bool) Source #

A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

restoreDBInstanceFromS3_dbName :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance.

restoreDBInstanceFromS3_dbParameterGroupName :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

The name of the DB parameter group to associate with this DB instance.

If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.

restoreDBInstanceFromS3_dbSecurityGroups :: Lens' RestoreDBInstanceFromS3 (Maybe [Text]) Source #

A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.

restoreDBInstanceFromS3_dbSubnetGroupName :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

A DB subnet group to associate with this DB instance.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mydbsubnetgroup

restoreDBInstanceFromS3_deletionProtection :: Lens' RestoreDBInstanceFromS3 (Maybe Bool) Source #

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.

restoreDBInstanceFromS3_enableCloudwatchLogsExports :: Lens' RestoreDBInstanceFromS3 (Maybe [Text]) Source #

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

restoreDBInstanceFromS3_enableIAMDatabaseAuthentication :: Lens' RestoreDBInstanceFromS3 (Maybe Bool) Source #

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

restoreDBInstanceFromS3_enablePerformanceInsights :: Lens' RestoreDBInstanceFromS3 (Maybe Bool) Source #

A value that indicates whether to enable Performance Insights for the DB instance.

For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

restoreDBInstanceFromS3_engineVersion :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

restoreDBInstanceFromS3_iops :: Lens' RestoreDBInstanceFromS3 (Maybe Int) Source #

The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.

restoreDBInstanceFromS3_kmsKeyId :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

The Amazon Web Services KMS key identifier for an encrypted DB instance.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

restoreDBInstanceFromS3_licenseModel :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

The license model for this DB instance. Use general-public-license.

restoreDBInstanceFromS3_manageMasterUserPassword :: Lens' RestoreDBInstanceFromS3 (Maybe Bool) Source #

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.

Constraints:

Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.

restoreDBInstanceFromS3_masterUserPassword :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

The password for the master user. The password can include any printable ASCII character except "/", """, or "@".

Constraints: Can't be specified if ManageMasterUserPassword is turned on.

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

restoreDBInstanceFromS3_masterUserSecretKmsKeyId :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

restoreDBInstanceFromS3_masterUsername :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

The name for the master user.

Constraints:

Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.

restoreDBInstanceFromS3_maxAllocatedStorage :: Lens' RestoreDBInstanceFromS3 (Maybe Int) Source #

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.

restoreDBInstanceFromS3_monitoringInterval :: Lens' RestoreDBInstanceFromS3 (Maybe Int) Source #

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

Default: 0

restoreDBInstanceFromS3_monitoringRoleArn :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

restoreDBInstanceFromS3_multiAZ :: Lens' RestoreDBInstanceFromS3 (Maybe Bool) Source #

A value that indicates whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.

restoreDBInstanceFromS3_networkType :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

The network type of the DB instance.

Valid values:

```
IPV4
```
```
DUAL
```

The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

restoreDBInstanceFromS3_optionGroupName :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.

restoreDBInstanceFromS3_performanceInsightsKMSKeyId :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

restoreDBInstanceFromS3_performanceInsightsRetentionPeriod :: Lens' RestoreDBInstanceFromS3 (Maybe Int) Source #

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

7
month * 31, where month is a number of months from 1-23
731

For example, the following values are valid:

93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

restoreDBInstanceFromS3_port :: Lens' RestoreDBInstanceFromS3 (Maybe Int) Source #

The port number on which the database accepts connections.

Type: Integer

Valid Values: 1150-65535

Default: 3306

restoreDBInstanceFromS3_preferredBackupWindow :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

The time range each day during which automated backups are created if automated backups are enabled. For more information, see Backup 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.

restoreDBInstanceFromS3_preferredMaintenanceWindow :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.

Constraints:

Must be in the format ddd:hh24:mi-ddd:hh24:mi.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.

restoreDBInstanceFromS3_processorFeatures :: Lens' RestoreDBInstanceFromS3 (Maybe [ProcessorFeature]) Source #

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

restoreDBInstanceFromS3_publiclyAccessible :: Lens' RestoreDBInstanceFromS3 (Maybe Bool) Source #

A value that indicates whether the DB instance is publicly accessible.

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

restoreDBInstanceFromS3_s3Prefix :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

The prefix of your Amazon S3 bucket.

restoreDBInstanceFromS3_storageEncrypted :: Lens' RestoreDBInstanceFromS3 (Maybe Bool) Source #

A value that indicates whether the new DB instance is encrypted or not.

restoreDBInstanceFromS3_storageThroughput :: Lens' RestoreDBInstanceFromS3 (Maybe Int) Source #

Specifies the storage throughput value for the DB instance.

This setting doesn't apply to RDS Custom or Amazon Aurora.

restoreDBInstanceFromS3_storageType :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

Specifies the storage type to be associated with the DB instance.

Valid values: gp2 | gp3 | io1 | standard

If you specify io1 or gp3, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified; otherwise gp2

restoreDBInstanceFromS3_tags :: Lens' RestoreDBInstanceFromS3 (Maybe [Tag]) Source #

A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

restoreDBInstanceFromS3_useDefaultProcessorFeatures :: Lens' RestoreDBInstanceFromS3 (Maybe Bool) Source #

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

restoreDBInstanceFromS3_vpcSecurityGroupIds :: Lens' RestoreDBInstanceFromS3 (Maybe [Text]) Source #

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

restoreDBInstanceFromS3_dbInstanceIdentifier :: Lens' RestoreDBInstanceFromS3 Text Source #

The DB instance 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.
Can't end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

restoreDBInstanceFromS3_dbInstanceClass :: Lens' RestoreDBInstanceFromS3 Text Source #

The compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.

restoreDBInstanceFromS3_engine :: Lens' RestoreDBInstanceFromS3 Text Source #

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

Valid Values: mysql

restoreDBInstanceFromS3_sourceEngine :: Lens' RestoreDBInstanceFromS3 Text Source #

The name of the engine of your source database.

Valid Values: mysql

restoreDBInstanceFromS3_sourceEngineVersion :: Lens' RestoreDBInstanceFromS3 Text Source #

The version of the database that the backup files were created from.

MySQL versions 5.6 and 5.7 are supported.

Example: 5.6.40

restoreDBInstanceFromS3_s3BucketName :: Lens' RestoreDBInstanceFromS3 Text Source #

The name of your Amazon S3 bucket that contains your database backup file.

restoreDBInstanceFromS3_s3IngestionRoleArn :: Lens' RestoreDBInstanceFromS3 Text Source #

An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.

restoreDBInstanceFromS3Response_dbInstance :: Lens' RestoreDBInstanceFromS3Response (Maybe DBInstance) Source #

Undocumented member.

restoreDBInstanceFromS3Response_httpStatus :: Lens' RestoreDBInstanceFromS3Response Int Source #

The response's http status code.

RestoreDBInstanceToPointInTime

restoreDBInstanceToPointInTime_autoMinorVersionUpgrade :: Lens' RestoreDBInstanceToPointInTime (Maybe Bool) Source #

A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.

This setting doesn't apply to RDS Custom.

restoreDBInstanceToPointInTime_availabilityZone :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #

The Availability Zone (AZ) where the DB instance will be created.

Default: A random, system-chosen Availability Zone.

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

Example: us-east-1a

restoreDBInstanceToPointInTime_backupTarget :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #

Specifies where automated backups and manual snapshots are stored for the restored DB instance.

Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

restoreDBInstanceToPointInTime_copyTagsToSnapshot :: Lens' RestoreDBInstanceToPointInTime (Maybe Bool) Source #

A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.

restoreDBInstanceToPointInTime_customIamInstanceProfile :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

This setting is required for RDS Custom.

restoreDBInstanceToPointInTime_dbInstanceClass :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #

The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Default: The same DBInstanceClass as the original DB instance.

restoreDBInstanceToPointInTime_dbName :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #

The database name for the restored DB instance.

This parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.

restoreDBInstanceToPointInTime_dbParameterGroupName :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #

The name of the DB parameter group to associate with this DB instance.

If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.

This setting doesn't apply to RDS Custom.

Constraints:

If supplied, must match the name of an existing DBParameterGroup.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.

restoreDBInstanceToPointInTime_dbSubnetGroupName :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #

The DB subnet group name to use for the new instance.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mydbsubnetgroup

restoreDBInstanceToPointInTime_deletionProtection :: Lens' RestoreDBInstanceToPointInTime (Maybe Bool) Source #

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.

restoreDBInstanceToPointInTime_domain :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #

Specify the Active Directory directory ID to restore the DB instance in. Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

This setting doesn't apply to RDS Custom.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

restoreDBInstanceToPointInTime_domainIAMRoleName :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #

Specify the name of the IAM role to be used when making API calls to the Directory Service.

This setting doesn't apply to RDS Custom.

restoreDBInstanceToPointInTime_enableCloudwatchLogsExports :: Lens' RestoreDBInstanceToPointInTime (Maybe [Text]) Source #

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

This setting doesn't apply to RDS Custom.

restoreDBInstanceToPointInTime_enableCustomerOwnedIp :: Lens' RestoreDBInstanceToPointInTime (Maybe Bool) Source #

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

This setting doesn't apply to RDS Custom.

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

restoreDBInstanceToPointInTime_enableIAMDatabaseAuthentication :: Lens' RestoreDBInstanceToPointInTime (Maybe Bool) Source #

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

This setting doesn't apply to RDS Custom.

For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

restoreDBInstanceToPointInTime_engine :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #

The database engine to use for the new instance.

This setting doesn't apply to RDS Custom.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Valid Values:

```
mariadb
```
```
mysql
```
```
oracle-ee
```
```
oracle-ee-cdb
```
```
oracle-se2
```
```
oracle-se2-cdb
```
```
postgres
```
```
sqlserver-ee
```
```
sqlserver-se
```
```
sqlserver-ex
```
```
sqlserver-web
```

restoreDBInstanceToPointInTime_iops :: Lens' RestoreDBInstanceToPointInTime (Maybe Int) Source #

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

Constraints: Must be an integer greater than 1000.

SQL Server

Setting the IOPS value for the SQL Server database engine isn't supported.

restoreDBInstanceToPointInTime_licenseModel :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #

License model information for the restored DB instance.

This setting doesn't apply to RDS Custom.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

restoreDBInstanceToPointInTime_maxAllocatedStorage :: Lens' RestoreDBInstanceToPointInTime (Maybe Int) Source #

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.

This setting doesn't apply to RDS Custom.

restoreDBInstanceToPointInTime_multiAZ :: Lens' RestoreDBInstanceToPointInTime (Maybe Bool) Source #

A value that indicates whether the DB instance is a Multi-AZ deployment.

This setting doesn't apply to RDS Custom.

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

restoreDBInstanceToPointInTime_networkType :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #

The network type of the DB instance.

Valid values:

```
IPV4
```
```
DUAL
```

The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

restoreDBInstanceToPointInTime_optionGroupName :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #

The name of the option group to be used for the restored DB instance.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance

This setting doesn't apply to RDS Custom.

restoreDBInstanceToPointInTime_port :: Lens' RestoreDBInstanceToPointInTime (Maybe Int) Source #

The port number on which the database accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB instance.

restoreDBInstanceToPointInTime_processorFeatures :: Lens' RestoreDBInstanceToPointInTime (Maybe [ProcessorFeature]) Source #

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

This setting doesn't apply to RDS Custom.

restoreDBInstanceToPointInTime_publiclyAccessible :: Lens' RestoreDBInstanceToPointInTime (Maybe Bool) Source #

A value that indicates whether the DB instance is publicly accessible.

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

restoreDBInstanceToPointInTime_restoreTime :: Lens' RestoreDBInstanceToPointInTime (Maybe UTCTime) Source #

The date and time to restore from.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

Must be before the latest restorable time for the DB instance
Can't be specified if the UseLatestRestorableTime parameter is enabled

Example: 2009-09-07T23:45:00Z

restoreDBInstanceToPointInTime_sourceDBInstanceAutomatedBackupsArn :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #

The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

This setting doesn't apply to RDS Custom.

restoreDBInstanceToPointInTime_sourceDBInstanceIdentifier :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #

The identifier of the source DB instance from which to restore.

Constraints:

Must match the identifier of an existing DB instance.

restoreDBInstanceToPointInTime_sourceDbiResourceId :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #

The resource ID of the source DB instance from which to restore.

restoreDBInstanceToPointInTime_storageThroughput :: Lens' RestoreDBInstanceToPointInTime (Maybe Int) Source #

Specifies the storage throughput value for the DB instance.

This setting doesn't apply to RDS Custom or Amazon Aurora.

restoreDBInstanceToPointInTime_storageType :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #

Specifies the storage type to be associated with the DB instance.

Valid values: gp2 | gp3 | io1 | standard

If you specify io1 or gp3, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise gp2

restoreDBInstanceToPointInTime_tags :: Lens' RestoreDBInstanceToPointInTime (Maybe [Tag]) Source #

Undocumented member.

restoreDBInstanceToPointInTime_tdeCredentialArn :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #

The ARN from the key store with which to associate the instance for TDE encryption.

This setting doesn't apply to RDS Custom.

restoreDBInstanceToPointInTime_tdeCredentialPassword :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #

The password for the given ARN from the key store in order to access the device.

This setting doesn't apply to RDS Custom.

restoreDBInstanceToPointInTime_useDefaultProcessorFeatures :: Lens' RestoreDBInstanceToPointInTime (Maybe Bool) Source #

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

This setting doesn't apply to RDS Custom.

restoreDBInstanceToPointInTime_useLatestRestorableTime :: Lens' RestoreDBInstanceToPointInTime (Maybe Bool) Source #

A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.

Constraints: Can't be specified if the RestoreTime parameter is provided.

restoreDBInstanceToPointInTime_vpcSecurityGroupIds :: Lens' RestoreDBInstanceToPointInTime (Maybe [Text]) Source #

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

Default: The default EC2 VPC security group for the DB subnet group's VPC.

restoreDBInstanceToPointInTime_targetDBInstanceIdentifier :: Lens' RestoreDBInstanceToPointInTime Text Source #

The name of the new DB instance to be created.

Constraints:

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

restoreDBInstanceToPointInTimeResponse_dbInstance :: Lens' RestoreDBInstanceToPointInTimeResponse (Maybe DBInstance) Source #

Undocumented member.

restoreDBInstanceToPointInTimeResponse_httpStatus :: Lens' RestoreDBInstanceToPointInTimeResponse Int Source #

The response's http status code.

RevokeDBSecurityGroupIngress

revokeDBSecurityGroupIngress_cidrip :: Lens' RevokeDBSecurityGroupIngress (Maybe Text) Source #

The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId can't be provided.

revokeDBSecurityGroupIngress_eC2SecurityGroupId :: Lens' RevokeDBSecurityGroupIngress (Maybe Text) Source #

The id of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

revokeDBSecurityGroupIngress_eC2SecurityGroupName :: Lens' RevokeDBSecurityGroupIngress (Maybe Text) Source #

The name of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

revokeDBSecurityGroupIngress_eC2SecurityGroupOwnerId :: Lens' RevokeDBSecurityGroupIngress (Maybe Text) Source #

The Amazon Web Services account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The Amazon Web Services access key ID isn't an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

revokeDBSecurityGroupIngress_dbSecurityGroupName :: Lens' RevokeDBSecurityGroupIngress Text Source #

The name of the DB security group to revoke ingress from.

revokeDBSecurityGroupIngressResponse_dbSecurityGroup :: Lens' RevokeDBSecurityGroupIngressResponse (Maybe DBSecurityGroup) Source #

Undocumented member.

revokeDBSecurityGroupIngressResponse_httpStatus :: Lens' RevokeDBSecurityGroupIngressResponse Int Source #

The response's http status code.

StartActivityStream

startActivityStream_applyImmediately :: Lens' StartActivityStream (Maybe Bool) Source #

Specifies whether or not the database activity stream is to start as soon as possible, regardless of the maintenance window for the database.

startActivityStream_engineNativeAuditFieldsIncluded :: Lens' StartActivityStream (Maybe Bool) Source #

Specifies whether the database activity stream includes engine-native audit fields. This option only applies to an Oracle DB instance. By default, no engine-native audit fields are included.

startActivityStream_resourceArn :: Lens' StartActivityStream Text Source #

The Amazon Resource Name (ARN) of the DB cluster, for example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.

startActivityStream_mode :: Lens' StartActivityStream ActivityStreamMode Source #

Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

startActivityStream_kmsKeyId :: Lens' StartActivityStream Text Source #

The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

startActivityStreamResponse_applyImmediately :: Lens' StartActivityStreamResponse (Maybe Bool) Source #

Indicates whether or not the database activity stream will start as soon as possible, regardless of the maintenance window for the database.

startActivityStreamResponse_engineNativeAuditFieldsIncluded :: Lens' StartActivityStreamResponse (Maybe Bool) Source #

Indicates whether engine-native audit fields are included in the database activity stream.

startActivityStreamResponse_kinesisStreamName :: Lens' StartActivityStreamResponse (Maybe Text) Source #

The name of the Amazon Kinesis data stream to be used for the database activity stream.

startActivityStreamResponse_kmsKeyId :: Lens' StartActivityStreamResponse (Maybe Text) Source #

The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.

startActivityStreamResponse_mode :: Lens' StartActivityStreamResponse (Maybe ActivityStreamMode) Source #

The mode of the database activity stream.

startActivityStreamResponse_status :: Lens' StartActivityStreamResponse (Maybe ActivityStreamStatus) Source #

The status of the database activity stream.

startActivityStreamResponse_httpStatus :: Lens' StartActivityStreamResponse Int Source #

The response's http status code.

StartDBCluster

startDBCluster_dbClusterIdentifier :: Lens' StartDBCluster Text Source #

The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as a lowercase string.

startDBClusterResponse_dbCluster :: Lens' StartDBClusterResponse (Maybe DBCluster) Source #

Undocumented member.

startDBClusterResponse_httpStatus :: Lens' StartDBClusterResponse Int Source #

The response's http status code.

StartDBInstance

startDBInstance_dbInstanceIdentifier :: Lens' StartDBInstance Text Source #

The user-supplied instance identifier.

startDBInstanceResponse_dbInstance :: Lens' StartDBInstanceResponse (Maybe DBInstance) Source #

Undocumented member.

startDBInstanceResponse_httpStatus :: Lens' StartDBInstanceResponse Int Source #

The response's http status code.

StartDBInstanceAutomatedBackupsReplication

startDBInstanceAutomatedBackupsReplication_backupRetentionPeriod :: Lens' StartDBInstanceAutomatedBackupsReplication (Maybe Int) Source #

The retention period for the replicated automated backups.

startDBInstanceAutomatedBackupsReplication_destinationRegion :: Lens' StartDBInstanceAutomatedBackupsReplication (Maybe Text) Source #

Pseudo-parameter used when populating the PreSignedUrl of a cross-region StartDBInstanceAutomatedBackupsReplication request. To replicate from region SRC to region DST, send a request to region DST. In that request, pass a PreSignedUrl for region SRC with DestinationRegion set to region DST.

startDBInstanceAutomatedBackupsReplication_kmsKeyId :: Lens' StartDBInstanceAutomatedBackupsReplication (Maybe Text) Source #

The Amazon Web Services KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination Amazon Web Services Region, for example, arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.

startDBInstanceAutomatedBackupsReplication_preSignedUrl :: Lens' StartDBInstanceAutomatedBackupsReplication (Maybe Text) Source #

In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request for the StartDBInstanceAutomatedBackupsReplication operation to call in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the StartDBInstanceAutomatedBackupsReplication API operation that can run in the Amazon Web Services Region that contains the source DB instance.

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.

startDBInstanceAutomatedBackupsReplication_sourceDBInstanceArn :: Lens' StartDBInstanceAutomatedBackupsReplication Text Source #

The Amazon Resource Name (ARN) of the source DB instance for the replicated automated backups, for example, arn:aws:rds:us-west-2:123456789012:db:mydatabase.

startDBInstanceAutomatedBackupsReplicationResponse_dbInstanceAutomatedBackup :: Lens' StartDBInstanceAutomatedBackupsReplicationResponse (Maybe DBInstanceAutomatedBackup) Source #

Undocumented member.

startDBInstanceAutomatedBackupsReplicationResponse_httpStatus :: Lens' StartDBInstanceAutomatedBackupsReplicationResponse Int Source #

The response's http status code.

StartExportTask

startExportTask_exportOnly :: Lens' StartExportTask (Maybe [Text]) Source #

The data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are the following:

database - Export all the data from a specified database.
database.table table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
database.schema schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

startExportTask_s3Prefix :: Lens' StartExportTask (Maybe Text) Source #

The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

startExportTask_exportTaskIdentifier :: Lens' StartExportTask Text Source #

A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is to be exported to.

startExportTask_sourceArn :: Lens' StartExportTask Text Source #

The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3.

startExportTask_s3BucketName :: Lens' StartExportTask Text Source #

The name of the Amazon S3 bucket to export the snapshot to.

startExportTask_iamRoleArn :: Lens' StartExportTask Text Source #

The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot.

startExportTask_kmsKeyId :: Lens' StartExportTask Text Source #

The ID of the Amazon Web Services KMS key to use to encrypt the snapshot exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to run the following operations. These can be set in the Amazon Web Services KMS key policy:

kms:Encrypt
kms:Decrypt
kms:GenerateDataKey
kms:GenerateDataKeyWithoutPlaintext
kms:ReEncryptFrom
kms:ReEncryptTo
kms:CreateGrant
kms:DescribeKey
kms:RetireGrant

exportTask_exportOnly :: Lens' ExportTask (Maybe [Text]) Source #

The data exported from the snapshot. Valid values are the following:

database - Export all the data from a specified database.
database.table table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
database.schema schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

exportTask_exportTaskIdentifier :: Lens' ExportTask (Maybe Text) Source #

A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is exported to.

exportTask_failureCause :: Lens' ExportTask (Maybe Text) Source #

The reason the export failed, if it failed.

exportTask_iamRoleArn :: Lens' ExportTask (Maybe Text) Source #

The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.

exportTask_kmsKeyId :: Lens' ExportTask (Maybe Text) Source #

The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key.

exportTask_percentProgress :: Lens' ExportTask (Maybe Int) Source #

The progress of the snapshot export task as a percentage.

exportTask_s3Bucket :: Lens' ExportTask (Maybe Text) Source #

The Amazon S3 bucket that the snapshot is exported to.

exportTask_s3Prefix :: Lens' ExportTask (Maybe Text) Source #

The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.

exportTask_snapshotTime :: Lens' ExportTask (Maybe UTCTime) Source #

The time that the snapshot was created.

exportTask_sourceArn :: Lens' ExportTask (Maybe Text) Source #

The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

exportTask_sourceType :: Lens' ExportTask (Maybe ExportSourceType) Source #

The type of source for the export.

exportTask_status :: Lens' ExportTask (Maybe Text) Source #

The progress status of the export task.

exportTask_taskEndTime :: Lens' ExportTask (Maybe UTCTime) Source #

The time that the snapshot export task completed.

exportTask_taskStartTime :: Lens' ExportTask (Maybe UTCTime) Source #

The time that the snapshot export task started.

exportTask_totalExtractedDataInGB :: Lens' ExportTask (Maybe Int) Source #

The total amount of data exported, in gigabytes.

exportTask_warningMessage :: Lens' ExportTask (Maybe Text) Source #

A warning about the snapshot export task.

StopActivityStream

stopActivityStream_applyImmediately :: Lens' StopActivityStream (Maybe Bool) Source #

Specifies whether or not the database activity stream is to stop as soon as possible, regardless of the maintenance window for the database.

stopActivityStream_resourceArn :: Lens' StopActivityStream Text Source #

The Amazon Resource Name (ARN) of the DB cluster for the database activity stream. For example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.

stopActivityStreamResponse_kinesisStreamName :: Lens' StopActivityStreamResponse (Maybe Text) Source #

The name of the Amazon Kinesis data stream used for the database activity stream.

stopActivityStreamResponse_kmsKeyId :: Lens' StopActivityStreamResponse (Maybe Text) Source #

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

stopActivityStreamResponse_status :: Lens' StopActivityStreamResponse (Maybe ActivityStreamStatus) Source #

The status of the database activity stream.

stopActivityStreamResponse_httpStatus :: Lens' StopActivityStreamResponse Int Source #

The response's http status code.

StopDBCluster

stopDBCluster_dbClusterIdentifier :: Lens' StopDBCluster Text Source #

The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as a lowercase string.

stopDBClusterResponse_dbCluster :: Lens' StopDBClusterResponse (Maybe DBCluster) Source #

Undocumented member.

stopDBClusterResponse_httpStatus :: Lens' StopDBClusterResponse Int Source #

The response's http status code.

StopDBInstance

stopDBInstance_dbSnapshotIdentifier :: Lens' StopDBInstance (Maybe Text) Source #

The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.

stopDBInstance_dbInstanceIdentifier :: Lens' StopDBInstance Text Source #

The user-supplied instance identifier.

stopDBInstanceResponse_dbInstance :: Lens' StopDBInstanceResponse (Maybe DBInstance) Source #

Undocumented member.

stopDBInstanceResponse_httpStatus :: Lens' StopDBInstanceResponse Int Source #

The response's http status code.

StopDBInstanceAutomatedBackupsReplication

stopDBInstanceAutomatedBackupsReplication_sourceDBInstanceArn :: Lens' StopDBInstanceAutomatedBackupsReplication Text Source #

The Amazon Resource Name (ARN) of the source DB instance for which to stop replicating automated backups, for example, arn:aws:rds:us-west-2:123456789012:db:mydatabase.

stopDBInstanceAutomatedBackupsReplicationResponse_dbInstanceAutomatedBackup :: Lens' StopDBInstanceAutomatedBackupsReplicationResponse (Maybe DBInstanceAutomatedBackup) Source #

Undocumented member.

stopDBInstanceAutomatedBackupsReplicationResponse_httpStatus :: Lens' StopDBInstanceAutomatedBackupsReplicationResponse Int Source #

The response's http status code.

SwitchoverBlueGreenDeployment

switchoverBlueGreenDeployment_switchoverTimeout :: Lens' SwitchoverBlueGreenDeployment (Maybe Natural) Source #

The amount of time, in seconds, for the switchover to complete. The default is 300.

If the switchover takes longer than the specified duration, then any changes are rolled back, and no changes are made to the environments.

switchoverBlueGreenDeployment_blueGreenDeploymentIdentifier :: Lens' SwitchoverBlueGreenDeployment Text Source #

The blue/green deployment identifier.

Constraints:

Must match an existing blue/green deployment identifier.

switchoverBlueGreenDeploymentResponse_blueGreenDeployment :: Lens' SwitchoverBlueGreenDeploymentResponse (Maybe BlueGreenDeployment) Source #

Undocumented member.

switchoverBlueGreenDeploymentResponse_httpStatus :: Lens' SwitchoverBlueGreenDeploymentResponse Int Source #

The response's http status code.

SwitchoverReadReplica

switchoverReadReplica_dbInstanceIdentifier :: Lens' SwitchoverReadReplica Text Source #

The DB instance identifier of the current standby database. This value is stored as a lowercase string.

Constraints:

Must match the identiﬁer of an existing Oracle read replica DB instance.

switchoverReadReplicaResponse_dbInstance :: Lens' SwitchoverReadReplicaResponse (Maybe DBInstance) Source #

Undocumented member.

switchoverReadReplicaResponse_httpStatus :: Lens' SwitchoverReadReplicaResponse Int Source #

The response's http status code.

Types

AccountQuota

accountQuota_accountQuotaName :: Lens' AccountQuota (Maybe Text) Source #

The name of the Amazon RDS quota for this Amazon Web Services account.

accountQuota_max :: Lens' AccountQuota (Maybe Integer) Source #

The maximum allowed value for the quota.

accountQuota_used :: Lens' AccountQuota (Maybe Integer) Source #

The amount currently used toward the quota maximum.

AvailabilityZone

availabilityZone_name :: Lens' AvailabilityZone (Maybe Text) Source #

The name of the Availability Zone.

AvailableProcessorFeature

availableProcessorFeature_allowedValues :: Lens' AvailableProcessorFeature (Maybe Text) Source #

The allowed values for the processor feature of the DB instance class.

availableProcessorFeature_defaultValue :: Lens' AvailableProcessorFeature (Maybe Text) Source #

The default value for the processor feature of the DB instance class.

availableProcessorFeature_name :: Lens' AvailableProcessorFeature (Maybe Text) Source #

The name of the processor feature. Valid names are coreCount and threadsPerCore.

BlueGreenDeployment

blueGreenDeployment_blueGreenDeploymentIdentifier :: Lens' BlueGreenDeployment (Maybe Text) Source #

The system-generated identifier of the blue/green deployment.

blueGreenDeployment_blueGreenDeploymentName :: Lens' BlueGreenDeployment (Maybe Text) Source #

The user-supplied name of the blue/green deployment.

blueGreenDeployment_createTime :: Lens' BlueGreenDeployment (Maybe UTCTime) Source #

Specifies the time when the blue/green deployment was created, in Universal Coordinated Time (UTC).

blueGreenDeployment_deleteTime :: Lens' BlueGreenDeployment (Maybe UTCTime) Source #

Specifies the time when the blue/green deployment was deleted, in Universal Coordinated Time (UTC).

blueGreenDeployment_source :: Lens' BlueGreenDeployment (Maybe Text) Source #

The source database for the blue/green deployment.

Before switchover, the source database is the production database in the blue environment.

blueGreenDeployment_status :: Lens' BlueGreenDeployment (Maybe Text) Source #

The status of the blue/green deployment.

Values:

PROVISIONING - Resources are being created in the green environment.
AVAILABLE - Resources are available in the green environment.
SWITCHOVER_IN_PROGRESS - The deployment is being switched from the blue environment to the green environment.
SWITCHOVER_COMPLETED - Switchover from the blue environment to the green environment is complete.
INVALID_CONFIGURATION - Resources in the green environment are invalid, so switchover isn't possible.
SWITCHOVER_FAILED - Switchover was attempted but failed.
DELETING - The blue/green deployment is being deleted.

blueGreenDeployment_statusDetails :: Lens' BlueGreenDeployment (Maybe Text) Source #

Additional information about the status of the blue/green deployment.

blueGreenDeployment_switchoverDetails :: Lens' BlueGreenDeployment (Maybe [SwitchoverDetail]) Source #

The details about each source and target resource in the blue/green deployment.

blueGreenDeployment_tagList :: Lens' BlueGreenDeployment (Maybe [Tag]) Source #

Undocumented member.

blueGreenDeployment_target :: Lens' BlueGreenDeployment (Maybe Text) Source #

The target database for the blue/green deployment.

Before switchover, the target database is the clone database in the green environment.

blueGreenDeployment_tasks :: Lens' BlueGreenDeployment (Maybe [BlueGreenDeploymentTask]) Source #

Either tasks to be performed or tasks that have been completed on the target database before switchover.

BlueGreenDeploymentTask

blueGreenDeploymentTask_name :: Lens' BlueGreenDeploymentTask (Maybe Text) Source #

The name of the blue/green deployment task.

blueGreenDeploymentTask_status :: Lens' BlueGreenDeploymentTask (Maybe Text) Source #

The status of the blue/green deployment task.

Values:

PENDING - The resources are being prepared for deployment.
IN_PROGRESS - The resource is being deployed.
COMPLETED - The resource has been deployed.
FAILED - Deployment of the resource failed.

Certificate

certificate_certificateArn :: Lens' Certificate (Maybe Text) Source #

The Amazon Resource Name (ARN) for the certificate.

certificate_certificateIdentifier :: Lens' Certificate (Maybe Text) Source #

The unique key that identifies a certificate.

certificate_certificateType :: Lens' Certificate (Maybe Text) Source #

The type of the certificate.

certificate_customerOverride :: Lens' Certificate (Maybe Bool) Source #

Whether there is an override for the default certificate identifier.

certificate_customerOverrideValidTill :: Lens' Certificate (Maybe UTCTime) Source #

If there is an override for the default certificate identifier, when the override expires.

certificate_thumbprint :: Lens' Certificate (Maybe Text) Source #

The thumbprint of the certificate.

certificate_validFrom :: Lens' Certificate (Maybe UTCTime) Source #

The starting date from which the certificate is valid.

certificate_validTill :: Lens' Certificate (Maybe UTCTime) Source #

The final date that the certificate continues to be valid.

CertificateDetails

certificateDetails_cAIdentifier :: Lens' CertificateDetails (Maybe Text) Source #

The CA identifier of the CA certificate used for the DB instance's server certificate.

certificateDetails_validTill :: Lens' CertificateDetails (Maybe UTCTime) Source #

The expiration date of the DB instance’s server certificate.

CharacterSet

characterSet_characterSetDescription :: Lens' CharacterSet (Maybe Text) Source #

The description of the character set.

characterSet_characterSetName :: Lens' CharacterSet (Maybe Text) Source #

The name of the character set.

CloudwatchLogsExportConfiguration

cloudwatchLogsExportConfiguration_disableLogTypes :: Lens' CloudwatchLogsExportConfiguration (Maybe [Text]) Source #

The list of log types to disable.

cloudwatchLogsExportConfiguration_enableLogTypes :: Lens' CloudwatchLogsExportConfiguration (Maybe [Text]) Source #

The list of log types to enable.

ClusterPendingModifiedValues

clusterPendingModifiedValues_allocatedStorage :: Lens' ClusterPendingModifiedValues (Maybe Int) Source #

The allocated storage size in gibibytes (GiB) for all database engines except Amazon Aurora. For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

clusterPendingModifiedValues_backupRetentionPeriod :: Lens' ClusterPendingModifiedValues (Maybe Int) Source #

The number of days for which automatic DB snapshots are retained.

clusterPendingModifiedValues_dbClusterIdentifier :: Lens' ClusterPendingModifiedValues (Maybe Text) Source #

The DBClusterIdentifier value for the DB cluster.

clusterPendingModifiedValues_engineVersion :: Lens' ClusterPendingModifiedValues (Maybe Text) Source #

The database engine version.

clusterPendingModifiedValues_iAMDatabaseAuthenticationEnabled :: Lens' ClusterPendingModifiedValues (Maybe Bool) Source #

A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

clusterPendingModifiedValues_iops :: Lens' ClusterPendingModifiedValues (Maybe Int) Source #

The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

clusterPendingModifiedValues_masterUserPassword :: Lens' ClusterPendingModifiedValues (Maybe Text) Source #

The master credentials for the DB cluster.

clusterPendingModifiedValues_pendingCloudwatchLogsExports :: Lens' ClusterPendingModifiedValues (Maybe PendingCloudwatchLogsExports) Source #

Undocumented member.

ConnectionPoolConfiguration

connectionPoolConfiguration_connectionBorrowTimeout :: Lens' ConnectionPoolConfiguration (Maybe Int) Source #

The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.

Default: 120

Constraints: between 1 and 3600, or 0 representing unlimited

connectionPoolConfiguration_initQuery :: Lens' ConnectionPoolConfiguration (Maybe Text) Source #

One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.

Default: no initialization query

connectionPoolConfiguration_maxConnectionsPercent :: Lens' ConnectionPoolConfiguration (Maybe Int) Source #

The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter.

Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines

Constraints: Must be between 1 and 100.

connectionPoolConfiguration_maxIdleConnectionsPercent :: Lens' ConnectionPoolConfiguration (Maybe Int) Source #

Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.

If you specify this parameter, then you must also include a value for MaxConnectionsPercent.

Default: The default value is half of the value of MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and for all other engines, the default is 50.

Constraints: Must be between 0 and the value of MaxConnectionsPercent.

connectionPoolConfiguration_sessionPinningFilters :: Lens' ConnectionPoolConfiguration (Maybe [Text]) Source #

Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior.

Default: no session pinning filters

ConnectionPoolConfigurationInfo

connectionPoolConfigurationInfo_connectionBorrowTimeout :: Lens' ConnectionPoolConfigurationInfo (Maybe Int) Source #

The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.

connectionPoolConfigurationInfo_initQuery :: Lens' ConnectionPoolConfigurationInfo (Maybe Text) Source #

One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. This setting is empty by default. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.

connectionPoolConfigurationInfo_maxConnectionsPercent :: Lens' ConnectionPoolConfigurationInfo (Maybe Int) Source #

The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

connectionPoolConfigurationInfo_maxIdleConnectionsPercent :: Lens' ConnectionPoolConfigurationInfo (Maybe Int) Source #

Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.

connectionPoolConfigurationInfo_sessionPinningFilters :: Lens' ConnectionPoolConfigurationInfo (Maybe [Text]) Source #

Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior. This setting is only supported for MySQL engine family databases. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

CustomDBEngineVersionAMI

customDBEngineVersionAMI_imageId :: Lens' CustomDBEngineVersionAMI (Maybe Text) Source #

A value that indicates the ID of the AMI.

customDBEngineVersionAMI_status :: Lens' CustomDBEngineVersionAMI (Maybe Text) Source #

A value that indicates the status of a custom engine version (CEV).

DBCluster

dbCluster_activityStreamKinesisStreamName :: Lens' DBCluster (Maybe Text) Source #

The name of the Amazon Kinesis data stream used for the database activity stream.

dbCluster_activityStreamKmsKeyId :: Lens' DBCluster (Maybe Text) Source #

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

dbCluster_activityStreamMode :: Lens' DBCluster (Maybe ActivityStreamMode) Source #

The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

dbCluster_activityStreamStatus :: Lens' DBCluster (Maybe ActivityStreamStatus) Source #

The status of the database activity stream.

dbCluster_allocatedStorage :: Lens' DBCluster (Maybe Int) Source #

For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

dbCluster_associatedRoles :: Lens' DBCluster (Maybe [DBClusterRole]) Source #

Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.

dbCluster_autoMinorVersionUpgrade :: Lens' DBCluster (Maybe Bool) Source #

A value that indicates that minor version patches are applied automatically.

This setting is only for non-Aurora Multi-AZ DB clusters.

dbCluster_automaticRestartTime :: Lens' DBCluster (Maybe UTCTime) Source #

The time when a stopped DB cluster is restarted automatically.

dbCluster_availabilityZones :: Lens' DBCluster (Maybe [Text]) Source #

Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

dbCluster_backtrackConsumedChangeRecords :: Lens' DBCluster (Maybe Integer) Source #

The number of change records stored for Backtrack.

dbCluster_backtrackWindow :: Lens' DBCluster (Maybe Integer) Source #

The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.

dbCluster_backupRetentionPeriod :: Lens' DBCluster (Maybe Int) Source #

Specifies the number of days for which automatic DB snapshots are retained.

dbCluster_capacity :: Lens' DBCluster (Maybe Int) Source #

The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.

dbCluster_characterSetName :: Lens' DBCluster (Maybe Text) Source #

If present, specifies the name of the character set that this cluster is associated with.

dbCluster_cloneGroupId :: Lens' DBCluster (Maybe Text) Source #

Identifies the clone group to which the DB cluster is associated.

dbCluster_clusterCreateTime :: Lens' DBCluster (Maybe UTCTime) Source #

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

dbCluster_copyTagsToSnapshot :: Lens' DBCluster (Maybe Bool) Source #

Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

dbCluster_crossAccountClone :: Lens' DBCluster (Maybe Bool) Source #

Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

dbCluster_customEndpoints :: Lens' DBCluster (Maybe [Text]) Source #

Identifies all custom endpoints associated with the cluster.

dbCluster_dbClusterArn :: Lens' DBCluster (Maybe Text) Source #

The Amazon Resource Name (ARN) for the DB cluster.

dbCluster_dbClusterIdentifier :: Lens' DBCluster (Maybe Text) Source #

Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

dbCluster_dbClusterInstanceClass :: Lens' DBCluster (Maybe Text) Source #

The name of the compute and memory capacity class of the DB instance.

This setting is only for non-Aurora Multi-AZ DB clusters.

dbCluster_dbClusterMembers :: Lens' DBCluster (Maybe [DBClusterMember]) Source #

Provides the list of instances that make up the DB cluster.

dbCluster_dbClusterOptionGroupMemberships :: Lens' DBCluster (Maybe [DBClusterOptionGroupStatus]) Source #

Provides the list of option group memberships for this DB cluster.

dbCluster_dbClusterParameterGroup :: Lens' DBCluster (Maybe Text) Source #

Specifies the name of the DB cluster parameter group for the DB cluster.

dbCluster_dbSubnetGroup :: Lens' DBCluster (Maybe Text) Source #

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

dbCluster_dbSystemId :: Lens' DBCluster (Maybe Text) Source #

Reserved for future use.

dbCluster_databaseName :: Lens' DBCluster (Maybe Text) Source #

Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

dbCluster_dbClusterResourceId :: Lens' DBCluster (Maybe Text) Source #

The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

dbCluster_deletionProtection :: Lens' DBCluster (Maybe Bool) Source #

Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

dbCluster_domainMemberships :: Lens' DBCluster (Maybe [DomainMembership]) Source #

The Active Directory Domain membership records associated with the DB cluster.

dbCluster_earliestBacktrackTime :: Lens' DBCluster (Maybe UTCTime) Source #

The earliest time to which a DB cluster can be backtracked.

dbCluster_earliestRestorableTime :: Lens' DBCluster (Maybe UTCTime) Source #

The earliest time to which a database can be restored with point-in-time restore.

dbCluster_enabledCloudwatchLogsExports :: Lens' DBCluster (Maybe [Text]) Source #

A list of log types that this DB cluster is configured to export to CloudWatch Logs.

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.

dbCluster_endpoint :: Lens' DBCluster (Maybe Text) Source #

Specifies the connection endpoint for the primary instance of the DB cluster.

dbCluster_engine :: Lens' DBCluster (Maybe Text) Source #

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

dbCluster_engineMode :: Lens' DBCluster (Maybe Text) Source #

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

For more information, see CreateDBCluster.

dbCluster_engineVersion :: Lens' DBCluster (Maybe Text) Source #

Indicates the database engine version.

dbCluster_globalWriteForwardingRequested :: Lens' DBCluster (Maybe Bool) Source #

Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.

dbCluster_globalWriteForwardingStatus :: Lens' DBCluster (Maybe WriteForwardingStatus) Source #

Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

dbCluster_hostedZoneId :: Lens' DBCluster (Maybe Text) Source #

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

dbCluster_httpEndpointEnabled :: Lens' DBCluster (Maybe Bool) Source #

A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide.

dbCluster_iAMDatabaseAuthenticationEnabled :: Lens' DBCluster (Maybe Bool) Source #

A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

dbCluster_iops :: Lens' DBCluster (Maybe Int) Source #

The Provisioned IOPS (I/O operations per second) value.

This setting is only for non-Aurora Multi-AZ DB clusters.

dbCluster_kmsKeyId :: Lens' DBCluster (Maybe Text) Source #

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

dbCluster_latestRestorableTime :: Lens' DBCluster (Maybe UTCTime) Source #

Specifies the latest time to which a database can be restored with point-in-time restore.

dbCluster_masterUserSecret :: Lens' DBCluster (Maybe MasterUserSecret) Source #

Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.

dbCluster_masterUsername :: Lens' DBCluster (Maybe Text) Source #

Contains the master username for the DB cluster.

dbCluster_monitoringInterval :: Lens' DBCluster (Maybe Int) Source #

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.

This setting is only for non-Aurora Multi-AZ DB clusters.

dbCluster_monitoringRoleArn :: Lens' DBCluster (Maybe Text) Source #

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

This setting is only for non-Aurora Multi-AZ DB clusters.

dbCluster_multiAZ :: Lens' DBCluster (Maybe Bool) Source #

Specifies whether the DB cluster has instances in multiple Availability Zones.

dbCluster_networkType :: Lens' DBCluster (Maybe Text) Source #

The network type of the DB instance.

Valid values:

```
IPV4
```
```
DUAL
```

The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.

This setting is only for Aurora DB clusters.

dbCluster_pendingModifiedValues :: Lens' DBCluster (Maybe ClusterPendingModifiedValues) Source #

A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

dbCluster_percentProgress :: Lens' DBCluster (Maybe Text) Source #

Specifies the progress of the operation as a percentage.

dbCluster_performanceInsightsEnabled :: Lens' DBCluster (Maybe Bool) Source #

True if Performance Insights is enabled for the DB cluster, and otherwise false.

This setting is only for non-Aurora Multi-AZ DB clusters.

dbCluster_performanceInsightsKMSKeyId :: Lens' DBCluster (Maybe Text) Source #

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

This setting is only for non-Aurora Multi-AZ DB clusters.

dbCluster_performanceInsightsRetentionPeriod :: Lens' DBCluster (Maybe Int) Source #

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

7
month * 31, where month is a number of months from 1-23
731

For example, the following values are valid:

93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731

This setting is only for non-Aurora Multi-AZ DB clusters.

dbCluster_port :: Lens' DBCluster (Maybe Int) Source #

Specifies the port that the database engine is listening on.

dbCluster_preferredBackupWindow :: Lens' DBCluster (Maybe Text) Source #

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

dbCluster_preferredMaintenanceWindow :: Lens' DBCluster (Maybe Text) Source #

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

dbCluster_publiclyAccessible :: Lens' DBCluster (Maybe Bool) Source #

Specifies the accessibility options for the DB instance.

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

This setting is only for non-Aurora Multi-AZ DB clusters.

dbCluster_readReplicaIdentifiers :: Lens' DBCluster (Maybe [Text]) Source #

Contains one or more identifiers of the read replicas associated with this DB cluster.

dbCluster_readerEndpoint :: Lens' DBCluster (Maybe Text) Source #

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

dbCluster_replicationSourceIdentifier :: Lens' DBCluster (Maybe Text) Source #

Contains the identifier of the source DB cluster if this DB cluster is a read replica.

dbCluster_scalingConfigurationInfo :: Lens' DBCluster (Maybe ScalingConfigurationInfo) Source #

Undocumented member.

dbCluster_serverlessV2ScalingConfiguration :: Lens' DBCluster (Maybe ServerlessV2ScalingConfigurationInfo) Source #

Undocumented member.

dbCluster_status :: Lens' DBCluster (Maybe Text) Source #

Specifies the current state of this DB cluster.

dbCluster_storageEncrypted :: Lens' DBCluster (Maybe Bool) Source #

Specifies whether the DB cluster is encrypted.

dbCluster_storageType :: Lens' DBCluster (Maybe Text) Source #

The storage type associated with the DB cluster.

This setting is only for non-Aurora Multi-AZ DB clusters.

dbCluster_tagList :: Lens' DBCluster (Maybe [Tag]) Source #

Undocumented member.

dbCluster_vpcSecurityGroups :: Lens' DBCluster (Maybe [VpcSecurityGroupMembership]) Source #

Provides a list of VPC security groups that the DB cluster belongs to.

DBClusterBacktrack

dbClusterBacktrack_backtrackIdentifier :: Lens' DBClusterBacktrack (Maybe Text) Source #

Contains the backtrack identifier.

dbClusterBacktrack_backtrackRequestCreationTime :: Lens' DBClusterBacktrack (Maybe UTCTime) Source #

The timestamp of the time at which the backtrack was requested.

dbClusterBacktrack_backtrackTo :: Lens' DBClusterBacktrack (Maybe UTCTime) Source #

The timestamp of the time to which the DB cluster was backtracked.

dbClusterBacktrack_backtrackedFrom :: Lens' DBClusterBacktrack (Maybe UTCTime) Source #

The timestamp of the time from which the DB cluster was backtracked.

dbClusterBacktrack_dbClusterIdentifier :: Lens' DBClusterBacktrack (Maybe Text) Source #

Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

dbClusterBacktrack_status :: Lens' DBClusterBacktrack (Maybe Text) Source #

The status of the backtrack. This property returns one of the following values:

applying - The backtrack is currently being applied to or rolled back from the DB cluster.
completed - The backtrack has successfully been applied to or rolled back from the DB cluster.
failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.
pending - The backtrack is currently pending application to or rollback from the DB cluster.

DBClusterEndpoint

dbClusterEndpoint_customEndpointType :: Lens' DBClusterEndpoint (Maybe Text) Source #

The type associated with a custom endpoint. One of: READER, WRITER, ANY.

dbClusterEndpoint_dbClusterEndpointArn :: Lens' DBClusterEndpoint (Maybe Text) Source #

The Amazon Resource Name (ARN) for the endpoint.

dbClusterEndpoint_dbClusterEndpointIdentifier :: Lens' DBClusterEndpoint (Maybe Text) Source #

The identifier associated with the endpoint. This parameter is stored as a lowercase string.

dbClusterEndpoint_dbClusterEndpointResourceIdentifier :: Lens' DBClusterEndpoint (Maybe Text) Source #

A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

dbClusterEndpoint_dbClusterIdentifier :: Lens' DBClusterEndpoint (Maybe Text) Source #

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

dbClusterEndpoint_endpoint :: Lens' DBClusterEndpoint (Maybe Text) Source #

The DNS address of the endpoint.

dbClusterEndpoint_endpointType :: Lens' DBClusterEndpoint (Maybe Text) Source #

The type of the endpoint. One of: READER, WRITER, CUSTOM.

dbClusterEndpoint_excludedMembers :: Lens' DBClusterEndpoint (Maybe [Text]) Source #

List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

dbClusterEndpoint_staticMembers :: Lens' DBClusterEndpoint (Maybe [Text]) Source #

List of DB instance identifiers that are part of the custom endpoint group.

dbClusterEndpoint_status :: Lens' DBClusterEndpoint (Maybe Text) Source #

The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.

DBClusterMember

dbClusterMember_dbClusterParameterGroupStatus :: Lens' DBClusterMember (Maybe Text) Source #

Specifies the status of the DB cluster parameter group for this member of the DB cluster.

dbClusterMember_dbInstanceIdentifier :: Lens' DBClusterMember (Maybe Text) Source #

Specifies the instance identifier for this member of the DB cluster.

dbClusterMember_isClusterWriter :: Lens' DBClusterMember (Maybe Bool) Source #

Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

dbClusterMember_promotionTier :: Lens' DBClusterMember (Maybe Int) Source #

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

DBClusterOptionGroupStatus

dbClusterOptionGroupStatus_dbClusterOptionGroupName :: Lens' DBClusterOptionGroupStatus (Maybe Text) Source #

Specifies the name of the DB cluster option group.

dbClusterOptionGroupStatus_status :: Lens' DBClusterOptionGroupStatus (Maybe Text) Source #

Specifies the status of the DB cluster option group.

DBClusterParameterGroup

dbClusterParameterGroup_dbClusterParameterGroupArn :: Lens' DBClusterParameterGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) for the DB cluster parameter group.

dbClusterParameterGroup_dbClusterParameterGroupName :: Lens' DBClusterParameterGroup (Maybe Text) Source #

The name of the DB cluster parameter group.

dbClusterParameterGroup_dbParameterGroupFamily :: Lens' DBClusterParameterGroup (Maybe Text) Source #

The name of the DB parameter group family that this DB cluster parameter group is compatible with.

dbClusterParameterGroup_description :: Lens' DBClusterParameterGroup (Maybe Text) Source #

Provides the customer-specified description for this DB cluster parameter group.

DBClusterParameterGroupNameMessage

dbClusterParameterGroupNameMessage_dbClusterParameterGroupName :: Lens' DBClusterParameterGroupNameMessage (Maybe Text) Source #

The name of the DB cluster parameter group.

Constraints:

Must be 1 to 255 letters or numbers.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

This value is stored as a lowercase string.

DBClusterRole

dbClusterRole_featureName :: Lens' DBClusterRole (Maybe Text) Source #

The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.

dbClusterRole_roleArn :: Lens' DBClusterRole (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

dbClusterRole_status :: Lens' DBClusterRole (Maybe Text) Source #

Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:

ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.
PENDING - the IAM role ARN is being associated with the DB cluster.
INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.

DBClusterSnapshot

dbClusterSnapshot_allocatedStorage :: Lens' DBClusterSnapshot (Maybe Int) Source #

Specifies the allocated storage size in gibibytes (GiB).

dbClusterSnapshot_availabilityZones :: Lens' DBClusterSnapshot (Maybe [Text]) Source #

Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

dbClusterSnapshot_clusterCreateTime :: Lens' DBClusterSnapshot (Maybe UTCTime) Source #

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

dbClusterSnapshot_dbClusterIdentifier :: Lens' DBClusterSnapshot (Maybe Text) Source #

Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

dbClusterSnapshot_dbClusterSnapshotArn :: Lens' DBClusterSnapshot (Maybe Text) Source #

The Amazon Resource Name (ARN) for the DB cluster snapshot.

dbClusterSnapshot_dbClusterSnapshotIdentifier :: Lens' DBClusterSnapshot (Maybe Text) Source #

Specifies the identifier for the DB cluster snapshot.

dbClusterSnapshot_dbSystemId :: Lens' DBClusterSnapshot (Maybe Text) Source #

Reserved for future use.

dbClusterSnapshot_engine :: Lens' DBClusterSnapshot (Maybe Text) Source #

Specifies the name of the database engine for this DB cluster snapshot.

dbClusterSnapshot_engineMode :: Lens' DBClusterSnapshot (Maybe Text) Source #

Provides the engine mode of the database engine for this DB cluster snapshot.

dbClusterSnapshot_engineVersion :: Lens' DBClusterSnapshot (Maybe Text) Source #

Provides the version of the database engine for this DB cluster snapshot.

dbClusterSnapshot_iAMDatabaseAuthenticationEnabled :: Lens' DBClusterSnapshot (Maybe Bool) Source #

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

dbClusterSnapshot_kmsKeyId :: Lens' DBClusterSnapshot (Maybe Text) Source #

If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

dbClusterSnapshot_licenseModel :: Lens' DBClusterSnapshot (Maybe Text) Source #

Provides the license model information for this DB cluster snapshot.

dbClusterSnapshot_masterUsername :: Lens' DBClusterSnapshot (Maybe Text) Source #

Provides the master username for this DB cluster snapshot.

dbClusterSnapshot_percentProgress :: Lens' DBClusterSnapshot (Maybe Int) Source #

Specifies the percentage of the estimated data that has been transferred.

dbClusterSnapshot_port :: Lens' DBClusterSnapshot (Maybe Int) Source #

Specifies the port that the DB cluster was listening on at the time of the snapshot.

dbClusterSnapshot_snapshotCreateTime :: Lens' DBClusterSnapshot (Maybe UTCTime) Source #

Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

dbClusterSnapshot_snapshotType :: Lens' DBClusterSnapshot (Maybe Text) Source #

Provides the type of the DB cluster snapshot.

dbClusterSnapshot_sourceDBClusterSnapshotArn :: Lens' DBClusterSnapshot (Maybe Text) Source #

If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

dbClusterSnapshot_status :: Lens' DBClusterSnapshot (Maybe Text) Source #

Specifies the status of this DB cluster snapshot. Valid statuses are the following:

```
available
```
```
copying
```
```
creating
```

dbClusterSnapshot_storageEncrypted :: Lens' DBClusterSnapshot (Maybe Bool) Source #

Specifies whether the DB cluster snapshot is encrypted.

dbClusterSnapshot_tagList :: Lens' DBClusterSnapshot (Maybe [Tag]) Source #

Undocumented member.

dbClusterSnapshot_vpcId :: Lens' DBClusterSnapshot (Maybe Text) Source #

Provides the VPC ID associated with the DB cluster snapshot.

DBClusterSnapshotAttribute

dbClusterSnapshotAttribute_attributeName :: Lens' DBClusterSnapshotAttribute (Maybe Text) Source #

The name of the manual DB cluster snapshot attribute.

The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

dbClusterSnapshotAttribute_attributeValues :: Lens' DBClusterSnapshotAttribute (Maybe [Text]) Source #

The value(s) for the manual DB cluster snapshot attribute.

If the AttributeName field is set to restore, then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot is public and available for any Amazon Web Services account to copy or restore.

DBClusterSnapshotAttributesResult

dbClusterSnapshotAttributesResult_dbClusterSnapshotAttributes :: Lens' DBClusterSnapshotAttributesResult (Maybe [DBClusterSnapshotAttribute]) Source #

The list of attributes and values for the manual DB cluster snapshot.

dbClusterSnapshotAttributesResult_dbClusterSnapshotIdentifier :: Lens' DBClusterSnapshotAttributesResult (Maybe Text) Source #

The identifier of the manual DB cluster snapshot that the attributes apply to.

DBEngineVersion

dbEngineVersion_createTime :: Lens' DBEngineVersion (Maybe UTCTime) Source #

The creation time of the DB engine version.

dbEngineVersion_customDBEngineVersionManifest :: Lens' DBEngineVersion (Maybe Text) Source #

JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide.

dbEngineVersion_dbEngineDescription :: Lens' DBEngineVersion (Maybe Text) Source #

The description of the database engine.

dbEngineVersion_dbEngineMediaType :: Lens' DBEngineVersion (Maybe Text) Source #

A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.

dbEngineVersion_dbEngineVersionArn :: Lens' DBEngineVersion (Maybe Text) Source #

The ARN of the custom engine version.

dbEngineVersion_dbEngineVersionDescription :: Lens' DBEngineVersion (Maybe Text) Source #

The description of the database engine version.

dbEngineVersion_dbParameterGroupFamily :: Lens' DBEngineVersion (Maybe Text) Source #

The name of the DB parameter group family for the database engine.

dbEngineVersion_databaseInstallationFilesS3BucketName :: Lens' DBEngineVersion (Maybe Text) Source #

The name of the Amazon S3 bucket that contains your database installation files.

dbEngineVersion_databaseInstallationFilesS3Prefix :: Lens' DBEngineVersion (Maybe Text) Source #

The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.

dbEngineVersion_defaultCharacterSet :: Lens' DBEngineVersion (Maybe CharacterSet) Source #

The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.

dbEngineVersion_engine :: Lens' DBEngineVersion (Maybe Text) Source #

The name of the database engine.

dbEngineVersion_engineVersion :: Lens' DBEngineVersion (Maybe Text) Source #

The version number of the database engine.

dbEngineVersion_exportableLogTypes :: Lens' DBEngineVersion (Maybe [Text]) Source #

The types of logs that the database engine has available for export to CloudWatch Logs.

dbEngineVersion_image :: Lens' DBEngineVersion (Maybe CustomDBEngineVersionAMI) Source #

The EC2 image

dbEngineVersion_kmsKeyId :: Lens' DBEngineVersion (Maybe Text) Source #

The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.

dbEngineVersion_majorEngineVersion :: Lens' DBEngineVersion (Maybe Text) Source #

The major engine version of the CEV.

dbEngineVersion_status :: Lens' DBEngineVersion (Maybe Text) Source #

The status of the DB engine version, either available or deprecated.

dbEngineVersion_supportedCACertificateIdentifiers :: Lens' DBEngineVersion (Maybe [Text]) Source #

A list of the supported CA certificate identifiers.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

dbEngineVersion_supportedCharacterSets :: Lens' DBEngineVersion (Maybe [CharacterSet]) Source #

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.

dbEngineVersion_supportedEngineModes :: Lens' DBEngineVersion (Maybe [Text]) Source #

A list of the supported DB engine modes.

dbEngineVersion_supportedFeatureNames :: Lens' DBEngineVersion (Maybe [Text]) Source #

A list of features supported by the DB engine.

The supported features vary by DB engine and DB engine version.

To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:

aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>

For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:

aws rds describe-db-engine-versions --engine postgres --engine-version 13.3

The supported features are listed under SupportedFeatureNames in the output.

dbEngineVersion_supportedNcharCharacterSets :: Lens' DBEngineVersion (Maybe [CharacterSet]) Source #

A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.

dbEngineVersion_supportedTimezones :: Lens' DBEngineVersion (Maybe [Timezone]) Source #

A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

dbEngineVersion_supportsBabelfish :: Lens' DBEngineVersion (Maybe Bool) Source #

A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.

dbEngineVersion_supportsCertificateRotationWithoutRestart :: Lens' DBEngineVersion (Maybe Bool) Source #

A value that indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.

dbEngineVersion_supportsGlobalDatabases :: Lens' DBEngineVersion (Maybe Bool) Source #

A value that indicates whether you can use Aurora global databases with a specific DB engine version.

dbEngineVersion_supportsLogExportsToCloudwatchLogs :: Lens' DBEngineVersion (Maybe Bool) Source #

A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

dbEngineVersion_supportsParallelQuery :: Lens' DBEngineVersion (Maybe Bool) Source #

A value that indicates whether you can use Aurora parallel query with a specific DB engine version.

dbEngineVersion_supportsReadReplica :: Lens' DBEngineVersion (Maybe Bool) Source #

Indicates whether the database engine version supports read replicas.

dbEngineVersion_tagList :: Lens' DBEngineVersion (Maybe [Tag]) Source #

Undocumented member.

dbEngineVersion_validUpgradeTarget :: Lens' DBEngineVersion (Maybe [UpgradeTarget]) Source #

A list of engine versions that this database engine version can be upgraded to.

DBInstance

dbInstance_activityStreamEngineNativeAuditFieldsIncluded :: Lens' DBInstance (Maybe Bool) Source #

Indicates whether engine-native audit fields are included in the database activity stream.

dbInstance_activityStreamKinesisStreamName :: Lens' DBInstance (Maybe Text) Source #

The name of the Amazon Kinesis data stream used for the database activity stream.

dbInstance_activityStreamKmsKeyId :: Lens' DBInstance (Maybe Text) Source #

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

dbInstance_activityStreamMode :: Lens' DBInstance (Maybe ActivityStreamMode) Source #

The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.

dbInstance_activityStreamPolicyStatus :: Lens' DBInstance (Maybe ActivityStreamPolicyStatus) Source #

The status of the policy state of the activity stream.

dbInstance_activityStreamStatus :: Lens' DBInstance (Maybe ActivityStreamStatus) Source #

The status of the database activity stream.

dbInstance_allocatedStorage :: Lens' DBInstance (Maybe Int) Source #

Specifies the allocated storage size specified in gibibytes (GiB).

dbInstance_associatedRoles :: Lens' DBInstance (Maybe [DBInstanceRole]) Source #

The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.

dbInstance_autoMinorVersionUpgrade :: Lens' DBInstance (Maybe Bool) Source #

A value that indicates that minor version patches are applied automatically.

dbInstance_automaticRestartTime :: Lens' DBInstance (Maybe UTCTime) Source #

The time when a stopped DB instance is restarted automatically.

dbInstance_automationMode :: Lens' DBInstance (Maybe AutomationMode) Source #

The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.

dbInstance_availabilityZone :: Lens' DBInstance (Maybe Text) Source #

Specifies the name of the Availability Zone the DB instance is located in.

dbInstance_awsBackupRecoveryPointArn :: Lens' DBInstance (Maybe Text) Source #

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

dbInstance_backupRetentionPeriod :: Lens' DBInstance (Maybe Int) Source #

Specifies the number of days for which automatic DB snapshots are retained.

dbInstance_backupTarget :: Lens' DBInstance (Maybe Text) Source #

Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

dbInstance_cACertificateIdentifier :: Lens' DBInstance (Maybe Text) Source #

The identifier of the CA certificate for this DB instance.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

dbInstance_certificateDetails :: Lens' DBInstance (Maybe CertificateDetails) Source #

The details of the DB instance's server certificate.

dbInstance_characterSetName :: Lens' DBInstance (Maybe Text) Source #

If present, specifies the name of the character set that this instance is associated with.

dbInstance_copyTagsToSnapshot :: Lens' DBInstance (Maybe Bool) Source #

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.

dbInstance_customIamInstanceProfile :: Lens' DBInstance (Maybe Text) Source #

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

dbInstance_customerOwnedIpEnabled :: Lens' DBInstance (Maybe Bool) Source #

Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

dbInstance_dbClusterIdentifier :: Lens' DBInstance (Maybe Text) Source #

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

dbInstance_dbInstanceArn :: Lens' DBInstance (Maybe Text) Source #

The Amazon Resource Name (ARN) for the DB instance.

dbInstance_dbInstanceAutomatedBackupsReplications :: Lens' DBInstance (Maybe [DBInstanceAutomatedBackupsReplication]) Source #

The list of replicated automated backups associated with the DB instance.

dbInstance_dbInstanceClass :: Lens' DBInstance (Maybe Text) Source #

Contains the name of the compute and memory capacity class of the DB instance.

dbInstance_dbInstanceIdentifier :: Lens' DBInstance (Maybe Text) Source #

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

dbInstance_dbInstanceStatus :: Lens' DBInstance (Maybe Text) Source #

Specifies the current state of this database.

For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.

dbInstance_dbName :: Lens' DBInstance (Maybe Text) Source #

The meaning of this parameter differs according to the database engine you use.

MySQL, MariaDB, SQL Server, PostgreSQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

dbInstance_dbParameterGroups :: Lens' DBInstance (Maybe [DBParameterGroupStatus]) Source #

Provides the list of DB parameter groups applied to this DB instance.

dbInstance_dbSecurityGroups :: Lens' DBInstance (Maybe [DBSecurityGroupMembership]) Source #

A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

dbInstance_dbSubnetGroup :: Lens' DBInstance (Maybe DBSubnetGroup) Source #

Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

dbInstance_dbSystemId :: Lens' DBInstance (Maybe Text) Source #

The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is valid for RDS Custom only.

dbInstance_dbInstancePort :: Lens' DBInstance (Maybe Int) Source #

Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

dbInstance_dbiResourceId :: Lens' DBInstance (Maybe Text) Source #

The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.

dbInstance_deletionProtection :: Lens' DBInstance (Maybe Bool) Source #

Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.

dbInstance_domainMemberships :: Lens' DBInstance (Maybe [DomainMembership]) Source #

The Active Directory Domain membership records associated with the DB instance.

dbInstance_enabledCloudwatchLogsExports :: Lens' DBInstance (Maybe [Text]) Source #

A list of log types that this DB instance is configured to export to CloudWatch Logs.

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.

dbInstance_endpoint :: Lens' DBInstance (Maybe Endpoint) Source #

Specifies the connection endpoint.

The endpoint might not be shown for instances whose status is creating.

dbInstance_engine :: Lens' DBInstance (Maybe Text) Source #

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

dbInstance_engineVersion :: Lens' DBInstance (Maybe Text) Source #

Indicates the database engine version.

dbInstance_enhancedMonitoringResourceArn :: Lens' DBInstance (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

dbInstance_iAMDatabaseAuthenticationEnabled :: Lens' DBInstance (Maybe Bool) Source #

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

IAM database authentication can be enabled for the following database engines

For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

dbInstance_instanceCreateTime :: Lens' DBInstance (Maybe UTCTime) Source #

Provides the date and time the DB instance was created.

dbInstance_iops :: Lens' DBInstance (Maybe Int) Source #

Specifies the Provisioned IOPS (I/O operations per second) value.

dbInstance_kmsKeyId :: Lens' DBInstance (Maybe Text) Source #

If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

dbInstance_latestRestorableTime :: Lens' DBInstance (Maybe UTCTime) Source #

Specifies the latest time to which a database can be restored with point-in-time restore.

dbInstance_licenseModel :: Lens' DBInstance (Maybe Text) Source #

License model information for this DB instance. This setting doesn't apply to RDS Custom.

dbInstance_listenerEndpoint :: Lens' DBInstance (Maybe Endpoint) Source #

Specifies the listener connection endpoint for SQL Server Always On.

dbInstance_masterUserSecret :: Lens' DBInstance (Maybe MasterUserSecret) Source #

Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.

dbInstance_masterUsername :: Lens' DBInstance (Maybe Text) Source #

Contains the master username for the DB instance.

dbInstance_maxAllocatedStorage :: Lens' DBInstance (Maybe Int) Source #

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

dbInstance_monitoringInterval :: Lens' DBInstance (Maybe Int) Source #

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

dbInstance_monitoringRoleArn :: Lens' DBInstance (Maybe Text) Source #

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

dbInstance_multiAZ :: Lens' DBInstance (Maybe Bool) Source #

Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.

dbInstance_ncharCharacterSetName :: Lens' DBInstance (Maybe Text) Source #

The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

dbInstance_networkType :: Lens' DBInstance (Maybe Text) Source #

The network type of the DB instance.

Valid values:

```
IPV4
```
```
DUAL
```

The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.

dbInstance_optionGroupMemberships :: Lens' DBInstance (Maybe [OptionGroupMembership]) Source #

Provides the list of option group memberships for this DB instance.

dbInstance_pendingModifiedValues :: Lens' DBInstance (Maybe PendingModifiedValues) Source #

A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

dbInstance_performanceInsightsEnabled :: Lens' DBInstance (Maybe Bool) Source #

True if Performance Insights is enabled for the DB instance, and otherwise false.

dbInstance_performanceInsightsKMSKeyId :: Lens' DBInstance (Maybe Text) Source #

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

dbInstance_performanceInsightsRetentionPeriod :: Lens' DBInstance (Maybe Int) Source #

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

7
month * 31, where month is a number of months from 1-23
731

For example, the following values are valid:

93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731

dbInstance_preferredBackupWindow :: Lens' DBInstance (Maybe Text) Source #

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

dbInstance_preferredMaintenanceWindow :: Lens' DBInstance (Maybe Text) Source #

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

dbInstance_processorFeatures :: Lens' DBInstance (Maybe [ProcessorFeature]) Source #

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

dbInstance_promotionTier :: Lens' DBInstance (Maybe Int) Source #

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

dbInstance_publiclyAccessible :: Lens' DBInstance (Maybe Bool) Source #

Specifies the accessibility options for the DB instance.

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

dbInstance_readReplicaDBClusterIdentifiers :: Lens' DBInstance (Maybe [Text]) Source #

Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.

Currently, each RDS DB instance can have only one Aurora read replica.

dbInstance_readReplicaDBInstanceIdentifiers :: Lens' DBInstance (Maybe [Text]) Source #

Contains one or more identifiers of the read replicas associated with this DB instance.

dbInstance_readReplicaSourceDBInstanceIdentifier :: Lens' DBInstance (Maybe Text) Source #

Contains the identifier of the source DB instance if this DB instance is a read replica.

dbInstance_replicaMode :: Lens' DBInstance (Maybe ReplicaMode) Source #

The open mode of an Oracle read replica. The default is open-read-only. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

This attribute is only supported in RDS for Oracle.

dbInstance_resumeFullAutomationModeTime :: Lens' DBInstance (Maybe UTCTime) Source #

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

dbInstance_secondaryAvailabilityZone :: Lens' DBInstance (Maybe Text) Source #

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

dbInstance_statusInfos :: Lens' DBInstance (Maybe [DBInstanceStatusInfo]) Source #

The status of a read replica. If the instance isn't a read replica, this is blank.

dbInstance_storageEncrypted :: Lens' DBInstance (Maybe Bool) Source #

Specifies whether the DB instance is encrypted.

dbInstance_storageThroughput :: Lens' DBInstance (Maybe Int) Source #

Specifies the storage throughput for the DB instance.

This setting applies only to the gp3 storage type.

dbInstance_storageType :: Lens' DBInstance (Maybe Text) Source #

Specifies the storage type associated with the DB instance.

dbInstance_tagList :: Lens' DBInstance (Maybe [Tag]) Source #

Undocumented member.

dbInstance_tdeCredentialArn :: Lens' DBInstance (Maybe Text) Source #

The ARN from the key store with which the instance is associated for TDE encryption.

dbInstance_timezone :: Lens' DBInstance (Maybe Text) Source #

The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

dbInstance_vpcSecurityGroups :: Lens' DBInstance (Maybe [VpcSecurityGroupMembership]) Source #

Provides a list of VPC security group elements that the DB instance belongs to.

DBInstanceAutomatedBackup

dbInstanceAutomatedBackup_allocatedStorage :: Lens' DBInstanceAutomatedBackup (Maybe Int) Source #

Specifies the allocated storage size in gibibytes (GiB).

dbInstanceAutomatedBackup_availabilityZone :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.

dbInstanceAutomatedBackup_backupRetentionPeriod :: Lens' DBInstanceAutomatedBackup (Maybe Int) Source #

The retention period for the automated backups.

dbInstanceAutomatedBackup_backupTarget :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

Specifies where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

dbInstanceAutomatedBackup_dbInstanceArn :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The Amazon Resource Name (ARN) for the automated backups.

dbInstanceAutomatedBackup_dbInstanceAutomatedBackupsArn :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The Amazon Resource Name (ARN) for the replicated automated backups.

dbInstanceAutomatedBackup_dbInstanceAutomatedBackupsReplications :: Lens' DBInstanceAutomatedBackup (Maybe [DBInstanceAutomatedBackupsReplication]) Source #

The list of replications to different Amazon Web Services Regions associated with the automated backup.

dbInstanceAutomatedBackup_dbInstanceIdentifier :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The customer id of the instance that is/was associated with the automated backup.

dbInstanceAutomatedBackup_dbiResourceId :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

dbInstanceAutomatedBackup_encrypted :: Lens' DBInstanceAutomatedBackup (Maybe Bool) Source #

Specifies whether the automated backup is encrypted.

dbInstanceAutomatedBackup_engine :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The name of the database engine for this automated backup.

dbInstanceAutomatedBackup_engineVersion :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The version of the database engine for the automated backup.

dbInstanceAutomatedBackup_iAMDatabaseAuthenticationEnabled :: Lens' DBInstanceAutomatedBackup (Maybe Bool) Source #

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

dbInstanceAutomatedBackup_instanceCreateTime :: Lens' DBInstanceAutomatedBackup (Maybe UTCTime) Source #

Provides the date and time that the DB instance was created.

dbInstanceAutomatedBackup_iops :: Lens' DBInstanceAutomatedBackup (Maybe Int) Source #

The IOPS (I/O operations per second) value for the automated backup.

dbInstanceAutomatedBackup_kmsKeyId :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The Amazon Web Services KMS key ID for an automated backup.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

dbInstanceAutomatedBackup_licenseModel :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

License model information for the automated backup.

dbInstanceAutomatedBackup_masterUsername :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The license model of an automated backup.

dbInstanceAutomatedBackup_optionGroupName :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.

dbInstanceAutomatedBackup_port :: Lens' DBInstanceAutomatedBackup (Maybe Int) Source #

The port number that the automated backup used for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

dbInstanceAutomatedBackup_region :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The Amazon Web Services Region associated with the automated backup.

dbInstanceAutomatedBackup_restoreWindow :: Lens' DBInstanceAutomatedBackup (Maybe RestoreWindow) Source #

Earliest and latest time an instance can be restored to.

dbInstanceAutomatedBackup_status :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

Provides a list of status information for an automated backup:

active - automated backups for current instances
retained - automated backups for deleted instances
creating - automated backups that are waiting for the first automated snapshot to be available.

dbInstanceAutomatedBackup_storageThroughput :: Lens' DBInstanceAutomatedBackup (Maybe Int) Source #

Specifies the storage throughput for the automated backup.

dbInstanceAutomatedBackup_storageType :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

Specifies the storage type associated with the automated backup.

dbInstanceAutomatedBackup_tdeCredentialArn :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The ARN from the key store with which the automated backup is associated for TDE encryption.

dbInstanceAutomatedBackup_timezone :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

dbInstanceAutomatedBackup_vpcId :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

Provides the VPC ID associated with the DB instance.

DBInstanceAutomatedBackupsReplication

dbInstanceAutomatedBackupsReplication_dbInstanceAutomatedBackupsArn :: Lens' DBInstanceAutomatedBackupsReplication (Maybe Text) Source #

The Amazon Resource Name (ARN) of the replicated automated backups.

DBInstanceRole

dbInstanceRole_featureName :: Lens' DBInstanceRole (Maybe Text) Source #

The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.

dbInstanceRole_roleArn :: Lens' DBInstanceRole (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.

dbInstanceRole_status :: Lens' DBInstanceRole (Maybe Text) Source #

Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:

ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
PENDING - the IAM role ARN is being associated with the DB instance.
INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.

DBInstanceStatusInfo

dbInstanceStatusInfo_message :: Lens' DBInstanceStatusInfo (Maybe Text) Source #

Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.

dbInstanceStatusInfo_normal :: Lens' DBInstanceStatusInfo (Maybe Bool) Source #

Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

dbInstanceStatusInfo_status :: Lens' DBInstanceStatusInfo (Maybe Text) Source #

Status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.

dbInstanceStatusInfo_statusType :: Lens' DBInstanceStatusInfo (Maybe Text) Source #

This value is currently "read replication."

DBParameterGroup

dbParameterGroup_dbParameterGroupArn :: Lens' DBParameterGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) for the DB parameter group.

dbParameterGroup_dbParameterGroupFamily :: Lens' DBParameterGroup (Maybe Text) Source #

The name of the DB parameter group family that this DB parameter group is compatible with.

dbParameterGroup_dbParameterGroupName :: Lens' DBParameterGroup (Maybe Text) Source #

The name of the DB parameter group.

dbParameterGroup_description :: Lens' DBParameterGroup (Maybe Text) Source #

Provides the customer-specified description for this DB parameter group.

DBParameterGroupNameMessage

dbParameterGroupNameMessage_dbParameterGroupName :: Lens' DBParameterGroupNameMessage (Maybe Text) Source #

The name of the DB parameter group.

DBParameterGroupStatus

dbParameterGroupStatus_dbParameterGroupName :: Lens' DBParameterGroupStatus (Maybe Text) Source #

The name of the DB parameter group.

dbParameterGroupStatus_parameterApplyStatus :: Lens' DBParameterGroupStatus (Maybe Text) Source #

The status of parameter updates.

DBProxy

dbProxy_auth :: Lens' DBProxy (Maybe [UserAuthConfigInfo]) Source #

One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.

dbProxy_createdDate :: Lens' DBProxy (Maybe UTCTime) Source #

The date and time when the proxy was first created.

dbProxy_dbProxyArn :: Lens' DBProxy (Maybe Text) Source #

The Amazon Resource Name (ARN) for the proxy.

dbProxy_dbProxyName :: Lens' DBProxy (Maybe Text) Source #

The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.

dbProxy_debugLogging :: Lens' DBProxy (Maybe Bool) Source #

Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.

dbProxy_endpoint :: Lens' DBProxy (Maybe Text) Source #

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

dbProxy_engineFamily :: Lens' DBProxy (Maybe Text) Source #

The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER supports RDS for Microsoft SQL Server databases.

dbProxy_idleClientTimeout :: Lens' DBProxy (Maybe Int) Source #

The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.

Default: 1800 (30 minutes)

Constraints: 1 to 28,800

dbProxy_requireTLS :: Lens' DBProxy (Maybe Bool) Source #

Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

dbProxy_roleArn :: Lens' DBProxy (Maybe Text) Source #

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

dbProxy_status :: Lens' DBProxy (Maybe DBProxyStatus) Source #

The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.

dbProxy_updatedDate :: Lens' DBProxy (Maybe UTCTime) Source #

The date and time when the proxy was last updated.

dbProxy_vpcId :: Lens' DBProxy (Maybe Text) Source #

Provides the VPC ID of the DB proxy.

dbProxy_vpcSecurityGroupIds :: Lens' DBProxy (Maybe [Text]) Source #

Provides a list of VPC security groups that the proxy belongs to.

dbProxy_vpcSubnetIds :: Lens' DBProxy (Maybe [Text]) Source #

The EC2 subnet IDs for the proxy.

DBProxyEndpoint

dbProxyEndpoint_createdDate :: Lens' DBProxyEndpoint (Maybe UTCTime) Source #

The date and time when the DB proxy endpoint was first created.

dbProxyEndpoint_dbProxyEndpointArn :: Lens' DBProxyEndpoint (Maybe Text) Source #

The Amazon Resource Name (ARN) for the DB proxy endpoint.

dbProxyEndpoint_dbProxyEndpointName :: Lens' DBProxyEndpoint (Maybe Text) Source #

The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

dbProxyEndpoint_dbProxyName :: Lens' DBProxyEndpoint (Maybe Text) Source #

The identifier for the DB proxy that is associated with this DB proxy endpoint.

dbProxyEndpoint_endpoint :: Lens' DBProxyEndpoint (Maybe Text) Source #

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

dbProxyEndpoint_isDefault :: Lens' DBProxyEndpoint (Maybe Bool) Source #

A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.

dbProxyEndpoint_status :: Lens' DBProxyEndpoint (Maybe DBProxyEndpointStatus) Source #

The current status of this DB proxy endpoint. A status of available means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.

dbProxyEndpoint_targetRole :: Lens' DBProxyEndpoint (Maybe DBProxyEndpointTargetRole) Source #

A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

dbProxyEndpoint_vpcId :: Lens' DBProxyEndpoint (Maybe Text) Source #

Provides the VPC ID of the DB proxy endpoint.

dbProxyEndpoint_vpcSecurityGroupIds :: Lens' DBProxyEndpoint (Maybe [Text]) Source #

Provides a list of VPC security groups that the DB proxy endpoint belongs to.

dbProxyEndpoint_vpcSubnetIds :: Lens' DBProxyEndpoint (Maybe [Text]) Source #

The EC2 subnet IDs for the DB proxy endpoint.

DBProxyTarget

dbProxyTarget_endpoint :: Lens' DBProxyTarget (Maybe Text) Source #

The writer endpoint for the RDS DB instance or Aurora DB cluster.

dbProxyTarget_port :: Lens' DBProxyTarget (Maybe Int) Source #

The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.

dbProxyTarget_rdsResourceId :: Lens' DBProxyTarget (Maybe Text) Source #

The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.

dbProxyTarget_role :: Lens' DBProxyTarget (Maybe TargetRole) Source #

A value that indicates whether the target of the proxy can be used for read/write or read-only operations.

dbProxyTarget_targetArn :: Lens' DBProxyTarget (Maybe Text) Source #

The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.

dbProxyTarget_targetHealth :: Lens' DBProxyTarget (Maybe TargetHealth) Source #

Information about the connection health of the RDS Proxy target.

dbProxyTarget_trackedClusterId :: Lens' DBProxyTarget (Maybe Text) Source #

The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.

dbProxyTarget_type :: Lens' DBProxyTarget (Maybe TargetType) Source #

Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.

DBProxyTargetGroup

dbProxyTargetGroup_connectionPoolConfig :: Lens' DBProxyTargetGroup (Maybe ConnectionPoolConfigurationInfo) Source #

The settings that determine the size and behavior of the connection pool for the target group.

dbProxyTargetGroup_createdDate :: Lens' DBProxyTargetGroup (Maybe UTCTime) Source #

The date and time when the target group was first created.

dbProxyTargetGroup_dbProxyName :: Lens' DBProxyTargetGroup (Maybe Text) Source #

The identifier for the RDS proxy associated with this target group.

dbProxyTargetGroup_isDefault :: Lens' DBProxyTargetGroup (Maybe Bool) Source #

Whether this target group is the first one used for connection requests by the associated proxy. Because each proxy is currently associated with a single target group, currently this setting is always true.

dbProxyTargetGroup_status :: Lens' DBProxyTargetGroup (Maybe Text) Source #

The current status of this target group. A status of available means the target group is correctly associated with a database. Other values indicate that you must wait for the target group to be ready, or take some action to resolve an issue.

dbProxyTargetGroup_targetGroupArn :: Lens' DBProxyTargetGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) representing the target group.

dbProxyTargetGroup_targetGroupName :: Lens' DBProxyTargetGroup (Maybe Text) Source #

The identifier for the target group. This name must be unique for all target groups owned by your Amazon Web Services account in the specified Amazon Web Services Region.

dbProxyTargetGroup_updatedDate :: Lens' DBProxyTargetGroup (Maybe UTCTime) Source #

The date and time when the target group was last updated.

DBSecurityGroup

dbSecurityGroup_dbSecurityGroupArn :: Lens' DBSecurityGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) for the DB security group.

dbSecurityGroup_dbSecurityGroupDescription :: Lens' DBSecurityGroup (Maybe Text) Source #

Provides the description of the DB security group.

dbSecurityGroup_dbSecurityGroupName :: Lens' DBSecurityGroup (Maybe Text) Source #

Specifies the name of the DB security group.

dbSecurityGroup_eC2SecurityGroups :: Lens' DBSecurityGroup (Maybe [EC2SecurityGroup]) Source #

Contains a list of EC2SecurityGroup elements.

dbSecurityGroup_iPRanges :: Lens' DBSecurityGroup (Maybe [IPRange]) Source #

Contains a list of IPRange elements.

dbSecurityGroup_ownerId :: Lens' DBSecurityGroup (Maybe Text) Source #

Provides the Amazon Web Services ID of the owner of a specific DB security group.

dbSecurityGroup_vpcId :: Lens' DBSecurityGroup (Maybe Text) Source #

Provides the VpcId of the DB security group.

DBSecurityGroupMembership

dbSecurityGroupMembership_dbSecurityGroupName :: Lens' DBSecurityGroupMembership (Maybe Text) Source #

The name of the DB security group.

dbSecurityGroupMembership_status :: Lens' DBSecurityGroupMembership (Maybe Text) Source #

The status of the DB security group.

DBSnapshot

dbSnapshot_allocatedStorage :: Lens' DBSnapshot (Maybe Int) Source #

Specifies the allocated storage size in gibibytes (GiB).

dbSnapshot_availabilityZone :: Lens' DBSnapshot (Maybe Text) Source #

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

dbSnapshot_dbInstanceIdentifier :: Lens' DBSnapshot (Maybe Text) Source #

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

dbSnapshot_dbSnapshotArn :: Lens' DBSnapshot (Maybe Text) Source #

The Amazon Resource Name (ARN) for the DB snapshot.

dbSnapshot_dbSnapshotIdentifier :: Lens' DBSnapshot (Maybe Text) Source #

Specifies the identifier for the DB snapshot.

dbSnapshot_dbiResourceId :: Lens' DBSnapshot (Maybe Text) Source #

The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

dbSnapshot_encrypted :: Lens' DBSnapshot (Maybe Bool) Source #

Specifies whether the DB snapshot is encrypted.

dbSnapshot_engine :: Lens' DBSnapshot (Maybe Text) Source #

Specifies the name of the database engine.

dbSnapshot_engineVersion :: Lens' DBSnapshot (Maybe Text) Source #

Specifies the version of the database engine.

dbSnapshot_iAMDatabaseAuthenticationEnabled :: Lens' DBSnapshot (Maybe Bool) Source #

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

dbSnapshot_instanceCreateTime :: Lens' DBSnapshot (Maybe UTCTime) Source #

Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

dbSnapshot_iops :: Lens' DBSnapshot (Maybe Int) Source #

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

dbSnapshot_kmsKeyId :: Lens' DBSnapshot (Maybe Text) Source #

If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

dbSnapshot_licenseModel :: Lens' DBSnapshot (Maybe Text) Source #

License model information for the restored DB instance.

dbSnapshot_masterUsername :: Lens' DBSnapshot (Maybe Text) Source #

Provides the master username for the DB snapshot.

dbSnapshot_optionGroupName :: Lens' DBSnapshot (Maybe Text) Source #

Provides the option group name for the DB snapshot.

dbSnapshot_originalSnapshotCreateTime :: Lens' DBSnapshot (Maybe UTCTime) Source #

Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.

dbSnapshot_percentProgress :: Lens' DBSnapshot (Maybe Int) Source #

The percentage of the estimated data that has been transferred.

dbSnapshot_port :: Lens' DBSnapshot (Maybe Int) Source #

Specifies the port that the database engine was listening on at the time of the snapshot.

dbSnapshot_processorFeatures :: Lens' DBSnapshot (Maybe [ProcessorFeature]) Source #

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

dbSnapshot_snapshotCreateTime :: Lens' DBSnapshot (Maybe UTCTime) Source #

Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.

dbSnapshot_snapshotDatabaseTime :: Lens' DBSnapshot (Maybe UTCTime) Source #

The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.

dbSnapshot_snapshotTarget :: Lens' DBSnapshot (Maybe Text) Source #

Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

dbSnapshot_snapshotType :: Lens' DBSnapshot (Maybe Text) Source #

Provides the type of the DB snapshot.

dbSnapshot_sourceDBSnapshotIdentifier :: Lens' DBSnapshot (Maybe Text) Source #

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.

dbSnapshot_sourceRegion :: Lens' DBSnapshot (Maybe Text) Source #

The Amazon Web Services Region that the DB snapshot was created in or copied from.

dbSnapshot_status :: Lens' DBSnapshot (Maybe Text) Source #

Specifies the status of this DB snapshot.

dbSnapshot_storageThroughput :: Lens' DBSnapshot (Maybe Int) Source #

Specifies the storage throughput for the DB snapshot.

dbSnapshot_storageType :: Lens' DBSnapshot (Maybe Text) Source #

Specifies the storage type associated with DB snapshot.

dbSnapshot_tagList :: Lens' DBSnapshot (Maybe [Tag]) Source #

Undocumented member.

dbSnapshot_tdeCredentialArn :: Lens' DBSnapshot (Maybe Text) Source #

The ARN from the key store with which to associate the instance for TDE encryption.

dbSnapshot_timezone :: Lens' DBSnapshot (Maybe Text) Source #

The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.

dbSnapshot_vpcId :: Lens' DBSnapshot (Maybe Text) Source #

Provides the VPC ID associated with the DB snapshot.

DBSnapshotAttribute

dbSnapshotAttribute_attributeName :: Lens' DBSnapshotAttribute (Maybe Text) Source #

The name of the manual DB snapshot attribute.

The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBSnapshotAttribute API action.

dbSnapshotAttribute_attributeValues :: Lens' DBSnapshotAttribute (Maybe [Text]) Source #

The value or values for the manual DB snapshot attribute.

If the AttributeName field is set to restore, then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If a value of all is in the list, then the manual DB snapshot is public and available for any Amazon Web Services account to copy or restore.

DBSnapshotAttributesResult

dbSnapshotAttributesResult_dbSnapshotAttributes :: Lens' DBSnapshotAttributesResult (Maybe [DBSnapshotAttribute]) Source #

The list of attributes and values for the manual DB snapshot.

dbSnapshotAttributesResult_dbSnapshotIdentifier :: Lens' DBSnapshotAttributesResult (Maybe Text) Source #

The identifier of the manual DB snapshot that the attributes apply to.

DBSubnetGroup

dbSubnetGroup_dbSubnetGroupArn :: Lens' DBSubnetGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) for the DB subnet group.

dbSubnetGroup_dbSubnetGroupDescription :: Lens' DBSubnetGroup (Maybe Text) Source #

Provides the description of the DB subnet group.

dbSubnetGroup_dbSubnetGroupName :: Lens' DBSubnetGroup (Maybe Text) Source #

The name of the DB subnet group.

dbSubnetGroup_subnetGroupStatus :: Lens' DBSubnetGroup (Maybe Text) Source #

Provides the status of the DB subnet group.

dbSubnetGroup_subnets :: Lens' DBSubnetGroup (Maybe [Subnet]) Source #

Contains a list of Subnet elements.

dbSubnetGroup_supportedNetworkTypes :: Lens' DBSubnetGroup (Maybe [Text]) Source #

The network type of the DB subnet group.

Valid values:

```
IPV4
```
```
DUAL
```

A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

dbSubnetGroup_vpcId :: Lens' DBSubnetGroup (Maybe Text) Source #

Provides the VpcId of the DB subnet group.

DescribeDBLogFilesDetails

describeDBLogFilesDetails_lastWritten :: Lens' DescribeDBLogFilesDetails (Maybe Integer) Source #

A POSIX timestamp when the last log entry was written.

describeDBLogFilesDetails_logFileName :: Lens' DescribeDBLogFilesDetails (Maybe Text) Source #

The name of the log file for the specified DB instance.

describeDBLogFilesDetails_size :: Lens' DescribeDBLogFilesDetails (Maybe Integer) Source #

The size, in bytes, of the log file for the specified DB instance.

DomainMembership

domainMembership_domain :: Lens' DomainMembership (Maybe Text) Source #

The identifier of the Active Directory Domain.

domainMembership_fqdn :: Lens' DomainMembership (Maybe Text) Source #

The fully qualified domain name of the Active Directory Domain.

domainMembership_iAMRoleName :: Lens' DomainMembership (Maybe Text) Source #

The name of the IAM role to be used when making API calls to the Directory Service.

domainMembership_status :: Lens' DomainMembership (Maybe Text) Source #

The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.

DoubleRange

doubleRange_from :: Lens' DoubleRange (Maybe Double) Source #

The minimum value in the range.

doubleRange_to :: Lens' DoubleRange (Maybe Double) Source #

The maximum value in the range.

EC2SecurityGroup

eC2SecurityGroup_eC2SecurityGroupId :: Lens' EC2SecurityGroup (Maybe Text) Source #

Specifies the id of the EC2 security group.

eC2SecurityGroup_eC2SecurityGroupName :: Lens' EC2SecurityGroup (Maybe Text) Source #

Specifies the name of the EC2 security group.

eC2SecurityGroup_eC2SecurityGroupOwnerId :: Lens' EC2SecurityGroup (Maybe Text) Source #

Specifies the Amazon Web Services ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

eC2SecurityGroup_status :: Lens' EC2SecurityGroup (Maybe Text) Source #

Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".

Endpoint

endpoint_address :: Lens' Endpoint (Maybe Text) Source #

Specifies the DNS address of the DB instance.

endpoint_hostedZoneId :: Lens' Endpoint (Maybe Text) Source #

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

endpoint_port :: Lens' Endpoint (Maybe Int) Source #

Specifies the port that the database engine is listening on.

EngineDefaults

engineDefaults_dbParameterGroupFamily :: Lens' EngineDefaults (Maybe Text) Source #

Specifies the name of the DB parameter group family that the engine default parameters apply to.

engineDefaults_marker :: Lens' EngineDefaults (Maybe Text) Source #

An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

engineDefaults_parameters :: Lens' EngineDefaults (Maybe [Parameter]) Source #

Contains a list of engine default parameters.

Event

event_date :: Lens' Event (Maybe UTCTime) Source #

Specifies the date and time of the event.

event_eventCategories :: Lens' Event (Maybe [Text]) Source #

Specifies the category for the event.

event_message :: Lens' Event (Maybe Text) Source #

Provides the text of this event.

event_sourceArn :: Lens' Event (Maybe Text) Source #

The Amazon Resource Name (ARN) for the event.

event_sourceIdentifier :: Lens' Event (Maybe Text) Source #

Provides the identifier for the source of the event.

event_sourceType :: Lens' Event (Maybe SourceType) Source #

Specifies the source type for this event.

EventCategoriesMap

eventCategoriesMap_eventCategories :: Lens' EventCategoriesMap (Maybe [Text]) Source #

The event categories for the specified source type

eventCategoriesMap_sourceType :: Lens' EventCategoriesMap (Maybe Text) Source #

The source type that the returned categories belong to

EventSubscription

eventSubscription_custSubscriptionId :: Lens' EventSubscription (Maybe Text) Source #

The RDS event notification subscription Id.

eventSubscription_customerAwsId :: Lens' EventSubscription (Maybe Text) Source #

The Amazon Web Services customer account associated with the RDS event notification subscription.

eventSubscription_enabled :: Lens' EventSubscription (Maybe Bool) Source #

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

eventSubscription_eventCategoriesList :: Lens' EventSubscription (Maybe [Text]) Source #

A list of event categories for the RDS event notification subscription.

eventSubscription_eventSubscriptionArn :: Lens' EventSubscription (Maybe Text) Source #

The Amazon Resource Name (ARN) for the event subscription.

eventSubscription_snsTopicArn :: Lens' EventSubscription (Maybe Text) Source #

The topic ARN of the RDS event notification subscription.

eventSubscription_sourceIdsList :: Lens' EventSubscription (Maybe [Text]) Source #

A list of source IDs for the RDS event notification subscription.

eventSubscription_sourceType :: Lens' EventSubscription (Maybe Text) Source #

The source type for the RDS event notification subscription.

eventSubscription_status :: Lens' EventSubscription (Maybe Text) Source #

The status of the RDS event notification subscription.

Constraints:

The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

eventSubscription_subscriptionCreationTime :: Lens' EventSubscription (Maybe Text) Source #

The time the RDS event notification subscription was created.

ExportTask

exportTask_exportOnly :: Lens' ExportTask (Maybe [Text]) Source #

The data exported from the snapshot. Valid values are the following:

database - Export all the data from a specified database.
database.table table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
database.schema schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

exportTask_exportTaskIdentifier :: Lens' ExportTask (Maybe Text) Source #

A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is exported to.

exportTask_failureCause :: Lens' ExportTask (Maybe Text) Source #

The reason the export failed, if it failed.

exportTask_iamRoleArn :: Lens' ExportTask (Maybe Text) Source #

The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.

exportTask_kmsKeyId :: Lens' ExportTask (Maybe Text) Source #

The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key.

exportTask_percentProgress :: Lens' ExportTask (Maybe Int) Source #

The progress of the snapshot export task as a percentage.

exportTask_s3Bucket :: Lens' ExportTask (Maybe Text) Source #

The Amazon S3 bucket that the snapshot is exported to.

exportTask_s3Prefix :: Lens' ExportTask (Maybe Text) Source #

The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.

exportTask_snapshotTime :: Lens' ExportTask (Maybe UTCTime) Source #

The time that the snapshot was created.

exportTask_sourceArn :: Lens' ExportTask (Maybe Text) Source #

The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

exportTask_sourceType :: Lens' ExportTask (Maybe ExportSourceType) Source #

The type of source for the export.

exportTask_status :: Lens' ExportTask (Maybe Text) Source #

The progress status of the export task.

exportTask_taskEndTime :: Lens' ExportTask (Maybe UTCTime) Source #

The time that the snapshot export task completed.

exportTask_taskStartTime :: Lens' ExportTask (Maybe UTCTime) Source #

The time that the snapshot export task started.

exportTask_totalExtractedDataInGB :: Lens' ExportTask (Maybe Int) Source #

The total amount of data exported, in gigabytes.

exportTask_warningMessage :: Lens' ExportTask (Maybe Text) Source #

A warning about the snapshot export task.

FailoverState

failoverState_fromDbClusterArn :: Lens' FailoverState (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.

failoverState_status :: Lens' FailoverState (Maybe FailoverStatus) Source #

The current status of the Aurora global database (GlobalCluster). Possible values are as follows:

pending – A request to fail over the Aurora global database (GlobalCluster) has been received by the service. The GlobalCluster's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.
failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.
cancelling – The request to fail over the Aurora global database (GlobalCluster) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.

failoverState_toDbClusterArn :: Lens' FailoverState (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.

Filter

filter_name :: Lens' Filter Text Source #

The name of the filter. Filter names are case-sensitive.

filter_values :: Lens' Filter [Text] Source #

One or more filter values. Filter values are case-sensitive.

GlobalCluster

globalCluster_databaseName :: Lens' GlobalCluster (Maybe Text) Source #

The default database name within the new global database cluster.

globalCluster_deletionProtection :: Lens' GlobalCluster (Maybe Bool) Source #

The deletion protection setting for the new global database cluster.

globalCluster_engine :: Lens' GlobalCluster (Maybe Text) Source #

The Aurora database engine used by the global database cluster.

globalCluster_engineVersion :: Lens' GlobalCluster (Maybe Text) Source #

Indicates the database engine version.

globalCluster_failoverState :: Lens' GlobalCluster (Maybe FailoverState) Source #

A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database (GlobalCluster).

globalCluster_globalClusterArn :: Lens' GlobalCluster (Maybe Text) Source #

The Amazon Resource Name (ARN) for the global database cluster.

globalCluster_globalClusterIdentifier :: Lens' GlobalCluster (Maybe Text) Source #

Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.

globalCluster_globalClusterMembers :: Lens' GlobalCluster (Maybe [GlobalClusterMember]) Source #

The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.

globalCluster_globalClusterResourceId :: Lens' GlobalCluster (Maybe Text) Source #

The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.

globalCluster_status :: Lens' GlobalCluster (Maybe Text) Source #

Specifies the current state of this global database cluster.

globalCluster_storageEncrypted :: Lens' GlobalCluster (Maybe Bool) Source #

The storage encryption setting for the global database cluster.

GlobalClusterMember

globalClusterMember_dbClusterArn :: Lens' GlobalClusterMember (Maybe Text) Source #

The Amazon Resource Name (ARN) for each Aurora cluster.

globalClusterMember_globalWriteForwardingStatus :: Lens' GlobalClusterMember (Maybe WriteForwardingStatus) Source #

Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

globalClusterMember_isWriter :: Lens' GlobalClusterMember (Maybe Bool) Source #

Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.

globalClusterMember_readers :: Lens' GlobalClusterMember (Maybe [Text]) Source #

The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.

IPRange

iPRange_cidrip :: Lens' IPRange (Maybe Text) Source #

Specifies the IP range.

iPRange_status :: Lens' IPRange (Maybe Text) Source #

Specifies the status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".

MasterUserSecret

masterUserSecret_kmsKeyId :: Lens' MasterUserSecret (Maybe Text) Source #

The Amazon Web Services KMS key identifier that is used to encrypt the secret.

masterUserSecret_secretArn :: Lens' MasterUserSecret (Maybe Text) Source #

The Amazon Resource Name (ARN) of the secret.

masterUserSecret_secretStatus :: Lens' MasterUserSecret (Maybe Text) Source #

The status of the secret.

The possible status values include the following:

creating - The secret is being created.
active - The secret is available for normal use and rotation.
rotating - The secret is being rotated.
impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret.
When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.

MinimumEngineVersionPerAllowedValue

minimumEngineVersionPerAllowedValue_allowedValue :: Lens' MinimumEngineVersionPerAllowedValue (Maybe Text) Source #

The allowed value for an option setting.

minimumEngineVersionPerAllowedValue_minimumEngineVersion :: Lens' MinimumEngineVersionPerAllowedValue (Maybe Text) Source #

The minimum DB engine version required for the allowed value.

Option

option_dbSecurityGroupMemberships :: Lens' Option (Maybe [DBSecurityGroupMembership]) Source #

If the option requires access to a port, then this DB security group allows access to the port.

option_optionDescription :: Lens' Option (Maybe Text) Source #

The description of the option.

option_optionName :: Lens' Option (Maybe Text) Source #

The name of the option.

option_optionSettings :: Lens' Option (Maybe [OptionSetting]) Source #

The option settings for this option.

option_optionVersion :: Lens' Option (Maybe Text) Source #

The version of the option.

option_permanent :: Lens' Option (Maybe Bool) Source #

Indicate if this option is permanent.

option_persistent :: Lens' Option (Maybe Bool) Source #

Indicate if this option is persistent.

option_port :: Lens' Option (Maybe Int) Source #

If required, the port configured for this option to use.

option_vpcSecurityGroupMemberships :: Lens' Option (Maybe [VpcSecurityGroupMembership]) Source #

If the option requires access to a port, then this VPC security group allows access to the port.

OptionConfiguration

optionConfiguration_dbSecurityGroupMemberships :: Lens' OptionConfiguration (Maybe [Text]) Source #

A list of DBSecurityGroupMembership name strings used for this option.

optionConfiguration_optionSettings :: Lens' OptionConfiguration (Maybe [OptionSetting]) Source #

The option settings to include in an option group.

optionConfiguration_optionVersion :: Lens' OptionConfiguration (Maybe Text) Source #

The version for the option.

optionConfiguration_port :: Lens' OptionConfiguration (Maybe Int) Source #

The optional port for the option.

optionConfiguration_vpcSecurityGroupMemberships :: Lens' OptionConfiguration (Maybe [Text]) Source #

A list of VpcSecurityGroupMembership name strings used for this option.

optionConfiguration_optionName :: Lens' OptionConfiguration Text Source #

The configuration of options to include in a group.

OptionGroup

optionGroup_allowsVpcAndNonVpcInstanceMemberships :: Lens' OptionGroup (Maybe Bool) Source #

Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.

optionGroup_copyTimestamp :: Lens' OptionGroup (Maybe UTCTime) Source #

Indicates when the option group was copied.

optionGroup_engineName :: Lens' OptionGroup (Maybe Text) Source #

Indicates the name of the engine that this option group can be applied to.

optionGroup_majorEngineVersion :: Lens' OptionGroup (Maybe Text) Source #

Indicates the major engine version associated with this option group.

optionGroup_optionGroupArn :: Lens' OptionGroup (Maybe Text) Source #

Specifies the Amazon Resource Name (ARN) for the option group.

optionGroup_optionGroupDescription :: Lens' OptionGroup (Maybe Text) Source #

Provides a description of the option group.

optionGroup_optionGroupName :: Lens' OptionGroup (Maybe Text) Source #

Specifies the name of the option group.

optionGroup_options :: Lens' OptionGroup (Maybe [Option]) Source #

Indicates what options are available in the option group.

optionGroup_sourceAccountId :: Lens' OptionGroup (Maybe Text) Source #

Specifies the Amazon Web Services account ID for the option group from which this option group is copied.

optionGroup_sourceOptionGroup :: Lens' OptionGroup (Maybe Text) Source #

Specifies the name of the option group from which this option group is copied.

optionGroup_vpcId :: Lens' OptionGroup (Maybe Text) Source #

If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.

OptionGroupMembership

optionGroupMembership_optionGroupName :: Lens' OptionGroupMembership (Maybe Text) Source #

The name of the option group that the instance belongs to.

optionGroupMembership_status :: Lens' OptionGroupMembership (Maybe Text) Source #

The status of the DB instance's option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.

OptionGroupOption

optionGroupOption_copyableCrossAccount :: Lens' OptionGroupOption (Maybe Bool) Source #

Specifies whether the option can be copied across Amazon Web Services accounts.

optionGroupOption_defaultPort :: Lens' OptionGroupOption (Maybe Int) Source #

If the option requires a port, specifies the default port for the option.

optionGroupOption_description :: Lens' OptionGroupOption (Maybe Text) Source #

The description of the option.

optionGroupOption_engineName :: Lens' OptionGroupOption (Maybe Text) Source #

The name of the engine that this option can be applied to.

optionGroupOption_majorEngineVersion :: Lens' OptionGroupOption (Maybe Text) Source #

Indicates the major engine version that the option is available for.

optionGroupOption_minimumRequiredMinorEngineVersion :: Lens' OptionGroupOption (Maybe Text) Source #

The minimum required engine version for the option to be applied.

optionGroupOption_name :: Lens' OptionGroupOption (Maybe Text) Source #

The name of the option.

optionGroupOption_optionGroupOptionSettings :: Lens' OptionGroupOption (Maybe [OptionGroupOptionSetting]) Source #

The option settings that are available (and the default value) for each option in an option group.

optionGroupOption_optionGroupOptionVersions :: Lens' OptionGroupOption (Maybe [OptionVersion]) Source #

The versions that are available for the option.

optionGroupOption_optionsConflictsWith :: Lens' OptionGroupOption (Maybe [Text]) Source #

The options that conflict with this option.

optionGroupOption_optionsDependedOn :: Lens' OptionGroupOption (Maybe [Text]) Source #

The options that are prerequisites for this option.

optionGroupOption_permanent :: Lens' OptionGroupOption (Maybe Bool) Source #

Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.

optionGroupOption_persistent :: Lens' OptionGroupOption (Maybe Bool) Source #

Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.

optionGroupOption_portRequired :: Lens' OptionGroupOption (Maybe Bool) Source #

Specifies whether the option requires a port.

optionGroupOption_requiresAutoMinorEngineVersionUpgrade :: Lens' OptionGroupOption (Maybe Bool) Source #

If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.

optionGroupOption_supportsOptionVersionDowngrade :: Lens' OptionGroupOption (Maybe Bool) Source #

If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.

optionGroupOption_vpcOnly :: Lens' OptionGroupOption (Maybe Bool) Source #

If true, you can only use this option with a DB instance that is in a VPC.

OptionGroupOptionSetting

optionGroupOptionSetting_allowedValues :: Lens' OptionGroupOptionSetting (Maybe Text) Source #

Indicates the acceptable values for the option group option.

optionGroupOptionSetting_applyType :: Lens' OptionGroupOptionSetting (Maybe Text) Source #

The DB engine specific parameter type for the option group option.

optionGroupOptionSetting_defaultValue :: Lens' OptionGroupOptionSetting (Maybe Text) Source #

The default value for the option group option.

optionGroupOptionSetting_isModifiable :: Lens' OptionGroupOptionSetting (Maybe Bool) Source #

Boolean value where true indicates that this option group option can be changed from the default value.

optionGroupOptionSetting_isRequired :: Lens' OptionGroupOptionSetting (Maybe Bool) Source #

Boolean value where true indicates that a value must be specified for this option setting of the option group option.

optionGroupOptionSetting_minimumEngineVersionPerAllowedValue :: Lens' OptionGroupOptionSetting (Maybe [MinimumEngineVersionPerAllowedValue]) Source #

The minimum DB engine version required for the corresponding allowed value for this option setting.

optionGroupOptionSetting_settingDescription :: Lens' OptionGroupOptionSetting (Maybe Text) Source #

The description of the option group option.

optionGroupOptionSetting_settingName :: Lens' OptionGroupOptionSetting (Maybe Text) Source #

The name of the option group option.

OptionSetting

optionSetting_allowedValues :: Lens' OptionSetting (Maybe Text) Source #

The allowed values of the option setting.

optionSetting_applyType :: Lens' OptionSetting (Maybe Text) Source #

The DB engine specific parameter type.

optionSetting_dataType :: Lens' OptionSetting (Maybe Text) Source #

The data type of the option setting.

optionSetting_defaultValue :: Lens' OptionSetting (Maybe Text) Source #

The default value of the option setting.

optionSetting_description :: Lens' OptionSetting (Maybe Text) Source #

The description of the option setting.

optionSetting_isCollection :: Lens' OptionSetting (Maybe Bool) Source #

Indicates if the option setting is part of a collection.

optionSetting_isModifiable :: Lens' OptionSetting (Maybe Bool) Source #

A Boolean value that, when true, indicates the option setting can be modified from the default.

optionSetting_name :: Lens' OptionSetting (Maybe Text) Source #

The name of the option that has settings that you can set.

optionSetting_value :: Lens' OptionSetting (Maybe Text) Source #

The current value of the option setting.

OptionVersion

optionVersion_isDefault :: Lens' OptionVersion (Maybe Bool) Source #

True if the version is the default version of the option, and otherwise false.

optionVersion_version :: Lens' OptionVersion (Maybe Text) Source #

The version of the option.

OrderableDBInstanceOption

orderableDBInstanceOption_availabilityZoneGroup :: Lens' OrderableDBInstanceOption (Maybe Text) Source #

The Availability Zone group for a DB instance.

orderableDBInstanceOption_availabilityZones :: Lens' OrderableDBInstanceOption (Maybe [AvailabilityZone]) Source #

A list of Availability Zones for a DB instance.

orderableDBInstanceOption_availableProcessorFeatures :: Lens' OrderableDBInstanceOption (Maybe [AvailableProcessorFeature]) Source #

A list of the available processor features for the DB instance class of a DB instance.

orderableDBInstanceOption_dbInstanceClass :: Lens' OrderableDBInstanceOption (Maybe Text) Source #

The DB instance class for a DB instance.

orderableDBInstanceOption_engine :: Lens' OrderableDBInstanceOption (Maybe Text) Source #

The engine type of a DB instance.

orderableDBInstanceOption_engineVersion :: Lens' OrderableDBInstanceOption (Maybe Text) Source #

The engine version of a DB instance.

orderableDBInstanceOption_licenseModel :: Lens' OrderableDBInstanceOption (Maybe Text) Source #

The license model for a DB instance.

orderableDBInstanceOption_maxIopsPerDbInstance :: Lens' OrderableDBInstanceOption (Maybe Int) Source #

Maximum total provisioned IOPS for a DB instance.

orderableDBInstanceOption_maxIopsPerGib :: Lens' OrderableDBInstanceOption (Maybe Double) Source #

Maximum provisioned IOPS per GiB for a DB instance.

orderableDBInstanceOption_maxStorageSize :: Lens' OrderableDBInstanceOption (Maybe Int) Source #

Maximum storage size for a DB instance.

orderableDBInstanceOption_maxStorageThroughputPerDbInstance :: Lens' OrderableDBInstanceOption (Maybe Int) Source #

Maximum storage throughput for a DB instance.

orderableDBInstanceOption_maxStorageThroughputPerIops :: Lens' OrderableDBInstanceOption (Maybe Double) Source #

Maximum storage throughput to provisioned IOPS ratio for a DB instance.

orderableDBInstanceOption_minIopsPerDbInstance :: Lens' OrderableDBInstanceOption (Maybe Int) Source #

Minimum total provisioned IOPS for a DB instance.

orderableDBInstanceOption_minIopsPerGib :: Lens' OrderableDBInstanceOption (Maybe Double) Source #

Minimum provisioned IOPS per GiB for a DB instance.

orderableDBInstanceOption_minStorageSize :: Lens' OrderableDBInstanceOption (Maybe Int) Source #

Minimum storage size for a DB instance.

orderableDBInstanceOption_minStorageThroughputPerDbInstance :: Lens' OrderableDBInstanceOption (Maybe Int) Source #

Minimum storage throughput for a DB instance.

orderableDBInstanceOption_minStorageThroughputPerIops :: Lens' OrderableDBInstanceOption (Maybe Double) Source #

Minimum storage throughput to provisioned IOPS ratio for a DB instance.

orderableDBInstanceOption_multiAZCapable :: Lens' OrderableDBInstanceOption (Maybe Bool) Source #

Indicates whether a DB instance is Multi-AZ capable.

orderableDBInstanceOption_outpostCapable :: Lens' OrderableDBInstanceOption (Maybe Bool) Source #

Whether a DB instance supports RDS on Outposts.

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

orderableDBInstanceOption_readReplicaCapable :: Lens' OrderableDBInstanceOption (Maybe Bool) Source #

Indicates whether a DB instance can have a read replica.

orderableDBInstanceOption_storageType :: Lens' OrderableDBInstanceOption (Maybe Text) Source #

Indicates the storage type for a DB instance.

orderableDBInstanceOption_supportedActivityStreamModes :: Lens' OrderableDBInstanceOption (Maybe [Text]) Source #

The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value [sync, async]. Aurora MySQL and RDS for Oracle return [async] only. If Database Activity Streams isn't supported, the return value is an empty list.

orderableDBInstanceOption_supportedEngineModes :: Lens' OrderableDBInstanceOption (Maybe [Text]) Source #

A list of the supported DB engine modes.

orderableDBInstanceOption_supportedNetworkTypes :: Lens' OrderableDBInstanceOption (Maybe [Text]) Source #

The network types supported by the DB instance (IPV4 or DUAL).

A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

orderableDBInstanceOption_supportsClusters :: Lens' OrderableDBInstanceOption (Maybe Bool) Source #

Whether DB instances can be configured as a Multi-AZ DB cluster.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

orderableDBInstanceOption_supportsEnhancedMonitoring :: Lens' OrderableDBInstanceOption (Maybe Bool) Source #

Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

orderableDBInstanceOption_supportsGlobalDatabases :: Lens' OrderableDBInstanceOption (Maybe Bool) Source #

A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.

orderableDBInstanceOption_supportsIAMDatabaseAuthentication :: Lens' OrderableDBInstanceOption (Maybe Bool) Source #

Indicates whether a DB instance supports IAM database authentication.

orderableDBInstanceOption_supportsIops :: Lens' OrderableDBInstanceOption (Maybe Bool) Source #

Indicates whether a DB instance supports provisioned IOPS.

orderableDBInstanceOption_supportsKerberosAuthentication :: Lens' OrderableDBInstanceOption (Maybe Bool) Source #

Whether a DB instance supports Kerberos Authentication.

orderableDBInstanceOption_supportsPerformanceInsights :: Lens' OrderableDBInstanceOption (Maybe Bool) Source #

True if a DB instance supports Performance Insights, otherwise false.

orderableDBInstanceOption_supportsStorageAutoscaling :: Lens' OrderableDBInstanceOption (Maybe Bool) Source #

Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.

orderableDBInstanceOption_supportsStorageEncryption :: Lens' OrderableDBInstanceOption (Maybe Bool) Source #

Indicates whether a DB instance supports encrypted storage.

orderableDBInstanceOption_supportsStorageThroughput :: Lens' OrderableDBInstanceOption (Maybe Bool) Source #

Indicates whether a DB instance supports storage throughput.

orderableDBInstanceOption_vpc :: Lens' OrderableDBInstanceOption (Maybe Bool) Source #

Indicates whether a DB instance is in a VPC.

Outpost

outpost_arn :: Lens' Outpost (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Outpost.

Parameter

parameter_allowedValues :: Lens' Parameter (Maybe Text) Source #

Specifies the valid range of values for the parameter.

parameter_applyMethod :: Lens' Parameter (Maybe ApplyMethod) Source #

Indicates when to apply parameter updates.

parameter_applyType :: Lens' Parameter (Maybe Text) Source #

Specifies the engine specific parameters type.

parameter_dataType :: Lens' Parameter (Maybe Text) Source #

Specifies the valid data type for the parameter.

parameter_description :: Lens' Parameter (Maybe Text) Source #

Provides a description of the parameter.

parameter_isModifiable :: Lens' Parameter (Maybe Bool) Source #

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

parameter_minimumEngineVersion :: Lens' Parameter (Maybe Text) Source #

The earliest engine version to which the parameter can apply.

parameter_parameterName :: Lens' Parameter (Maybe Text) Source #

Specifies the name of the parameter.

parameter_parameterValue :: Lens' Parameter (Maybe Text) Source #

Specifies the value of the parameter.

parameter_source :: Lens' Parameter (Maybe Text) Source #

Indicates the source of the parameter value.

parameter_supportedEngineModes :: Lens' Parameter (Maybe [Text]) Source #

The valid DB engine modes.

PendingCloudwatchLogsExports

pendingCloudwatchLogsExports_logTypesToDisable :: Lens' PendingCloudwatchLogsExports (Maybe [Text]) Source #

Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

pendingCloudwatchLogsExports_logTypesToEnable :: Lens' PendingCloudwatchLogsExports (Maybe [Text]) Source #

Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

PendingMaintenanceAction

pendingMaintenanceAction_action :: Lens' PendingMaintenanceAction (Maybe Text) Source #

The type of pending maintenance action that is available for the resource. Valid actions are system-update, db-upgrade, hardware-maintenance, and ca-certificate-rotation.

pendingMaintenanceAction_autoAppliedAfterDate :: Lens' PendingMaintenanceAction (Maybe UTCTime) Source #

The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date.

pendingMaintenanceAction_currentApplyDate :: Lens' PendingMaintenanceAction (Maybe UTCTime) Source #

The effective date when the pending maintenance action is applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.

pendingMaintenanceAction_description :: Lens' PendingMaintenanceAction (Maybe Text) Source #

A description providing more detail about the maintenance action.

pendingMaintenanceAction_forcedApplyDate :: Lens' PendingMaintenanceAction (Maybe UTCTime) Source #

The date when the maintenance action is automatically applied.

On this date, the maintenance action is applied to the resource as soon as possible, regardless of the maintenance window for the resource. There might be a delay of one or more days from this date before the maintenance action is applied.

pendingMaintenanceAction_optInStatus :: Lens' PendingMaintenanceAction (Maybe Text) Source #

Indicates the type of opt-in request that has been received for the resource.

PendingModifiedValues

pendingModifiedValues_allocatedStorage :: Lens' PendingModifiedValues (Maybe Int) Source #

The allocated storage size for the DB instance specified in gibibytes (GiB).

pendingModifiedValues_automationMode :: Lens' PendingModifiedValues (Maybe AutomationMode) Source #

The automation mode of the RDS Custom DB instance: full or all-paused. If full, the DB instance automates monitoring and instance recovery. If all-paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.

pendingModifiedValues_backupRetentionPeriod :: Lens' PendingModifiedValues (Maybe Int) Source #

The number of days for which automated backups are retained.

pendingModifiedValues_cACertificateIdentifier :: Lens' PendingModifiedValues (Maybe Text) Source #

The identifier of the CA certificate for the DB instance.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

pendingModifiedValues_dbInstanceClass :: Lens' PendingModifiedValues (Maybe Text) Source #

The name of the compute and memory capacity class for the DB instance.

pendingModifiedValues_dbInstanceIdentifier :: Lens' PendingModifiedValues (Maybe Text) Source #

The database identifier for the DB instance.

pendingModifiedValues_dbSubnetGroupName :: Lens' PendingModifiedValues (Maybe Text) Source #

The DB subnet group for the DB instance.

pendingModifiedValues_engineVersion :: Lens' PendingModifiedValues (Maybe Text) Source #

The database engine version.

pendingModifiedValues_iAMDatabaseAuthenticationEnabled :: Lens' PendingModifiedValues (Maybe Bool) Source #

Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

pendingModifiedValues_iops :: Lens' PendingModifiedValues (Maybe Int) Source #

The Provisioned IOPS value for the DB instance.

pendingModifiedValues_licenseModel :: Lens' PendingModifiedValues (Maybe Text) Source #

The license model for the DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

pendingModifiedValues_masterUserPassword :: Lens' PendingModifiedValues (Maybe Text) Source #

The master credentials for the DB instance.

pendingModifiedValues_multiAZ :: Lens' PendingModifiedValues (Maybe Bool) Source #

A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.

pendingModifiedValues_pendingCloudwatchLogsExports :: Lens' PendingModifiedValues (Maybe PendingCloudwatchLogsExports) Source #

Undocumented member.

pendingModifiedValues_port :: Lens' PendingModifiedValues (Maybe Int) Source #

The port for the DB instance.

pendingModifiedValues_processorFeatures :: Lens' PendingModifiedValues (Maybe [ProcessorFeature]) Source #

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

pendingModifiedValues_resumeFullAutomationModeTime :: Lens' PendingModifiedValues (Maybe UTCTime) Source #

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

pendingModifiedValues_storageThroughput :: Lens' PendingModifiedValues (Maybe Int) Source #

The storage throughput of the DB instance.

pendingModifiedValues_storageType :: Lens' PendingModifiedValues (Maybe Text) Source #

The storage type of the DB instance.

ProcessorFeature

processorFeature_name :: Lens' ProcessorFeature (Maybe Text) Source #

The name of the processor feature. Valid names are coreCount and threadsPerCore.

processorFeature_value :: Lens' ProcessorFeature (Maybe Text) Source #

The value of a processor feature name.

Range

range_from :: Lens' Range (Maybe Int) Source #

The minimum value in the range.

range_step :: Lens' Range (Maybe Int) Source #

The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...

range_to :: Lens' Range (Maybe Int) Source #

The maximum value in the range.

RecurringCharge

recurringCharge_recurringChargeAmount :: Lens' RecurringCharge (Maybe Double) Source #

The amount of the recurring charge.

recurringCharge_recurringChargeFrequency :: Lens' RecurringCharge (Maybe Text) Source #

The frequency of the recurring charge.

ReservedDBInstance

reservedDBInstance_currencyCode :: Lens' ReservedDBInstance (Maybe Text) Source #

The currency code for the reserved DB instance.

reservedDBInstance_dbInstanceClass :: Lens' ReservedDBInstance (Maybe Text) Source #

The DB instance class for the reserved DB instance.

reservedDBInstance_dbInstanceCount :: Lens' ReservedDBInstance (Maybe Int) Source #

The number of reserved DB instances.

reservedDBInstance_duration :: Lens' ReservedDBInstance (Maybe Int) Source #

The duration of the reservation in seconds.

reservedDBInstance_fixedPrice :: Lens' ReservedDBInstance (Maybe Double) Source #

The fixed price charged for this reserved DB instance.

reservedDBInstance_leaseId :: Lens' ReservedDBInstance (Maybe Text) Source #

The unique identifier for the lease associated with the reserved DB instance.

Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

reservedDBInstance_multiAZ :: Lens' ReservedDBInstance (Maybe Bool) Source #

Indicates if the reservation applies to Multi-AZ deployments.

reservedDBInstance_offeringType :: Lens' ReservedDBInstance (Maybe Text) Source #

The offering type of this reserved DB instance.

reservedDBInstance_productDescription :: Lens' ReservedDBInstance (Maybe Text) Source #

The description of the reserved DB instance.

reservedDBInstance_recurringCharges :: Lens' ReservedDBInstance (Maybe [RecurringCharge]) Source #

The recurring price charged to run this reserved DB instance.

reservedDBInstance_reservedDBInstanceArn :: Lens' ReservedDBInstance (Maybe Text) Source #

The Amazon Resource Name (ARN) for the reserved DB instance.

reservedDBInstance_reservedDBInstanceId :: Lens' ReservedDBInstance (Maybe Text) Source #

The unique identifier for the reservation.

reservedDBInstance_reservedDBInstancesOfferingId :: Lens' ReservedDBInstance (Maybe Text) Source #

The offering identifier.

reservedDBInstance_startTime :: Lens' ReservedDBInstance (Maybe UTCTime) Source #

The time the reservation started.

reservedDBInstance_state :: Lens' ReservedDBInstance (Maybe Text) Source #

The state of the reserved DB instance.

reservedDBInstance_usagePrice :: Lens' ReservedDBInstance (Maybe Double) Source #

The hourly price charged for this reserved DB instance.

ReservedDBInstancesOffering

reservedDBInstancesOffering_currencyCode :: Lens' ReservedDBInstancesOffering (Maybe Text) Source #

The currency code for the reserved DB instance offering.

reservedDBInstancesOffering_dbInstanceClass :: Lens' ReservedDBInstancesOffering (Maybe Text) Source #

The DB instance class for the reserved DB instance.

reservedDBInstancesOffering_duration :: Lens' ReservedDBInstancesOffering (Maybe Int) Source #

The duration of the offering in seconds.

reservedDBInstancesOffering_fixedPrice :: Lens' ReservedDBInstancesOffering (Maybe Double) Source #

The fixed price charged for this offering.

reservedDBInstancesOffering_multiAZ :: Lens' ReservedDBInstancesOffering (Maybe Bool) Source #

Indicates if the offering applies to Multi-AZ deployments.

reservedDBInstancesOffering_offeringType :: Lens' ReservedDBInstancesOffering (Maybe Text) Source #

The offering type.

reservedDBInstancesOffering_productDescription :: Lens' ReservedDBInstancesOffering (Maybe Text) Source #

The database engine used by the offering.

reservedDBInstancesOffering_recurringCharges :: Lens' ReservedDBInstancesOffering (Maybe [RecurringCharge]) Source #

The recurring price charged to run this reserved DB instance.

reservedDBInstancesOffering_reservedDBInstancesOfferingId :: Lens' ReservedDBInstancesOffering (Maybe Text) Source #

The offering identifier.

reservedDBInstancesOffering_usagePrice :: Lens' ReservedDBInstancesOffering (Maybe Double) Source #

The hourly price charged for this offering.

ResourcePendingMaintenanceActions

resourcePendingMaintenanceActions_pendingMaintenanceActionDetails :: Lens' ResourcePendingMaintenanceActions (Maybe [PendingMaintenanceAction]) Source #

A list that provides details about the pending maintenance actions for the resource.

resourcePendingMaintenanceActions_resourceIdentifier :: Lens' ResourcePendingMaintenanceActions (Maybe Text) Source #

The ARN of the resource that has pending maintenance actions.

RestoreWindow

restoreWindow_earliestTime :: Lens' RestoreWindow (Maybe UTCTime) Source #

The earliest time you can restore an instance to.

restoreWindow_latestTime :: Lens' RestoreWindow (Maybe UTCTime) Source #

The latest time you can restore an instance to.

ScalingConfiguration

scalingConfiguration_autoPause :: Lens' ScalingConfiguration (Maybe Bool) Source #

A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).

If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.

scalingConfiguration_maxCapacity :: Lens' ScalingConfiguration (Maybe Int) Source #

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

The maximum capacity must be greater than or equal to the minimum capacity.

scalingConfiguration_minCapacity :: Lens' ScalingConfiguration (Maybe Int) Source #

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

The minimum capacity must be less than or equal to the maximum capacity.

scalingConfiguration_secondsBeforeTimeout :: Lens' ScalingConfiguration (Maybe Int) Source #

The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.

Specify a value between 60 and 600 seconds.

scalingConfiguration_secondsUntilAutoPause :: Lens' ScalingConfiguration (Maybe Int) Source #

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

Specify a value between 300 and 86,400 seconds.

scalingConfiguration_timeoutAction :: Lens' ScalingConfiguration (Maybe Text) Source #

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.

RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.

If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.

For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

ScalingConfigurationInfo

scalingConfigurationInfo_autoPause :: Lens' ScalingConfigurationInfo (Maybe Bool) Source #

A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.

When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.

scalingConfigurationInfo_maxCapacity :: Lens' ScalingConfigurationInfo (Maybe Int) Source #

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

scalingConfigurationInfo_minCapacity :: Lens' ScalingConfigurationInfo (Maybe Int) Source #

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

scalingConfigurationInfo_secondsBeforeTimeout :: Lens' ScalingConfigurationInfo (Maybe Int) Source #

The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.

scalingConfigurationInfo_secondsUntilAutoPause :: Lens' ScalingConfigurationInfo (Maybe Int) Source #

The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).

scalingConfigurationInfo_timeoutAction :: Lens' ScalingConfigurationInfo (Maybe Text) Source #

The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange.

ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.

ServerlessV2ScalingConfiguration

serverlessV2ScalingConfiguration_maxCapacity :: Lens' ServerlessV2ScalingConfiguration (Maybe Double) Source #

The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.

serverlessV2ScalingConfiguration_minCapacity :: Lens' ServerlessV2ScalingConfiguration (Maybe Double) Source #

The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.

ServerlessV2ScalingConfigurationInfo

serverlessV2ScalingConfigurationInfo_maxCapacity :: Lens' ServerlessV2ScalingConfigurationInfo (Maybe Double) Source #

The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.

serverlessV2ScalingConfigurationInfo_minCapacity :: Lens' ServerlessV2ScalingConfigurationInfo (Maybe Double) Source #

The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.

SourceRegion

sourceRegion_endpoint :: Lens' SourceRegion (Maybe Text) Source #

The endpoint for the source Amazon Web Services Region endpoint.

sourceRegion_regionName :: Lens' SourceRegion (Maybe Text) Source #

The name of the source Amazon Web Services Region.

sourceRegion_status :: Lens' SourceRegion (Maybe Text) Source #

The status of the source Amazon Web Services Region.

sourceRegion_supportsDBInstanceAutomatedBackupsReplication :: Lens' SourceRegion (Maybe Bool) Source #

Whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.

Subnet

subnet_subnetAvailabilityZone :: Lens' Subnet (Maybe AvailabilityZone) Source #

Undocumented member.

subnet_subnetIdentifier :: Lens' Subnet (Maybe Text) Source #

The identifier of the subnet.

subnet_subnetOutpost :: Lens' Subnet (Maybe Outpost) Source #

If the subnet is associated with an Outpost, this value specifies the Outpost.

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

subnet_subnetStatus :: Lens' Subnet (Maybe Text) Source #

The status of the subnet.

SwitchoverDetail

switchoverDetail_sourceMember :: Lens' SwitchoverDetail (Maybe Text) Source #

The Amazon Resource Name (ARN) of a resource in the blue environment.

switchoverDetail_status :: Lens' SwitchoverDetail (Maybe Text) Source #

The switchover status of a resource in a blue/green deployment.

Values:

preparing-for-switchover - The resource is being prepared to switch over.
ready-for-switchover - The resource is ready to switch over.
switchover-in-progress - The resource is being switched over.
switchover-completed - The resource has been switched over.
switchover-failed - The resource attempted to switch over but failed.

switchoverDetail_targetMember :: Lens' SwitchoverDetail (Maybe Text) Source #

The Amazon Resource Name (ARN) of a resource in the green environment.

Tag

tag_key :: Lens' Tag (Maybe Text) Source #

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").

tag_value :: Lens' Tag (Maybe Text) Source #

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").

TargetHealth

targetHealth_description :: Lens' TargetHealth (Maybe Text) Source #

A description of the health of the RDS Proxy target. If the State is AVAILABLE, a description is not included.

targetHealth_reason :: Lens' TargetHealth (Maybe TargetHealthReason) Source #

The reason for the current health State of the RDS Proxy target.

targetHealth_state :: Lens' TargetHealth (Maybe TargetState) Source #

The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:

registering > unavailable > available > unavailable > available

Timezone

timezone_timezoneName :: Lens' Timezone (Maybe Text) Source #

The name of the time zone.

UpgradeTarget

upgradeTarget_autoUpgrade :: Lens' UpgradeTarget (Maybe Bool) Source #

A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

upgradeTarget_description :: Lens' UpgradeTarget (Maybe Text) Source #

The version of the database engine that a DB instance can be upgraded to.

upgradeTarget_engine :: Lens' UpgradeTarget (Maybe Text) Source #

The name of the upgrade target database engine.

upgradeTarget_engineVersion :: Lens' UpgradeTarget (Maybe Text) Source #

The version number of the upgrade target database engine.

upgradeTarget_isMajorVersionUpgrade :: Lens' UpgradeTarget (Maybe Bool) Source #

A value that indicates whether upgrading to the target version requires upgrading the major version of the database engine.

upgradeTarget_supportedEngineModes :: Lens' UpgradeTarget (Maybe [Text]) Source #

A list of the supported DB engine modes for the target engine version.

upgradeTarget_supportsBabelfish :: Lens' UpgradeTarget (Maybe Bool) Source #

A value that indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.

upgradeTarget_supportsGlobalDatabases :: Lens' UpgradeTarget (Maybe Bool) Source #

A value that indicates whether you can use Aurora global databases with the target engine version.

upgradeTarget_supportsParallelQuery :: Lens' UpgradeTarget (Maybe Bool) Source #

A value that indicates whether you can use Aurora parallel query with the target engine version.

UserAuthConfig

userAuthConfig_authScheme :: Lens' UserAuthConfig (Maybe AuthScheme) Source #

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

userAuthConfig_clientPasswordAuthType :: Lens' UserAuthConfig (Maybe ClientPasswordAuthType) Source #

The type of authentication the proxy uses for connections from clients.

userAuthConfig_description :: Lens' UserAuthConfig (Maybe Text) Source #

A user-specified description about the authentication used by a proxy to log in as a specific database user.

userAuthConfig_iAMAuth :: Lens' UserAuthConfig (Maybe IAMAuthMode) Source #

Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

userAuthConfig_secretArn :: Lens' UserAuthConfig (Maybe Text) Source #

The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

userAuthConfig_userName :: Lens' UserAuthConfig (Maybe Text) Source #

The name of the database user to which the proxy connects.

UserAuthConfigInfo

userAuthConfigInfo_authScheme :: Lens' UserAuthConfigInfo (Maybe AuthScheme) Source #

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

userAuthConfigInfo_clientPasswordAuthType :: Lens' UserAuthConfigInfo (Maybe ClientPasswordAuthType) Source #

The type of authentication the proxy uses for connections from clients.

userAuthConfigInfo_description :: Lens' UserAuthConfigInfo (Maybe Text) Source #

A user-specified description about the authentication used by a proxy to log in as a specific database user.

userAuthConfigInfo_iAMAuth :: Lens' UserAuthConfigInfo (Maybe IAMAuthMode) Source #

Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

userAuthConfigInfo_secretArn :: Lens' UserAuthConfigInfo (Maybe Text) Source #

The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

userAuthConfigInfo_userName :: Lens' UserAuthConfigInfo (Maybe Text) Source #

The name of the database user to which the proxy connects.

ValidDBInstanceModificationsMessage

validDBInstanceModificationsMessage_storage :: Lens' ValidDBInstanceModificationsMessage (Maybe [ValidStorageOptions]) Source #

Valid storage options for your DB instance.

validDBInstanceModificationsMessage_validProcessorFeatures :: Lens' ValidDBInstanceModificationsMessage (Maybe [AvailableProcessorFeature]) Source #

Valid processor features for your DB instance.

ValidStorageOptions

validStorageOptions_iopsToStorageRatio :: Lens' ValidStorageOptions (Maybe [DoubleRange]) Source #

The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage.

validStorageOptions_provisionedIops :: Lens' ValidStorageOptions (Maybe [Range]) Source #

The valid range of provisioned IOPS. For example, 1000-256,000.

validStorageOptions_provisionedStorageThroughput :: Lens' ValidStorageOptions (Maybe [Range]) Source #

The valid range of provisioned storage throughput. For example, 500-4,000 mebibytes per second (MiBps).

validStorageOptions_storageSize :: Lens' ValidStorageOptions (Maybe [Range]) Source #

The valid range of storage in gibibytes (GiB). For example, 100 to 16,384.

validStorageOptions_storageThroughputToIopsRatio :: Lens' ValidStorageOptions (Maybe [DoubleRange]) Source #

The valid range of storage throughput to provisioned IOPS ratios. For example, 0-0.25.

validStorageOptions_storageType :: Lens' ValidStorageOptions (Maybe Text) Source #

The valid storage types for your DB instance. For example: gp2, gp3, io1.

validStorageOptions_supportsStorageAutoscaling :: Lens' ValidStorageOptions (Maybe Bool) Source #

Whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.