Amazonka.DocumentDB.Lens

Operations

AddSourceIdentifierToSubscription

addSourceIdentifierToSubscription_subscriptionName :: Lens' AddSourceIdentifierToSubscription Text

The name of the Amazon DocumentDB event notification subscription that you want to add a source identifier to.

addSourceIdentifierToSubscription_sourceIdentifier :: Lens' AddSourceIdentifierToSubscription Text

The identifier of the event source to be added:

• If the source type is an instance, a DBInstanceIdentifier must be provided.
• If the source type is a security group, a DBSecurityGroupName must be provided.
• If the source type is a parameter group, a DBParameterGroupName must be provided.
• If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

addSourceIdentifierToSubscriptionResponse_eventSubscription :: Lens' AddSourceIdentifierToSubscriptionResponse (Maybe EventSubscription)

Undocumented member.

addSourceIdentifierToSubscriptionResponse_httpStatus :: Lens' AddSourceIdentifierToSubscriptionResponse Int

The response's http status code.

AddTagsToResource

addTagsToResource_resourceName :: Lens' AddTagsToResource Text

The Amazon DocumentDB resource that the tags are added to. This value is an Amazon Resource Name .

addTagsToResource_tags :: Lens' AddTagsToResource [Tag]

The tags to be assigned to the Amazon DocumentDB resource.

ApplyPendingMaintenanceAction

applyPendingMaintenanceAction_resourceIdentifier :: Lens' ApplyPendingMaintenanceAction Text

The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to.

applyPendingMaintenanceAction_applyAction :: Lens' ApplyPendingMaintenanceAction Text

The pending maintenance action to apply to this resource.

Valid values: system-update, db-upgrade

applyPendingMaintenanceAction_optInType :: Lens' ApplyPendingMaintenanceAction Text

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)

Undocumented member.

applyPendingMaintenanceActionResponse_httpStatus :: Lens' ApplyPendingMaintenanceActionResponse Int

The response's http status code.

CopyDBClusterParameterGroup

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

The tags that are to be assigned to the parameter group.

copyDBClusterParameterGroup_sourceDBClusterParameterGroupIdentifier :: Lens' CopyDBClusterParameterGroup Text

The identifier or Amazon Resource Name (ARN) for the source cluster parameter group.

Constraints:

• Must specify a valid cluster parameter group.
• If the source cluster parameter group is in the same Amazon Web Services Region as the copy, specify a valid parameter group identifier; for example, my-db-cluster-param-group, or a valid ARN.
• If the source parameter group is in a different Amazon Web Services Region than the copy, specify a valid cluster parameter group ARN; for example, arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group.

copyDBClusterParameterGroup_targetDBClusterParameterGroupIdentifier :: Lens' CopyDBClusterParameterGroup Text

The identifier for the copied cluster parameter group.

Constraints:

• Cannot be null, empty, or blank.
• Must contain from 1 to 255 letters, numbers, or hyphens.
• The first character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-param-group1

copyDBClusterParameterGroup_targetDBClusterParameterGroupDescription :: Lens' CopyDBClusterParameterGroup Text

A description for the copied cluster parameter group.

copyDBClusterParameterGroupResponse_dbClusterParameterGroup :: Lens' CopyDBClusterParameterGroupResponse (Maybe DBClusterParameterGroup)

Undocumented member.

copyDBClusterParameterGroupResponse_httpStatus :: Lens' CopyDBClusterParameterGroupResponse Int

The response's http status code.

CopyDBClusterSnapshot

copyDBClusterSnapshot_copyTags :: Lens' CopyDBClusterSnapshot (Maybe Bool)

Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false. The default is false.

copyDBClusterSnapshot_kmsKeyId :: Lens' CopyDBClusterSnapshot (Maybe Text)

The KMS key ID for an encrypted cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

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

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

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

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

copyDBClusterSnapshot_preSignedUrl :: Lens' CopyDBClusterSnapshot (Maybe Text)

The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Amazon Web Services Region.

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 pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.

The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:

• SourceRegion - The ID of the region that contains the snapshot to be copied.
• SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted 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 cluster snapshot from the us-east-1 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.
• TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.

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

The tags to be assigned to the cluster snapshot.

copyDBClusterSnapshot_sourceDBClusterSnapshotIdentifier :: Lens' CopyDBClusterSnapshot Text

The identifier of the cluster snapshot to copy. This parameter is not case sensitive.

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 snapshot identifier.
• If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid cluster snapshot ARN.

Example: my-cluster-snapshot1

copyDBClusterSnapshot_targetDBClusterSnapshotIdentifier :: Lens' CopyDBClusterSnapshot Text

The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

Constraints:

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

Example: my-cluster-snapshot2

copyDBClusterSnapshotResponse_dbClusterSnapshot :: Lens' CopyDBClusterSnapshotResponse (Maybe DBClusterSnapshot)

Undocumented member.

copyDBClusterSnapshotResponse_httpStatus :: Lens' CopyDBClusterSnapshotResponse Int

The response's http status code.

CreateDBCluster

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

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

createDBCluster_backupRetentionPeriod :: Lens' CreateDBCluster (Maybe Int)

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

Default: 1

Constraints:

• Must be a value from 1 to 35.

createDBCluster_dbClusterParameterGroupName :: Lens' CreateDBCluster (Maybe Text)

The name of the cluster parameter group to associate with this cluster.

createDBCluster_dbSubnetGroupName :: Lens' CreateDBCluster (Maybe Text)

A subnet group to associate with this cluster.

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

Example: mySubnetgroup

createDBCluster_deletionProtection :: Lens' CreateDBCluster (Maybe Bool)

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

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

A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.

createDBCluster_engineVersion :: Lens' CreateDBCluster (Maybe Text)

The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.

createDBCluster_globalClusterIdentifier :: Lens' CreateDBCluster (Maybe Text)

The cluster identifier of the new global cluster.

createDBCluster_kmsKeyId :: Lens' CreateDBCluster (Maybe Text)

The KMS key identifier for an encrypted cluster.

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

If an encryption key is not specified in KmsKeyId:

• If the StorageEncrypted parameter is true, Amazon DocumentDB uses your default encryption key.

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

createDBCluster_masterUserPassword :: Lens' CreateDBCluster (Maybe Text)

The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

createDBCluster_masterUsername :: Lens' CreateDBCluster (Maybe Text)

The name of the master user for the cluster.

Constraints:

• Must be from 1 to 63 letters or numbers.
• The first character must be a letter.
• Cannot be a reserved word for the chosen database engine.

createDBCluster_port :: Lens' CreateDBCluster (Maybe Int)

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

createDBCluster_preSignedUrl :: Lens' CreateDBCluster (Maybe Text)

Not currently supported.

createDBCluster_preferredBackupWindow :: Lens' CreateDBCluster (Maybe Text)

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

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.

Constraints:

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

createDBCluster_preferredMaintenanceWindow :: Lens' CreateDBCluster (Maybe Text)

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

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

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

createDBCluster_storageEncrypted :: Lens' CreateDBCluster (Maybe Bool)

Specifies whether the cluster is encrypted.

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

The tags to be assigned to the cluster.

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

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

createDBCluster_dbClusterIdentifier :: Lens' CreateDBCluster Text

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

Constraints:

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

Example: my-cluster

createDBCluster_engine :: Lens' CreateDBCluster Text

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

Valid values: docdb

createDBClusterResponse_dbCluster :: Lens' CreateDBClusterResponse (Maybe DBCluster)

Undocumented member.

createDBClusterResponse_httpStatus :: Lens' CreateDBClusterResponse Int

The response's http status code.

CreateDBClusterParameterGroup

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

The tags to be assigned to the cluster parameter group.

createDBClusterParameterGroup_dbClusterParameterGroupName :: Lens' CreateDBClusterParameterGroup Text

The name of the cluster parameter group.

Constraints:

• Must not match the name of an existing DBClusterParameterGroup.

This value is stored as a lowercase string.

createDBClusterParameterGroup_dbParameterGroupFamily :: Lens' CreateDBClusterParameterGroup Text

The cluster parameter group family name.

createDBClusterParameterGroup_description :: Lens' CreateDBClusterParameterGroup Text

The description for the cluster parameter group.

createDBClusterParameterGroupResponse_dbClusterParameterGroup :: Lens' CreateDBClusterParameterGroupResponse (Maybe DBClusterParameterGroup)

Undocumented member.

createDBClusterParameterGroupResponse_httpStatus :: Lens' CreateDBClusterParameterGroupResponse Int

The response's http status code.

CreateDBClusterSnapshot

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

The tags to be assigned to the cluster snapshot.

createDBClusterSnapshot_dbClusterSnapshotIdentifier :: Lens' CreateDBClusterSnapshot Text

The identifier of the cluster snapshot. This parameter is stored as a lowercase string.

Constraints:

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

Example: my-cluster-snapshot1

createDBClusterSnapshot_dbClusterIdentifier :: Lens' CreateDBClusterSnapshot Text

The identifier of the cluster to create a snapshot for. This parameter is not case sensitive.

Constraints:

• Must match the identifier of an existing DBCluster.

Example: my-cluster

createDBClusterSnapshotResponse_dbClusterSnapshot :: Lens' CreateDBClusterSnapshotResponse (Maybe DBClusterSnapshot)

Undocumented member.

createDBClusterSnapshotResponse_httpStatus :: Lens' CreateDBClusterSnapshotResponse Int

The response's http status code.

CreateDBInstance

createDBInstance_autoMinorVersionUpgrade :: Lens' CreateDBInstance (Maybe Bool)

This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Default: false

createDBInstance_availabilityZone :: Lens' CreateDBInstance (Maybe Text)

The Amazon EC2 Availability Zone that the instance is created in.

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

Example: us-east-1d

createDBInstance_copyTagsToSnapshot :: Lens' CreateDBInstance (Maybe Bool)

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

createDBInstance_enablePerformanceInsights :: Lens' CreateDBInstance (Maybe Bool)

A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

createDBInstance_performanceInsightsKMSKeyId :: Lens' CreateDBInstance (Maybe Text)

The KMS key identifier for encryption of Performance Insights data.

The 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 DocumentDB 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.

createDBInstance_preferredMaintenanceWindow :: Lens' CreateDBInstance (Maybe Text)

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

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

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

createDBInstance_promotionTier :: Lens' CreateDBInstance (Maybe Int)

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

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

The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

