Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Neptune.Lens

Contents

Operations
Types

Description

Synopsis

Operations

AddRoleToDBCluster

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

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

addRoleToDBCluster_dbClusterIdentifier :: Lens' AddRoleToDBCluster Text Source #

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

addRoleToDBCluster_roleArn :: Lens' AddRoleToDBCluster Text Source #

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

AddSourceIdentifierToSubscription

addSourceIdentifierToSubscription_subscriptionName :: Lens' AddSourceIdentifierToSubscription Text Source #

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

addSourceIdentifierToSubscription_sourceIdentifier :: Lens' AddSourceIdentifierToSubscription Text Source #

The identifier of the event source to be added.

Constraints:

If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.
If the source type is a DB security group, a DBSecurityGroupName must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.

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

Undocumented member.

addSourceIdentifierToSubscriptionResponse_httpStatus :: Lens' AddSourceIdentifierToSubscriptionResponse Int Source #

The response's http status code.

AddTagsToResource

addTagsToResource_resourceName :: Lens' AddTagsToResource Text Source #

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

addTagsToResource_tags :: Lens' AddTagsToResource [Tag] Source #

The tags to be assigned to the Amazon Neptune resource.

ApplyPendingMaintenanceAction

applyPendingMaintenanceAction_resourceIdentifier :: Lens' ApplyPendingMaintenanceAction Text Source #

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

applyPendingMaintenanceAction_applyAction :: Lens' ApplyPendingMaintenanceAction Text Source #

The pending maintenance action to apply to this resource.

Valid values: system-update, db-upgrade

applyPendingMaintenanceAction_optInType :: Lens' ApplyPendingMaintenanceAction Text Source #

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

Valid values:

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

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

Undocumented member.

applyPendingMaintenanceActionResponse_httpStatus :: Lens' ApplyPendingMaintenanceActionResponse Int Source #

The response's http status code.

CopyDBClusterParameterGroup

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

The tags to be assigned to the copied DB cluster parameter group.

copyDBClusterParameterGroup_sourceDBClusterParameterGroupIdentifier :: Lens' CopyDBClusterParameterGroup Text Source #

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

Constraints:

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

copyDBClusterParameterGroup_targetDBClusterParameterGroupIdentifier :: Lens' CopyDBClusterParameterGroup Text Source #

The identifier for the copied DB cluster parameter group.

Constraints:

Cannot be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
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 Source #

A description for the copied DB cluster parameter group.

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

Undocumented member.

copyDBClusterParameterGroupResponse_httpStatus :: Lens' CopyDBClusterParameterGroupResponse Int Source #

The response's http status code.

CopyDBClusterSnapshot

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

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

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

The Amazon Amazon KMS key ID for an encrypted DB 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 DB cluster snapshot from your Amazon 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 DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.

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

KMS encryption keys are specific to the Amazon Region that they are created in, and you can't use encryption keys from one Amazon Region in another Amazon Region.

You cannot encrypt an unencrypted DB cluster snapshot when you copy it. If you try to copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

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

Not currently supported.

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

The tags to assign to the new DB cluster snapshot copy.

copyDBClusterSnapshot_sourceDBClusterSnapshotIdentifier :: Lens' CopyDBClusterSnapshot Text Source #

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

Constraints:

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

Example: my-cluster-snapshot1

copyDBClusterSnapshot_targetDBClusterSnapshotIdentifier :: Lens' CopyDBClusterSnapshot Text Source #

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

Constraints:

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

Example: my-cluster-snapshot2

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

Undocumented member.

copyDBClusterSnapshotResponse_httpStatus :: Lens' CopyDBClusterSnapshotResponse Int Source #

The response's http status code.

CopyDBParameterGroup

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

The tags to be assigned to the copied DB parameter group.

copyDBParameterGroup_sourceDBParameterGroupIdentifier :: Lens' CopyDBParameterGroup Text Source #

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

Constraints:

Must specify a valid DB parameter group.
Must specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN.

copyDBParameterGroup_targetDBParameterGroupIdentifier :: Lens' CopyDBParameterGroup Text Source #

The identifier for the copied DB parameter group.

Constraints:

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

Example: my-db-parameter-group

copyDBParameterGroup_targetDBParameterGroupDescription :: Lens' CopyDBParameterGroup Text Source #

A description for the copied DB parameter group.

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

Undocumented member.

copyDBParameterGroupResponse_httpStatus :: Lens' CopyDBParameterGroupResponse Int Source #

The response's http status code.

CreateDBCluster

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

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

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

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

Default: 1

Constraints:

Must be a value from 1 to 35

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

(Not supported by Neptune)

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

/If set to true, tags are copied to any snapshot of the DB cluster that is created./

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

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default is used.

Constraints:

If supplied, must match the name of an existing DBClusterParameterGroup.

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

A DB subnet group to associate with this DB cluster.

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

Example: mySubnetgroup

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

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

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

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is enabled.

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

The list of log types that need to be enabled for exporting to CloudWatch Logs.

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

If set to true, enables Amazon Identity and Access Management (IAM) authentication for the entire DB cluster (this cannot be set at an instance level).

Default: false.

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

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

Example: 1.0.2.1

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

The ID of the Neptune global database to which this new DB cluster should be added.

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

The Amazon KMS key identifier for an encrypted DB cluster.

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

If an encryption key is not specified in KmsKeyId:

If ReplicationSourceIdentifier identifies an encrypted source, then Amazon Neptune will use the encryption key used to encrypt the source. Otherwise, Amazon Neptune will use your default encryption key.
If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, then Amazon Neptune will use your default encryption key.

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

If you create a Read Replica of an encrypted DB cluster in another Amazon Region, you must set KmsKeyId to a KMS key ID that is valid in the destination Amazon Region. This key is used to encrypt the Read Replica in that Amazon Region.

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

Not supported by Neptune.

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

Not supported by Neptune.

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

(Not supported by Neptune)

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

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

Default: 8182

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

This parameter is not currently supported.

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

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

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Neptune User Guide.

Constraints:

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

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

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

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

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Neptune User Guide.

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

Constraints: Minimum 30-minute window.

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

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

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

Undocumented member.

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

Specifies whether the DB cluster is encrypted.

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

The tags to assign to the new DB cluster.

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

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

createDBCluster_dbClusterIdentifier :: Lens' CreateDBCluster Text Source #

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

Constraints:

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

Example: my-cluster1

createDBCluster_engine :: Lens' CreateDBCluster Text Source #

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

Valid Values: neptune

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

Undocumented member.

createDBClusterResponse_httpStatus :: Lens' CreateDBClusterResponse Int Source #

The response's http status code.

CreateDBClusterEndpoint

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

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

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

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

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

The tags to be assigned to the Amazon Neptune resource.

createDBClusterEndpoint_dbClusterIdentifier :: Lens' CreateDBClusterEndpoint Text Source #

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

createDBClusterEndpoint_dbClusterEndpointIdentifier :: Lens' CreateDBClusterEndpoint Text Source #

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

createDBClusterEndpoint_endpointType :: Lens' CreateDBClusterEndpoint Text Source #

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

createDBClusterEndpointResponse_customEndpointType :: Lens' CreateDBClusterEndpointResponse (Maybe Text) Source #

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

createDBClusterEndpointResponse_dbClusterEndpointArn :: Lens' CreateDBClusterEndpointResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the endpoint.

createDBClusterEndpointResponse_dbClusterEndpointIdentifier :: Lens' CreateDBClusterEndpointResponse (Maybe Text) Source #

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

createDBClusterEndpointResponse_dbClusterEndpointResourceIdentifier :: Lens' CreateDBClusterEndpointResponse (Maybe Text) Source #

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

createDBClusterEndpointResponse_dbClusterIdentifier :: Lens' CreateDBClusterEndpointResponse (Maybe Text) Source #

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

createDBClusterEndpointResponse_endpoint :: Lens' CreateDBClusterEndpointResponse (Maybe Text) Source #

The DNS address of the endpoint.

createDBClusterEndpointResponse_endpointType :: Lens' CreateDBClusterEndpointResponse (Maybe Text) Source #

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

createDBClusterEndpointResponse_excludedMembers :: Lens' CreateDBClusterEndpointResponse (Maybe [Text]) Source #

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

createDBClusterEndpointResponse_staticMembers :: Lens' CreateDBClusterEndpointResponse (Maybe [Text]) Source #

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

createDBClusterEndpointResponse_status :: Lens' CreateDBClusterEndpointResponse (Maybe Text) Source #

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

createDBClusterEndpointResponse_httpStatus :: Lens' CreateDBClusterEndpointResponse Int Source #

The response's http status code.

CreateDBClusterParameterGroup

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

The tags to be assigned to the new DB cluster parameter group.

createDBClusterParameterGroup_dbClusterParameterGroupName :: Lens' CreateDBClusterParameterGroup Text Source #

The name of the DB cluster parameter group.

Constraints:

Must match the name of an existing DBClusterParameterGroup.

This value is stored as a lowercase string.

createDBClusterParameterGroup_dbParameterGroupFamily :: Lens' CreateDBClusterParameterGroup Text Source #

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

createDBClusterParameterGroup_description :: Lens' CreateDBClusterParameterGroup Text Source #

The description for the DB cluster parameter group.

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

Undocumented member.

createDBClusterParameterGroupResponse_httpStatus :: Lens' CreateDBClusterParameterGroupResponse Int Source #

The response's http status code.

CreateDBClusterSnapshot

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

The tags to be assigned to the DB cluster snapshot.

createDBClusterSnapshot_dbClusterSnapshotIdentifier :: Lens' CreateDBClusterSnapshot Text Source #

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

Constraints:

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

Example: my-cluster1-snapshot1

createDBClusterSnapshot_dbClusterIdentifier :: Lens' CreateDBClusterSnapshot Text Source #

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

Constraints:

Must match the identifier of an existing DBCluster.

Example: my-cluster1

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

Undocumented member.

createDBClusterSnapshotResponse_httpStatus :: Lens' CreateDBClusterSnapshotResponse Int Source #

The response's http status code.

CreateDBInstance

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

Not supported by Neptune.

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

Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.

Default: true

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

The EC2 Availability Zone that the DB instance is created in

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

Example: us-east-1d

Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same Amazon Region as the current endpoint.

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

The number of days for which automated backups are retained.

Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see CreateDBCluster.

Default: 1

Constraints:

Must be a value from 0 to 35
Cannot be set to 0 if the DB instance is a source to Read Replicas

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

(Not supported by Neptune)

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

True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.

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

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

For information on creating a DB cluster, see CreateDBCluster.

Type: String

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

Not supported.

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

The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used.

Constraints:

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

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

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

Default: The default DB security group for the database engine.

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

A DB subnet group to associate with this DB instance.

If there is no DB subnet group, then it is a non-VPC DB instance.

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

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

DB instances in a DB cluster can be deleted even when deletion protection is enabled in their parent DB cluster.

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

Specify the Active Directory Domain to create the instance in.

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

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

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

The list of log types that need to be enabled for exporting to CloudWatch Logs.

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

Not supported by Neptune (ignored).

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

(Not supported by Neptune)

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

The version number of the database engine to use. Currently, setting this parameter has no effect.

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

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

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

The Amazon KMS key identifier for an encrypted DB instance.

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

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

If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon Neptune will use your default encryption key. Amazon KMS creates the default encryption key for your Amazon account. Your Amazon account has a different default encryption key for each Amazon Region.

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

License model information for this DB instance.

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

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

Not supported by Neptune.

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

Not supported by Neptune.

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

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

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

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

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

The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess.

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

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

Specifies if the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

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

(Not supported by Neptune)

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

(Not supported by Neptune)

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

The port number on which the database accepts connections.

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

Default: 8182

Type: Integer

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

The daily time range during which automated backups are created.

Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see CreateDBCluster.

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

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 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) Source #

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

Default: 1

Valid Values: 0 - 15

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

This flag should no longer be used.

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

Specifies whether the DB instance is encrypted.

Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see CreateDBCluster.

Default: false

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

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

Not applicable. Storage is managed by the DB Cluster.

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

The tags to assign to the new instance.

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

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

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

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

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

The time zone of the DB instance.

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

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

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see CreateDBCluster.

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

createDBInstance_dbInstanceIdentifier :: Lens' CreateDBInstance Text Source #

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

Constraints:

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

Example: mydbinstance

createDBInstance_dbInstanceClass :: Lens' CreateDBInstance Text Source #

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all Amazon Regions.

createDBInstance_engine :: Lens' CreateDBInstance Text Source #

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

Valid Values: neptune

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

Undocumented member.

createDBInstanceResponse_httpStatus :: Lens' CreateDBInstanceResponse Int Source #

The response's http status code.

CreateDBParameterGroup

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

The tags to be assigned to the new DB parameter group.

createDBParameterGroup_dbParameterGroupName :: Lens' CreateDBParameterGroup Text Source #

The name of the DB parameter group.

Constraints:

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

This value is stored as a lowercase string.

createDBParameterGroup_dbParameterGroupFamily :: Lens' CreateDBParameterGroup Text Source #

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

createDBParameterGroup_description :: Lens' CreateDBParameterGroup Text Source #

The description for the DB parameter group.

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

Undocumented member.

createDBParameterGroupResponse_httpStatus :: Lens' CreateDBParameterGroupResponse Int Source #

The response's http status code.

CreateDBSubnetGroup

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

The tags to be assigned to the new DB subnet group.

createDBSubnetGroup_dbSubnetGroupName :: Lens' CreateDBSubnetGroup Text Source #