createDBInstance_dbInstanceIdentifier :: Lens' CreateDBInstance Text

The instance identifier. This parameter is stored as a lowercase string.

Constraints:

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

Example: mydbinstance

createDBInstance_dbInstanceClass :: Lens' CreateDBInstance Text

The compute and memory capacity of the instance; for example, db.r5.large.

createDBInstance_engine :: Lens' CreateDBInstance Text

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

Valid value: docdb

createDBInstance_dbClusterIdentifier :: Lens' CreateDBInstance Text

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

createDBInstanceResponse_dbInstance :: Lens' CreateDBInstanceResponse (Maybe DBInstance)

Undocumented member.

createDBInstanceResponse_httpStatus :: Lens' CreateDBInstanceResponse Int

The response's http status code.

CreateDBSubnetGroup

createDBSubnetGroup_tags :: Lens' CreateDBSubnetGroup (Maybe [Tag])

The tags to be assigned to the subnet group.

createDBSubnetGroup_dbSubnetGroupName :: Lens' CreateDBSubnetGroup Text

The name for the 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.

Example: mySubnetgroup

createDBSubnetGroup_dbSubnetGroupDescription :: Lens' CreateDBSubnetGroup Text

The description for the subnet group.

createDBSubnetGroup_subnetIds :: Lens' CreateDBSubnetGroup [Text]

The Amazon EC2 subnet IDs for the subnet group.

createDBSubnetGroupResponse_dbSubnetGroup :: Lens' CreateDBSubnetGroupResponse (Maybe DBSubnetGroup)

Undocumented member.

createDBSubnetGroupResponse_httpStatus :: Lens' CreateDBSubnetGroupResponse Int

The response's http status code.

CreateEventSubscription

createEventSubscription_enabled :: Lens' CreateEventSubscription (Maybe Bool)

A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

createEventSubscription_eventCategories :: Lens' CreateEventSubscription (Maybe [Text])

A list of event categories for a SourceType that you want to subscribe to.

createEventSubscription_sourceIds :: Lens' CreateEventSubscription (Maybe [Text])

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 provided, SourceType must also be provided.
• If the source type is an instance, a DBInstanceIdentifier must be provided.
• If the source type is a security group, a DBSecurityGroupName must be provided.
• If the source type is a parameter group, a DBParameterGroupName must be provided.
• If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

createEventSubscription_sourceType :: Lens' CreateEventSubscription (Maybe Text)

The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned.

Valid values: db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot

createEventSubscription_tags :: Lens' CreateEventSubscription (Maybe [Tag])

The tags to be assigned to the event subscription.

createEventSubscription_subscriptionName :: Lens' CreateEventSubscription Text

The name of the subscription.

Constraints: The name must be fewer than 255 characters.

createEventSubscription_snsTopicArn :: Lens' CreateEventSubscription Text

The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.

createEventSubscriptionResponse_eventSubscription :: Lens' CreateEventSubscriptionResponse (Maybe EventSubscription)

Undocumented member.

createEventSubscriptionResponse_httpStatus :: Lens' CreateEventSubscriptionResponse Int

The response's http status code.

CreateGlobalCluster

createGlobalCluster_databaseName :: Lens' CreateGlobalCluster (Maybe Text)

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

createGlobalCluster_deletionProtection :: Lens' CreateGlobalCluster (Maybe Bool)

The deletion protection setting for the new global cluster. The global cluster can't be deleted when deletion protection is enabled.

createGlobalCluster_engine :: Lens' CreateGlobalCluster (Maybe Text)

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

createGlobalCluster_engineVersion :: Lens' CreateGlobalCluster (Maybe Text)

The engine version of the global cluster.

createGlobalCluster_sourceDBClusterIdentifier :: Lens' CreateGlobalCluster (Maybe Text)

The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. This parameter is optional.

createGlobalCluster_storageEncrypted :: Lens' CreateGlobalCluster (Maybe Bool)

The storage encryption setting for the new global cluster.

createGlobalCluster_globalClusterIdentifier :: Lens' CreateGlobalCluster Text

The cluster identifier of the new global cluster.

createGlobalClusterResponse_globalCluster :: Lens' CreateGlobalClusterResponse (Maybe GlobalCluster)

Undocumented member.

createGlobalClusterResponse_httpStatus :: Lens' CreateGlobalClusterResponse Int

The response's http status code.

DeleteDBCluster

deleteDBCluster_finalDBSnapshotIdentifier :: Lens' DeleteDBCluster (Maybe Text)

The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

• Must be from 1 to 255 letters, numbers, or hyphens.
• The first character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

deleteDBCluster_skipFinalSnapshot :: Lens' DeleteDBCluster (Maybe Bool)

Determines whether a final cluster snapshot is created before the cluster is deleted. If true is specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created before the DB cluster is deleted.

If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter.

Default: false

deleteDBCluster_dbClusterIdentifier :: Lens' DeleteDBCluster Text

The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.

Constraints:

• Must match an existing DBClusterIdentifier.

deleteDBClusterResponse_dbCluster :: Lens' DeleteDBClusterResponse (Maybe DBCluster)

Undocumented member.

deleteDBClusterResponse_httpStatus :: Lens' DeleteDBClusterResponse Int

The response's http status code.

DeleteDBClusterParameterGroup

deleteDBClusterParameterGroup_dbClusterParameterGroupName :: Lens' DeleteDBClusterParameterGroup Text

The name of the cluster parameter group.

Constraints:

• Must be the name of an existing cluster parameter group.
• You can't delete a default cluster parameter group.
• Cannot be associated with any clusters.

DeleteDBClusterSnapshot

deleteDBClusterSnapshot_dbClusterSnapshotIdentifier :: Lens' DeleteDBClusterSnapshot Text

The identifier of the cluster snapshot to delete.

Constraints: Must be the name of an existing cluster snapshot in the available state.

deleteDBClusterSnapshotResponse_dbClusterSnapshot :: Lens' DeleteDBClusterSnapshotResponse (Maybe DBClusterSnapshot)

Undocumented member.

deleteDBClusterSnapshotResponse_httpStatus :: Lens' DeleteDBClusterSnapshotResponse Int

The response's http status code.

DeleteDBInstance

deleteDBInstance_dbInstanceIdentifier :: Lens' DeleteDBInstance Text

The instance identifier for the instance to be deleted. This parameter isn't case sensitive.

Constraints:

• Must match the name of an existing instance.

deleteDBInstanceResponse_dbInstance :: Lens' DeleteDBInstanceResponse (Maybe DBInstance)

Undocumented member.

deleteDBInstanceResponse_httpStatus :: Lens' DeleteDBInstanceResponse Int

The response's http status code.

DeleteDBSubnetGroup

deleteDBSubnetGroup_dbSubnetGroupName :: Lens' DeleteDBSubnetGroup Text

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: mySubnetgroup

DeleteEventSubscription

deleteEventSubscription_subscriptionName :: Lens' DeleteEventSubscription Text

The name of the Amazon DocumentDB event notification subscription that you want to delete.

deleteEventSubscriptionResponse_eventSubscription :: Lens' DeleteEventSubscriptionResponse (Maybe EventSubscription)

Undocumented member.

deleteEventSubscriptionResponse_httpStatus :: Lens' DeleteEventSubscriptionResponse Int

The response's http status code.

DeleteGlobalCluster

deleteGlobalCluster_globalClusterIdentifier :: Lens' DeleteGlobalCluster Text

The cluster identifier of the global cluster being deleted.

deleteGlobalClusterResponse_globalCluster :: Lens' DeleteGlobalClusterResponse (Maybe GlobalCluster)

Undocumented member.

deleteGlobalClusterResponse_httpStatus :: Lens' DeleteGlobalClusterResponse Int

The response's http status code.

DescribeCertificates

describeCertificates_certificateIdentifier :: Lens' DescribeCertificates (Maybe Text)

The user-supplied certificate identifier. If this parameter is specified, information for only the specified certificate is returned. If this parameter is omitted, a list of up to MaxRecords certificates is returned. This parameter is not case sensitive.

Constraints

• Must match an existing CertificateIdentifier.

describeCertificates_filters :: Lens' DescribeCertificates (Maybe [Filter])

This parameter is not currently supported.

describeCertificates_marker :: Lens' DescribeCertificates (Maybe Text)

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)

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

describeCertificatesResponse_certificates :: Lens' DescribeCertificatesResponse (Maybe [Certificate])

A list of certificates for this Amazon Web Services account.

describeCertificatesResponse_marker :: Lens' DescribeCertificatesResponse (Maybe Text)

An optional pagination token provided if the number of records retrieved is greater than MaxRecords. If this parameter is specified, the marker specifies the next record in the list. Including the value of Marker in the next call to DescribeCertificates results in the next page of certificates.

describeCertificatesResponse_httpStatus :: Lens' DescribeCertificatesResponse Int

The response's http status code.

DescribeDBClusterParameterGroups

describeDBClusterParameterGroups_dbClusterParameterGroupName :: Lens' DescribeDBClusterParameterGroups (Maybe Text)

The name of a specific cluster parameter group to return details for.

Constraints:

• If provided, must match the name of an existing DBClusterParameterGroup.

describeDBClusterParameterGroups_filters :: Lens' DescribeDBClusterParameterGroups (Maybe [Filter])

This parameter is not currently supported.

describeDBClusterParameterGroups_marker :: Lens' DescribeDBClusterParameterGroups (Maybe Text)

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.

describeDBClusterParameterGroups_maxRecords :: Lens' DescribeDBClusterParameterGroups (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBClusterParameterGroupsResponse_dbClusterParameterGroups :: Lens' DescribeDBClusterParameterGroupsResponse (Maybe [DBClusterParameterGroup])

A list of cluster parameter groups.

describeDBClusterParameterGroupsResponse_marker :: Lens' DescribeDBClusterParameterGroupsResponse (Maybe Text)

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.

describeDBClusterParameterGroupsResponse_httpStatus :: Lens' DescribeDBClusterParameterGroupsResponse Int

The response's http status code.

DescribeDBClusterParameters

describeDBClusterParameters_filters :: Lens' DescribeDBClusterParameters (Maybe [Filter])

This parameter is not currently supported.

describeDBClusterParameters_marker :: Lens' DescribeDBClusterParameters (Maybe Text)

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.

describeDBClusterParameters_maxRecords :: Lens' DescribeDBClusterParameters (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBClusterParameters_source :: Lens' DescribeDBClusterParameters (Maybe Text)

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