The name for the DB subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

createDBSubnetGroup_dbSubnetGroupDescription :: Lens' CreateDBSubnetGroup Text Source #

The description for the DB subnet group.

createDBSubnetGroup_subnetIds :: Lens' CreateDBSubnetGroup [Text] Source #

The EC2 Subnet IDs for the DB subnet group.

createDBSubnetGroupResponse_dbSubnetGroup :: Lens' CreateDBSubnetGroupResponse (Maybe DBSubnetGroup) Source #

Undocumented member.

createDBSubnetGroupResponse_httpStatus :: Lens' CreateDBSubnetGroupResponse Int Source #

The response's http status code.

CreateEventSubscription

createEventSubscription_enabled :: Lens' CreateEventSubscription (Maybe Bool) Source #

A 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]) Source #

A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the DescribeEventCategories action.

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

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

Constraints:

If SourceIds are supplied, SourceType must also be provided.
If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.
If the source type is a DB security group, a DBSecurityGroupName must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.

createEventSubscription_sourceType :: Lens' CreateEventSubscription (Maybe Text) Source #

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

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

The tags to be applied to the new event subscription.

createEventSubscription_subscriptionName :: Lens' CreateEventSubscription Text Source #

The name of the subscription.

Constraints: The name must be less than 255 characters.

createEventSubscription_snsTopicArn :: Lens' CreateEventSubscription Text Source #

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

createEventSubscriptionResponse_eventSubscription :: Lens' CreateEventSubscriptionResponse (Maybe EventSubscription) Source #

Undocumented member.

createEventSubscriptionResponse_httpStatus :: Lens' CreateEventSubscriptionResponse Int Source #

The response's http status code.

CreateGlobalCluster

createGlobalCluster_deletionProtection :: Lens' CreateGlobalCluster (Maybe Bool) Source #

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

createGlobalCluster_engine :: Lens' CreateGlobalCluster (Maybe Text) Source #

The name of the database engine to be used in the global database.

Valid values: neptune

createGlobalCluster_engineVersion :: Lens' CreateGlobalCluster (Maybe Text) Source #

The Neptune engine version to be used by the global database.

Valid values: 1.2.0.0 or above.

createGlobalCluster_sourceDBClusterIdentifier :: Lens' CreateGlobalCluster (Maybe Text) Source #

(Optional) The Amazon Resource Name (ARN) of an existing Neptune DB cluster to use as the primary cluster of the new global database.

createGlobalCluster_storageEncrypted :: Lens' CreateGlobalCluster (Maybe Bool) Source #

The storage encryption setting for the new global database cluster.

createGlobalCluster_globalClusterIdentifier :: Lens' CreateGlobalCluster Text Source #

The cluster identifier of the new global database cluster.

createGlobalClusterResponse_globalCluster :: Lens' CreateGlobalClusterResponse (Maybe GlobalCluster) Source #

Undocumented member.

createGlobalClusterResponse_httpStatus :: Lens' CreateGlobalClusterResponse Int Source #

The response's http status code.

DeleteDBCluster

deleteDBCluster_finalDBSnapshotIdentifier :: Lens' DeleteDBCluster (Maybe Text) Source #

The DB cluster snapshot identifier of the new DB 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 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

deleteDBCluster_skipFinalSnapshot :: Lens' DeleteDBCluster (Maybe Bool) Source #

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

You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is false.

Default: false

deleteDBCluster_dbClusterIdentifier :: Lens' DeleteDBCluster Text Source #

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

Constraints:

Must match an existing DBClusterIdentifier.

deleteDBClusterResponse_dbCluster :: Lens' DeleteDBClusterResponse (Maybe DBCluster) Source #

Undocumented member.

deleteDBClusterResponse_httpStatus :: Lens' DeleteDBClusterResponse Int Source #

The response's http status code.

DeleteDBClusterEndpoint

deleteDBClusterEndpoint_dbClusterEndpointIdentifier :: Lens' DeleteDBClusterEndpoint Text Source #

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

deleteDBClusterEndpointResponse_customEndpointType :: Lens' DeleteDBClusterEndpointResponse (Maybe Text) Source #

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

deleteDBClusterEndpointResponse_dbClusterEndpointArn :: Lens' DeleteDBClusterEndpointResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the endpoint.

deleteDBClusterEndpointResponse_dbClusterEndpointIdentifier :: Lens' DeleteDBClusterEndpointResponse (Maybe Text) Source #

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

deleteDBClusterEndpointResponse_dbClusterEndpointResourceIdentifier :: Lens' DeleteDBClusterEndpointResponse (Maybe Text) Source #

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

deleteDBClusterEndpointResponse_dbClusterIdentifier :: Lens' DeleteDBClusterEndpointResponse (Maybe Text) Source #

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

deleteDBClusterEndpointResponse_endpoint :: Lens' DeleteDBClusterEndpointResponse (Maybe Text) Source #

The DNS address of the endpoint.

deleteDBClusterEndpointResponse_endpointType :: Lens' DeleteDBClusterEndpointResponse (Maybe Text) Source #

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

deleteDBClusterEndpointResponse_excludedMembers :: Lens' DeleteDBClusterEndpointResponse (Maybe [Text]) Source #

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

deleteDBClusterEndpointResponse_staticMembers :: Lens' DeleteDBClusterEndpointResponse (Maybe [Text]) Source #

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

deleteDBClusterEndpointResponse_status :: Lens' DeleteDBClusterEndpointResponse (Maybe Text) Source #

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

deleteDBClusterEndpointResponse_httpStatus :: Lens' DeleteDBClusterEndpointResponse Int Source #

The response's http status code.

DeleteDBClusterParameterGroup

deleteDBClusterParameterGroup_dbClusterParameterGroupName :: Lens' DeleteDBClusterParameterGroup Text Source #

The name of the DB cluster parameter group.

Constraints:

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

DeleteDBClusterSnapshot

deleteDBClusterSnapshot_dbClusterSnapshotIdentifier :: Lens' DeleteDBClusterSnapshot Text Source #

The identifier of the DB cluster snapshot to delete.

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

deleteDBClusterSnapshotResponse_dbClusterSnapshot :: Lens' DeleteDBClusterSnapshotResponse (Maybe DBClusterSnapshot) Source #

Undocumented member.

deleteDBClusterSnapshotResponse_httpStatus :: Lens' DeleteDBClusterSnapshotResponse Int Source #

The response's http status code.

DeleteDBInstance

deleteDBInstance_finalDBSnapshotIdentifier :: Lens' DeleteDBInstance (Maybe Text) Source #

The DBSnapshotIdentifier of the new DBSnapshot 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 1 to 255 letters or numbers.
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Cannot be specified when deleting a Read Replica.

deleteDBInstance_skipFinalSnapshot :: Lens' DeleteDBInstance (Maybe Bool) Source #

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

Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to "true".

Specify true when deleting a Read Replica.

The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.

Default: false

deleteDBInstance_dbInstanceIdentifier :: Lens' DeleteDBInstance Text Source #

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

Constraints:

Must match the name of an existing DB instance.

deleteDBInstanceResponse_dbInstance :: Lens' DeleteDBInstanceResponse (Maybe DBInstance) Source #

Undocumented member.

deleteDBInstanceResponse_httpStatus :: Lens' DeleteDBInstanceResponse Int Source #

The response's http status code.

DeleteDBParameterGroup

deleteDBParameterGroup_dbParameterGroupName :: Lens' DeleteDBParameterGroup Text Source #

The name of the DB parameter group.

Constraints:

Must be the name of an existing DB parameter group
You can't delete a default DB parameter group
Cannot be associated with any DB instances

DeleteDBSubnetGroup

deleteDBSubnetGroup_dbSubnetGroupName :: Lens' DeleteDBSubnetGroup Text Source #

The name of the database subnet group to delete.

You can't delete the default subnet group.

Constraints:

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

Example: mySubnetgroup

DeleteEventSubscription

deleteEventSubscription_subscriptionName :: Lens' DeleteEventSubscription Text Source #

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

deleteEventSubscriptionResponse_eventSubscription :: Lens' DeleteEventSubscriptionResponse (Maybe EventSubscription) Source #

Undocumented member.

deleteEventSubscriptionResponse_httpStatus :: Lens' DeleteEventSubscriptionResponse Int Source #

The response's http status code.

DeleteGlobalCluster

deleteGlobalCluster_globalClusterIdentifier :: Lens' DeleteGlobalCluster Text Source #

The cluster identifier of the global database cluster being deleted.

deleteGlobalClusterResponse_globalCluster :: Lens' DeleteGlobalClusterResponse (Maybe GlobalCluster) Source #

Undocumented member.

deleteGlobalClusterResponse_httpStatus :: Lens' DeleteGlobalClusterResponse Int Source #

The response's http status code.

DescribeDBClusterEndpoints

describeDBClusterEndpoints_dbClusterEndpointIdentifier :: Lens' DescribeDBClusterEndpoints (Maybe Text) Source #

The identifier of the endpoint to describe. This parameter is stored as a lowercase string.

describeDBClusterEndpoints_dbClusterIdentifier :: Lens' DescribeDBClusterEndpoints (Maybe Text) Source #

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

describeDBClusterEndpoints_filters :: Lens' DescribeDBClusterEndpoints (Maybe [Filter]) Source #

A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, inactive, modifying.

describeDBClusterEndpoints_marker :: Lens' DescribeDBClusterEndpoints (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBClusterEndpoints_maxRecords :: Lens' DescribeDBClusterEndpoints (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBClusterEndpointsResponse_dbClusterEndpoints :: Lens' DescribeDBClusterEndpointsResponse (Maybe [DBClusterEndpoint]) Source #

Contains the details of the endpoints associated with the cluster and matching any filter conditions.

describeDBClusterEndpointsResponse_marker :: Lens' DescribeDBClusterEndpointsResponse (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBClusterEndpointsResponse_httpStatus :: Lens' DescribeDBClusterEndpointsResponse Int Source #

The response's http status code.

DescribeDBClusterParameterGroups

describeDBClusterParameterGroups_dbClusterParameterGroupName :: Lens' DescribeDBClusterParameterGroups (Maybe Text) Source #

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

Constraints:

If supplied, must match the name of an existing DBClusterParameterGroup.

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

This parameter is not currently supported.

describeDBClusterParameterGroups_marker :: Lens' DescribeDBClusterParameterGroups (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBClusterParameterGroups_maxRecords :: Lens' DescribeDBClusterParameterGroups (Maybe Int) Source #

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

Default: 100

Constraints: Minimum 20, maximum 100.

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

A list of DB cluster parameter groups.

describeDBClusterParameterGroupsResponse_marker :: Lens' DescribeDBClusterParameterGroupsResponse (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBClusterParameterGroupsResponse_httpStatus :: Lens' DescribeDBClusterParameterGroupsResponse Int Source #

The response's http status code.

DescribeDBClusterParameters

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

This parameter is not currently supported.

describeDBClusterParameters_marker :: Lens' DescribeDBClusterParameters (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBClusterParameters_maxRecords :: Lens' DescribeDBClusterParameters (Maybe Int) Source #

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

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBClusterParameters_source :: Lens' DescribeDBClusterParameters (Maybe Text) Source #

A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

describeDBClusterParameters_dbClusterParameterGroupName :: Lens' DescribeDBClusterParameters Text Source #

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

Constraints:

If supplied, must match the name of an existing DBClusterParameterGroup.

describeDBClusterParametersResponse_marker :: Lens' DescribeDBClusterParametersResponse (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

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

Provides a list of parameters for the DB cluster parameter group.

describeDBClusterParametersResponse_httpStatus :: Lens' DescribeDBClusterParametersResponse Int Source #

The response's http status code.

DescribeDBClusterSnapshotAttributes

describeDBClusterSnapshotAttributes_dbClusterSnapshotIdentifier :: Lens' DescribeDBClusterSnapshotAttributes Text Source #

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

describeDBClusterSnapshotAttributesResponse_dbClusterSnapshotAttributesResult :: Lens' DescribeDBClusterSnapshotAttributesResponse (Maybe DBClusterSnapshotAttributesResult) Source #

Undocumented member.

describeDBClusterSnapshotAttributesResponse_httpStatus :: Lens' DescribeDBClusterSnapshotAttributesResponse Int Source #

The response's http status code.

DescribeDBClusterSnapshots

describeDBClusterSnapshots_dbClusterIdentifier :: Lens' DescribeDBClusterSnapshots (Maybe Text) Source #

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

Constraints:

If supplied, must match the identifier of an existing DBCluster.

describeDBClusterSnapshots_dbClusterSnapshotIdentifier :: Lens' DescribeDBClusterSnapshots (Maybe Text) Source #

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

Constraints:

If supplied, must match the identifier of an existing DBClusterSnapshot.
If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

describeDBClusterSnapshots_filters :: Lens' DescribeDBClusterSnapshots (Maybe [Filter]) Source #

This parameter is not currently supported.

describeDBClusterSnapshots_includePublic :: Lens' DescribeDBClusterSnapshots (Maybe Bool) Source #

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

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

describeDBClusterSnapshots_includeShared :: Lens' DescribeDBClusterSnapshots (Maybe Bool) Source #

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

You can give an Amazon account permission to restore a manual DB cluster snapshot from another Amazon account by the ModifyDBClusterSnapshotAttribute API action.

describeDBClusterSnapshots_marker :: Lens' DescribeDBClusterSnapshots (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBClusterSnapshots_maxRecords :: Lens' DescribeDBClusterSnapshots (Maybe Int) Source #

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

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBClusterSnapshots_snapshotType :: Lens' DescribeDBClusterSnapshots (Maybe Text) Source #

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

automated - Return all DB cluster snapshots that have been automatically taken by Amazon Neptune for my Amazon account.
manual - Return all DB cluster snapshots that have been taken by my Amazon account.
shared - Return all manual DB cluster snapshots that have been shared to my Amazon account.
public - Return all DB cluster snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public DB cluster snapshots with these results by setting the IncludePublic 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]) Source #

Provides a list of DB cluster snapshots for the user.

describeDBClusterSnapshotsResponse_marker :: Lens' DescribeDBClusterSnapshotsResponse (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBClusterSnapshotsResponse_httpStatus :: Lens' DescribeDBClusterSnapshotsResponse Int Source #

The response's http status code.

DescribeDBClusters

describeDBClusters_dbClusterIdentifier :: Lens' DescribeDBClusters (Maybe Text) Source #

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

Constraints:

If supplied, must match an existing DBClusterIdentifier.

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

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

Supported filters:

db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.
engine - Accepts an engine name (such as neptune), and restricts the results list to DB clusters created by that engine.

For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB clusters are returned, you could use the following command:

describeDBClusters_marker :: Lens' DescribeDBClusters (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBClusters_maxRecords :: Lens' DescribeDBClusters (Maybe Int) Source #

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

Default: 100

Constraints: Minimum 20, maximum 100.

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

Contains a list of DB clusters for the user.

describeDBClustersResponse_marker :: Lens' DescribeDBClustersResponse (Maybe Text) Source #

A pagination token that can be used in a subsequent DescribeDBClusters request.

describeDBClustersResponse_httpStatus :: Lens' DescribeDBClustersResponse Int Source #

The response's http status code.

DescribeDBEngineVersions

describeDBEngineVersions_dbParameterGroupFamily :: Lens' DescribeDBEngineVersions (Maybe Text) Source #

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

Constraints:

If supplied, must match an existing DBParameterGroupFamily.

describeDBEngineVersions_defaultOnly :: Lens' DescribeDBEngineVersions (Maybe Bool) Source #

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

describeDBEngineVersions_engine :: Lens' DescribeDBEngineVersions (Maybe Text) Source #

The database engine to return.

describeDBEngineVersions_engineVersion :: Lens' DescribeDBEngineVersions (Maybe Text) Source #

The database engine version to return.

Example: 5.1.49

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

Not currently supported.

describeDBEngineVersions_listSupportedCharacterSets :: Lens' DescribeDBEngineVersions (Maybe Bool) Source #

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) Source #

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) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBEngineVersions_maxRecords :: Lens' DescribeDBEngineVersions (Maybe Int) Source #

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

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

A list of DBEngineVersion elements.

describeDBEngineVersionsResponse_marker :: Lens' DescribeDBEngineVersionsResponse (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBEngineVersionsResponse_httpStatus :: Lens' DescribeDBEngineVersionsResponse Int Source #

The response's http status code.

DescribeDBInstances

describeDBInstances_dbInstanceIdentifier :: Lens' DescribeDBInstances (Maybe Text) Source #

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

Constraints:

If supplied, must match the identifier of an existing DBInstance.

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

A filter that specifies one or more DB instances to describe.

Supported filters:

db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB clusters identified by these ARNs.
engine - Accepts an engine name (such as neptune), and restricts the results list to DB instances created by that engine.

For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB instances are returned, you could use the following command:

describeDBInstances_marker :: Lens' DescribeDBInstances (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBInstances_maxRecords :: Lens' DescribeDBInstances (Maybe Int) Source #

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

Default: 100

Constraints: Minimum 20, maximum 100.

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

A list of DBInstance instances.

describeDBInstancesResponse_marker :: Lens' DescribeDBInstancesResponse (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

describeDBInstancesResponse_httpStatus :: Lens' DescribeDBInstancesResponse Int Source #

The response's http status code.

DescribeDBParameterGroups

describeDBParameterGroups_dbParameterGroupName :: Lens' DescribeDBParameterGroups (Maybe Text) Source #

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

Constraints:

If supplied, must match the name of an existing DBClusterParameterGroup.

describeDBParameterGroups_filters :: Lens' DescribeDBParameterGroups (Maybe [Filter]) Source #

This parameter is not currently supported.

describeDBParameterGroups_marker :: Lens' DescribeDBParameterGroups (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBParameterGroups_maxRecords :: Lens' DescribeDBParameterGroups (Maybe Int) Source #

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

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBParameterGroupsResponse_dbParameterGroups :: Lens' DescribeDBParameterGroupsResponse (Maybe [DBParameterGroup]) Source #

A list of DBParameterGroup instances.

describeDBParameterGroupsResponse_marker :: Lens' DescribeDBParameterGroupsResponse (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBParameterGroupsResponse_httpStatus :: Lens' DescribeDBParameterGroupsResponse Int Source #

The response's http status code.

DescribeDBParameters

describeDBParameters_filters :: Lens' DescribeDBParameters (Maybe [Filter]) Source #

This parameter is not currently supported.

describeDBParameters_marker :: Lens' DescribeDBParameters (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBParameters_maxRecords :: Lens' DescribeDBParameters (Maybe Int) Source #

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

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBParameters_source :: Lens' DescribeDBParameters (Maybe Text) Source #

The parameter types to return.

Default: All parameter types returned

Valid Values: user | system | engine-default

describeDBParameters_dbParameterGroupName :: Lens' DescribeDBParameters Text Source #

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

Constraints:

If supplied, must match the name of an existing DBParameterGroup.

describeDBParametersResponse_marker :: Lens' DescribeDBParametersResponse (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBParametersResponse_parameters :: Lens' DescribeDBParametersResponse (Maybe [Parameter]) Source #

A list of Parameter values.

describeDBParametersResponse_httpStatus :: Lens' DescribeDBParametersResponse Int Source #

The response's http status code.

DescribeDBSubnetGroups

describeDBSubnetGroups_dbSubnetGroupName :: Lens' DescribeDBSubnetGroups (Maybe Text) Source #

The name of the DB subnet group to return details for.

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

This parameter is not currently supported.

describeDBSubnetGroups_marker :: Lens' DescribeDBSubnetGroups (Maybe Text) Source #

An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBSubnetGroups_maxRecords :: Lens' DescribeDBSubnetGroups (Maybe Int) Source #

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

Default: 100

Constraints: Minimum 20, maximum 100.

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

A list of DBSubnetGroup instances.

describeDBSubnetGroupsResponse_marker :: Lens' DescribeDBSubnetGroupsResponse (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBSubnetGroupsResponse_httpStatus :: Lens' DescribeDBSubnetGroupsResponse Int Source #

The response's http status code.

DescribeEngineDefaultClusterParameters

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

This parameter is not currently supported.

describeEngineDefaultClusterParameters_marker :: Lens' DescribeEngineDefaultClusterParameters (Maybe Text) Source #

An optional pagination token provided by a previous DescribeEngineDefaultClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeEngineDefaultClusterParameters_maxRecords :: Lens' DescribeEngineDefaultClusterParameters (Maybe Int) Source #

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

Default: 100

Constraints: Minimum 20, maximum 100.

describeEngineDefaultClusterParameters_dbParameterGroupFamily :: Lens' DescribeEngineDefaultClusterParameters Text Source #

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

describeEngineDefaultClusterParametersResponse_engineDefaults :: Lens' DescribeEngineDefaultClusterParametersResponse (Maybe EngineDefaults) Source #

Undocumented member.

describeEngineDefaultClusterParametersResponse_httpStatus :: Lens' DescribeEngineDefaultClusterParametersResponse Int Source #

The response's http status code.

DescribeEngineDefaultParameters

describeEngineDefaultParameters_filters :: Lens' DescribeEngineDefaultParameters (Maybe [Filter]) Source #

Not currently supported.

describeEngineDefaultParameters_marker :: Lens' DescribeEngineDefaultParameters (Maybe Text) Source #

An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeEngineDefaultParameters_maxRecords :: Lens' DescribeEngineDefaultParameters (Maybe Int) Source #

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

Default: 100

Constraints: Minimum 20, maximum 100.

describeEngineDefaultParameters_dbParameterGroupFamily :: Lens' DescribeEngineDefaultParameters Text Source #

The name of the DB parameter group family.

describeEngineDefaultParametersResponse_engineDefaults :: Lens' DescribeEngineDefaultParametersResponse (Maybe EngineDefaults) Source #

Undocumented member.

describeEngineDefaultParametersResponse_httpStatus :: Lens' DescribeEngineDefaultParametersResponse Int Source #

The response's http status code.

DescribeEventCategories

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

This parameter is not currently supported.

describeEventCategories_sourceType :: Lens' DescribeEventCategories (Maybe Text) Source #

The type of source that is generating the events.

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

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

A list of EventCategoriesMap data types.

describeEventCategoriesResponse_httpStatus :: Lens' DescribeEventCategoriesResponse Int Source #

The response's http status code.

DescribeEventSubscriptions

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

This parameter is not currently supported.

describeEventSubscriptions_marker :: Lens' DescribeEventSubscriptions (Maybe Text) Source #

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

describeEventSubscriptions_maxRecords :: Lens' DescribeEventSubscriptions (Maybe Int) Source #

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

Default: 100

Constraints: Minimum 20, maximum 100.

describeEventSubscriptions_subscriptionName :: Lens' DescribeEventSubscriptions (Maybe Text) Source #

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

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

A list of EventSubscriptions data types.

describeEventSubscriptionsResponse_marker :: Lens' DescribeEventSubscriptionsResponse (Maybe Text) Source #

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeEventSubscriptionsResponse_httpStatus :: Lens' DescribeEventSubscriptionsResponse Int Source #

The response's http status code.

DescribeEvents

describeEvents_duration :: Lens' DescribeEvents (Maybe Int) Source #

The number of minutes to retrieve events for.

Default: 60

describeEvents_endTime :: Lens' DescribeEvents (Maybe UTCTime) Source #

The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

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

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

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

This parameter is not currently supported.

describeEvents_marker :: Lens' DescribeEvents (Maybe Text) Source #

An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeEvents_maxRecords :: Lens' DescribeEvents (Maybe Int) Source #

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

Default: 100

Constraints: Minimum 20, maximum 100.

describeEvents_sourceIdentifier :: Lens' DescribeEvents (Maybe Text) Source #

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

Constraints:

If SourceIdentifier is supplied, SourceType must also be provided.
If the source type is DBInstance, then a DBInstanceIdentifier must be supplied.
If the source type is DBSecurityGroup, a DBSecurityGroupName must be supplied.
If the source type is DBParameterGroup, a DBParameterGroupName must be supplied.
If the source type is DBSnapshot, a DBSnapshotIdentifier must be supplied.
Cannot end with a hyphen or contain two consecutive hyphens.

describeEvents_sourceType :: Lens' DescribeEvents (Maybe SourceType) Source #

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

describeEvents_startTime :: Lens' DescribeEvents (Maybe UTCTime) Source #

The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

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

A list of Event instances.

describeEventsResponse_marker :: Lens' DescribeEventsResponse (Maybe Text) Source #

An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

describeEventsResponse_httpStatus :: Lens' DescribeEventsResponse Int Source #

The response's http status code.

DescribeGlobalClusters

describeGlobalClusters_globalClusterIdentifier :: Lens' DescribeGlobalClusters (Maybe Text) Source #

The user-supplied DB cluster identifier. If this parameter is specified, only information about the specified DB cluster is returned. This parameter is not case-sensitive.

Constraints: If supplied, must match an existing DB cluster identifier.

describeGlobalClusters_marker :: Lens' DescribeGlobalClusters (Maybe Text) Source #

(Optional) A pagination token returned by a previous call to DescribeGlobalClusters. If this parameter is specified, the response will only include records beyond the marker, up to the number specified by MaxRecords.

describeGlobalClusters_maxRecords :: Lens' DescribeGlobalClusters (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination marker token is included in the response that you can use to retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

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

The list of global clusters and instances returned by this request.

describeGlobalClustersResponse_marker :: Lens' DescribeGlobalClustersResponse (Maybe Text) Source #

A pagination token. If this parameter is returned in the response, more records are available, which can be retrieved by one or more additional calls to DescribeGlobalClusters.

describeGlobalClustersResponse_httpStatus :: Lens' DescribeGlobalClustersResponse Int Source #

The response's http status code.

DescribeOrderableDBInstanceOptions

describeOrderableDBInstanceOptions_dbInstanceClass :: Lens' DescribeOrderableDBInstanceOptions (Maybe Text) Source #

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

describeOrderableDBInstanceOptions_engineVersion :: Lens' DescribeOrderableDBInstanceOptions (Maybe Text) Source #

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

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

This parameter is not currently supported.

describeOrderableDBInstanceOptions_licenseModel :: Lens' DescribeOrderableDBInstanceOptions (Maybe Text) Source #

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

describeOrderableDBInstanceOptions_marker :: Lens' DescribeOrderableDBInstanceOptions (Maybe Text) Source #

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

describeOrderableDBInstanceOptions_maxRecords :: Lens' DescribeOrderableDBInstanceOptions (Maybe Int) Source #

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

Default: 100

Constraints: Minimum 20, maximum 100.

describeOrderableDBInstanceOptions_vpc :: Lens' DescribeOrderableDBInstanceOptions (Maybe Bool) Source #