The name of a specific cluster parameter group to return parameter details for.

Constraints:

• If provided, must match the name of an existing DBClusterParameterGroup.

describeDBClusterParametersResponse_marker :: Lens' DescribeDBClusterParametersResponse (Maybe Text)

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.

describeDBClusterParametersResponse_parameters :: Lens' DescribeDBClusterParametersResponse (Maybe [Parameter])

Provides a list of parameters for the cluster parameter group.

describeDBClusterParametersResponse_httpStatus :: Lens' DescribeDBClusterParametersResponse Int

The response's http status code.

DescribeDBClusterSnapshotAttributes

describeDBClusterSnapshotAttributes_dbClusterSnapshotIdentifier :: Lens' DescribeDBClusterSnapshotAttributes Text

The identifier for the cluster snapshot to describe the attributes for.

describeDBClusterSnapshotAttributesResponse_dbClusterSnapshotAttributesResult :: Lens' DescribeDBClusterSnapshotAttributesResponse (Maybe DBClusterSnapshotAttributesResult)

Undocumented member.

describeDBClusterSnapshotAttributesResponse_httpStatus :: Lens' DescribeDBClusterSnapshotAttributesResponse Int

The response's http status code.

DescribeDBClusterSnapshots

describeDBClusterSnapshots_dbClusterIdentifier :: Lens' DescribeDBClusterSnapshots (Maybe Text)

The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.

Constraints:

• If provided, must match the identifier of an existing DBCluster.

describeDBClusterSnapshots_dbClusterSnapshotIdentifier :: Lens' DescribeDBClusterSnapshots (Maybe Text)

A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

• If provided, 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])

This parameter is not currently supported.

describeDBClusterSnapshots_includePublic :: Lens' DescribeDBClusterSnapshots (Maybe Bool)

Set to true to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise false. The default is false.

describeDBClusterSnapshots_includeShared :: Lens' DescribeDBClusterSnapshots (Maybe Bool)

Set to true to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise false. The default is false.

describeDBClusterSnapshots_marker :: Lens' DescribeDBClusterSnapshots (Maybe Text)

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.

describeDBClusterSnapshots_maxRecords :: Lens' DescribeDBClusterSnapshots (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBClusterSnapshots_snapshotType :: Lens' DescribeDBClusterSnapshots (Maybe Text)

The type of cluster snapshots to be returned. You can specify one of the following values:

• automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
• manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.
• shared - Return all manual cluster snapshots that have been shared to your Amazon Web Services account.
• public - Return all cluster snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting theIncludePublic parameter to true.

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])

Provides a list of cluster snapshots.

describeDBClusterSnapshotsResponse_marker :: Lens' DescribeDBClusterSnapshotsResponse (Maybe Text)

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.

describeDBClusterSnapshotsResponse_httpStatus :: Lens' DescribeDBClusterSnapshotsResponse Int

The response's http status code.

DescribeDBClusters

describeDBClusters_dbClusterIdentifier :: Lens' DescribeDBClusters (Maybe Text)

The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.

Constraints:

• If provided, must match an existing DBClusterIdentifier.

describeDBClusters_filters :: Lens' DescribeDBClusters (Maybe [Filter])

A filter that specifies one or more clusters to describe.

Supported filters:

• db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.

describeDBClusters_marker :: Lens' DescribeDBClusters (Maybe Text)

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.

describeDBClusters_maxRecords :: Lens' DescribeDBClusters (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBClustersResponse_dbClusters :: Lens' DescribeDBClustersResponse (Maybe [DBCluster])

A list of clusters.

describeDBClustersResponse_marker :: Lens' DescribeDBClustersResponse (Maybe Text)

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.

describeDBClustersResponse_httpStatus :: Lens' DescribeDBClustersResponse Int

The response's http status code.

DescribeDBEngineVersions

describeDBEngineVersions_dbParameterGroupFamily :: Lens' DescribeDBEngineVersions (Maybe Text)

The name of a specific parameter group family to return details for.

Constraints:

• If provided, must match an existing DBParameterGroupFamily.

describeDBEngineVersions_defaultOnly :: Lens' DescribeDBEngineVersions (Maybe Bool)

Indicates that only the default version of the specified engine or engine and major version combination is returned.

describeDBEngineVersions_engine :: Lens' DescribeDBEngineVersions (Maybe Text)

The database engine to return.

describeDBEngineVersions_engineVersion :: Lens' DescribeDBEngineVersions (Maybe Text)

The database engine version to return.

Example: 3.6.0

describeDBEngineVersions_filters :: Lens' DescribeDBEngineVersions (Maybe [Filter])

This parameter is not currently supported.

describeDBEngineVersions_listSupportedCharacterSets :: Lens' DescribeDBEngineVersions (Maybe Bool)

If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

describeDBEngineVersions_listSupportedTimezones :: Lens' DescribeDBEngineVersions (Maybe Bool)

If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

describeDBEngineVersions_marker :: Lens' DescribeDBEngineVersions (Maybe Text)

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)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBEngineVersionsResponse_dbEngineVersions :: Lens' DescribeDBEngineVersionsResponse (Maybe [DBEngineVersion])

Detailed information about one or more engine versions.

describeDBEngineVersionsResponse_marker :: Lens' DescribeDBEngineVersionsResponse (Maybe Text)

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

The response's http status code.

DescribeDBInstances

describeDBInstances_dbInstanceIdentifier :: Lens' DescribeDBInstances (Maybe Text)

The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn't case sensitive.

Constraints:

• If provided, must match the identifier of an existing DBInstance.

describeDBInstances_filters :: Lens' DescribeDBInstances (Maybe [Filter])

A filter that specifies one or more instances to describe.

Supported filters:

• db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.
• db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.

describeDBInstances_marker :: Lens' DescribeDBInstances (Maybe Text)

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.

describeDBInstances_maxRecords :: Lens' DescribeDBInstances (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBInstancesResponse_dbInstances :: Lens' DescribeDBInstancesResponse (Maybe [DBInstance])

Detailed information about one or more instances.

describeDBInstancesResponse_marker :: Lens' DescribeDBInstancesResponse (Maybe Text)

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

The response's http status code.

DescribeDBSubnetGroups

describeDBSubnetGroups_dbSubnetGroupName :: Lens' DescribeDBSubnetGroups (Maybe Text)

The name of the subnet group to return details for.

describeDBSubnetGroups_filters :: Lens' DescribeDBSubnetGroups (Maybe [Filter])

This parameter is not currently supported.

describeDBSubnetGroups_marker :: Lens' DescribeDBSubnetGroups (Maybe Text)

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.

describeDBSubnetGroups_maxRecords :: Lens' DescribeDBSubnetGroups (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBSubnetGroupsResponse_dbSubnetGroups :: Lens' DescribeDBSubnetGroupsResponse (Maybe [DBSubnetGroup])

Detailed information about one or more subnet groups.

describeDBSubnetGroupsResponse_marker :: Lens' DescribeDBSubnetGroupsResponse (Maybe Text)

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

The response's http status code.

DescribeEngineDefaultClusterParameters

describeEngineDefaultClusterParameters_filters :: Lens' DescribeEngineDefaultClusterParameters (Maybe [Filter])

This parameter is not currently supported.

describeEngineDefaultClusterParameters_marker :: Lens' DescribeEngineDefaultClusterParameters (Maybe Text)

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.

describeEngineDefaultClusterParameters_maxRecords :: Lens' DescribeEngineDefaultClusterParameters (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

describeEngineDefaultClusterParameters_dbParameterGroupFamily :: Lens' DescribeEngineDefaultClusterParameters Text

The name of the cluster parameter group family to return the engine parameter information for.

describeEngineDefaultClusterParametersResponse_engineDefaults :: Lens' DescribeEngineDefaultClusterParametersResponse (Maybe EngineDefaults)

Undocumented member.

describeEngineDefaultClusterParametersResponse_httpStatus :: Lens' DescribeEngineDefaultClusterParametersResponse Int

The response's http status code.

DescribeEventCategories

describeEventCategories_filters :: Lens' DescribeEventCategories (Maybe [Filter])

This parameter is not currently supported.

describeEventCategories_sourceType :: Lens' DescribeEventCategories (Maybe Text)

The type of source that is generating the events.

Valid values: db-instance, db-parameter-group, db-security-group

describeEventCategoriesResponse_eventCategoriesMapList :: Lens' DescribeEventCategoriesResponse (Maybe [EventCategoriesMap])

A list of event category maps.

describeEventCategoriesResponse_httpStatus :: Lens' DescribeEventCategoriesResponse Int

The response's http status code.

DescribeEventSubscriptions

describeEventSubscriptions_filters :: Lens' DescribeEventSubscriptions (Maybe [Filter])

This parameter is not currently supported.

describeEventSubscriptions_marker :: Lens' DescribeEventSubscriptions (Maybe Text)

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.

describeEventSubscriptions_maxRecords :: Lens' DescribeEventSubscriptions (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

describeEventSubscriptions_subscriptionName :: Lens' DescribeEventSubscriptions (Maybe Text)

The name of the Amazon DocumentDB event notification subscription that you want to describe.

describeEventSubscriptionsResponse_eventSubscriptionsList :: Lens' DescribeEventSubscriptionsResponse (Maybe [EventSubscription])

A list of event subscriptions.

describeEventSubscriptionsResponse_marker :: Lens' DescribeEventSubscriptionsResponse (Maybe Text)

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.

describeEventSubscriptionsResponse_httpStatus :: Lens' DescribeEventSubscriptionsResponse Int

The response's http status code.

DescribeEvents

describeEvents_duration :: Lens' DescribeEvents (Maybe Int)

The number of minutes to retrieve events for.

Default: 60

describeEvents_endTime :: Lens' DescribeEvents (Maybe UTCTime)

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

describeEvents_eventCategories :: Lens' DescribeEvents (Maybe [Text])

A list of event categories that trigger notifications for an event notification subscription.

describeEvents_filters :: Lens' DescribeEvents (Maybe [Filter])

This parameter is not currently supported.

describeEvents_marker :: Lens' DescribeEvents (Maybe Text)

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.

describeEvents_maxRecords :: Lens' DescribeEvents (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