The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

describeOrderableDBInstanceOptions_engine :: Lens' DescribeOrderableDBInstanceOptions Text Source #

The name of the engine to retrieve DB instance options for.

describeOrderableDBInstanceOptionsResponse_marker :: Lens' DescribeOrderableDBInstanceOptionsResponse (Maybe Text) Source #

An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

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

An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

describeOrderableDBInstanceOptionsResponse_httpStatus :: Lens' DescribeOrderableDBInstanceOptionsResponse Int Source #

The response's http status code.

DescribePendingMaintenanceActions

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

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

Supported filters:

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

describePendingMaintenanceActions_marker :: Lens' DescribePendingMaintenanceActions (Maybe Text) Source #

An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.

describePendingMaintenanceActions_maxRecords :: Lens' DescribePendingMaintenanceActions (Maybe Int) Source #

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

Default: 100

Constraints: Minimum 20, maximum 100.

describePendingMaintenanceActions_resourceIdentifier :: Lens' DescribePendingMaintenanceActions (Maybe Text) Source #

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

describePendingMaintenanceActionsResponse_marker :: Lens' DescribePendingMaintenanceActionsResponse (Maybe Text) Source #

An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.

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

A list of the pending maintenance actions for the resource.

describePendingMaintenanceActionsResponse_httpStatus :: Lens' DescribePendingMaintenanceActionsResponse Int Source #

The response's http status code.

DescribeValidDBInstanceModifications

describeValidDBInstanceModifications_dbInstanceIdentifier :: Lens' DescribeValidDBInstanceModifications Text Source #

The customer identifier or the ARN of your DB instance.

describeValidDBInstanceModificationsResponse_validDBInstanceModificationsMessage :: Lens' DescribeValidDBInstanceModificationsResponse (Maybe ValidDBInstanceModificationsMessage) Source #

Undocumented member.

describeValidDBInstanceModificationsResponse_httpStatus :: Lens' DescribeValidDBInstanceModificationsResponse Int Source #

The response's http status code.

FailoverDBCluster

failoverDBCluster_dbClusterIdentifier :: Lens' FailoverDBCluster (Maybe Text) Source #

A DB 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) Source #

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

You must specify the instance identifier for an Read Replica in the DB cluster. For example, mydbcluster-replica1.

failoverDBClusterResponse_dbCluster :: Lens' FailoverDBClusterResponse (Maybe DBCluster) Source #

Undocumented member.

failoverDBClusterResponse_httpStatus :: Lens' FailoverDBClusterResponse Int Source #

The response's http status code.

FailoverGlobalCluster

failoverGlobalCluster_globalClusterIdentifier :: Lens' FailoverGlobalCluster Text Source #

Identifier of the Neptune global database that should be failed over. The identifier is the unique key assigned by the user when the Neptune global database was created. In other words, it's the name of the global database that you want to fail over.

Constraints: Must match the identifier of an existing Neptune global database.

failoverGlobalCluster_targetDbClusterIdentifier :: Lens' FailoverGlobalCluster Text Source #

The Amazon Resource Name (ARN) of the secondary Neptune DB cluster that you want to promote to primary for the global database.

failoverGlobalClusterResponse_globalCluster :: Lens' FailoverGlobalClusterResponse (Maybe GlobalCluster) Source #

Undocumented member.

failoverGlobalClusterResponse_httpStatus :: Lens' FailoverGlobalClusterResponse Int Source #

The response's http status code.

ListTagsForResource

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

This parameter is not currently supported.

listTagsForResource_resourceName :: Lens' ListTagsForResource Text Source #

The Amazon Neptune resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).

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

List of tags returned by the ListTagsForResource operation.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

ModifyDBCluster

modifyDBCluster_allowMajorVersionUpgrade :: Lens' ModifyDBCluster (Maybe Bool) Source #

A value that indicates whether upgrades between different major versions are allowed.

Constraints: You must set the allow-major-version-upgrade flag when providing an EngineVersion parameter that uses a different major version than the DB cluster's current version.

modifyDBCluster_applyImmediately :: Lens' ModifyDBCluster (Maybe Bool) Source #

A value that 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 DB cluster. If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window.

The ApplyImmediately parameter only affects NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to NewDBClusterIdentifier 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) Source #

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

Default: 1

Constraints:

Must be a value from 1 to 35

modifyDBCluster_cloudwatchLogsExportConfiguration :: Lens' ModifyDBCluster (Maybe CloudwatchLogsExportConfiguration) Source #

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

modifyDBCluster_copyTagsToSnapshot :: Lens' ModifyDBCluster (Maybe Bool) Source #

/If set to true, tags are copied to any snapshot of the DB cluster that is created./

modifyDBCluster_dbClusterParameterGroupName :: Lens' ModifyDBCluster (Maybe Text) Source #

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

modifyDBCluster_dbInstanceParameterGroupName :: Lens' ModifyDBCluster (Maybe Text) Source #

The name of the DB parameter group to apply to all instances of the DB cluster.

When you apply a parameter group using DBInstanceParameterGroupName, parameter changes aren't applied during the next maintenance window but instead are applied immediately.

Default: The existing name setting

Constraints:

The DB parameter group must be in the same DB parameter group family as the target DB cluster version.
The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter.

modifyDBCluster_deletionProtection :: Lens' ModifyDBCluster (Maybe Bool) Source #

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

modifyDBCluster_enableIAMDatabaseAuthentication :: Lens' ModifyDBCluster (Maybe Bool) Source #

True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

modifyDBCluster_engineVersion :: Lens' ModifyDBCluster (Maybe Text) Source #

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.

For a list of valid engine versions, see Engine Releases for Amazon Neptune, or call DescribeDBEngineVersions.

modifyDBCluster_masterUserPassword :: Lens' ModifyDBCluster (Maybe Text) Source #

Not supported by Neptune.

modifyDBCluster_newDBClusterIdentifier :: Lens' ModifyDBCluster (Maybe Text) Source #

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

Constraints:

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

Example: my-cluster2

modifyDBCluster_optionGroupName :: Lens' ModifyDBCluster (Maybe Text) Source #

Not supported by Neptune.

modifyDBCluster_port :: Lens' ModifyDBCluster (Maybe Int) Source #

The port number on which the DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

modifyDBCluster_preferredBackupWindow :: Lens' ModifyDBCluster (Maybe Text) Source #

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

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

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

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

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

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

Constraints: Minimum 30-minute window.

modifyDBCluster_serverlessV2ScalingConfiguration :: Lens' ModifyDBCluster (Maybe ServerlessV2ScalingConfiguration) Source #

Undocumented member.

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

A list of VPC security groups that the DB cluster will belong to.

modifyDBCluster_dbClusterIdentifier :: Lens' ModifyDBCluster Text Source #

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

Constraints:

Must match the identifier of an existing DBCluster.

modifyDBClusterResponse_dbCluster :: Lens' ModifyDBClusterResponse (Maybe DBCluster) Source #

Undocumented member.

modifyDBClusterResponse_httpStatus :: Lens' ModifyDBClusterResponse Int Source #

The response's http status code.

ModifyDBClusterEndpoint

modifyDBClusterEndpoint_endpointType :: Lens' ModifyDBClusterEndpoint (Maybe Text) Source #

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

modifyDBClusterEndpoint_excludedMembers :: Lens' ModifyDBClusterEndpoint (Maybe [Text]) Source #

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

modifyDBClusterEndpoint_staticMembers :: Lens' ModifyDBClusterEndpoint (Maybe [Text]) Source #

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

modifyDBClusterEndpoint_dbClusterEndpointIdentifier :: Lens' ModifyDBClusterEndpoint Text Source #

The identifier of the endpoint to modify. This parameter is stored as a lowercase string.

modifyDBClusterEndpointResponse_customEndpointType :: Lens' ModifyDBClusterEndpointResponse (Maybe Text) Source #

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

modifyDBClusterEndpointResponse_dbClusterEndpointArn :: Lens' ModifyDBClusterEndpointResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the endpoint.

modifyDBClusterEndpointResponse_dbClusterEndpointIdentifier :: Lens' ModifyDBClusterEndpointResponse (Maybe Text) Source #

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

modifyDBClusterEndpointResponse_dbClusterEndpointResourceIdentifier :: Lens' ModifyDBClusterEndpointResponse (Maybe Text) Source #

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

modifyDBClusterEndpointResponse_dbClusterIdentifier :: Lens' ModifyDBClusterEndpointResponse (Maybe Text) Source #

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

modifyDBClusterEndpointResponse_endpoint :: Lens' ModifyDBClusterEndpointResponse (Maybe Text) Source #

The DNS address of the endpoint.

modifyDBClusterEndpointResponse_endpointType :: Lens' ModifyDBClusterEndpointResponse (Maybe Text) Source #

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

modifyDBClusterEndpointResponse_excludedMembers :: Lens' ModifyDBClusterEndpointResponse (Maybe [Text]) Source #

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

modifyDBClusterEndpointResponse_staticMembers :: Lens' ModifyDBClusterEndpointResponse (Maybe [Text]) Source #

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

modifyDBClusterEndpointResponse_status :: Lens' ModifyDBClusterEndpointResponse (Maybe Text) Source #

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

modifyDBClusterEndpointResponse_httpStatus :: Lens' ModifyDBClusterEndpointResponse Int Source #

The response's http status code.

ModifyDBClusterParameterGroup

modifyDBClusterParameterGroup_dbClusterParameterGroupName :: Lens' ModifyDBClusterParameterGroup Text Source #

The name of the DB cluster parameter group to modify.

modifyDBClusterParameterGroup_parameters :: Lens' ModifyDBClusterParameterGroup [Parameter] Source #

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

dbClusterParameterGroupNameMessage_dbClusterParameterGroupName :: Lens' DBClusterParameterGroupNameMessage (Maybe Text) Source #

The name of the DB cluster parameter group.

Constraints:

Must be 1 to 255 letters or numbers.
First character must be a letter
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]) Source #

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

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

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

A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other Amazon accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon account identifiers, or all to remove authorization for any Amazon account to copy or restore the DB cluster snapshot. If you specify all, an Amazon account whose account ID is explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot.

modifyDBClusterSnapshotAttribute_dbClusterSnapshotIdentifier :: Lens' ModifyDBClusterSnapshotAttribute Text Source #

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

modifyDBClusterSnapshotAttribute_attributeName :: Lens' ModifyDBClusterSnapshotAttribute Text Source #

The name of the DB cluster snapshot attribute to modify.

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

modifyDBClusterSnapshotAttributeResponse_dbClusterSnapshotAttributesResult :: Lens' ModifyDBClusterSnapshotAttributeResponse (Maybe DBClusterSnapshotAttributesResult) Source #

Undocumented member.

modifyDBClusterSnapshotAttributeResponse_httpStatus :: Lens' ModifyDBClusterSnapshotAttributeResponse Int Source #

The response's http status code.

ModifyDBInstance

modifyDBInstance_allocatedStorage :: Lens' ModifyDBInstance (Maybe Int) Source #

Not supported by Neptune.

modifyDBInstance_allowMajorVersionUpgrade :: Lens' ModifyDBInstance (Maybe Bool) Source #

Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

modifyDBInstance_applyImmediately :: Lens' ModifyDBInstance (Maybe Bool) Source #

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 DB instance.

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

Default: false

modifyDBInstance_autoMinorVersionUpgrade :: Lens' ModifyDBInstance (Maybe Bool) Source #

Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and Neptune has enabled auto patching for that engine version.

modifyDBInstance_backupRetentionPeriod :: Lens' ModifyDBInstance (Maybe Int) Source #

Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

modifyDBInstance_cACertificateIdentifier :: Lens' ModifyDBInstance (Maybe Text) Source #

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

modifyDBInstance_cloudwatchLogsExportConfiguration :: Lens' ModifyDBInstance (Maybe CloudwatchLogsExportConfiguration) Source #

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.

modifyDBInstance_copyTagsToSnapshot :: Lens' ModifyDBInstance (Maybe Bool) Source #

True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.

modifyDBInstance_dbInstanceClass :: Lens' ModifyDBInstance (Maybe Text) Source #

The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all Amazon Regions.

If you modify the DB 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_dbParameterGroupName :: Lens' ModifyDBInstance (Maybe Text) Source #

The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.

Default: Uses existing setting

Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

modifyDBInstance_dbPortNumber :: Lens' ModifyDBInstance (Maybe Int) Source #

The port number on which the database accepts connections.

The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.

Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.

Default: 8182

modifyDBInstance_dbSecurityGroups :: Lens' ModifyDBInstance (Maybe [Text]) Source #

A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

If supplied, must match existing DBSecurityGroups.

modifyDBInstance_dbSubnetGroupName :: Lens' ModifyDBInstance (Maybe Text) Source #

The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC.

Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you specify true for the ApplyImmediately parameter.

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

Example: mySubnetGroup

modifyDBInstance_deletionProtection :: Lens' ModifyDBInstance (Maybe Bool) Source #

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

modifyDBInstance_domain :: Lens' ModifyDBInstance (Maybe Text) Source #

Not supported.

modifyDBInstance_domainIAMRoleName :: Lens' ModifyDBInstance (Maybe Text) Source #

Not supported

modifyDBInstance_enableIAMDatabaseAuthentication :: Lens' ModifyDBInstance (Maybe Bool) Source #

True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

You can enable IAM database authentication for the following database engines

Not applicable. Mapping Amazon IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: false