describeEvents_sourceIdentifier :: Lens' DescribeEvents (Maybe Text)

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 provided, SourceType must also be provided.
• If the source type is DBInstance, a DBInstanceIdentifier must be provided.
• If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.
• If the source type is DBParameterGroup, a DBParameterGroupName must be provided.
• If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.
• Cannot end with a hyphen or contain two consecutive hyphens.

describeEvents_sourceType :: Lens' DescribeEvents (Maybe SourceType)

The event source to retrieve events for. If no value is specified, all events are returned.

describeEvents_startTime :: Lens' DescribeEvents (Maybe UTCTime)

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

describeEventsResponse_events :: Lens' DescribeEventsResponse (Maybe [Event])

Detailed information about one or more events.

describeEventsResponse_marker :: Lens' DescribeEventsResponse (Maybe Text)

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.

describeEventsResponse_httpStatus :: Lens' DescribeEventsResponse Int

The response's http status code.

DescribeGlobalClusters

describeGlobalClusters_filters :: Lens' DescribeGlobalClusters (Maybe [Filter])

A filter that specifies one or more global DB clusters to describe.

Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

describeGlobalClusters_globalClusterIdentifier :: Lens' DescribeGlobalClusters (Maybe Text)

The user-supplied cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case-sensitive.

describeGlobalClusters_marker :: Lens' DescribeGlobalClusters (Maybe Text)

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)

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.

describeGlobalClustersResponse_globalClusters :: Lens' DescribeGlobalClustersResponse (Maybe [GlobalCluster])

describeGlobalClustersResponse_marker :: Lens' DescribeGlobalClustersResponse (Maybe Text)

describeGlobalClustersResponse_httpStatus :: Lens' DescribeGlobalClustersResponse Int

The response's http status code.

DescribeOrderableDBInstanceOptions

describeOrderableDBInstanceOptions_dbInstanceClass :: Lens' DescribeOrderableDBInstanceOptions (Maybe Text)

The instance class filter value. Specify this parameter to show only the available offerings that match the specified instance class.

describeOrderableDBInstanceOptions_engineVersion :: Lens' DescribeOrderableDBInstanceOptions (Maybe Text)

The engine version filter value. Specify this parameter to show only the available offerings that match the specified engine version.

describeOrderableDBInstanceOptions_filters :: Lens' DescribeOrderableDBInstanceOptions (Maybe [Filter])

This parameter is not currently supported.

describeOrderableDBInstanceOptions_licenseModel :: Lens' DescribeOrderableDBInstanceOptions (Maybe Text)

The license model filter value. Specify this parameter to show only the available offerings that match the specified license model.

describeOrderableDBInstanceOptions_marker :: Lens' DescribeOrderableDBInstanceOptions (Maybe Text)

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.

describeOrderableDBInstanceOptions_maxRecords :: Lens' DescribeOrderableDBInstanceOptions (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

describeOrderableDBInstanceOptions_vpc :: Lens' DescribeOrderableDBInstanceOptions (Maybe Bool)

The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

describeOrderableDBInstanceOptions_engine :: Lens' DescribeOrderableDBInstanceOptions Text

The name of the engine to retrieve instance options for.

describeOrderableDBInstanceOptionsResponse_marker :: Lens' DescribeOrderableDBInstanceOptionsResponse (Maybe Text)

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.

describeOrderableDBInstanceOptionsResponse_orderableDBInstanceOptions :: Lens' DescribeOrderableDBInstanceOptionsResponse (Maybe [OrderableDBInstanceOption])

The options that are available for a particular orderable instance.

describeOrderableDBInstanceOptionsResponse_httpStatus :: Lens' DescribeOrderableDBInstanceOptionsResponse Int

The response's http status code.

DescribePendingMaintenanceActions

describePendingMaintenanceActions_filters :: Lens' DescribePendingMaintenanceActions (Maybe [Filter])

A filter that specifies one or more resources to return pending maintenance actions for.

Supported filters:

• db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only pending maintenance actions for the clusters identified by these ARNs.
• db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only pending maintenance actions for the DB instances identified by these ARNs.

describePendingMaintenanceActions_marker :: Lens' DescribePendingMaintenanceActions (Maybe Text)

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.

describePendingMaintenanceActions_maxRecords :: Lens' DescribePendingMaintenanceActions (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

describePendingMaintenanceActions_resourceIdentifier :: Lens' DescribePendingMaintenanceActions (Maybe Text)

The ARN of a resource to return pending maintenance actions for.

describePendingMaintenanceActionsResponse_marker :: Lens' DescribePendingMaintenanceActionsResponse (Maybe Text)

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.

describePendingMaintenanceActionsResponse_pendingMaintenanceActions :: Lens' DescribePendingMaintenanceActionsResponse (Maybe [ResourcePendingMaintenanceActions])

The maintenance actions to be applied.

describePendingMaintenanceActionsResponse_httpStatus :: Lens' DescribePendingMaintenanceActionsResponse Int

The response's http status code.

FailoverDBCluster

failoverDBCluster_dbClusterIdentifier :: Lens' FailoverDBCluster (Maybe Text)

A cluster identifier to force a failover for. This parameter is not case sensitive.

Constraints:

• Must match the identifier of an existing DBCluster.

failoverDBCluster_targetDBInstanceIdentifier :: Lens' FailoverDBCluster (Maybe Text)

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.

failoverDBClusterResponse_dbCluster :: Lens' FailoverDBClusterResponse (Maybe DBCluster)

Undocumented member.

failoverDBClusterResponse_httpStatus :: Lens' FailoverDBClusterResponse Int

The response's http status code.

ListTagsForResource

listTagsForResource_filters :: Lens' ListTagsForResource (Maybe [Filter])

This parameter is not currently supported.

listTagsForResource_resourceName :: Lens' ListTagsForResource Text

The Amazon DocumentDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).

listTagsForResourceResponse_tagList :: Lens' ListTagsForResourceResponse (Maybe [Tag])

A list of one or more tags.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int

The response's http status code.

ModifyDBCluster

modifyDBCluster_applyImmediately :: Lens' ModifyDBCluster (Maybe Bool)

A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If this parameter is set to false, changes to the cluster are applied during the next maintenance window.

The ApplyImmediately parameter affects only the NewDBClusterIdentifier and MasterUserPassword values. If you set this parameter value to false, the changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

modifyDBCluster_backupRetentionPeriod :: Lens' ModifyDBCluster (Maybe Int)

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

Default: 1

Constraints:

• Must be a value from 1 to 35.

modifyDBCluster_cloudwatchLogsExportConfiguration :: Lens' ModifyDBCluster (Maybe CloudwatchLogsExportConfiguration)

The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs.

modifyDBCluster_dbClusterParameterGroupName :: Lens' ModifyDBCluster (Maybe Text)

The name of the cluster parameter group to use for the cluster.

modifyDBCluster_deletionProtection :: Lens' ModifyDBCluster (Maybe Bool)

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

modifyDBCluster_engineVersion :: Lens' ModifyDBCluster (Maybe Text)

The version number of the database engine to which you want to upgrade. Modifying engine version is not supported on Amazon DocumentDB.

modifyDBCluster_masterUserPassword :: Lens' ModifyDBCluster (Maybe Text)

The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

modifyDBCluster_newDBClusterIdentifier :: Lens' ModifyDBCluster (Maybe Text)

The new cluster identifier for the cluster when renaming a 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.
• Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster2

modifyDBCluster_port :: Lens' ModifyDBCluster (Maybe Int)

The port number on which the cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original cluster.

modifyDBCluster_preferredBackupWindow :: Lens' ModifyDBCluster (Maybe Text)

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

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.

Constraints:

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

modifyDBCluster_preferredMaintenanceWindow :: Lens' ModifyDBCluster (Maybe Text)

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

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

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon 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.

modifyDBCluster_vpcSecurityGroupIds :: Lens' ModifyDBCluster (Maybe [Text])

A list of virtual private cloud (VPC) security groups that the cluster will belong to.

modifyDBCluster_dbClusterIdentifier :: Lens' ModifyDBCluster Text

The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.

Constraints:

• Must match the identifier of an existing DBCluster.

modifyDBClusterResponse_dbCluster :: Lens' ModifyDBClusterResponse (Maybe DBCluster)

Undocumented member.

modifyDBClusterResponse_httpStatus :: Lens' ModifyDBClusterResponse Int

The response's http status code.

ModifyDBClusterParameterGroup

modifyDBClusterParameterGroup_dbClusterParameterGroupName :: Lens' ModifyDBClusterParameterGroup Text

The name of the cluster parameter group to modify.

modifyDBClusterParameterGroup_parameters :: Lens' ModifyDBClusterParameterGroup [Parameter]

A list of parameters in the cluster parameter group to modify.

dbClusterParameterGroupNameMessage_dbClusterParameterGroupName :: Lens' DBClusterParameterGroupNameMessage (Maybe Text)

The name of a cluster parameter group.

Constraints:

• Must be from 1 to 255 letters or numbers.
• The first character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

This value is stored as a lowercase string.

ModifyDBClusterSnapshotAttribute

modifyDBClusterSnapshotAttribute_valuesToAdd :: Lens' ModifyDBClusterSnapshotAttribute (Maybe [Text])

A list of cluster snapshot attributes to add to the attribute specified by AttributeName.

To authorize other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this list to include one or more Amazon Web Services account IDs. To make the manual cluster snapshot restorable by any Amazon Web Services account, set it to all. Do not add the all value for any manual cluster snapshots that contain private information that you don't want to be available to all Amazon Web Services accounts.

modifyDBClusterSnapshotAttribute_valuesToRemove :: Lens' ModifyDBClusterSnapshotAttribute (Maybe [Text])

A list of 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 cluster snapshot, set this list to include one or more Amazon Web Services account identifiers. To remove authorization for any Amazon Web Services account to copy or restore the cluster snapshot, set it to all . 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 cluster snapshot.

modifyDBClusterSnapshotAttribute_dbClusterSnapshotIdentifier :: Lens' ModifyDBClusterSnapshotAttribute Text

The identifier for the cluster snapshot to modify the attributes for.

modifyDBClusterSnapshotAttribute_attributeName :: Lens' ModifyDBClusterSnapshotAttribute Text

The name of the cluster snapshot attribute to modify.

To manage authorization for other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this value to restore.

modifyDBClusterSnapshotAttributeResponse_dbClusterSnapshotAttributesResult :: Lens' ModifyDBClusterSnapshotAttributeResponse (Maybe DBClusterSnapshotAttributesResult)