modifyDBInstance_enablePerformanceInsights :: Lens' ModifyDBInstance (Maybe Bool) Source #

(Not supported by Neptune)

modifyDBInstance_engineVersion :: Lens' ModifyDBInstance (Maybe Text) Source #

The version number of the database engine to upgrade to. Currently, setting this parameter has no effect. To upgrade your database engine to the most recent release, use the ApplyPendingMaintenanceAction API.

modifyDBInstance_iops :: Lens' ModifyDBInstance (Maybe Int) Source #

The new Provisioned IOPS (I/O operations per second) value for the instance.

Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

Default: Uses existing setting

modifyDBInstance_licenseModel :: Lens' ModifyDBInstance (Maybe Text) Source #

Not supported by Neptune.

modifyDBInstance_masterUserPassword :: Lens' ModifyDBInstance (Maybe Text) Source #

Not supported by Neptune.

modifyDBInstance_monitoringInterval :: Lens' ModifyDBInstance (Maybe Int) Source #

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

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

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

modifyDBInstance_monitoringRoleArn :: Lens' ModifyDBInstance (Maybe Text) Source #

The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess.

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

modifyDBInstance_multiAZ :: Lens' ModifyDBInstance (Maybe Bool) Source #

Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

modifyDBInstance_newDBInstanceIdentifier :: Lens' ModifyDBInstance (Maybe Text) Source #

The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if 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_optionGroupName :: Lens' ModifyDBInstance (Maybe Text) Source #

(Not supported by Neptune)

modifyDBInstance_performanceInsightsKMSKeyId :: Lens' ModifyDBInstance (Maybe Text) Source #

(Not supported by Neptune)

modifyDBInstance_preferredBackupWindow :: Lens' ModifyDBInstance (Maybe Text) Source #

The daily time range during which automated backups are created if automated backups are enabled.

Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

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

modifyDBInstance_preferredMaintenanceWindow :: Lens' ModifyDBInstance (Maybe Text) Source #

The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

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) Source #

A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid Values: 0 - 15

modifyDBInstance_publiclyAccessible :: Lens' ModifyDBInstance (Maybe Bool) Source #

This flag should no longer be used.

modifyDBInstance_storageType :: Lens' ModifyDBInstance (Maybe Text) Source #

Not supported.

modifyDBInstance_tdeCredentialArn :: Lens' ModifyDBInstance (Maybe Text) Source #

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

modifyDBInstance_tdeCredentialPassword :: Lens' ModifyDBInstance (Maybe Text) Source #

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

modifyDBInstance_vpcSecurityGroupIds :: Lens' ModifyDBInstance (Maybe [Text]) Source #

A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

If supplied, must match existing VpcSecurityGroupIds.

modifyDBInstance_dbInstanceIdentifier :: Lens' ModifyDBInstance Text Source #

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

Must match the identifier of an existing DBInstance.

modifyDBInstanceResponse_dbInstance :: Lens' ModifyDBInstanceResponse (Maybe DBInstance) Source #

Undocumented member.

modifyDBInstanceResponse_httpStatus :: Lens' ModifyDBInstanceResponse Int Source #

The response's http status code.

ModifyDBParameterGroup

modifyDBParameterGroup_dbParameterGroupName :: Lens' ModifyDBParameterGroup Text Source #

The name of the DB parameter group.

Constraints:

If supplied, must match the name of an existing DBParameterGroup.

modifyDBParameterGroup_parameters :: Lens' ModifyDBParameterGroup [Parameter] Source #

An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request.