Undocumented member.

modifyDBClusterSnapshotAttributeResponse_httpStatus :: Lens' ModifyDBClusterSnapshotAttributeResponse Int

The response's http status code.

ModifyDBInstance

modifyDBInstance_applyImmediately :: Lens' ModifyDBInstance (Maybe Bool)

Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the instance.

If this parameter is set to false, changes to the instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.

Default: false

modifyDBInstance_autoMinorVersionUpgrade :: Lens' ModifyDBInstance (Maybe Bool)

This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

modifyDBInstance_cACertificateIdentifier :: Lens' ModifyDBInstance (Maybe Text)

Indicates the certificate that needs to be associated with the instance.

modifyDBInstance_copyTagsToSnapshot :: Lens' ModifyDBInstance (Maybe Bool)

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.

modifyDBInstance_dbInstanceClass :: Lens' ModifyDBInstance (Maybe Text)

The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all Amazon Web Services Regions.

If you modify the instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

Default: Uses existing setting.

modifyDBInstance_enablePerformanceInsights :: Lens' ModifyDBInstance (Maybe Bool)

A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

modifyDBInstance_newDBInstanceIdentifier :: Lens' ModifyDBInstance (Maybe Text)

The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. 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.
• Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

modifyDBInstance_performanceInsightsKMSKeyId :: Lens' ModifyDBInstance (Maybe Text)

The KMS key identifier for encryption of Performance Insights data.

The 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 DocumentDB 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.

modifyDBInstance_preferredMaintenanceWindow :: Lens' ModifyDBInstance (Maybe Text)

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, changing this parameter causes a reboot of the instance. If you are 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 that pending changes are applied.

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_promotionTier :: Lens' ModifyDBInstance (Maybe Int)

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

modifyDBInstance_dbInstanceIdentifier :: Lens' ModifyDBInstance Text

The 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)

Undocumented member.

modifyDBInstanceResponse_httpStatus :: Lens' ModifyDBInstanceResponse Int

The response's http status code.

ModifyDBSubnetGroup

modifyDBSubnetGroup_dbSubnetGroupDescription :: Lens' ModifyDBSubnetGroup (Maybe Text)

The description for the subnet group.

modifyDBSubnetGroup_dbSubnetGroupName :: Lens' ModifyDBSubnetGroup Text

The name for the 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: mySubnetgroup

modifyDBSubnetGroup_subnetIds :: Lens' ModifyDBSubnetGroup [Text]

The Amazon EC2 subnet IDs for the subnet group.

modifyDBSubnetGroupResponse_dbSubnetGroup :: Lens' ModifyDBSubnetGroupResponse (Maybe DBSubnetGroup)

Undocumented member.

modifyDBSubnetGroupResponse_httpStatus :: Lens' ModifyDBSubnetGroupResponse Int

The response's http status code.

ModifyEventSubscription

modifyEventSubscription_enabled :: Lens' ModifyEventSubscription (Maybe Bool)

A Boolean value; set to true to activate the subscription.

modifyEventSubscription_eventCategories :: Lens' ModifyEventSubscription (Maybe [Text])

A list of event categories for a SourceType that you want to subscribe to.

modifyEventSubscription_snsTopicArn :: Lens' ModifyEventSubscription (Maybe Text)

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)

The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, set this parameter to db-instance. If this value is not specified, all events are returned.

Valid values: db-instance, db-parameter-group, db-security-group

modifyEventSubscription_subscriptionName :: Lens' ModifyEventSubscription Text

The name of the Amazon DocumentDB event notification subscription.

modifyEventSubscriptionResponse_eventSubscription :: Lens' ModifyEventSubscriptionResponse (Maybe EventSubscription)

Undocumented member.

modifyEventSubscriptionResponse_httpStatus :: Lens' ModifyEventSubscriptionResponse Int

The response's http status code.

ModifyGlobalCluster

modifyGlobalCluster_deletionProtection :: Lens' ModifyGlobalCluster (Maybe Bool)

Indicates if the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.

modifyGlobalCluster_newGlobalClusterIdentifier :: Lens' ModifyGlobalCluster (Maybe Text)

The new identifier for a global cluster when you modify a global cluster. This value is stored as a lowercase string.

• 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

modifyGlobalCluster_globalClusterIdentifier :: Lens' ModifyGlobalCluster Text

The identifier for the global cluster being modified. This parameter isn't case-sensitive.

Constraints:

• Must match the identifier of an existing global cluster.

modifyGlobalClusterResponse_globalCluster :: Lens' ModifyGlobalClusterResponse (Maybe GlobalCluster)

Undocumented member.

modifyGlobalClusterResponse_httpStatus :: Lens' ModifyGlobalClusterResponse Int

The response's http status code.

RebootDBInstance

rebootDBInstance_forceFailover :: Lens' RebootDBInstance (Maybe Bool)

When true, the reboot is conducted through a Multi-AZ failover.

Constraint: You can't specify true if the instance is not configured for Multi-AZ.

rebootDBInstance_dbInstanceIdentifier :: Lens' RebootDBInstance Text

The 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)

Undocumented member.

rebootDBInstanceResponse_httpStatus :: Lens' RebootDBInstanceResponse Int

The response's http status code.

RemoveFromGlobalCluster

removeFromGlobalCluster_globalClusterIdentifier :: Lens' RemoveFromGlobalCluster Text

The cluster identifier to detach from the Amazon DocumentDB global cluster.

removeFromGlobalCluster_dbClusterIdentifier :: Lens' RemoveFromGlobalCluster Text

The Amazon Resource Name (ARN) identifying the cluster that was detached from the Amazon DocumentDB global cluster.

removeFromGlobalClusterResponse_globalCluster :: Lens' RemoveFromGlobalClusterResponse (Maybe GlobalCluster)

Undocumented member.

removeFromGlobalClusterResponse_httpStatus :: Lens' RemoveFromGlobalClusterResponse Int

The response's http status code.

RemoveSourceIdentifierFromSubscription

removeSourceIdentifierFromSubscription_subscriptionName :: Lens' RemoveSourceIdentifierFromSubscription Text

The name of the Amazon DocumentDB event notification subscription that you want to remove a source identifier from.

removeSourceIdentifierFromSubscription_sourceIdentifier :: Lens' RemoveSourceIdentifierFromSubscription Text

The source identifier to be removed from the subscription, such as the instance identifier for an instance, or the name of a security group.

removeSourceIdentifierFromSubscriptionResponse_eventSubscription :: Lens' RemoveSourceIdentifierFromSubscriptionResponse (Maybe EventSubscription)

Undocumented member.

removeSourceIdentifierFromSubscriptionResponse_httpStatus :: Lens' RemoveSourceIdentifierFromSubscriptionResponse Int

The response's http status code.

RemoveTagsFromResource

removeTagsFromResource_resourceName :: Lens' RemoveTagsFromResource Text

The Amazon DocumentDB resource that the tags are removed from. This value is an Amazon Resource Name (ARN).

removeTagsFromResource_tagKeys :: Lens' RemoveTagsFromResource [Text]

The tag key (name) of the tag to be removed.

ResetDBClusterParameterGroup

resetDBClusterParameterGroup_parameters :: Lens' ResetDBClusterParameterGroup (Maybe [Parameter])

A list of parameter names in the cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is set to true.

resetDBClusterParameterGroup_resetAllParameters :: Lens' ResetDBClusterParameterGroup (Maybe Bool)

A value that is set to true to reset all parameters in the cluster parameter group to their default values, and false otherwise. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.

resetDBClusterParameterGroup_dbClusterParameterGroupName :: Lens' ResetDBClusterParameterGroup Text

The name of the cluster parameter group to reset.

dbClusterParameterGroupNameMessage_dbClusterParameterGroupName :: Lens' DBClusterParameterGroupNameMessage (Maybe Text)

The name of a cluster parameter group.

Constraints:

• Must be from 1 to 255 letters or numbers.
• The first character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

This value is stored as a lowercase string.

RestoreDBClusterFromSnapshot

restoreDBClusterFromSnapshot_availabilityZones :: Lens' RestoreDBClusterFromSnapshot (Maybe [Text])

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

restoreDBClusterFromSnapshot_dbSubnetGroupName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text)

The name of the subnet group to use for the new cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

restoreDBClusterFromSnapshot_deletionProtection :: Lens' RestoreDBClusterFromSnapshot (Maybe Bool)

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

restoreDBClusterFromSnapshot_enableCloudwatchLogsExports :: Lens' RestoreDBClusterFromSnapshot (Maybe [Text])

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

restoreDBClusterFromSnapshot_engineVersion :: Lens' RestoreDBClusterFromSnapshot (Maybe Text)

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

restoreDBClusterFromSnapshot_kmsKeyId :: Lens' RestoreDBClusterFromSnapshot (Maybe Text)

The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.

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

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

• If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the snapshot or the cluster snapshot.
• If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

restoreDBClusterFromSnapshot_port :: Lens' RestoreDBClusterFromSnapshot (Maybe Int)

The port number on which the new cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original cluster.

restoreDBClusterFromSnapshot_tags :: Lens' RestoreDBClusterFromSnapshot (Maybe [Tag])

The tags to be assigned to the restored cluster.

restoreDBClusterFromSnapshot_vpcSecurityGroupIds :: Lens' RestoreDBClusterFromSnapshot (Maybe [Text])

A list of virtual private cloud (VPC) security groups that the new cluster will belong to.

restoreDBClusterFromSnapshot_dbClusterIdentifier :: Lens' RestoreDBClusterFromSnapshot Text

The name of the cluster to create from the snapshot or cluster snapshot. This parameter isn't case sensitive.

Constraints:

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

Example: my-snapshot-id

restoreDBClusterFromSnapshot_snapshotIdentifier :: Lens' RestoreDBClusterFromSnapshot Text

The identifier for the snapshot or cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

Constraints:

• Must match the identifier of an existing snapshot.

restoreDBClusterFromSnapshot_engine :: Lens' RestoreDBClusterFromSnapshot Text

The database engine to use for the new cluster.

Default: The same as source.

Constraint: Must be compatible with the engine of the source.

restoreDBClusterFromSnapshotResponse_dbCluster :: Lens' RestoreDBClusterFromSnapshotResponse (Maybe DBCluster)

Undocumented member.

restoreDBClusterFromSnapshotResponse_httpStatus :: Lens' RestoreDBClusterFromSnapshotResponse Int

The response's http status code.

RestoreDBClusterToPointInTime

restoreDBClusterToPointInTime_dbSubnetGroupName :: Lens' RestoreDBClusterToPointInTime (Maybe Text)

The subnet group name to use for the new cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

restoreDBClusterToPointInTime_deletionProtection :: Lens' RestoreDBClusterToPointInTime (Maybe Bool)

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

restoreDBClusterToPointInTime_enableCloudwatchLogsExports :: Lens' RestoreDBClusterToPointInTime (Maybe [Text])

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

restoreDBClusterToPointInTime_kmsKeyId :: Lens' RestoreDBClusterToPointInTime (Maybe Text)

The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.

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

You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

• If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the source cluster.
• If the cluster is not encrypted, then the restored cluster is not encrypted.

If DBClusterIdentifier refers to a cluster that is not encrypted, then the restore request is rejected.

restoreDBClusterToPointInTime_port :: Lens' RestoreDBClusterToPointInTime (Maybe Int)

The port number on which the new cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The default port for the engine.

restoreDBClusterToPointInTime_restoreToTime :: Lens' RestoreDBClusterToPointInTime (Maybe UTCTime)

The date and time to restore the cluster to.

Valid values: A time in Universal Coordinated Time (UTC) format.

Constraints:

• Must be before the latest restorable time for the instance.
• Must be specified if the UseLatestRestorableTime parameter is not provided.
• Cannot be specified if the UseLatestRestorableTime parameter is true.
• Cannot be specified if the RestoreType parameter is copy-on-write.

Example: 2015-03-07T23:45:00Z

restoreDBClusterToPointInTime_restoreType :: Lens' RestoreDBClusterToPointInTime (Maybe Text)

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.

If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

restoreDBClusterToPointInTime_tags :: Lens' RestoreDBClusterToPointInTime (Maybe [Tag])

The tags to be assigned to the restored cluster.

restoreDBClusterToPointInTime_useLatestRestorableTime :: Lens' RestoreDBClusterToPointInTime (Maybe Bool)

A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if the RestoreToTime parameter is provided.

restoreDBClusterToPointInTime_vpcSecurityGroupIds :: Lens' RestoreDBClusterToPointInTime (Maybe [Text])

A list of VPC security groups that the new cluster belongs to.

restoreDBClusterToPointInTime_dbClusterIdentifier :: Lens' RestoreDBClusterToPointInTime Text

The name of the new cluster to be created.

Constraints:

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

restoreDBClusterToPointInTime_sourceDBClusterIdentifier :: Lens' RestoreDBClusterToPointInTime Text

The identifier of the source cluster from which to restore.

Constraints:

• Must match the identifier of an existing DBCluster.

restoreDBClusterToPointInTimeResponse_dbCluster :: Lens' RestoreDBClusterToPointInTimeResponse (Maybe DBCluster)

Undocumented member.

restoreDBClusterToPointInTimeResponse_httpStatus :: Lens' RestoreDBClusterToPointInTimeResponse Int

The response's http status code.

StartDBCluster

startDBCluster_dbClusterIdentifier :: Lens' StartDBCluster Text

The identifier of the cluster to restart. Example: docdb-2019-05-28-15-24-52

startDBClusterResponse_dbCluster :: Lens' StartDBClusterResponse (Maybe DBCluster)

Undocumented member.

startDBClusterResponse_httpStatus :: Lens' StartDBClusterResponse Int

The response's http status code.

StopDBCluster

stopDBCluster_dbClusterIdentifier :: Lens' StopDBCluster Text

The identifier of the cluster to stop. Example: docdb-2019-05-28-15-24-52

stopDBClusterResponse_dbCluster :: Lens' StopDBClusterResponse (Maybe DBCluster)

Undocumented member.

stopDBClusterResponse_httpStatus :: Lens' StopDBClusterResponse Int

The response's http status code.

Types

AvailabilityZone

availabilityZone_name :: Lens' AvailabilityZone (Maybe Text)

The name of the Availability Zone.

Certificate

certificate_certificateArn :: Lens' Certificate (Maybe Text)

The Amazon Resource Name (ARN) for the certificate.

Example: arn:aws:rds:us-east-1::cert:rds-ca-2019

certificate_certificateIdentifier :: Lens' Certificate (Maybe Text)

The unique key that identifies a certificate.

Example: rds-ca-2019

certificate_certificateType :: Lens' Certificate (Maybe Text)

The type of the certificate.

Example: CA

certificate_thumbprint :: Lens' Certificate (Maybe Text)

The thumbprint of the certificate.

certificate_validFrom :: Lens' Certificate (Maybe UTCTime)

The starting date-time from which the certificate is valid.

Example: 2019-07-31T17:57:09Z

certificate_validTill :: Lens' Certificate (Maybe UTCTime)

The date-time after which the certificate is no longer valid.

Example: 2024-07-31T17:57:09Z

CloudwatchLogsExportConfiguration

cloudwatchLogsExportConfiguration_disableLogTypes :: Lens' CloudwatchLogsExportConfiguration (Maybe [Text])

The list of log types to disable.

cloudwatchLogsExportConfiguration_enableLogTypes :: Lens' CloudwatchLogsExportConfiguration (Maybe [Text])

The list of log types to enable.

DBCluster

dbCluster_associatedRoles :: Lens' DBCluster (Maybe [DBClusterRole])

Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

dbCluster_availabilityZones :: Lens' DBCluster (Maybe [Text])

Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

dbCluster_backupRetentionPeriod :: Lens' DBCluster (Maybe Int)

Specifies the number of days for which automatic snapshots are retained.

dbCluster_cloneGroupId :: Lens' DBCluster (Maybe Text)

Identifies the clone group to which the DB cluster is associated.

dbCluster_clusterCreateTime :: Lens' DBCluster (Maybe UTCTime)

Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

dbCluster_dbClusterArn :: Lens' DBCluster (Maybe Text)

The Amazon Resource Name (ARN) for the cluster.

dbCluster_dbClusterIdentifier :: Lens' DBCluster (Maybe Text)

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

dbCluster_dbClusterMembers :: Lens' DBCluster (Maybe [DBClusterMember])

Provides the list of instances that make up the cluster.

dbCluster_dbClusterParameterGroup :: Lens' DBCluster (Maybe Text)

Specifies the name of the cluster parameter group for the cluster.

dbCluster_dbSubnetGroup :: Lens' DBCluster (Maybe Text)

Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.

dbCluster_dbClusterResourceId :: Lens' DBCluster (Maybe Text)

The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.

dbCluster_deletionProtection :: Lens' DBCluster (Maybe Bool)

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

dbCluster_earliestRestorableTime :: Lens' DBCluster (Maybe UTCTime)

The earliest time to which a database can be restored with point-in-time restore.

dbCluster_enabledCloudwatchLogsExports :: Lens' DBCluster (Maybe [Text])

A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

dbCluster_endpoint :: Lens' DBCluster (Maybe Text)

Specifies the connection endpoint for the primary instance of the cluster.

dbCluster_engine :: Lens' DBCluster (Maybe Text)

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

dbCluster_engineVersion :: Lens' DBCluster (Maybe Text)

Indicates the database engine version.

dbCluster_hostedZoneId :: Lens' DBCluster (Maybe Text)

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

dbCluster_kmsKeyId :: Lens' DBCluster (Maybe Text)

If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.

dbCluster_latestRestorableTime :: Lens' DBCluster (Maybe UTCTime)

Specifies the latest time to which a database can be restored with point-in-time restore.

dbCluster_masterUsername :: Lens' DBCluster (Maybe Text)

Contains the master user name for the cluster.

dbCluster_multiAZ :: Lens' DBCluster (Maybe Bool)

Specifies whether the cluster has instances in multiple Availability Zones.

dbCluster_percentProgress :: Lens' DBCluster (Maybe Text)

Specifies the progress of the operation as a percentage.

dbCluster_port :: Lens' DBCluster (Maybe Int)

Specifies the port that the database engine is listening on.

dbCluster_preferredBackupWindow :: Lens' DBCluster (Maybe Text)

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)

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

dbCluster_readReplicaIdentifiers :: Lens' DBCluster (Maybe [Text])

Contains one or more identifiers of the secondary clusters that are associated with this cluster.

dbCluster_readerEndpoint :: Lens' DBCluster (Maybe Text)

The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

If a failover occurs, and the Amazon DocumentDB 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 Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

dbCluster_replicationSourceIdentifier :: Lens' DBCluster (Maybe Text)

Contains the identifier of the source cluster if this cluster is a secondary cluster.

dbCluster_status :: Lens' DBCluster (Maybe Text)

Specifies the current state of this cluster.

dbCluster_storageEncrypted :: Lens' DBCluster (Maybe Bool)

Specifies whether the cluster is encrypted.

dbCluster_vpcSecurityGroups :: Lens' DBCluster (Maybe [VpcSecurityGroupMembership])

Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

DBClusterMember

dbClusterMember_dbClusterParameterGroupStatus :: Lens' DBClusterMember (Maybe Text)

Specifies the status of the cluster parameter group for this member of the DB cluster.

dbClusterMember_dbInstanceIdentifier :: Lens' DBClusterMember (Maybe Text)

Specifies the instance identifier for this member of the cluster.

dbClusterMember_isClusterWriter :: Lens' DBClusterMember (Maybe Bool)

A value that is true if the cluster member is the primary instance for the cluster and false otherwise.

dbClusterMember_promotionTier :: Lens' DBClusterMember (Maybe Int)

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

DBClusterParameterGroup

dbClusterParameterGroup_dbClusterParameterGroupArn :: Lens' DBClusterParameterGroup (Maybe Text)

The Amazon Resource Name (ARN) for the cluster parameter group.

dbClusterParameterGroup_dbClusterParameterGroupName :: Lens' DBClusterParameterGroup (Maybe Text)

Provides the name of the cluster parameter group.

dbClusterParameterGroup_dbParameterGroupFamily :: Lens' DBClusterParameterGroup (Maybe Text)

Provides the name of the parameter group family that this cluster parameter group is compatible with.

dbClusterParameterGroup_description :: Lens' DBClusterParameterGroup (Maybe Text)

Provides the customer-specified description for this cluster parameter group.

DBClusterParameterGroupNameMessage

dbClusterParameterGroupNameMessage_dbClusterParameterGroupName :: Lens' DBClusterParameterGroupNameMessage (Maybe Text)