Valid Values (for the application method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.

dbParameterGroupNameMessage_dbParameterGroupName :: Lens' DBParameterGroupNameMessage (Maybe Text) Source #

Provides the name of the DB parameter group.

ModifyDBSubnetGroup

modifyDBSubnetGroup_dbSubnetGroupDescription :: Lens' ModifyDBSubnetGroup (Maybe Text) Source #

The description for the DB subnet group.

modifyDBSubnetGroup_dbSubnetGroupName :: Lens' ModifyDBSubnetGroup Text Source #

The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group.

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

Example: mySubnetgroup

modifyDBSubnetGroup_subnetIds :: Lens' ModifyDBSubnetGroup [Text] Source #

The EC2 subnet IDs for the DB subnet group.

modifyDBSubnetGroupResponse_dbSubnetGroup :: Lens' ModifyDBSubnetGroupResponse (Maybe DBSubnetGroup) Source #

Undocumented member.

modifyDBSubnetGroupResponse_httpStatus :: Lens' ModifyDBSubnetGroupResponse Int Source #

The response's http status code.

ModifyEventSubscription

modifyEventSubscription_enabled :: Lens' ModifyEventSubscription (Maybe Bool) Source #

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

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

A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the DescribeEventCategories action.

modifyEventSubscription_snsTopicArn :: Lens' ModifyEventSubscription (Maybe Text) Source #

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

modifyEventSubscription_sourceType :: Lens' ModifyEventSubscription (Maybe Text) Source #

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

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

modifyEventSubscription_subscriptionName :: Lens' ModifyEventSubscription Text Source #

The name of the event notification subscription.

modifyEventSubscriptionResponse_eventSubscription :: Lens' ModifyEventSubscriptionResponse (Maybe EventSubscription) Source #

Undocumented member.

modifyEventSubscriptionResponse_httpStatus :: Lens' ModifyEventSubscriptionResponse Int Source #

The response's http status code.

ModifyGlobalCluster

modifyGlobalCluster_allowMajorVersionUpgrade :: Lens' ModifyGlobalCluster (Maybe Bool) Source #

A value that indicates whether major version upgrades are allowed.

Constraints: You must allow major version upgrades if you specify a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.

If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version, so you will need to apply any custom parameter groups after completing the upgrade.

modifyGlobalCluster_deletionProtection :: Lens' ModifyGlobalCluster (Maybe Bool) Source #

Indicates whether the global database has deletion protection enabled. The global database cannot be deleted when deletion protection is enabled.

modifyGlobalCluster_engineVersion :: Lens' ModifyGlobalCluster (Maybe Text) Source #

The version number of the database engine to which you want to upgrade. Changing this parameter will result in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

To list all of the available Neptune engine versions, use the following command:

modifyGlobalCluster_newGlobalClusterIdentifier :: Lens' ModifyGlobalCluster (Maybe Text) Source #

A new cluster identifier to assign to the global database. This value is stored as a lowercase string.

Constraints:

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

Example: my-cluster2

modifyGlobalCluster_globalClusterIdentifier :: Lens' ModifyGlobalCluster Text Source #

The DB cluster identifier for the global cluster being modified. This parameter is not case-sensitive.

Constraints: Must match the identifier of an existing global database cluster.

modifyGlobalClusterResponse_globalCluster :: Lens' ModifyGlobalClusterResponse (Maybe GlobalCluster) Source #

Undocumented member.

modifyGlobalClusterResponse_httpStatus :: Lens' ModifyGlobalClusterResponse Int Source #

The response's http status code.

PromoteReadReplicaDBCluster

promoteReadReplicaDBCluster_dbClusterIdentifier :: Lens' PromoteReadReplicaDBCluster Text Source #

Not supported.

promoteReadReplicaDBClusterResponse_dbCluster :: Lens' PromoteReadReplicaDBClusterResponse (Maybe DBCluster) Source #

Undocumented member.

promoteReadReplicaDBClusterResponse_httpStatus :: Lens' PromoteReadReplicaDBClusterResponse Int Source #

The response's http status code.

RebootDBInstance

rebootDBInstance_forceFailover :: Lens' RebootDBInstance (Maybe Bool) Source #

When true, the reboot is conducted through a MultiAZ failover.

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

rebootDBInstance_dbInstanceIdentifier :: Lens' RebootDBInstance Text Source #

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

Constraints:

Must match the identifier of an existing DBInstance.

rebootDBInstanceResponse_dbInstance :: Lens' RebootDBInstanceResponse (Maybe DBInstance) Source #

Undocumented member.

rebootDBInstanceResponse_httpStatus :: Lens' RebootDBInstanceResponse Int Source #

The response's http status code.

RemoveFromGlobalCluster

removeFromGlobalCluster_globalClusterIdentifier :: Lens' RemoveFromGlobalCluster Text Source #

The identifier of the Neptune global database from which to detach the specified Neptune DB cluster.

removeFromGlobalCluster_dbClusterIdentifier :: Lens' RemoveFromGlobalCluster Text Source #

The Amazon Resource Name (ARN) identifying the cluster to be detached from the Neptune global database cluster.

removeFromGlobalClusterResponse_globalCluster :: Lens' RemoveFromGlobalClusterResponse (Maybe GlobalCluster) Source #

Undocumented member.

removeFromGlobalClusterResponse_httpStatus :: Lens' RemoveFromGlobalClusterResponse Int Source #

The response's http status code.

RemoveRoleFromDBCluster

removeRoleFromDBCluster_featureName :: Lens' RemoveRoleFromDBCluster (Maybe Text) Source #

The name of the feature for the DB cluster that the IAM role is to be disassociated from. For the list of supported feature names, see DescribeDBEngineVersions.

removeRoleFromDBCluster_dbClusterIdentifier :: Lens' RemoveRoleFromDBCluster Text Source #

The name of the DB cluster to disassociate the IAM role from.

removeRoleFromDBCluster_roleArn :: Lens' RemoveRoleFromDBCluster Text Source #

The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB cluster, for example arn:aws:iam::123456789012:role/NeptuneAccessRole.

RemoveSourceIdentifierFromSubscription

removeSourceIdentifierFromSubscription_subscriptionName :: Lens' RemoveSourceIdentifierFromSubscription Text Source #

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

removeSourceIdentifierFromSubscription_sourceIdentifier :: Lens' RemoveSourceIdentifierFromSubscription Text Source #

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

removeSourceIdentifierFromSubscriptionResponse_eventSubscription :: Lens' RemoveSourceIdentifierFromSubscriptionResponse (Maybe EventSubscription) Source #

Undocumented member.

removeSourceIdentifierFromSubscriptionResponse_httpStatus :: Lens' RemoveSourceIdentifierFromSubscriptionResponse Int Source #

The response's http status code.

RemoveTagsFromResource

removeTagsFromResource_resourceName :: Lens' RemoveTagsFromResource Text Source #

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

removeTagsFromResource_tagKeys :: Lens' RemoveTagsFromResource [Text] Source #

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

ResetDBClusterParameterGroup

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

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

resetDBClusterParameterGroup_resetAllParameters :: Lens' ResetDBClusterParameterGroup (Maybe Bool) Source #

A value that is set to true to reset all parameters in the DB 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 Source #

The name of the DB cluster parameter group to reset.

dbClusterParameterGroupNameMessage_dbClusterParameterGroupName :: Lens' DBClusterParameterGroupNameMessage (Maybe Text) Source #

The name of the DB cluster parameter group.

Constraints:

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

This value is stored as a lowercase string.

ResetDBParameterGroup

resetDBParameterGroup_parameters :: Lens' ResetDBParameterGroup (Maybe [Parameter]) Source #

To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

Valid Values (for Apply method): pending-reboot

resetDBParameterGroup_resetAllParameters :: Lens' ResetDBParameterGroup (Maybe Bool) Source #

Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

Default: true

resetDBParameterGroup_dbParameterGroupName :: Lens' ResetDBParameterGroup Text Source #

The name of the DB parameter group.

Constraints:

Must match the name of an existing DBParameterGroup.

dbParameterGroupNameMessage_dbParameterGroupName :: Lens' DBParameterGroupNameMessage (Maybe Text) Source #

Provides the name of the DB parameter group.

RestoreDBClusterFromSnapshot

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

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

restoreDBClusterFromSnapshot_copyTagsToSnapshot :: Lens' RestoreDBClusterFromSnapshot (Maybe Bool) Source #

/If set to true, tags are copied to any snapshot of the restored DB cluster that is created./

restoreDBClusterFromSnapshot_dbClusterParameterGroupName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #

The name of the DB cluster parameter group to associate with the new DB cluster.

Constraints:

If supplied, must match the name of an existing DBClusterParameterGroup.

restoreDBClusterFromSnapshot_dbSubnetGroupName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #

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

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

Example: mySubnetgroup

restoreDBClusterFromSnapshot_databaseName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #

Not supported.

restoreDBClusterFromSnapshot_deletionProtection :: Lens' RestoreDBClusterFromSnapshot (Maybe Bool) Source #

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

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

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.

restoreDBClusterFromSnapshot_enableIAMDatabaseAuthentication :: Lens' RestoreDBClusterFromSnapshot (Maybe Bool) Source #

True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

restoreDBClusterFromSnapshot_engineVersion :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #

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

restoreDBClusterFromSnapshot_kmsKeyId :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #

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

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

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

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

restoreDBClusterFromSnapshot_optionGroupName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #

(Not supported by Neptune)

restoreDBClusterFromSnapshot_port :: Lens' RestoreDBClusterFromSnapshot (Maybe Int) Source #

The port number on which the new DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

restoreDBClusterFromSnapshot_serverlessV2ScalingConfiguration :: Lens' RestoreDBClusterFromSnapshot (Maybe ServerlessV2ScalingConfiguration) Source #

Undocumented member.

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

The tags to be assigned to the restored DB cluster.

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

A list of VPC security groups that the new DB cluster will belong to.

restoreDBClusterFromSnapshot_dbClusterIdentifier :: Lens' RestoreDBClusterFromSnapshot Text Source #

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

Constraints:

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

Example: my-snapshot-id

restoreDBClusterFromSnapshot_snapshotIdentifier :: Lens' RestoreDBClusterFromSnapshot Text Source #

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

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

Constraints:

Must match the identifier of an existing Snapshot.

restoreDBClusterFromSnapshot_engine :: Lens' RestoreDBClusterFromSnapshot Text Source #

The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source

restoreDBClusterFromSnapshotResponse_dbCluster :: Lens' RestoreDBClusterFromSnapshotResponse (Maybe DBCluster) Source #

Undocumented member.

restoreDBClusterFromSnapshotResponse_httpStatus :: Lens' RestoreDBClusterFromSnapshotResponse Int Source #

The response's http status code.

RestoreDBClusterToPointInTime

restoreDBClusterToPointInTime_dbClusterParameterGroupName :: Lens' RestoreDBClusterToPointInTime (Maybe Text) Source #

The name of the DB cluster parameter group to associate with the new DB cluster.

Constraints:

If supplied, must match the name of an existing DBClusterParameterGroup.

restoreDBClusterToPointInTime_dbSubnetGroupName :: Lens' RestoreDBClusterToPointInTime (Maybe Text) Source #

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

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

Example: mySubnetgroup

restoreDBClusterToPointInTime_deletionProtection :: Lens' RestoreDBClusterToPointInTime (Maybe Bool) Source #

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

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

The list of logs that the restored DB cluster is to export to CloudWatch Logs.

restoreDBClusterToPointInTime_enableIAMDatabaseAuthentication :: Lens' RestoreDBClusterToPointInTime (Maybe Bool) Source #

True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

restoreDBClusterToPointInTime_kmsKeyId :: Lens' RestoreDBClusterToPointInTime (Maybe Text) Source #

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

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

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

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

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

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

restoreDBClusterToPointInTime_optionGroupName :: Lens' RestoreDBClusterToPointInTime (Maybe Text) Source #

(Not supported by Neptune)

restoreDBClusterToPointInTime_port :: Lens' RestoreDBClusterToPointInTime (Maybe Int) Source #

The port number on which the new DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

restoreDBClusterToPointInTime_restoreToTime :: Lens' RestoreDBClusterToPointInTime (Maybe UTCTime) Source #

The date and time to restore the DB cluster to.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

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

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

restoreDBClusterToPointInTime_restoreType :: Lens' RestoreDBClusterToPointInTime (Maybe Text) Source #

The type of restore to be performed. You can specify one of the following values:

full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

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_serverlessV2ScalingConfiguration :: Lens' RestoreDBClusterToPointInTime (Maybe ServerlessV2ScalingConfiguration) Source #

Undocumented member.

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

The tags to be applied to the restored DB cluster.

restoreDBClusterToPointInTime_useLatestRestorableTime :: Lens' RestoreDBClusterToPointInTime (Maybe Bool) Source #

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

Default: false

Constraints: Cannot be specified if RestoreToTime parameter is provided.

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

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

restoreDBClusterToPointInTime_dbClusterIdentifier :: Lens' RestoreDBClusterToPointInTime Text Source #

The name of the new DB cluster to be created.

Constraints:

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

restoreDBClusterToPointInTime_sourceDBClusterIdentifier :: Lens' RestoreDBClusterToPointInTime Text Source #

The identifier of the source DB cluster from which to restore.

Constraints:

Must match the identifier of an existing DBCluster.

restoreDBClusterToPointInTimeResponse_dbCluster :: Lens' RestoreDBClusterToPointInTimeResponse (Maybe DBCluster) Source #

Undocumented member.

restoreDBClusterToPointInTimeResponse_httpStatus :: Lens' RestoreDBClusterToPointInTimeResponse Int Source #

The response's http status code.

StartDBCluster

startDBCluster_dbClusterIdentifier :: Lens' StartDBCluster Text Source #

The DB cluster identifier of the Neptune DB cluster to be started. This parameter is stored as a lowercase string.

startDBClusterResponse_dbCluster :: Lens' StartDBClusterResponse (Maybe DBCluster) Source #

Undocumented member.

startDBClusterResponse_httpStatus :: Lens' StartDBClusterResponse Int Source #

The response's http status code.

StopDBCluster

stopDBCluster_dbClusterIdentifier :: Lens' StopDBCluster Text Source #

The DB cluster identifier of the Neptune DB cluster to be stopped. This parameter is stored as a lowercase string.

stopDBClusterResponse_dbCluster :: Lens' StopDBClusterResponse (Maybe DBCluster) Source #

Undocumented member.

stopDBClusterResponse_httpStatus :: Lens' StopDBClusterResponse Int Source #

The response's http status code.

Types

AvailabilityZone

availabilityZone_name :: Lens' AvailabilityZone (Maybe Text) Source #

The name of the availability zone.

CharacterSet

characterSet_characterSetDescription :: Lens' CharacterSet (Maybe Text) Source #

The description of the character set.

characterSet_characterSetName :: Lens' CharacterSet (Maybe Text) Source #

The name of the character set.

CloudwatchLogsExportConfiguration

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

The list of log types to disable.

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

The list of log types to enable.

DBCluster

dbCluster_allocatedStorage :: Lens' DBCluster (Maybe Int) Source #

AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

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

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

dbCluster_automaticRestartTime :: Lens' DBCluster (Maybe UTCTime) Source #

Time at which the DB cluster will be automatically restarted.

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

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

dbCluster_backupRetentionPeriod :: Lens' DBCluster (Maybe Int) Source #

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

dbCluster_characterSetName :: Lens' DBCluster (Maybe Text) Source #

Not supported by Neptune.

dbCluster_cloneGroupId :: Lens' DBCluster (Maybe Text) Source #

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

dbCluster_clusterCreateTime :: Lens' DBCluster (Maybe UTCTime) Source #

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

dbCluster_copyTagsToSnapshot :: Lens' DBCluster (Maybe Bool) Source #

/If set to true, tags are copied to any snapshot of the DB cluster that is created./

dbCluster_crossAccountClone :: Lens' DBCluster (Maybe Bool) Source #

If set to true, the DB cluster can be cloned across accounts.

dbCluster_dbClusterArn :: Lens' DBCluster (Maybe Text) Source #

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

dbCluster_dbClusterIdentifier :: Lens' DBCluster (Maybe Text) Source #

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

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

Provides the list of instances that make up the DB cluster.

dbCluster_dbClusterOptionGroupMemberships :: Lens' DBCluster (Maybe [DBClusterOptionGroupStatus]) Source #

Not supported by Neptune.

dbCluster_dbClusterParameterGroup :: Lens' DBCluster (Maybe Text) Source #

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

dbCluster_dbSubnetGroup :: Lens' DBCluster (Maybe Text) Source #

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

dbCluster_databaseName :: Lens' DBCluster (Maybe Text) Source #

Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

dbCluster_dbClusterResourceId :: Lens' DBCluster (Maybe Text) Source #

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

dbCluster_deletionProtection :: Lens' DBCluster (Maybe Bool) Source #

Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

dbCluster_earliestRestorableTime :: Lens' DBCluster (Maybe UTCTime) Source #

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

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

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

dbCluster_endpoint :: Lens' DBCluster (Maybe Text) Source #

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

dbCluster_engine :: Lens' DBCluster (Maybe Text) Source #

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

dbCluster_engineVersion :: Lens' DBCluster (Maybe Text) Source #

Indicates the database engine version.

dbCluster_hostedZoneId :: Lens' DBCluster (Maybe Text) Source #

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

dbCluster_iAMDatabaseAuthenticationEnabled :: Lens' DBCluster (Maybe Bool) Source #

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

dbCluster_kmsKeyId :: Lens' DBCluster (Maybe Text) Source #

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

dbCluster_latestRestorableTime :: Lens' DBCluster (Maybe UTCTime) Source #

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

dbCluster_masterUsername :: Lens' DBCluster (Maybe Text) Source #

Not supported by Neptune.

dbCluster_multiAZ :: Lens' DBCluster (Maybe Bool) Source #

Specifies whether the DB cluster has instances in multiple Availability Zones.

dbCluster_percentProgress :: Lens' DBCluster (Maybe Text) Source #

Specifies the progress of the operation as a percentage.

dbCluster_port :: Lens' DBCluster (Maybe Int) Source #

Specifies the port that the database engine is listening on.

dbCluster_preferredBackupWindow :: Lens' DBCluster (Maybe Text) Source #

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

dbCluster_preferredMaintenanceWindow :: Lens' DBCluster (Maybe Text) Source #

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

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

Contains one or more identifiers of the Read Replicas associated with this DB cluster.

dbCluster_readerEndpoint :: Lens' DBCluster (Maybe Text) Source #

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

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

dbCluster_replicationSourceIdentifier :: Lens' DBCluster (Maybe Text) Source #

Not supported by Neptune.

dbCluster_serverlessV2ScalingConfiguration :: Lens' DBCluster (Maybe ServerlessV2ScalingConfigurationInfo) Source #

Undocumented member.

dbCluster_status :: Lens' DBCluster (Maybe Text) Source #

Specifies the current state of this DB cluster.

dbCluster_storageEncrypted :: Lens' DBCluster (Maybe Bool) Source #

Specifies whether the DB cluster is encrypted.

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

Provides a list of VPC security groups that the DB cluster belongs to.

DBClusterEndpoint

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

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

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

The Amazon Resource Name (ARN) for the endpoint.

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

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

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

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

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

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

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

The DNS address of the endpoint.

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

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

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

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

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

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

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

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

DBClusterMember

dbClusterMember_dbClusterParameterGroupStatus :: Lens' DBClusterMember (Maybe Text) Source #

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

dbClusterMember_dbInstanceIdentifier :: Lens' DBClusterMember (Maybe Text) Source #

Specifies the instance identifier for this member of the DB cluster.

dbClusterMember_isClusterWriter :: Lens' DBClusterMember (Maybe Bool) Source #

Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

dbClusterMember_promotionTier :: Lens' DBClusterMember (Maybe Int) Source #

A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

DBClusterOptionGroupStatus

dbClusterOptionGroupStatus_dbClusterOptionGroupName :: Lens' DBClusterOptionGroupStatus (Maybe Text) Source #

Not supported by Neptune.

dbClusterOptionGroupStatus_status :: Lens' DBClusterOptionGroupStatus (Maybe Text) Source #

Not supported by Neptune.

DBClusterParameterGroup

dbClusterParameterGroup_dbClusterParameterGroupArn :: Lens' DBClusterParameterGroup (Maybe Text) Source #

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

dbClusterParameterGroup_dbClusterParameterGroupName :: Lens' DBClusterParameterGroup (Maybe Text) Source #

Provides the name of the DB cluster parameter group.

dbClusterParameterGroup_dbParameterGroupFamily :: Lens' DBClusterParameterGroup (Maybe Text) Source #

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

dbClusterParameterGroup_description :: Lens' DBClusterParameterGroup (Maybe Text) Source #

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

DBClusterParameterGroupNameMessage

dbClusterParameterGroupNameMessage_dbClusterParameterGroupName :: Lens' DBClusterParameterGroupNameMessage (Maybe Text) Source #

The name of the DB cluster parameter group.

Constraints:

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

This value is stored as a lowercase string.

DBClusterRole

dbClusterRole_featureName :: Lens' DBClusterRole (Maybe Text) Source #

The name of the feature associated with the Amazon Identity and Access Management (IAM) role. For the list of supported feature names, see DescribeDBEngineVersions.

dbClusterRole_roleArn :: Lens' DBClusterRole (Maybe Text) Source #

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

dbClusterRole_status :: Lens' DBClusterRole (Maybe Text) Source #

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

ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon services on your behalf.
PENDING - the IAM role ARN is being associated with the DB cluster.
INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon services on your behalf.

DBClusterSnapshot

dbClusterSnapshot_allocatedStorage :: Lens' DBClusterSnapshot (Maybe Int) Source #

Specifies the allocated storage size in gibibytes (GiB).

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

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

dbClusterSnapshot_clusterCreateTime :: Lens' DBClusterSnapshot (Maybe UTCTime) Source #

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

dbClusterSnapshot_dbClusterIdentifier :: Lens' DBClusterSnapshot (Maybe Text) Source #

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

dbClusterSnapshot_dbClusterSnapshotArn :: Lens' DBClusterSnapshot (Maybe Text) Source #

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

dbClusterSnapshot_dbClusterSnapshotIdentifier :: Lens' DBClusterSnapshot (Maybe Text) Source #

Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.

After you restore a DB cluster using a DBClusterSnapshotIdentifier, you must specify the same DBClusterSnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.

However, if you don't specify the DBClusterSnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the DBClusterSnapshotIdentifier, and the original DB cluster is deleted.

dbClusterSnapshot_engine :: Lens' DBClusterSnapshot (Maybe Text) Source #

Specifies the name of the database engine.

dbClusterSnapshot_engineVersion :: Lens' DBClusterSnapshot (Maybe Text) Source #

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

dbClusterSnapshot_iAMDatabaseAuthenticationEnabled :: Lens' DBClusterSnapshot (Maybe Bool) Source #

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

dbClusterSnapshot_kmsKeyId :: Lens' DBClusterSnapshot (Maybe Text) Source #

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

dbClusterSnapshot_licenseModel :: Lens' DBClusterSnapshot (Maybe Text) Source #

Provides the license model information for this DB cluster snapshot.

dbClusterSnapshot_masterUsername :: Lens' DBClusterSnapshot (Maybe Text) Source #

Not supported by Neptune.

dbClusterSnapshot_percentProgress :: Lens' DBClusterSnapshot (Maybe Int) Source #

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

dbClusterSnapshot_port :: Lens' DBClusterSnapshot (Maybe Int) Source #

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

dbClusterSnapshot_snapshotCreateTime :: Lens' DBClusterSnapshot (Maybe UTCTime) Source #

Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

dbClusterSnapshot_snapshotType :: Lens' DBClusterSnapshot (Maybe Text) Source #

Provides the type of the DB cluster snapshot.

dbClusterSnapshot_sourceDBClusterSnapshotArn :: Lens' DBClusterSnapshot (Maybe Text) Source #

If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

dbClusterSnapshot_status :: Lens' DBClusterSnapshot (Maybe Text) Source #

Specifies the status of this DB cluster snapshot.

dbClusterSnapshot_storageEncrypted :: Lens' DBClusterSnapshot (Maybe Bool) Source #

Specifies whether the DB cluster snapshot is encrypted.

dbClusterSnapshot_vpcId :: Lens' DBClusterSnapshot (Maybe Text) Source #

Provides the VPC ID associated with the DB cluster snapshot.

DBClusterSnapshotAttribute

dbClusterSnapshotAttribute_attributeName :: Lens' DBClusterSnapshotAttribute (Maybe Text) Source #

The name of the manual DB cluster snapshot attribute.

The attribute named restore refers to the list of Amazon accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

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

The value(s) for the manual DB cluster snapshot attribute.

If the AttributeName field is set to restore, then this element returns a list of IDs of the Amazon accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot is public and available for any Amazon account to copy or restore.

DBClusterSnapshotAttributesResult

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

The list of attributes and values for the manual DB cluster snapshot.

dbClusterSnapshotAttributesResult_dbClusterSnapshotIdentifier :: Lens' DBClusterSnapshotAttributesResult (Maybe Text) Source #

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

DBEngineVersion

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

The description of the database engine.

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

The description of the database engine version.

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

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

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

(Not supported by Neptune)

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

The name of the database engine.

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

The version number of the database engine.

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

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

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

(Not supported by Neptune)

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

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

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

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

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

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

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

Indicates whether the database engine version supports read replicas.

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

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

DBInstance

dbInstance_allocatedStorage :: Lens' DBInstance (Maybe Int) Source #

Not supported by Neptune.

dbInstance_autoMinorVersionUpgrade :: Lens' DBInstance (Maybe Bool) Source #

Indicates that minor version patches are applied automatically.

dbInstance_availabilityZone :: Lens' DBInstance (Maybe Text) Source #

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

dbInstance_backupRetentionPeriod :: Lens' DBInstance (Maybe Int) Source #

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

dbInstance_cACertificateIdentifier :: Lens' DBInstance (Maybe Text) Source #

The identifier of the CA certificate for this DB instance.

dbInstance_characterSetName :: Lens' DBInstance (Maybe Text) Source #

(Not supported by Neptune)

dbInstance_copyTagsToSnapshot :: Lens' DBInstance (Maybe Bool) Source #

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

dbInstance_dbClusterIdentifier :: Lens' DBInstance (Maybe Text) Source #

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

dbInstance_dbInstanceArn :: Lens' DBInstance (Maybe Text) Source #

The Amazon Resource Name (ARN) for the DB instance.

dbInstance_dbInstanceClass :: Lens' DBInstance (Maybe Text) Source #

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

dbInstance_dbInstanceIdentifier :: Lens' DBInstance (Maybe Text) Source #

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

dbInstance_dbInstanceStatus :: Lens' DBInstance (Maybe Text) Source #

Specifies the current state of this database.

dbInstance_dbName :: Lens' DBInstance (Maybe Text) Source #

The database name.

dbInstance_dbParameterGroups :: Lens' DBInstance (Maybe [DBParameterGroupStatus]) Source #

Provides the list of DB parameter groups applied to this DB instance.

dbInstance_dbSecurityGroups :: Lens' DBInstance (Maybe [DBSecurityGroupMembership]) Source #

Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

dbInstance_dbSubnetGroup :: Lens' DBInstance (Maybe DBSubnetGroup) Source #

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

dbInstance_dbInstancePort :: Lens' DBInstance (Maybe Int) Source #

Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

dbInstance_dbiResourceId :: Lens' DBInstance (Maybe Text) Source #

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

dbInstance_deletionProtection :: Lens' DBInstance (Maybe Bool) Source #

Indicates whether or not the DB instance has deletion protection enabled. The instance can't be deleted when deletion protection is enabled. See Deleting a DB Instance.

dbInstance_domainMemberships :: Lens' DBInstance (Maybe [DomainMembership]) Source #

Not supported

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

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

dbInstance_endpoint :: Lens' DBInstance (Maybe Endpoint) Source #

Specifies the connection endpoint.

dbInstance_engine :: Lens' DBInstance (Maybe Text) Source #

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

dbInstance_engineVersion :: Lens' DBInstance (Maybe Text) Source #

Indicates the database engine version.

dbInstance_enhancedMonitoringResourceArn :: Lens' DBInstance (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

dbInstance_iAMDatabaseAuthenticationEnabled :: Lens' DBInstance (Maybe Bool) Source #

True if Amazon Identity and Access Management (IAM) authentication is enabled, and otherwise false.

dbInstance_instanceCreateTime :: Lens' DBInstance (Maybe UTCTime) Source #

Provides the date and time the DB instance was created.

dbInstance_iops :: Lens' DBInstance (Maybe Int) Source #

Specifies the Provisioned IOPS (I/O operations per second) value.

dbInstance_kmsKeyId :: Lens' DBInstance (Maybe Text) Source #

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

dbInstance_latestRestorableTime :: Lens' DBInstance (Maybe UTCTime) Source #

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

dbInstance_licenseModel :: Lens' DBInstance (Maybe Text) Source #

License model information for this DB instance.

dbInstance_masterUsername :: Lens' DBInstance (Maybe Text) Source #

Not supported by Neptune.

dbInstance_monitoringInterval :: Lens' DBInstance (Maybe Int) Source #

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

dbInstance_monitoringRoleArn :: Lens' DBInstance (Maybe Text) Source #

The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

dbInstance_multiAZ :: Lens' DBInstance (Maybe Bool) Source #

Specifies if the DB instance is a Multi-AZ deployment.

dbInstance_optionGroupMemberships :: Lens' DBInstance (Maybe [OptionGroupMembership]) Source #

(Not supported by Neptune)

dbInstance_pendingModifiedValues :: Lens' DBInstance (Maybe PendingModifiedValues) Source #

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

dbInstance_performanceInsightsEnabled :: Lens' DBInstance (Maybe Bool) Source #

(Not supported by Neptune)

dbInstance_performanceInsightsKMSKeyId :: Lens' DBInstance (Maybe Text) Source #

(Not supported by Neptune)

dbInstance_preferredBackupWindow :: Lens' DBInstance (Maybe Text) Source #

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

dbInstance_preferredMaintenanceWindow :: Lens' DBInstance (Maybe Text) Source #

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

dbInstance_promotionTier :: Lens' DBInstance (Maybe Int) Source #

A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

dbInstance_publiclyAccessible :: Lens' DBInstance (Maybe Bool) Source #

This flag should no longer be used.

dbInstance_readReplicaDBClusterIdentifiers :: Lens' DBInstance (Maybe [Text]) Source #

Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.

dbInstance_readReplicaDBInstanceIdentifiers :: Lens' DBInstance (Maybe [Text]) Source #

Contains one or more identifiers of the Read Replicas associated with this DB instance.

dbInstance_readReplicaSourceDBInstanceIdentifier :: Lens' DBInstance (Maybe Text) Source #

Contains the identifier of the source DB instance if this DB instance is a Read Replica.

dbInstance_secondaryAvailabilityZone :: Lens' DBInstance (Maybe Text) Source #

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

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

The status of a Read Replica. If the instance is not a Read Replica, this is blank.

dbInstance_storageEncrypted :: Lens' DBInstance (Maybe Bool) Source #

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

dbInstance_storageType :: Lens' DBInstance (Maybe Text) Source #

Specifies the storage type associated with DB instance.

dbInstance_tdeCredentialArn :: Lens' DBInstance (Maybe Text) Source #

The ARN from the key store with which the instance is associated for TDE encryption.

dbInstance_timezone :: Lens' DBInstance (Maybe Text) Source #

Not supported.

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

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

DBInstanceStatusInfo

dbInstanceStatusInfo_message :: Lens' DBInstanceStatusInfo (Maybe Text) Source #

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) Source #

Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