The name of a cluster parameter group.

Constraints:

• Must be from 1 to 255 letters or numbers.
• The first character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

This value is stored as a lowercase string.

DBClusterRole

dbClusterRole_roleArn :: Lens' DBClusterRole (Maybe Text)

The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.

dbClusterRole_status :: Lens' DBClusterRole (Maybe Text)

Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:

• ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.
• PENDING - The IAMrole ARN is being associated with the cluster.
• INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.

DBClusterSnapshot

dbClusterSnapshot_availabilityZones :: Lens' DBClusterSnapshot (Maybe [Text])

Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.

dbClusterSnapshot_clusterCreateTime :: Lens' DBClusterSnapshot (Maybe UTCTime)

Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

dbClusterSnapshot_dbClusterIdentifier :: Lens' DBClusterSnapshot (Maybe Text)

Specifies the cluster identifier of the cluster that this cluster snapshot was created from.

dbClusterSnapshot_dbClusterSnapshotArn :: Lens' DBClusterSnapshot (Maybe Text)

The Amazon Resource Name (ARN) for the cluster snapshot.

dbClusterSnapshot_dbClusterSnapshotIdentifier :: Lens' DBClusterSnapshot (Maybe Text)

Specifies the identifier for the cluster snapshot.

dbClusterSnapshot_engine :: Lens' DBClusterSnapshot (Maybe Text)

Specifies the name of the database engine.

dbClusterSnapshot_engineVersion :: Lens' DBClusterSnapshot (Maybe Text)

Provides the version of the database engine for this cluster snapshot.

dbClusterSnapshot_kmsKeyId :: Lens' DBClusterSnapshot (Maybe Text)

If StorageEncrypted is true, the KMS key identifier for the encrypted cluster snapshot.

dbClusterSnapshot_masterUsername :: Lens' DBClusterSnapshot (Maybe Text)

Provides the master user name for the cluster snapshot.

dbClusterSnapshot_percentProgress :: Lens' DBClusterSnapshot (Maybe Int)

Specifies the percentage of the estimated data that has been transferred.

dbClusterSnapshot_port :: Lens' DBClusterSnapshot (Maybe Int)

Specifies the port that the cluster was listening on at the time of the snapshot.

dbClusterSnapshot_snapshotCreateTime :: Lens' DBClusterSnapshot (Maybe UTCTime)

Provides the time when the snapshot was taken, in UTC.

dbClusterSnapshot_snapshotType :: Lens' DBClusterSnapshot (Maybe Text)

Provides the type of the cluster snapshot.

dbClusterSnapshot_sourceDBClusterSnapshotArn :: Lens' DBClusterSnapshot (Maybe Text)

If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.

dbClusterSnapshot_status :: Lens' DBClusterSnapshot (Maybe Text)

Specifies the status of this cluster snapshot.

dbClusterSnapshot_storageEncrypted :: Lens' DBClusterSnapshot (Maybe Bool)

Specifies whether the cluster snapshot is encrypted.

dbClusterSnapshot_vpcId :: Lens' DBClusterSnapshot (Maybe Text)

Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.

DBClusterSnapshotAttribute

dbClusterSnapshotAttribute_attributeName :: Lens' DBClusterSnapshotAttribute (Maybe Text)

The name of the manual 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 cluster snapshot.

dbClusterSnapshotAttribute_attributeValues :: Lens' DBClusterSnapshotAttribute (Maybe [Text])

The values for the manual 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 cluster snapshot. If a value of all is in the list, then the manual cluster snapshot is public and available for any Amazon Web Services account to copy or restore.

DBClusterSnapshotAttributesResult

dbClusterSnapshotAttributesResult_dbClusterSnapshotAttributes :: Lens' DBClusterSnapshotAttributesResult (Maybe [DBClusterSnapshotAttribute])

The list of attributes and values for the cluster snapshot.

dbClusterSnapshotAttributesResult_dbClusterSnapshotIdentifier :: Lens' DBClusterSnapshotAttributesResult (Maybe Text)

The identifier of the cluster snapshot that the attributes apply to.

DBEngineVersion

dbEngineVersion_dbEngineDescription :: Lens' DBEngineVersion (Maybe Text)

The description of the database engine.

dbEngineVersion_dbEngineVersionDescription :: Lens' DBEngineVersion (Maybe Text)

The description of the database engine version.

dbEngineVersion_dbParameterGroupFamily :: Lens' DBEngineVersion (Maybe Text)

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

dbEngineVersion_engine :: Lens' DBEngineVersion (Maybe Text)

The name of the database engine.

dbEngineVersion_engineVersion :: Lens' DBEngineVersion (Maybe Text)

The version number of the database engine.

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

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

dbEngineVersion_supportsLogExportsToCloudwatchLogs :: Lens' DBEngineVersion (Maybe Bool)

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

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

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

DBInstance

dbInstance_autoMinorVersionUpgrade :: Lens' DBInstance (Maybe Bool)

Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

dbInstance_availabilityZone :: Lens' DBInstance (Maybe Text)

Specifies the name of the Availability Zone that the instance is located in.

dbInstance_backupRetentionPeriod :: Lens' DBInstance (Maybe Int)

Specifies the number of days for which automatic snapshots are retained.

dbInstance_cACertificateIdentifier :: Lens' DBInstance (Maybe Text)

The identifier of the CA certificate for this DB instance.

dbInstance_copyTagsToSnapshot :: Lens' DBInstance (Maybe Bool)

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

dbInstance_dbClusterIdentifier :: Lens' DBInstance (Maybe Text)

Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

dbInstance_dbInstanceArn :: Lens' DBInstance (Maybe Text)

The Amazon Resource Name (ARN) for the instance.

dbInstance_dbInstanceClass :: Lens' DBInstance (Maybe Text)

Contains the name of the compute and memory capacity class of the instance.

dbInstance_dbInstanceIdentifier :: Lens' DBInstance (Maybe Text)

Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

dbInstance_dbInstanceStatus :: Lens' DBInstance (Maybe Text)

Specifies the current state of this database.

dbInstance_dbSubnetGroup :: Lens' DBInstance (Maybe DBSubnetGroup)

Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

dbInstance_dbiResourceId :: Lens' DBInstance (Maybe Text)

The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.

dbInstance_enabledCloudwatchLogsExports :: Lens' DBInstance (Maybe [Text])

A list of log types that this instance is configured to export to CloudWatch Logs.

dbInstance_endpoint :: Lens' DBInstance (Maybe Endpoint)

Specifies the connection endpoint.

dbInstance_engine :: Lens' DBInstance (Maybe Text)

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

dbInstance_engineVersion :: Lens' DBInstance (Maybe Text)

Indicates the database engine version.

dbInstance_instanceCreateTime :: Lens' DBInstance (Maybe UTCTime)

Provides the date and time that the instance was created.

dbInstance_kmsKeyId :: Lens' DBInstance (Maybe Text)

If StorageEncrypted is true, the KMS key identifier for the encrypted instance.

dbInstance_latestRestorableTime :: Lens' DBInstance (Maybe UTCTime)

Specifies the latest time to which a database can be restored with point-in-time restore.

dbInstance_pendingModifiedValues :: Lens' DBInstance (Maybe PendingModifiedValues)

Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

dbInstance_preferredBackupWindow :: Lens' DBInstance (Maybe Text)

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)

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

dbInstance_promotionTier :: Lens' DBInstance (Maybe Int)

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

dbInstance_publiclyAccessible :: Lens' DBInstance (Maybe Bool)

Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

dbInstance_statusInfos :: Lens' DBInstance (Maybe [DBInstanceStatusInfo])

The status of a read replica. If the instance is not a read replica, this is blank.

dbInstance_storageEncrypted :: Lens' DBInstance (Maybe Bool)

Specifies whether or not the instance is encrypted.

dbInstance_vpcSecurityGroups :: Lens' DBInstance (Maybe [VpcSecurityGroupMembership])

Provides a list of VPC security group elements that the instance belongs to.

DBInstanceStatusInfo

dbInstanceStatusInfo_message :: Lens' DBInstanceStatusInfo (Maybe Text)

Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

dbInstanceStatusInfo_normal :: Lens' DBInstanceStatusInfo (Maybe Bool)

A 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)

Status of the instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

dbInstanceStatusInfo_statusType :: Lens' DBInstanceStatusInfo (Maybe Text)

This value is currently "read replication."

DBSubnetGroup

dbSubnetGroup_dbSubnetGroupArn :: Lens' DBSubnetGroup (Maybe Text)

The Amazon Resource Name (ARN) for the DB subnet group.

dbSubnetGroup_dbSubnetGroupDescription :: Lens' DBSubnetGroup (Maybe Text)

Provides the description of the subnet group.

dbSubnetGroup_dbSubnetGroupName :: Lens' DBSubnetGroup (Maybe Text)

The name of the subnet group.

dbSubnetGroup_subnetGroupStatus :: Lens' DBSubnetGroup (Maybe Text)

Provides the status of the subnet group.

dbSubnetGroup_subnets :: Lens' DBSubnetGroup (Maybe [Subnet])

Detailed information about one or more subnets within a subnet group.

dbSubnetGroup_vpcId :: Lens' DBSubnetGroup (Maybe Text)

Provides the virtual private cloud (VPC) ID of the subnet group.

Endpoint

endpoint_address :: Lens' Endpoint (Maybe Text)

Specifies the DNS address of the instance.

endpoint_hostedZoneId :: Lens' Endpoint (Maybe Text)

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

endpoint_port :: Lens' Endpoint (Maybe Int)

Specifies the port that the database engine is listening on.

EngineDefaults

engineDefaults_dbParameterGroupFamily :: Lens' EngineDefaults (Maybe Text)

The name of the cluster parameter group family to return the engine parameter information for.

engineDefaults_marker :: Lens' EngineDefaults (Maybe Text)

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.

engineDefaults_parameters :: Lens' EngineDefaults (Maybe [Parameter])

The parameters of a particular cluster parameter group family.

Event

event_date :: Lens' Event (Maybe UTCTime)

Specifies the date and time of the event.

event_eventCategories :: Lens' Event (Maybe [Text])

Specifies the category for the event.

event_message :: Lens' Event (Maybe Text)

Provides the text of this event.

event_sourceArn :: Lens' Event (Maybe Text)

The Amazon Resource Name (ARN) for the event.

event_sourceIdentifier :: Lens' Event (Maybe Text)

Provides the identifier for the source of the event.

event_sourceType :: Lens' Event (Maybe SourceType)

Specifies the source type for this event.

EventCategoriesMap

eventCategoriesMap_eventCategories :: Lens' EventCategoriesMap (Maybe [Text])

The event categories for the specified source type.

eventCategoriesMap_sourceType :: Lens' EventCategoriesMap (Maybe Text)

The source type that the returned categories belong to.

EventSubscription

eventSubscription_custSubscriptionId :: Lens' EventSubscription (Maybe Text)

The Amazon DocumentDB event notification subscription ID.

eventSubscription_customerAwsId :: Lens' EventSubscription (Maybe Text)

The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.

eventSubscription_enabled :: Lens' EventSubscription (Maybe Bool)

A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.

eventSubscription_eventCategoriesList :: Lens' EventSubscription (Maybe [Text])

A list of event categories for the Amazon DocumentDB event notification subscription.

eventSubscription_eventSubscriptionArn :: Lens' EventSubscription (Maybe Text)

The Amazon Resource Name (ARN) for the event subscription.

eventSubscription_snsTopicArn :: Lens' EventSubscription (Maybe Text)

The topic ARN of the Amazon DocumentDB event notification subscription.

eventSubscription_sourceIdsList :: Lens' EventSubscription (Maybe [Text])

A list of source IDs for the Amazon DocumentDB event notification subscription.

eventSubscription_sourceType :: Lens' EventSubscription (Maybe Text)

The source type for the Amazon DocumentDB event notification subscription.

eventSubscription_status :: Lens' EventSubscription (Maybe Text)

The status of the Amazon DocumentDB event notification subscription.

Constraints:

Can be one of the following: creating, modifying, deleting, active, no-permission, topic-not-exist

The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.

eventSubscription_subscriptionCreationTime :: Lens' EventSubscription (Maybe Text)

The time at which the Amazon DocumentDB event notification subscription was created.

Filter

filter_name :: Lens' Filter Text

The name of the filter. Filter names are case sensitive.

filter_values :: Lens' Filter [Text]

One or more filter values. Filter values are case sensitive.

GlobalCluster

globalCluster_databaseName :: Lens' GlobalCluster (Maybe Text)

The default database name within the new global cluster.

globalCluster_deletionProtection :: Lens' GlobalCluster (Maybe Bool)

The deletion protection setting for the new global cluster.

globalCluster_engine :: Lens' GlobalCluster (Maybe Text)

The Amazon DocumentDB database engine used by the global cluster.

globalCluster_engineVersion :: Lens' GlobalCluster (Maybe Text)

Indicates the database engine version.

globalCluster_globalClusterArn :: Lens' GlobalCluster (Maybe Text)

The Amazon Resource Name (ARN) for the global cluster.

globalCluster_globalClusterIdentifier :: Lens' GlobalCluster (Maybe Text)

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

globalCluster_globalClusterMembers :: Lens' GlobalCluster (Maybe [GlobalClusterMember])

The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

globalCluster_globalClusterResourceId :: Lens' GlobalCluster (Maybe Text)

The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.

globalCluster_status :: Lens' GlobalCluster (Maybe Text)

Specifies the current state of this global cluster.

globalCluster_storageEncrypted :: Lens' GlobalCluster (Maybe Bool)

The storage encryption setting for the global cluster.

GlobalClusterMember

globalClusterMember_dbClusterArn :: Lens' GlobalClusterMember (Maybe Text)

The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.

globalClusterMember_isWriter :: Lens' GlobalClusterMember (Maybe Bool)

Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.

globalClusterMember_readers :: Lens' GlobalClusterMember (Maybe [Text])

The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global cluster.

OrderableDBInstanceOption

orderableDBInstanceOption_availabilityZones :: Lens' OrderableDBInstanceOption (Maybe [AvailabilityZone])

A list of Availability Zones for an instance.

orderableDBInstanceOption_dbInstanceClass :: Lens' OrderableDBInstanceOption (Maybe Text)

The instance class for an instance.

orderableDBInstanceOption_engine :: Lens' OrderableDBInstanceOption (Maybe Text)

The engine type of an instance.

orderableDBInstanceOption_engineVersion :: Lens' OrderableDBInstanceOption (Maybe Text)

The engine version of an instance.

orderableDBInstanceOption_licenseModel :: Lens' OrderableDBInstanceOption (Maybe Text)

The license model for an instance.

orderableDBInstanceOption_vpc :: Lens' OrderableDBInstanceOption (Maybe Bool)

Indicates whether an instance is in a virtual private cloud (VPC).

Parameter

parameter_allowedValues :: Lens' Parameter (Maybe Text)

Specifies the valid range of values for the parameter.

parameter_applyMethod :: Lens' Parameter (Maybe ApplyMethod)

Indicates when to apply parameter updates.

parameter_applyType :: Lens' Parameter (Maybe Text)

Specifies the engine-specific parameters type.

parameter_dataType :: Lens' Parameter (Maybe Text)

Specifies the valid data type for the parameter.

parameter_description :: Lens' Parameter (Maybe Text)

Provides a description of the parameter.

parameter_isModifiable :: Lens' Parameter (Maybe Bool)

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)

The earliest engine version to which the parameter can apply.

parameter_parameterName :: Lens' Parameter (Maybe Text)

Specifies the name of the parameter.

parameter_parameterValue :: Lens' Parameter (Maybe Text)

Specifies the value of the parameter.

parameter_source :: Lens' Parameter (Maybe Text)

Indicates the source of the parameter value.

PendingCloudwatchLogsExports

pendingCloudwatchLogsExports_logTypesToDisable :: Lens' PendingCloudwatchLogsExports (Maybe [Text])

Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.

pendingCloudwatchLogsExports_logTypesToEnable :: Lens' PendingCloudwatchLogsExports (Maybe [Text])

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)

The type of pending maintenance action that is available for the resource.

pendingMaintenanceAction_autoAppliedAfterDate :: Lens' PendingMaintenanceAction (Maybe UTCTime)

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. If this date is specified, any next-maintenance opt-in requests are ignored.

pendingMaintenanceAction_currentApplyDate :: Lens' PendingMaintenanceAction (Maybe UTCTime)

The effective date when the pending maintenance action is applied to the resource.

pendingMaintenanceAction_description :: Lens' PendingMaintenanceAction (Maybe Text)

A description providing more detail about the maintenance action.

pendingMaintenanceAction_forcedApplyDate :: Lens' PendingMaintenanceAction (Maybe UTCTime)

The date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.

pendingMaintenanceAction_optInStatus :: Lens' PendingMaintenanceAction (Maybe Text)

Indicates the type of opt-in request that has been received for the resource.

PendingModifiedValues

pendingModifiedValues_allocatedStorage :: Lens' PendingModifiedValues (Maybe Int)

Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.

pendingModifiedValues_backupRetentionPeriod :: Lens' PendingModifiedValues (Maybe Int)

Specifies the pending number of days for which automated backups are retained.

pendingModifiedValues_cACertificateIdentifier :: Lens' PendingModifiedValues (Maybe Text)

Specifies the identifier of the certificate authority (CA) certificate for the DB instance.

pendingModifiedValues_dbInstanceClass :: Lens' PendingModifiedValues (Maybe Text)

Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.

pendingModifiedValues_dbInstanceIdentifier :: Lens' PendingModifiedValues (Maybe Text)

Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.

pendingModifiedValues_dbSubnetGroupName :: Lens' PendingModifiedValues (Maybe Text)

The new subnet group for the instance.

pendingModifiedValues_engineVersion :: Lens' PendingModifiedValues (Maybe Text)

Indicates the database engine version.

pendingModifiedValues_iops :: Lens' PendingModifiedValues (Maybe Int)

Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.

pendingModifiedValues_licenseModel :: Lens' PendingModifiedValues (Maybe Text)

The license model for the instance.

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

pendingModifiedValues_masterUserPassword :: Lens' PendingModifiedValues (Maybe Text)

Contains the pending or currently in-progress change of the master credentials for the instance.

pendingModifiedValues_multiAZ :: Lens' PendingModifiedValues (Maybe Bool)

Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.

pendingModifiedValues_pendingCloudwatchLogsExports :: Lens' PendingModifiedValues (Maybe PendingCloudwatchLogsExports)

A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

pendingModifiedValues_port :: Lens' PendingModifiedValues (Maybe Int)

Specifies the pending port for the instance.

pendingModifiedValues_storageType :: Lens' PendingModifiedValues (Maybe Text)

Specifies the storage type to be associated with the instance.

ResourcePendingMaintenanceActions

resourcePendingMaintenanceActions_pendingMaintenanceActionDetails :: Lens' ResourcePendingMaintenanceActions (Maybe [PendingMaintenanceAction])

A list that provides details about the pending maintenance actions for the resource.

resourcePendingMaintenanceActions_resourceIdentifier :: Lens' ResourcePendingMaintenanceActions (Maybe Text)

The Amazon Resource Name (ARN) of the resource that has pending maintenance actions.

Subnet

subnet_subnetAvailabilityZone :: Lens' Subnet (Maybe AvailabilityZone)

Specifies the Availability Zone for the subnet.

subnet_subnetIdentifier :: Lens' Subnet (Maybe Text)

Specifies the identifier of the subnet.

subnet_subnetStatus :: Lens' Subnet (Maybe Text)

Specifies the status of the subnet.

Tag

tag_key :: Lens' Tag (Maybe Text)

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 contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").

tag_value :: Lens' Tag (Maybe Text)

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 contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").

UpgradeTarget

upgradeTarget_autoUpgrade :: Lens' UpgradeTarget (Maybe Bool)

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)

The version of the database engine that an instance can be upgraded to.

upgradeTarget_engine :: Lens' UpgradeTarget (Maybe Text)

The name of the upgrade target database engine.

upgradeTarget_engineVersion :: Lens' UpgradeTarget (Maybe Text)

The version number of the upgrade target database engine.

upgradeTarget_isMajorVersionUpgrade :: Lens' UpgradeTarget (Maybe Bool)

A value that indicates whether a database engine is upgraded to a major version.

VpcSecurityGroupMembership

vpcSecurityGroupMembership_status :: Lens' VpcSecurityGroupMembership (Maybe Text)

The status of the VPC security group.

vpcSecurityGroupMembership_vpcSecurityGroupId :: Lens' VpcSecurityGroupMembership (Maybe Text)

The name of the VPC security group.