dbInstanceStatusInfo_status :: Lens' DBInstanceStatusInfo (Maybe Text) Source #

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

dbInstanceStatusInfo_statusType :: Lens' DBInstanceStatusInfo (Maybe Text) Source #

This value is currently "read replication."

DBParameterGroup

dbParameterGroup_dbParameterGroupArn :: Lens' DBParameterGroup (Maybe Text) Source #

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

dbParameterGroup_dbParameterGroupFamily :: Lens' DBParameterGroup (Maybe Text) Source #

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

dbParameterGroup_dbParameterGroupName :: Lens' DBParameterGroup (Maybe Text) Source #

Provides the name of the DB parameter group.

dbParameterGroup_description :: Lens' DBParameterGroup (Maybe Text) Source #

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

DBParameterGroupNameMessage

dbParameterGroupNameMessage_dbParameterGroupName :: Lens' DBParameterGroupNameMessage (Maybe Text) Source #

Provides the name of the DB parameter group.

DBParameterGroupStatus

dbParameterGroupStatus_dbParameterGroupName :: Lens' DBParameterGroupStatus (Maybe Text) Source #

The name of the DP parameter group.

dbParameterGroupStatus_parameterApplyStatus :: Lens' DBParameterGroupStatus (Maybe Text) Source #

The status of parameter updates.

DBSecurityGroupMembership

dbSecurityGroupMembership_dbSecurityGroupName :: Lens' DBSecurityGroupMembership (Maybe Text) Source #

The name of the DB security group.

dbSecurityGroupMembership_status :: Lens' DBSecurityGroupMembership (Maybe Text) Source #

The status of the DB security group.

DBSubnetGroup

dbSubnetGroup_dbSubnetGroupArn :: Lens' DBSubnetGroup (Maybe Text) Source #

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

dbSubnetGroup_dbSubnetGroupDescription :: Lens' DBSubnetGroup (Maybe Text) Source #

Provides the description of the DB subnet group.

dbSubnetGroup_dbSubnetGroupName :: Lens' DBSubnetGroup (Maybe Text) Source #

The name of the DB subnet group.

dbSubnetGroup_subnetGroupStatus :: Lens' DBSubnetGroup (Maybe Text) Source #

Provides the status of the DB subnet group.

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

Contains a list of Subnet elements.

dbSubnetGroup_vpcId :: Lens' DBSubnetGroup (Maybe Text) Source #

Provides the VpcId of the DB subnet group.

DomainMembership

domainMembership_domain :: Lens' DomainMembership (Maybe Text) Source #

The identifier of the Active Directory Domain.

domainMembership_fqdn :: Lens' DomainMembership (Maybe Text) Source #

The fully qualified domain name of the Active Directory Domain.

domainMembership_iAMRoleName :: Lens' DomainMembership (Maybe Text) Source #

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

domainMembership_status :: Lens' DomainMembership (Maybe Text) Source #

The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).

DoubleRange

doubleRange_from :: Lens' DoubleRange (Maybe Double) Source #

The minimum value in the range.

doubleRange_to :: Lens' DoubleRange (Maybe Double) Source #

The maximum value in the range.

Endpoint

endpoint_address :: Lens' Endpoint (Maybe Text) Source #

Specifies the DNS address of the DB instance.

endpoint_hostedZoneId :: Lens' Endpoint (Maybe Text) Source #

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

endpoint_port :: Lens' Endpoint (Maybe Int) Source #

Specifies the port that the database engine is listening on.

EngineDefaults

engineDefaults_dbParameterGroupFamily :: Lens' EngineDefaults (Maybe Text) Source #

Specifies the name of the DB parameter group family that the engine default parameters apply to.

engineDefaults_marker :: Lens' EngineDefaults (Maybe Text) Source #

An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

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

Contains a list of engine default parameters.

Event

event_date :: Lens' Event (Maybe UTCTime) Source #

Specifies the date and time of the event.

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

Specifies the category for the event.

event_message :: Lens' Event (Maybe Text) Source #

Provides the text of this event.

event_sourceArn :: Lens' Event (Maybe Text) Source #

The Amazon Resource Name (ARN) for the event.

event_sourceIdentifier :: Lens' Event (Maybe Text) Source #

Provides the identifier for the source of the event.

event_sourceType :: Lens' Event (Maybe SourceType) Source #

Specifies the source type for this event.

EventCategoriesMap

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

The event categories for the specified source type

eventCategoriesMap_sourceType :: Lens' EventCategoriesMap (Maybe Text) Source #

The source type that the returned categories belong to

EventSubscription

eventSubscription_custSubscriptionId :: Lens' EventSubscription (Maybe Text) Source #

The event notification subscription Id.

eventSubscription_customerAwsId :: Lens' EventSubscription (Maybe Text) Source #

The Amazon customer account associated with the event notification subscription.

eventSubscription_enabled :: Lens' EventSubscription (Maybe Bool) Source #

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

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

A list of event categories for the event notification subscription.

eventSubscription_eventSubscriptionArn :: Lens' EventSubscription (Maybe Text) Source #

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

eventSubscription_snsTopicArn :: Lens' EventSubscription (Maybe Text) Source #

The topic ARN of the event notification subscription.

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

A list of source IDs for the event notification subscription.

eventSubscription_sourceType :: Lens' EventSubscription (Maybe Text) Source #

The source type for the event notification subscription.

eventSubscription_status :: Lens' EventSubscription (Maybe Text) Source #

The status of the event notification subscription.

Constraints:

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

eventSubscription_subscriptionCreationTime :: Lens' EventSubscription (Maybe Text) Source #

The time the event notification subscription was created.

Filter

filter_name :: Lens' Filter Text Source #

This parameter is not currently supported.

filter_values :: Lens' Filter [Text] Source #

This parameter is not currently supported.

GlobalCluster

globalCluster_deletionProtection :: Lens' GlobalCluster (Maybe Bool) Source #

The deletion protection setting for the global database.

globalCluster_engine :: Lens' GlobalCluster (Maybe Text) Source #

The Neptune database engine used by the global database ("neptune").

globalCluster_engineVersion :: Lens' GlobalCluster (Maybe Text) Source #

The Neptune engine version used by the global database.

globalCluster_globalClusterArn :: Lens' GlobalCluster (Maybe Text) Source #

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

globalCluster_globalClusterIdentifier :: Lens' GlobalCluster (Maybe Text) Source #

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

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

A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.

globalCluster_globalClusterResourceId :: Lens' GlobalCluster (Maybe Text) Source #

An immutable identifier for the global database that is unique within in all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

globalCluster_status :: Lens' GlobalCluster (Maybe Text) Source #

Specifies the current state of this global database.

globalCluster_storageEncrypted :: Lens' GlobalCluster (Maybe Bool) Source #

The storage encryption setting for the global database.

GlobalClusterMember

globalClusterMember_dbClusterArn :: Lens' GlobalClusterMember (Maybe Text) Source #

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

globalClusterMember_isWriter :: Lens' GlobalClusterMember (Maybe Bool) Source #

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

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

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

OptionGroupMembership

optionGroupMembership_optionGroupName :: Lens' OptionGroupMembership (Maybe Text) Source #

Not supported by Neptune.

optionGroupMembership_status :: Lens' OptionGroupMembership (Maybe Text) Source #

Not supported by Neptune.

OrderableDBInstanceOption

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

A list of Availability Zones for a DB instance.

orderableDBInstanceOption_dbInstanceClass :: Lens' OrderableDBInstanceOption (Maybe Text) Source #

The DB instance class for a DB instance.

orderableDBInstanceOption_engine :: Lens' OrderableDBInstanceOption (Maybe Text) Source #

The engine type of a DB instance.

orderableDBInstanceOption_engineVersion :: Lens' OrderableDBInstanceOption (Maybe Text) Source #

The engine version of a DB instance.

orderableDBInstanceOption_licenseModel :: Lens' OrderableDBInstanceOption (Maybe Text) Source #

The license model for a DB instance.

orderableDBInstanceOption_maxIopsPerDbInstance :: Lens' OrderableDBInstanceOption (Maybe Int) Source #

Maximum total provisioned IOPS for a DB instance.

orderableDBInstanceOption_maxIopsPerGib :: Lens' OrderableDBInstanceOption (Maybe Double) Source #

Maximum provisioned IOPS per GiB for a DB instance.

orderableDBInstanceOption_maxStorageSize :: Lens' OrderableDBInstanceOption (Maybe Int) Source #

Maximum storage size for a DB instance.

orderableDBInstanceOption_minIopsPerDbInstance :: Lens' OrderableDBInstanceOption (Maybe Int) Source #

Minimum total provisioned IOPS for a DB instance.

orderableDBInstanceOption_minIopsPerGib :: Lens' OrderableDBInstanceOption (Maybe Double) Source #

Minimum provisioned IOPS per GiB for a DB instance.

orderableDBInstanceOption_minStorageSize :: Lens' OrderableDBInstanceOption (Maybe Int) Source #

Minimum storage size for a DB instance.

orderableDBInstanceOption_multiAZCapable :: Lens' OrderableDBInstanceOption (Maybe Bool) Source #

Indicates whether a DB instance is Multi-AZ capable.

orderableDBInstanceOption_readReplicaCapable :: Lens' OrderableDBInstanceOption (Maybe Bool) Source #

Indicates whether a DB instance can have a Read Replica.

orderableDBInstanceOption_storageType :: Lens' OrderableDBInstanceOption (Maybe Text) Source #

Indicates the storage type for a DB instance.

orderableDBInstanceOption_supportsEnhancedMonitoring :: Lens' OrderableDBInstanceOption (Maybe Bool) Source #

Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

orderableDBInstanceOption_supportsGlobalDatabases :: Lens' OrderableDBInstanceOption (Maybe Bool) Source #

A value that indicates whether you can use Neptune global databases with a specific combination of other DB engine attributes.

orderableDBInstanceOption_supportsIAMDatabaseAuthentication :: Lens' OrderableDBInstanceOption (Maybe Bool) Source #

Indicates whether a DB instance supports IAM database authentication.

orderableDBInstanceOption_supportsIops :: Lens' OrderableDBInstanceOption (Maybe Bool) Source #

Indicates whether a DB instance supports provisioned IOPS.

orderableDBInstanceOption_supportsPerformanceInsights :: Lens' OrderableDBInstanceOption (Maybe Bool) Source #

(Not supported by Neptune)

orderableDBInstanceOption_supportsStorageEncryption :: Lens' OrderableDBInstanceOption (Maybe Bool) Source #

Indicates whether a DB instance supports encrypted storage.

orderableDBInstanceOption_vpc :: Lens' OrderableDBInstanceOption (Maybe Bool) Source #

Indicates whether a DB instance is in a VPC.

Parameter

parameter_allowedValues :: Lens' Parameter (Maybe Text) Source #

Specifies the valid range of values for the parameter.

parameter_applyMethod :: Lens' Parameter (Maybe ApplyMethod) Source #

Indicates when to apply parameter updates.

parameter_applyType :: Lens' Parameter (Maybe Text) Source #

Specifies the engine specific parameters type.

parameter_dataType :: Lens' Parameter (Maybe Text) Source #

Specifies the valid data type for the parameter.

parameter_description :: Lens' Parameter (Maybe Text) Source #

Provides a description of the parameter.

parameter_isModifiable :: Lens' Parameter (Maybe Bool) Source #

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

parameter_minimumEngineVersion :: Lens' Parameter (Maybe Text) Source #

The earliest engine version to which the parameter can apply.

parameter_parameterName :: Lens' Parameter (Maybe Text) Source #

Specifies the name of the parameter.

parameter_parameterValue :: Lens' Parameter (Maybe Text) Source #

Specifies the value of the parameter.

parameter_source :: Lens' Parameter (Maybe Text) Source #

Indicates the source of the parameter value.

PendingCloudwatchLogsExports

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

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

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

Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

PendingMaintenanceAction

pendingMaintenanceAction_action :: Lens' PendingMaintenanceAction (Maybe Text) Source #

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

pendingMaintenanceAction_autoAppliedAfterDate :: Lens' PendingMaintenanceAction (Maybe UTCTime) Source #

The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored.

pendingMaintenanceAction_currentApplyDate :: Lens' PendingMaintenanceAction (Maybe UTCTime) Source #

The effective date when the pending maintenance action is applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.

pendingMaintenanceAction_description :: Lens' PendingMaintenanceAction (Maybe Text) Source #

A description providing more detail about the maintenance action.

pendingMaintenanceAction_forcedApplyDate :: Lens' PendingMaintenanceAction (Maybe UTCTime) Source #

The date when the maintenance action is automatically applied. 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) Source #

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

PendingModifiedValues

pendingModifiedValues_allocatedStorage :: Lens' PendingModifiedValues (Maybe Int) Source #

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

pendingModifiedValues_backupRetentionPeriod :: Lens' PendingModifiedValues (Maybe Int) Source #

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

pendingModifiedValues_cACertificateIdentifier :: Lens' PendingModifiedValues (Maybe Text) Source #

Specifies the identifier of the CA certificate for the DB instance.

pendingModifiedValues_dbInstanceClass :: Lens' PendingModifiedValues (Maybe Text) Source #

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

pendingModifiedValues_dbInstanceIdentifier :: Lens' PendingModifiedValues (Maybe Text) Source #

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

pendingModifiedValues_dbSubnetGroupName :: Lens' PendingModifiedValues (Maybe Text) Source #

The new DB subnet group for the DB instance.

pendingModifiedValues_engineVersion :: Lens' PendingModifiedValues (Maybe Text) Source #

Indicates the database engine version.

pendingModifiedValues_iops :: Lens' PendingModifiedValues (Maybe Int) Source #

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

pendingModifiedValues_licenseModel :: Lens' PendingModifiedValues (Maybe Text) Source #

Not supported by Neptune.

pendingModifiedValues_masterUserPassword :: Lens' PendingModifiedValues (Maybe Text) Source #

Not supported by Neptune.

pendingModifiedValues_multiAZ :: Lens' PendingModifiedValues (Maybe Bool) Source #

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

pendingModifiedValues_pendingCloudwatchLogsExports :: Lens' PendingModifiedValues (Maybe PendingCloudwatchLogsExports) Source #

This PendingCloudwatchLogsExports structure specifies pending changes to which CloudWatch logs are enabled and which are disabled.

pendingModifiedValues_port :: Lens' PendingModifiedValues (Maybe Int) Source #

Specifies the pending port for the DB instance.

pendingModifiedValues_storageType :: Lens' PendingModifiedValues (Maybe Text) Source #

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

Range

range_from :: Lens' Range (Maybe Int) Source #

The minimum value in the range.

range_step :: Lens' Range (Maybe Int) Source #

The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...

range_to :: Lens' Range (Maybe Int) Source #

The maximum value in the range.

ResourcePendingMaintenanceActions

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

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

resourcePendingMaintenanceActions_resourceIdentifier :: Lens' ResourcePendingMaintenanceActions (Maybe Text) Source #

The ARN of the resource that has pending maintenance actions.

ServerlessV2ScalingConfiguration

serverlessV2ScalingConfiguration_maxCapacity :: Lens' ServerlessV2ScalingConfiguration (Maybe Double) Source #

The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.

serverlessV2ScalingConfiguration_minCapacity :: Lens' ServerlessV2ScalingConfiguration (Maybe Double) Source #

The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.

ServerlessV2ScalingConfigurationInfo

serverlessV2ScalingConfigurationInfo_maxCapacity :: Lens' ServerlessV2ScalingConfigurationInfo (Maybe Double) Source #

The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.

serverlessV2ScalingConfigurationInfo_minCapacity :: Lens' ServerlessV2ScalingConfigurationInfo (Maybe Double) Source #

The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.

Subnet

subnet_subnetAvailabilityZone :: Lens' Subnet (Maybe AvailabilityZone) Source #

Specifies the EC2 Availability Zone that the subnet is in.

subnet_subnetIdentifier :: Lens' Subnet (Maybe Text) Source #

Specifies the identifier of the subnet.

subnet_subnetStatus :: Lens' Subnet (Maybe Text) Source #

Specifies the status of the subnet.

Tag

tag_key :: Lens' Tag (Maybe Text) Source #

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").

tag_value :: Lens' Tag (Maybe Text) Source #

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").

Timezone

timezone_timezoneName :: Lens' Timezone (Maybe Text) Source #

The name of the time zone.

UpgradeTarget

upgradeTarget_autoUpgrade :: Lens' UpgradeTarget (Maybe Bool) Source #

A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

upgradeTarget_description :: Lens' UpgradeTarget (Maybe Text) Source #

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

upgradeTarget_engine :: Lens' UpgradeTarget (Maybe Text) Source #

The name of the upgrade target database engine.

upgradeTarget_engineVersion :: Lens' UpgradeTarget (Maybe Text) Source #

The version number of the upgrade target database engine.

upgradeTarget_isMajorVersionUpgrade :: Lens' UpgradeTarget (Maybe Bool) Source #

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

upgradeTarget_supportsGlobalDatabases :: Lens' UpgradeTarget (Maybe Bool) Source #

A value that indicates whether you can use Neptune global databases with the target engine version.

ValidDBInstanceModificationsMessage

validDBInstanceModificationsMessage_storage :: Lens' ValidDBInstanceModificationsMessage (Maybe [ValidStorageOptions]) Source #

Valid storage options for your DB instance.

ValidStorageOptions

validStorageOptions_iopsToStorageRatio :: Lens' ValidStorageOptions (Maybe [DoubleRange]) Source #

The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage.

validStorageOptions_provisionedIops :: Lens' ValidStorageOptions (Maybe [Range]) Source #

The valid range of provisioned IOPS. For example, 1000-20000.

validStorageOptions_storageSize :: Lens' ValidStorageOptions (Maybe [Range]) Source #

The valid range of storage in gibibytes. For example, 100 to 16384.

validStorageOptions_storageType :: Lens' ValidStorageOptions (Maybe Text) Source #

The valid storage types for your DB instance. For example, gp2, io1.

VpcSecurityGroupMembership

vpcSecurityGroupMembership_status :: Lens' VpcSecurityGroupMembership (Maybe Text) Source #

The status of the VPC security group.

vpcSecurityGroupMembership_vpcSecurityGroupId :: Lens' VpcSecurityGroupMembership (Maybe Text) Source #

The name of the VPC security group.