Module Smaws_Client_Neptune.Types

type nonrec string_ = string
type nonrec vpc_security_group_membership = {
  1. status : string_ option;
    (*

    The status of the VPC security group.

    *)
  2. vpc_security_group_id : string_ option;
    (*

    The name of the VPC security group.

    *)
}

This data type is used as a response element for queries on VPC security group membership.

type nonrec vpc_security_group_membership_list = vpc_security_group_membership list
type nonrec vpc_security_group_id_list = string_ list
type nonrec boolean_ = bool
type nonrec boolean_optional = bool
type nonrec upgrade_target = {
  1. supports_global_databases : boolean_optional option;
    (*

    A value that indicates whether you can use Neptune global databases with the target engine version.

    *)
  2. is_major_version_upgrade : boolean_ option;
    (*

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

    *)
  3. auto_upgrade : boolean_ option;
    (*

    A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

    *)
  4. description : string_ option;
    (*

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

    *)
  5. engine_version : string_ option;
    (*

    The version number of the upgrade target database engine.

    *)
  6. engine : string_ option;
    (*

    The name of the upgrade target database engine.

    *)
}

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

type nonrec valid_upgrade_target_list = upgrade_target list
type nonrec integer = int
type nonrec integer_optional = int
type nonrec range = {
  1. step : integer_optional option;
    (*

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

    *)
  2. to_ : integer option;
    (*

    The maximum value in the range.

    *)
  3. from_ : integer option;
    (*

    The minimum value in the range.

    *)
}

A range of integer values.

type nonrec range_list = range list
type nonrec double = float
type nonrec double_range = {
  1. to_ : double option;
    (*

    The maximum value in the range.

    *)
  2. from_ : double option;
    (*

    The minimum value in the range.

    *)
}

A range of double values.

type nonrec double_range_list = double_range list
type nonrec valid_storage_options = {
  1. iops_to_storage_ratio : double_range_list option;
    (*

    Not applicable. In Neptune the storage type is managed at the DB Cluster level.

    *)
  2. provisioned_iops : range_list option;
    (*

    Not applicable. In Neptune the storage type is managed at the DB Cluster level.

    *)
  3. storage_size : range_list option;
    (*

    Not applicable. In Neptune the storage type is managed at the DB Cluster level.

    *)
  4. storage_type : string_ option;
    (*

    Not applicable. In Neptune the storage type is managed at the DB Cluster level.

    *)
}

Not applicable. In Neptune the storage type is managed at the DB Cluster level.

type nonrec valid_storage_options_list = valid_storage_options list
type nonrec valid_db_instance_modifications_message = {
  1. storage : valid_storage_options_list option;
    (*

    Valid storage options for your DB instance.

    *)
}

Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action. You can use this information when you call ModifyDBInstance.

type nonrec timezone = {
  1. timezone_name : string_ option;
    (*

    The name of the time zone.

    *)
}

A time zone associated with a DBInstance.

type nonrec tag = {
  1. value : string_ option;
    (*

    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}_.:/=+\\-]*)$").

    *)
  2. key : string_ option;
    (*

    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}_.:/=+\\-]*)$").

    *)
}

Metadata assigned to an Amazon Neptune resource consisting of a key-value pair.

type nonrec tag_list = tag list
type nonrec tag_list_message = {
  1. tag_list : tag_list option;
    (*

    List of tags returned by the ListTagsForResource operation.

    *)
}
type nonrec t_stamp = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec global_cluster_identifier = string
type nonrec readers_arn_list = string_ list
type nonrec global_cluster_member = {
  1. is_writer : boolean_ option;
    (*

    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.

    *)
  2. readers : readers_arn_list option;
    (*

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

    *)
  3. db_cluster_arn : string_ option;
    (*

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

    *)
}

A data structure with information about any primary and secondary clusters associated with an Neptune global database.

type nonrec global_cluster_member_list = global_cluster_member list
type nonrec failover_status =
  1. | CANCELLING
  2. | FAILING_OVER
  3. | PENDING
type nonrec failover_state = {
  1. is_data_loss_allowed : boolean_ option;
    (*

    Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover.

    *)
  2. to_db_cluster_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being promoted, and which is associated with this state.

    *)
  3. from_db_cluster_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being demoted, and which is associated with this state.

    *)
  4. status : failover_status option;
    (*

    The current status of the global cluster. Possible values are as follows:

    • pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary DB cluster and the specified secondary DB cluster are being verified before the operation starts.
    • failing-over – Neptune is promoting the chosen secondary Neptune DB cluster to become the new primary DB cluster to fail over the global cluster.
    • cancelling – The request to switch over or fail over the global cluster was cancelled and the primary Neptune DB cluster and the selected secondary Neptune DB cluster are returning to their previous states.
    • switching-over – This status covers the range of Neptune internal operations that take place during the switchover process, such as demoting the primary Neptune DB cluster, promoting the secondary Neptune DB cluster, and synchronizing replicas.
    *)
}

Contains the state of scheduled or in-process operations on a global cluster (Neptune global database). This data type is empty unless a switchover or failover operation is scheduled or is in progress on the Neptune global database.

type nonrec global_cluster = {
  1. tag_list : tag_list option;
    (*

    A list of global cluster tags.

    *)
  2. failover_state : failover_state option;
    (*

    A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Neptune global database). This object is empty unless the SwitchoverGlobalCluster or FailoverGlobalCluster operation was called on this global cluster.

    *)
  3. global_cluster_members : global_cluster_member_list option;
    (*

    A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.

    *)
  4. deletion_protection : boolean_optional option;
    (*

    The deletion protection setting for the global database.

    *)
  5. storage_encrypted : boolean_optional option;
    (*

    The storage encryption setting for the global database.

    *)
  6. database_name : string_ option;
    (*

    The default database name within the new global database cluster.

    *)
  7. engine_version : string_ option;
    (*

    The Neptune engine version used by the global database.

    *)
  8. engine : string_ option;
    (*

    The Neptune database engine used by the global database ("neptune").

    *)
  9. status : string_ option;
    (*

    Specifies the current state of this global database.

    *)
  10. global_cluster_arn : string_ option;
    (*

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

    *)
  11. global_cluster_resource_id : string_ option;
    (*

    An immutable identifier for the global database that is unique within all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

    *)
  12. global_cluster_identifier : global_cluster_identifier option;
    (*

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

    *)
}

Contains the details of an Amazon Neptune global database.

This data type is used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and RemoveFromGlobalCluster actions.

type nonrec switchover_global_cluster_result = {
  1. global_cluster : global_cluster option;
}
type nonrec switchover_global_cluster_message = {
  1. target_db_cluster_identifier : string_;
    (*

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

    *)
  2. global_cluster_identifier : global_cluster_identifier;
    (*

    The identifier of the global database cluster to switch over. This parameter isn't case-sensitive.

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

    *)
}
type nonrec exception_message = string
type nonrec invalid_global_cluster_state_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The global cluster is in an invalid state and can't perform the requested operation.

type nonrec invalid_db_cluster_state_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The DB cluster is not in a valid state.

type nonrec global_cluster_not_found_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The GlobalClusterIdentifier doesn't refer to an existing global database cluster.

type nonrec db_cluster_not_found_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

DBClusterIdentifier does not refer to an existing DB cluster.

type nonrec supported_timezones_list = timezone list
type nonrec character_set = {
  1. character_set_description : string_ option;
    (*

    The description of the character set.

    *)
  2. character_set_name : string_ option;
    (*

    The name of the character set.

    *)
}

Specifies a character set.

type nonrec supported_character_sets_list = character_set list
type nonrec subscription_not_found_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The designated subscription could not be found.

type nonrec subscription_category_not_found_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The designated subscription category could not be found.

type nonrec subscription_already_exist_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

This subscription already exists.

type nonrec availability_zone = {
  1. name : string_ option;
    (*

    The name of the availability zone.

    *)
}

Specifies an Availability Zone.

type nonrec subnet = {
  1. subnet_status : string_ option;
    (*

    Specifies the status of the subnet.

    *)
  2. subnet_availability_zone : availability_zone option;
    (*

    Specifies the EC2 Availability Zone that the subnet is in.

    *)
  3. subnet_identifier : string_ option;
    (*

    Specifies the identifier of the subnet.

    *)
}

Specifies a subnet.

This data type is used as a response element in the DescribeDBSubnetGroups action.

type nonrec subnet_list = subnet list
type nonrec subnet_identifier_list = string_ list
type nonrec subnet_already_in_use = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The DB subnet is already in use in the Availability Zone.

type nonrec string_list = string_ list
type nonrec storage_type_not_supported_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

StorageType specified cannot be associated with the DB Instance.

type nonrec storage_quota_exceeded_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

Request would result in user exceeding the allowed amount of storage available across all DB instances.

type nonrec availability_zones = string_ list
type nonrec db_cluster_option_group_status = {
  1. status : string_ option;
    (*

    Not supported by Neptune.

    *)
  2. db_cluster_option_group_name : string_ option;
    (*

    Not supported by Neptune.

    *)
}

Not supported by Neptune.

type nonrec db_cluster_option_group_memberships = db_cluster_option_group_status list
type nonrec read_replica_identifier_list = string_ list
type nonrec db_cluster_member = {
  1. promotion_tier : integer_optional option;
    (*

    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.

    *)
  2. db_cluster_parameter_group_status : string_ option;
    (*

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

    *)
  3. is_cluster_writer : boolean_ option;
    (*

    Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

    *)
  4. db_instance_identifier : string_ option;
    (*

    Specifies the instance identifier for this member of the DB cluster.

    *)
}

Contains information about an instance that is part of a DB cluster.

type nonrec db_cluster_member_list = db_cluster_member list
type nonrec db_cluster_role = {
  1. feature_name : string_ option;
    (*

    The name of the feature associated with the Amazon Identity and Access Management (IAM) role. For the list of supported feature names, see DescribeDBEngineVersions.

    *)
  2. status : string_ option;
    (*

    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.
    *)
  3. role_arn : string_ option;
    (*

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

    *)
}

Describes an Amazon Identity and Access Management (IAM) role that is associated with a DB cluster.

type nonrec db_cluster_roles = db_cluster_role list
type nonrec log_type_list = string_ list
type nonrec pending_cloudwatch_logs_exports = {
  1. log_types_to_disable : log_type_list option;
    (*

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

    *)
  2. log_types_to_enable : log_type_list option;
    (*

    Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

    *)
}

A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.

Valid log types are: audit (to publish audit logs) and slowquery (to publish slow-query logs). See Publishing Neptune logs to Amazon CloudWatch logs.

type nonrec cluster_pending_modified_values = {
  1. network_type : string_ option;
    (*

    The pending change in network type for the DB cluster.

    Valid Values: IPV4, DUAL

    *)
  2. iops : integer_optional option;
    (*

    The Provisioned IOPS (I/O operations per second) value. This setting is only for Multi-AZ DB clusters.

    *)
  3. allocated_storage : integer_optional option;
    (*

    The allocated storage size in gibibytes (GiB) for database engines. For Neptune, AllocatedStorage always returns 1, because Neptune DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

    *)
  4. storage_type : string_ option;
    (*

    The pending change in storage type for the DB cluster.   Valid Values:

    • standard   –   ( the default ) Configures cost-effective database storage for applications with moderate to small I/O usage.

    • iopt1   –   Enables I/O-Optimized storage that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput.

      Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.

    *)
  5. backup_retention_period : integer_optional option;
    (*

    The number of days for which automatic DB snapshots are retained.

    *)
  6. engine_version : string_ option;
    (*

    The database engine version.

    *)
  7. iam_database_authentication_enabled : boolean_optional option;
    (*

    A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

    *)
  8. db_cluster_identifier : string_ option;
    (*

    The DBClusterIdentifier value for the DB cluster.

    *)
  9. pending_cloudwatch_logs_exports : pending_cloudwatch_logs_exports option;
    (*

    This PendingCloudwatchLogsExports structure specifies pending changes to which CloudWatch logs are enabled and which are disabled.

    *)
}

This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.

type nonrec double_optional = float
type nonrec serverless_v2_scaling_configuration_info = {
  1. max_capacity : double_optional option;
    (*

    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.

    *)
  2. min_capacity : double_optional option;
    (*

    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.

    *)
}

Shows the scaling configuration for a Neptune Serverless DB cluster.

For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

type nonrec db_cluster = {
  1. network_type : string_ option;
    (*

    The network type of the DB cluster.

    Valid Values:

    • IPV4   –   The DB cluster uses only IPv4 addresses for communication.
    • DUAL   –   The DB cluster uses both IPv4 and IPv6 addresses for communication.
    *)
  2. storage_type : string_ option;
    (*

    The storage type used by the DB cluster.

    Valid Values:

    • standard   –   ( the default ) Provides cost-effective database storage for applications with moderate to small I/O usage.

    • iopt1   –   Enables I/O-Optimized storage that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput.

      Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.

    *)
  3. io_optimized_next_allowed_modification_time : t_stamp option;
    (*

    The next time you can modify the DB cluster to use the iopt1 storage type.

    *)
  4. global_cluster_identifier : global_cluster_identifier option;
    (*

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

    *)
  5. serverless_v2_scaling_configuration : serverless_v2_scaling_configuration_info option;
    (*

    Shows the scaling configuration for a Neptune Serverless DB cluster.

    For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

    *)
  6. automatic_restart_time : t_stamp option;
    (*

    Time at which the DB cluster will be automatically restarted.

    *)
  7. cross_account_clone : boolean_optional option;
    (*

    If set to true, the DB cluster can be cloned across accounts.

    *)
  8. deletion_protection : boolean_optional option;
    (*

    Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

    *)
  9. pending_modified_values : cluster_pending_modified_values option;
    (*

    This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.

    *)
  10. enabled_cloudwatch_logs_exports : log_type_list option;
    (*

    A list of the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: audit (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See Publishing Neptune logs to Amazon CloudWatch logs.

    *)
  11. copy_tags_to_snapshot : boolean_optional option;
    (*

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

    *)
  12. cluster_create_time : t_stamp option;
    (*

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

    *)
  13. clone_group_id : string_ option;
    (*

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

    *)
  14. iam_database_authentication_enabled : boolean_ option;
    (*

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

    *)
  15. associated_roles : db_cluster_roles option;
    (*

    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.

    *)
  16. db_cluster_arn : string_ option;
    (*

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

    *)
  17. db_cluster_resource_id : string_ option;
    (*

    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.

    *)
  18. kms_key_id : string_ option;
    (*

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

    *)
  19. storage_encrypted : boolean_ option;
    (*

    Specifies whether the DB cluster is encrypted.

    *)
  20. hosted_zone_id : string_ option;
    (*

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

    *)
  21. vpc_security_groups : vpc_security_group_membership_list option;
    (*

    Provides a list of VPC security groups that the DB cluster belongs to.

    *)
  22. db_cluster_members : db_cluster_member_list option;
    (*

    Provides the list of instances that make up the DB cluster.

    *)
  23. read_replica_identifiers : read_replica_identifier_list option;
    (*

    Contains one or more identifiers of the Read Replicas associated with this DB cluster.

    *)
  24. replication_source_identifier : string_ option;
    (*

    Not supported by Neptune.

    *)
  25. preferred_maintenance_window : string_ option;
    (*

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

    *)
  26. preferred_backup_window : string_ option;
    (*

    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

    *)
  27. db_cluster_option_group_memberships : db_cluster_option_group_memberships option;
    (*

    Not supported by Neptune.

    *)
  28. master_username : string_ option;
    (*

    Not supported by Neptune.

    *)
  29. port : integer_optional option;
    (*

    Specifies the port that the database engine is listening on.

    *)
  30. latest_restorable_time : t_stamp option;
    (*

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

    *)
  31. engine_version : string_ option;
    (*

    Indicates the database engine version.

    *)
  32. engine : string_ option;
    (*

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

    *)
  33. multi_a_z : boolean_ option;
    (*

    Specifies whether the DB cluster has instances in multiple Availability Zones.

    *)
  34. reader_endpoint : string_ option;
    (*

    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.

    *)
  35. endpoint : string_ option;
    (*

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

    *)
  36. earliest_restorable_time : t_stamp option;
    (*

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

    *)
  37. percent_progress : string_ option;
    (*

    Specifies the progress of the operation as a percentage.

    *)
  38. status : string_ option;
    (*

    Specifies the current state of this DB cluster.

    *)
  39. db_subnet_group : string_ option;
    (*

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

    *)
  40. db_cluster_parameter_group : string_ option;
    (*

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

    *)
  41. db_cluster_identifier : string_ option;
    (*

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

    *)
  42. database_name : string_ option;
    (*

    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.

    *)
  43. character_set_name : string_ option;
    (*

    Not supported by Neptune.

    *)
  44. backup_retention_period : integer_optional option;
    (*

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

    *)
  45. availability_zones : availability_zones option;
    (*

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

    *)
  46. allocated_storage : integer_optional option;
    (*

    AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

    *)
}

Contains the details of an Amazon Neptune DB cluster.

This data type is used as a response element in the DescribeDBClusters.

type nonrec stop_db_cluster_result = {
  1. db_cluster : db_cluster option;
}
type nonrec stop_db_cluster_message = {
  1. db_cluster_identifier : string_;
    (*

    The DB cluster identifier of the Neptune DB cluster to be stopped. This parameter is stored as a lowercase string.

    *)
}
type nonrec invalid_db_instance_state_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The specified DB instance is not in the available state.

type nonrec start_db_cluster_result = {
  1. db_cluster : db_cluster option;
}
type nonrec start_db_cluster_message = {
  1. db_cluster_identifier : string_;
    (*

    The DB cluster identifier of the Neptune DB cluster to be started. This parameter is stored as a lowercase string.

    *)
}
type nonrec source_type =
  1. | Db_cluster_snapshot
  2. | Db_cluster
  3. | Db_snapshot
  4. | Db_security_group
  5. | Db_parameter_group
  6. | Db_instance
type nonrec source_not_found_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The source could not be found.

type nonrec source_ids_list = string_ list
type nonrec snapshot_quota_exceeded_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

Request would result in user exceeding the allowed number of DB snapshots.

type nonrec shared_snapshot_quota_exceeded_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

type nonrec serverless_v2_scaling_configuration = {
  1. max_capacity : double_optional option;
    (*

    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.

    *)
  2. min_capacity : double_optional option;
    (*

    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.

    *)
}

Contains the scaling configuration of a Neptune Serverless DB cluster.

For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

type nonrec sensitive_string = string
type nonrec sns_topic_arn_not_found_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The ARN of the SNS topic could not be found.

type nonrec sns_no_authorization_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

There is no SNS authorization.

type nonrec sns_invalid_topic_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The SNS topic is invalid.

type nonrec restore_db_cluster_to_point_in_time_result = {
  1. db_cluster : db_cluster option;
}
type nonrec restore_db_cluster_to_point_in_time_message = {
  1. network_type : string_ option;
    (*

    The network type of the DB cluster.

    Valid Values:

    • IPV4   –   ( the default ) The DB cluster uses only IPv4 addresses for communication.
    • DUAL   –   The DB cluster uses both IPv4 and IPv6 addresses for communication. The DB subnet group associated with the cluster must support IPv6.
    *)
  2. storage_type : string_ option;
    (*

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

    Valid values: standard, iopt1

    Default: standard

    *)
  3. serverless_v2_scaling_configuration : serverless_v2_scaling_configuration option;
    (*

    Contains the scaling configuration of a Neptune Serverless DB cluster.

    For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

    *)
  4. deletion_protection : boolean_optional option;
    (*

    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.

    *)
  5. db_cluster_parameter_group_name : string_ option;
    (*

    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.
    *)
  6. enable_cloudwatch_logs_exports : log_type_list option;
    (*

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

    *)
  7. enable_iam_database_authentication : boolean_optional option;
    (*

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

    Default: false

    *)
  8. kms_key_id : string_ option;
    (*

    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.

    *)
  9. tags : tag_list option;
    (*

    The tags to be applied to the restored DB cluster.

    *)
  10. vpc_security_group_ids : vpc_security_group_id_list option;
    (*

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

    *)
  11. option_group_name : string_ option;
    (*

    (Not supported by Neptune)

    *)
  12. db_subnet_group_name : string_ option;
    (*

    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

    *)
  13. port : integer_optional option;
    (*

    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.

    *)
  14. use_latest_restorable_time : boolean_ option;
    (*

    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.

    *)
  15. restore_to_time : t_stamp option;
    (*

    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

    *)
  16. source_db_cluster_identifier : string_;
    (*

    The identifier of the source DB cluster from which to restore.

    Constraints:

    • Must match the identifier of an existing DBCluster.
    *)
  17. restore_type : string_ option;
    (*

    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.

    *)
  18. db_cluster_identifier : string_;
    (*

    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
    *)
}
type nonrec option_group_not_found_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The designated option group could not be found.

type nonrec network_type_not_supported_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The specified NetworkType is not supported for the DB cluster, DB subnet group, or orderable DB instance option.

type nonrec kms_key_not_accessible_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

Error accessing KMS key.

type nonrec invalid_vpc_network_state_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

DB subnet group does not cover all Availability Zones after it is created because users' change.

type nonrec invalid_subnet = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

type nonrec invalid_restore_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

Cannot restore from vpc backup to non-vpc DB instance.

type nonrec invalid_db_snapshot_state_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The state of the DB snapshot does not allow deletion.

type nonrec invalid_db_cluster_snapshot_state_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The supplied value is not a valid DB cluster snapshot state.

type nonrec insufficient_storage_cluster_capacity_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

type nonrec insufficient_db_cluster_capacity_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The DB cluster does not have enough capacity for the current operation.

type nonrec db_subnet_group_not_found_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

DBSubnetGroupName does not refer to an existing DB subnet group.

type nonrec db_cluster_snapshot_not_found_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.

type nonrec db_cluster_quota_exceeded_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.

type nonrec db_cluster_parameter_group_not_found_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.

type nonrec db_cluster_already_exists_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

User already has a DB cluster with the given identifier.

type nonrec restore_db_cluster_from_snapshot_result = {
  1. db_cluster : db_cluster option;
}
type nonrec restore_db_cluster_from_snapshot_message = {
  1. network_type : string_ option;
    (*

    The network type of the DB cluster.

    Valid Values:

    • IPV4   –   ( the default ) The DB cluster uses only IPv4 addresses for communication.
    • DUAL   –   The DB cluster uses both IPv4 and IPv6 addresses for communication. The DB subnet group associated with the cluster must support IPv6.
    *)
  2. storage_type : string_ option;
    (*

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

    Valid values: standard, iopt1

    Default: standard

    *)
  3. serverless_v2_scaling_configuration : serverless_v2_scaling_configuration option;
    (*

    Contains the scaling configuration of a Neptune Serverless DB cluster.

    For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

    *)
  4. copy_tags_to_snapshot : boolean_optional option;
    (*

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

    *)
  5. deletion_protection : boolean_optional option;
    (*

    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.

    *)
  6. db_cluster_parameter_group_name : string_ option;
    (*

    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.
    *)
  7. enable_cloudwatch_logs_exports : log_type_list option;
    (*

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

    *)
  8. enable_iam_database_authentication : boolean_optional option;
    (*

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

    Default: false

    *)
  9. kms_key_id : string_ option;
    (*

    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.
    *)
  10. tags : tag_list option;
    (*

    The tags to be assigned to the restored DB cluster.

    *)
  11. vpc_security_group_ids : vpc_security_group_id_list option;
    (*

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

    *)
  12. option_group_name : string_ option;
    (*

    (Not supported by Neptune)

    *)
  13. database_name : string_ option;
    (*

    Not supported.

    *)
  14. db_subnet_group_name : string_ option;
    (*

    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

    *)
  15. port : integer_optional option;
    (*

    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.

    *)
  16. engine_version : string_ option;
    (*

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

    *)
  17. engine : string_;
    (*

    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

    *)
  18. snapshot_identifier : string_;
    (*

    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.
    *)
  19. db_cluster_identifier : string_;
    (*

    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

    *)
  20. availability_zones : availability_zones option;
    (*

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

    *)
}
type nonrec db_snapshot_not_found_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

DBSnapshotIdentifier does not refer to an existing DB snapshot.

type nonrec pending_maintenance_action = {
  1. description : string_ option;
    (*

    A description providing more detail about the maintenance action.

    *)
  2. current_apply_date : t_stamp option;
    (*

    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.

    *)
  3. opt_in_status : string_ option;
    (*

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

    *)
  4. forced_apply_date : t_stamp option;
    (*

    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.

    *)
  5. auto_applied_after_date : t_stamp option;
    (*

    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.

    *)
  6. action : string_ option;
    (*

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

    *)
}

Provides information about a pending maintenance action for a resource.

type nonrec pending_maintenance_action_details = pending_maintenance_action list
type nonrec resource_pending_maintenance_actions = {
  1. pending_maintenance_action_details : pending_maintenance_action_details option;
    (*

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

    *)
  2. resource_identifier : string_ option;
    (*

    The ARN of the resource that has pending maintenance actions.

    *)
}

Describes the pending maintenance actions for a resource.

type nonrec resource_not_found_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The specified resource ID was not found.

type nonrec apply_method =
  1. | Pending_reboot
  2. | Immediate
type nonrec parameter = {
  1. apply_method : apply_method option;
    (*

    Indicates when to apply parameter updates.

    *)
  2. minimum_engine_version : string_ option;
    (*

    The earliest engine version to which the parameter can apply.

    *)
  3. is_modifiable : boolean_ option;
    (*

    Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

    *)
  4. allowed_values : string_ option;
    (*

    Specifies the valid range of values for the parameter.

    *)
  5. data_type : string_ option;
    (*

    Specifies the valid data type for the parameter.

    *)
  6. apply_type : string_ option;
    (*

    Specifies the engine specific parameters type.

    *)
  7. source : string_ option;
    (*

    Indicates the source of the parameter value.

    *)
  8. description : string_ option;
    (*

    Provides a description of the parameter.

    *)
  9. parameter_value : string_ option;
    (*

    Specifies the value of the parameter.

    *)
  10. parameter_name : string_ option;
    (*

    Specifies the name of the parameter.

    *)
}

Specifies a parameter.

type nonrec parameters_list = parameter list
type nonrec reset_db_parameter_group_message = {
  1. parameters : parameters_list option;
    (*

    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

    *)
  2. reset_all_parameters : boolean_ option;
    (*

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

    Default: true

    *)
  3. db_parameter_group_name : string_;
    (*

    The name of the DB parameter group.

    Constraints:

    • Must match the name of an existing DBParameterGroup.
    *)
}
type nonrec invalid_db_parameter_group_state_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.

type nonrec db_parameter_group_not_found_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

DBParameterGroupName does not refer to an existing DB parameter group.

type nonrec db_parameter_group_name_message = {
  1. db_parameter_group_name : string_ option;
    (*

    Provides the name of the DB parameter group.

    *)
}
type nonrec reset_db_cluster_parameter_group_message = {
  1. parameters : parameters_list option;
    (*

    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.

    *)
  2. reset_all_parameters : boolean_ option;
    (*

    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.

    *)
  3. db_cluster_parameter_group_name : string_;
    (*

    The name of the DB cluster parameter group to reset.

    *)
}
type nonrec db_cluster_parameter_group_name_message = {
  1. db_cluster_parameter_group_name : string_ option;
    (*

    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.

    *)
}
type nonrec key_list = string_ list
type nonrec remove_tags_from_resource_message = {
  1. tag_keys : key_list;
    (*

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

    *)
  2. resource_name : string_;
    (*

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

    *)
}
type nonrec db_instance_not_found_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

DBInstanceIdentifier does not refer to an existing DB instance.

type nonrec event_categories_list = string_ list
type nonrec event_subscription = {
  1. event_subscription_arn : string_ option;
    (*

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

    *)
  2. enabled : boolean_ option;
    (*

    A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

    *)
  3. event_categories_list : event_categories_list option;
    (*

    A list of event categories for the event notification subscription.

    *)
  4. source_ids_list : source_ids_list option;
    (*

    A list of source IDs for the event notification subscription.

    *)
  5. source_type : string_ option;
    (*

    The source type for the event notification subscription.

    *)
  6. subscription_creation_time : string_ option;
    (*

    The time the event notification subscription was created.

    *)
  7. status : string_ option;
    (*

    The status of the event notification subscription.

    Constraints:

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

    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.

    *)
  8. sns_topic_arn : string_ option;
    (*

    The topic ARN of the event notification subscription.

    *)
  9. cust_subscription_id : string_ option;
    (*

    The event notification subscription Id.

    *)
  10. customer_aws_id : string_ option;
    (*

    The Amazon customer account associated with the event notification subscription.

    *)
}

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

type nonrec remove_source_identifier_from_subscription_result = {
  1. event_subscription : event_subscription option;
}
type nonrec remove_source_identifier_from_subscription_message = {
  1. source_identifier : string_;
    (*

    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.

    *)
  2. subscription_name : string_;
    (*

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

    *)
}
type nonrec remove_role_from_db_cluster_message = {
  1. feature_name : string_ option;
    (*

    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.

    *)
  2. role_arn : string_;
    (*

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

    *)
  3. db_cluster_identifier : string_;
    (*

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

    *)
}
type nonrec db_cluster_role_not_found_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The specified IAM role Amazon Resource Name (ARN) is not associated with the specified DB cluster.

type nonrec remove_from_global_cluster_result = {
  1. global_cluster : global_cluster option;
}
type nonrec remove_from_global_cluster_message = {
  1. db_cluster_identifier : string_;
    (*

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

    *)
  2. global_cluster_identifier : global_cluster_identifier;
    (*

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

    *)
}
type nonrec endpoint = {
  1. hosted_zone_id : string_ option;
    (*

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

    *)
  2. port : integer option;
    (*

    Specifies the port that the database engine is listening on.

    *)
  3. address : string_ option;
    (*

    Specifies the DNS address of the DB instance.

    *)
}

Specifies a connection endpoint.

For the data structure that represents Amazon Neptune DB cluster endpoints, see DBClusterEndpoint.

type nonrec db_security_group_membership = {
  1. status : string_ option;
    (*

    The status of the DB security group.

    *)
  2. db_security_group_name : string_ option;
    (*

    The name of the DB security group.

    *)
}

Specifies membership in a designated DB security group.

type nonrec db_security_group_membership_list = db_security_group_membership list
type nonrec db_parameter_group_status = {
  1. parameter_apply_status : string_ option;
    (*

    The status of parameter updates.

    *)
  2. db_parameter_group_name : string_ option;
    (*

    The name of the DB parameter group.

    *)
}

The status of the DB parameter group.

This data type is used as a response element in the following actions:

  • CreateDBInstance
  • DeleteDBInstance
  • ModifyDBInstance
  • RebootDBInstance
type nonrec db_parameter_group_status_list = db_parameter_group_status list
type nonrec db_subnet_group = {
  1. supported_network_types : string_list option;
    (*

    The network types supported by the DB subnet group.

    Valid network types include IPV4 and DUAL. A DB subnet group supports DUAL if all subnets in the group have both IPv4 and IPv6 CIDRs.

    *)
  2. db_subnet_group_arn : string_ option;
    (*

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

    *)
  3. subnets : subnet_list option;
    (*

    Contains a list of Subnet elements.

    *)
  4. subnet_group_status : string_ option;
    (*

    Provides the status of the DB subnet group.

    *)
  5. vpc_id : string_ option;
    (*

    Provides the VpcId of the DB subnet group.

    *)
  6. db_subnet_group_description : string_ option;
    (*

    Provides the description of the DB subnet group.

    *)
  7. db_subnet_group_name : string_ option;
    (*

    The name of the DB subnet group.

    *)
}

Contains the details of an Amazon Neptune DB subnet group.

This data type is used as a response element in the DescribeDBSubnetGroups action.

type nonrec pending_modified_values = {
  1. pending_cloudwatch_logs_exports : pending_cloudwatch_logs_exports option;
    (*

    This PendingCloudwatchLogsExports structure specifies pending changes to which CloudWatch logs are enabled and which are disabled.

    *)
  2. db_subnet_group_name : string_ option;
    (*

    The new DB subnet group for the DB instance.

    *)
  3. ca_certificate_identifier : string_ option;
    (*

    Specifies the identifier of the CA certificate for the DB instance.

    *)
  4. storage_type : string_ option;
    (*

    Not applicable. In Neptune the storage type is managed at the DB Cluster level.

    *)
  5. db_instance_identifier : string_ option;
    (*

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

    *)
  6. iops : integer_optional option;
    (*

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

    *)
  7. license_model : string_ option;
    (*

    Not supported by Neptune.

    *)
  8. engine_version : string_ option;
    (*

    Indicates the database engine version.

    *)
  9. multi_a_z : boolean_optional option;
    (*

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

    *)
  10. backup_retention_period : integer_optional option;
    (*

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

    *)
  11. port : integer_optional option;
    (*

    Specifies the pending port for the DB instance.

    *)
  12. master_user_password : string_ option;
    (*

    Not supported by Neptune.

    *)
  13. allocated_storage : integer_optional option;
    (*

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

    *)
  14. db_instance_class : string_ option;
    (*

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

    *)
}

This data type is used as a response element in the ModifyDBInstance action.

type nonrec read_replica_db_instance_identifier_list = string_ list
type nonrec read_replica_db_cluster_identifier_list = string_ list
type nonrec option_group_membership = {
  1. status : string_ option;
    (*

    Not supported by Neptune.

    *)
  2. option_group_name : string_ option;
    (*

    Not supported by Neptune.

    *)
}

Not supported by Neptune.

type nonrec option_group_membership_list = option_group_membership list
type nonrec db_instance_status_info = {
  1. message : string_ option;
    (*

    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.

    *)
  2. status : string_ option;
    (*

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

    *)
  3. normal : boolean_ option;
    (*

    Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

    *)
  4. status_type : string_ option;
    (*

    This value is currently "read replication."

    *)
}

Provides a list of status information for a DB instance.

type nonrec db_instance_status_info_list = db_instance_status_info list
type nonrec domain_membership = {
  1. iam_role_name : string_ option;
    (*

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

    *)
  2. fqd_n : string_ option;
    (*

    The fully qualified domain name of the Active Directory Domain.

    *)
  3. status : string_ option;
    (*

    The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).

    *)
  4. domain : string_ option;
    (*

    The identifier of the Active Directory Domain.

    *)
}

An Active Directory Domain membership record associated with a DB instance.

type nonrec domain_membership_list = domain_membership list
type nonrec db_instance = {
  1. network_type : string_ option;
    (*

    The network type of the DB instance. Inherited from the DB cluster.

    Valid Values: IPV4, DUAL

    *)
  2. deletion_protection : boolean_optional option;
    (*

    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.

    *)
  3. enabled_cloudwatch_logs_exports : log_type_list option;
    (*

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

    *)
  4. performance_insights_kms_key_id : string_ option;
    (*

    (Not supported by Neptune)

    *)
  5. performance_insights_enabled : boolean_optional option;
    (*

    (Not supported by Neptune)

    *)
  6. iam_database_authentication_enabled : boolean_ option;
    (*

    True if Amazon Identity and Access Management (IAM) authentication is enabled, and otherwise false.

    *)
  7. timezone : string_ option;
    (*

    Not supported.

    *)
  8. db_instance_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the DB instance.

    *)
  9. promotion_tier : integer_optional option;
    (*

    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.

    *)
  10. monitoring_role_arn : string_ option;
    (*

    The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

    *)
  11. enhanced_monitoring_resource_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

    *)
  12. monitoring_interval : integer_optional option;
    (*

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

    *)
  13. copy_tags_to_snapshot : boolean_ option;
    (*

    Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

    *)
  14. domain_memberships : domain_membership_list option;
    (*

    Not supported

    *)
  15. ca_certificate_identifier : string_ option;
    (*

    The identifier of the CA certificate for this DB instance.

    *)
  16. dbi_resource_id : string_ option;
    (*

    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.

    *)
  17. kms_key_id : string_ option;
    (*

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

    *)
  18. storage_encrypted : boolean_ option;
    (*

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

    *)
  19. db_cluster_identifier : string_ option;
    (*

    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.

    *)
  20. db_instance_port : integer option;
    (*

    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.

    *)
  21. tde_credential_arn : string_ option;
    (*

    The ARN from the key store with which the instance is associated for TDE encryption.

    *)
  22. storage_type : string_ option;
    (*

    Specifies the storage type associated with the DB instance.

    *)
  23. status_infos : db_instance_status_info_list option;
    (*

    The status of a Read Replica. If the instance is not a Read Replica, this is blank.

    *)
  24. publicly_accessible : boolean_ option;
    (*

    Indicates whether the DB instance is publicly accessible.

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

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

    *)
  25. secondary_availability_zone : string_ option;
    (*

    If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

    *)
  26. character_set_name : string_ option;
    (*

    (Not supported by Neptune)

    *)
  27. option_group_memberships : option_group_membership_list option;
    (*

    (Not supported by Neptune)

    *)
  28. iops : integer_optional option;
    (*

    Specifies the Provisioned IOPS (I/O operations per second) value.

    *)
  29. license_model : string_ option;
    (*

    License model information for this DB instance.

    *)
  30. read_replica_db_cluster_identifiers : read_replica_db_cluster_identifier_list option;
    (*

    Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.

    *)
  31. read_replica_db_instance_identifiers : read_replica_db_instance_identifier_list option;
    (*

    Contains one or more identifiers of the Read Replicas associated with this DB instance.

    *)
  32. read_replica_source_db_instance_identifier : string_ option;
    (*

    Contains the identifier of the source DB instance if this DB instance is a Read Replica.

    *)
  33. auto_minor_version_upgrade : boolean_ option;
    (*

    Indicates that minor version patches are applied automatically.

    *)
  34. engine_version : string_ option;
    (*

    Indicates the database engine version.

    *)
  35. multi_a_z : boolean_ option;
    (*

    Specifies if the DB instance is a Multi-AZ deployment.

    *)
  36. latest_restorable_time : t_stamp option;
    (*

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

    *)
  37. pending_modified_values : pending_modified_values option;
    (*

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

    *)
  38. preferred_maintenance_window : string_ option;
    (*

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

    *)
  39. db_subnet_group : db_subnet_group option;
    (*

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

    *)
  40. availability_zone : string_ option;
    (*

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

    *)
  41. db_parameter_groups : db_parameter_group_status_list option;
    (*

    Provides the list of DB parameter groups applied to this DB instance.

    *)
  42. vpc_security_groups : vpc_security_group_membership_list option;
    (*

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

    *)
  43. db_security_groups : db_security_group_membership_list option;
    (*

    Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

    *)
  44. backup_retention_period : integer option;
    (*

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

    *)
  45. preferred_backup_window : string_ option;
    (*

    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

    *)
  46. instance_create_time : t_stamp option;
    (*

    Provides the date and time the DB instance was created.

    *)
  47. allocated_storage : integer option;
    (*

    Not supported by Neptune.

    *)
  48. endpoint : endpoint option;
    (*

    Specifies the connection endpoint.

    *)
  49. db_name : string_ option;
    (*

    The database name.

    *)
  50. master_username : string_ option;
    (*

    Not supported by Neptune.

    *)
  51. db_instance_status : string_ option;
    (*

    Specifies the current state of this database.

    *)
  52. engine : string_ option;
    (*

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

    *)
  53. db_instance_class : string_ option;
    (*

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

    *)
  54. db_instance_identifier : string_ option;
    (*

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

    *)
}

Contains the details of an Amazon Neptune DB instance.

This data type is used as a response element in the DescribeDBInstances action.

type nonrec reboot_db_instance_result = {
  1. db_instance : db_instance option;
}
type nonrec reboot_db_instance_message = {
  1. force_failover : boolean_optional option;
    (*

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

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

    *)
  2. db_instance_identifier : string_;
    (*

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

    Constraints:

    • Must match the identifier of an existing DBInstance.
    *)
}
type nonrec provisioned_iops_not_available_in_az_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

Provisioned IOPS not available in the specified Availability Zone.

type nonrec promote_read_replica_db_cluster_result = {
  1. db_cluster : db_cluster option;
}
type nonrec promote_read_replica_db_cluster_message = {
  1. db_cluster_identifier : string_;
    (*

    Not supported.

    *)
}
type nonrec pending_maintenance_actions = resource_pending_maintenance_actions list
type nonrec pending_maintenance_actions_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. pending_maintenance_actions : pending_maintenance_actions option;
    (*

    A list of the pending maintenance actions for the resource.

    *)
}
type nonrec availability_zone_list = availability_zone list
type nonrec orderable_db_instance_option = {
  1. supported_network_types : string_list option;
    (*

    The network types supported by the orderable DB instance option.

    *)
  2. supports_global_databases : boolean_ option;
    (*

    A value that indicates whether you can use Neptune global databases with a specific combination of other DB engine attributes.

    *)
  3. max_iops_per_gib : double_optional option;
    (*

    Maximum provisioned IOPS per GiB for a DB instance.

    *)
  4. min_iops_per_gib : double_optional option;
    (*

    Minimum provisioned IOPS per GiB for a DB instance.

    *)
  5. max_iops_per_db_instance : integer_optional option;
    (*

    Maximum total provisioned IOPS for a DB instance.

    *)
  6. min_iops_per_db_instance : integer_optional option;
    (*

    Minimum total provisioned IOPS for a DB instance.

    *)
  7. max_storage_size : integer_optional option;
    (*

    Maximum storage size for a DB instance.

    *)
  8. min_storage_size : integer_optional option;
    (*

    Minimum storage size for a DB instance.

    *)
  9. supports_performance_insights : boolean_ option;
    (*

    (Not supported by Neptune)

    *)
  10. supports_iam_database_authentication : boolean_ option;
    (*

    Indicates whether a DB instance supports IAM database authentication.

    *)
  11. supports_enhanced_monitoring : boolean_ option;
    (*

    Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

    *)
  12. supports_iops : boolean_ option;
    (*

    Indicates whether a DB instance supports provisioned IOPS.

    *)
  13. storage_type : string_ option;
    (*

    Not applicable. In Neptune the storage type is managed at the DB Cluster level.

    *)
  14. supports_storage_encryption : boolean_ option;
    (*

    Indicates whether a DB instance supports encrypted storage.

    *)
  15. vpc : boolean_ option;
    (*

    Indicates whether a DB instance is in a VPC.

    *)
  16. read_replica_capable : boolean_ option;
    (*

    Indicates whether a DB instance can have a Read Replica.

    *)
  17. multi_az_capable : boolean_ option;
    (*

    Indicates whether a DB instance is Multi-AZ capable.

    *)
  18. availability_zones : availability_zone_list option;
    (*

    A list of Availability Zones for a DB instance.

    *)
  19. license_model : string_ option;
    (*

    The license model for a DB instance.

    *)
  20. db_instance_class : string_ option;
    (*

    The DB instance class for a DB instance.

    *)
  21. engine_version : string_ option;
    (*

    The engine version of a DB instance.

    *)
  22. engine : string_ option;
    (*

    The engine type of a DB instance.

    *)
}

Contains a list of available options for a DB instance.

This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

type nonrec orderable_db_instance_options_list = orderable_db_instance_option list
type nonrec orderable_db_instance_options_message = {
  1. marker : string_ option;
    (*

    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 .

    *)
  2. orderable_db_instance_options : orderable_db_instance_options_list option;
    (*

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

    *)
}
type nonrec modify_global_cluster_result = {
  1. global_cluster : global_cluster option;
}
type nonrec modify_global_cluster_message = {
  1. allow_major_version_upgrade : boolean_optional option;
    (*

    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.

    *)
  2. engine_version : string_ option;
    (*

    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:

    *)
  3. deletion_protection : boolean_optional option;
    (*

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

    *)
  4. new_global_cluster_identifier : global_cluster_identifier option;
    (*

    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

    *)
  5. global_cluster_identifier : global_cluster_identifier;
    (*

    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.

    *)
}
type nonrec global_cluster_already_exists_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The GlobalClusterIdentifier already exists. Choose a new global database identifier (unique name) to create a new global database cluster.

type nonrec modify_event_subscription_result = {
  1. event_subscription : event_subscription option;
}
type nonrec modify_event_subscription_message = {
  1. enabled : boolean_optional option;
    (*

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

    *)
  2. event_categories : event_categories_list option;
    (*

    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.

    *)
  3. source_type : string_ option;
    (*

    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

    *)
  4. sns_topic_arn : string_ option;
    (*

    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.

    *)
  5. subscription_name : string_;
    (*

    The name of the event notification subscription.

    *)
}
type nonrec event_subscription_quota_exceeded_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

You have exceeded the number of events you can subscribe to.

type nonrec modify_db_subnet_group_result = {
  1. db_subnet_group : db_subnet_group option;
}
type nonrec modify_db_subnet_group_message = {
  1. subnet_ids : subnet_identifier_list;
    (*

    The EC2 subnet IDs for the DB subnet group.

    *)
  2. db_subnet_group_description : string_ option;
    (*

    The description for the DB subnet group.

    *)
  3. db_subnet_group_name : string_;
    (*

    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

    *)
}
type nonrec db_subnet_quota_exceeded_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

Request would result in user exceeding the allowed number of subnets in a DB subnet groups.

type nonrec db_subnet_group_does_not_cover_enough_a_zs = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

type nonrec modify_db_parameter_group_message = {
  1. parameters : parameters_list;
    (*

    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.

    *)
  2. db_parameter_group_name : string_;
    (*

    The name of the DB parameter group.

    Constraints:

    • If supplied, must match the name of an existing DBParameterGroup.
    *)
}
type nonrec modify_db_instance_result = {
  1. db_instance : db_instance option;
}
type nonrec db_security_group_name_list = string_ list
type nonrec cloudwatch_logs_export_configuration = {
  1. disable_log_types : log_type_list option;
    (*

    The list of log types to disable.

    *)
  2. enable_log_types : log_type_list option;
    (*

    The list of log types to enable.

    *)
}

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

The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported (or not exported) to CloudWatch Logs.

Valid log types are: audit (to publish audit logs) and slowquery (to publish slow-query logs). See Publishing Neptune logs to Amazon CloudWatch logs.

type nonrec modify_db_instance_message = {
  1. deletion_protection : boolean_optional option;
    (*

    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.

    *)
  2. cloudwatch_logs_export_configuration : cloudwatch_logs_export_configuration option;
    (*

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

    *)
  3. performance_insights_kms_key_id : string_ option;
    (*

    (Not supported by Neptune)

    *)
  4. enable_performance_insights : boolean_optional option;
    (*

    (Not supported by Neptune)

    *)
  5. enable_iam_database_authentication : boolean_optional option;
    (*

    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

    *)
  6. promotion_tier : integer_optional option;
    (*

    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

    *)
  7. domain_iam_role_name : string_ option;
    (*

    Not supported

    *)
  8. monitoring_role_arn : string_ option;
    (*

    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.

    *)
  9. publicly_accessible : boolean_optional option;
    (*

    Indicates whether the DB instance is publicly accessible.

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

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

    *)
  10. db_port_number : integer_optional option;
    (*

    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

    *)
  11. monitoring_interval : integer_optional option;
    (*

    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

    *)
  12. copy_tags_to_snapshot : boolean_optional option;
    (*

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

    *)
  13. domain : string_ option;
    (*

    Not supported.

    *)
  14. ca_certificate_identifier : string_ option;
    (*

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

    *)
  15. tde_credential_password : sensitive_string option;
    (*

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

    *)
  16. tde_credential_arn : string_ option;
    (*

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

    *)
  17. storage_type : string_ option;
    (*

    Not applicable. In Neptune the storage type is managed at the DB Cluster level.

    *)
  18. new_db_instance_identifier : string_ option;
    (*

    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

    *)
  19. option_group_name : string_ option;
    (*

    (Not supported by Neptune)

    *)
  20. iops : integer_optional option;
    (*

    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

    *)
  21. license_model : string_ option;
    (*

    Not supported by Neptune.

    *)
  22. auto_minor_version_upgrade : boolean_optional option;
    (*

    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.

    *)
  23. allow_major_version_upgrade : boolean_ option;
    (*

    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.

    *)
  24. engine_version : string_ option;
    (*

    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.

    *)
  25. multi_a_z : boolean_optional option;
    (*

    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.

    *)
  26. preferred_maintenance_window : string_ option;
    (*

    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

    *)
  27. preferred_backup_window : string_ option;
    (*

    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
    *)
  28. backup_retention_period : integer_optional option;
    (*

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

    Default: Uses existing setting

    *)
  29. db_parameter_group_name : string_ option;
    (*

    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.

    *)
  30. master_user_password : string_ option;
    (*

    Not supported by Neptune.

    *)
  31. apply_immediately : boolean_ option;
    (*

    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

    *)
  32. vpc_security_group_ids : vpc_security_group_id_list option;
    (*

    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.
    *)
  33. db_security_groups : db_security_group_name_list option;
    (*

    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.
    *)
  34. db_subnet_group_name : string_ option;
    (*

    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

    *)
  35. db_instance_class : string_ option;
    (*

    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

    *)
  36. allocated_storage : integer_optional option;
    (*

    Not supported by Neptune.

    *)
  37. db_instance_identifier : string_;
    (*

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

    Constraints:

    • Must match the identifier of an existing DBInstance.
    *)
}
type nonrec invalid_db_security_group_state_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The state of the DB security group does not allow deletion.

type nonrec insufficient_db_instance_capacity_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

Specified DB instance class is not available in the specified Availability Zone.

type nonrec domain_not_found_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

Domain does not refer to an existing Active Directory Domain.

type nonrec db_upgrade_dependency_failure_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The DB upgrade failed because a resource the DB depends on could not be modified.

type nonrec db_security_group_not_found_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

DBSecurityGroupName does not refer to an existing DB security group.

type nonrec db_instance_already_exists_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

User already has a DB instance with the given identifier.

type nonrec certificate_not_found_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

CertificateIdentifier does not refer to an existing certificate.

type nonrec authorization_not_found_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.

Neptune may not also be authorized via IAM to perform necessary actions on your behalf.

type nonrec attribute_value_list = string_ list
type nonrec db_cluster_snapshot_attribute = {
  1. attribute_values : attribute_value_list option;
    (*

    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.

    *)
  2. attribute_name : string_ option;
    (*

    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.

    *)
}

Contains the name and values of a manual DB cluster snapshot attribute.

Manual DB cluster snapshot attributes are used to authorize other Amazon accounts to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

type nonrec db_cluster_snapshot_attribute_list = db_cluster_snapshot_attribute list
type nonrec db_cluster_snapshot_attributes_result = {
  1. db_cluster_snapshot_attributes : db_cluster_snapshot_attribute_list option;
    (*

    The list of attributes and values for the manual DB cluster snapshot.

    *)
  2. db_cluster_snapshot_identifier : string_ option;
    (*

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

    *)
}

Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.

Manual DB cluster snapshot attributes are used to authorize other Amazon accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

type nonrec modify_db_cluster_snapshot_attribute_result = {
  1. db_cluster_snapshot_attributes_result : db_cluster_snapshot_attributes_result option;
}
type nonrec modify_db_cluster_snapshot_attribute_message = {
  1. values_to_remove : attribute_value_list option;
    (*

    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.

    *)
  2. values_to_add : attribute_value_list option;
    (*

    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.

    *)
  3. attribute_name : string_;
    (*

    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.

    *)
  4. db_cluster_snapshot_identifier : string_;
    (*

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

    *)
}
type nonrec modify_db_cluster_result = {
  1. db_cluster : db_cluster option;
}
type nonrec modify_db_cluster_parameter_group_message = {
  1. parameters : parameters_list;
    (*

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

    *)
  2. db_cluster_parameter_group_name : string_;
    (*

    The name of the DB cluster parameter group to modify.

    *)
}
type nonrec modify_db_cluster_message = {
  1. network_type : string_ option;
    (*

    The network type of the DB cluster.

    Valid Values:

    • IPV4   –   The DB cluster uses only IPv4 addresses for communication.
    • DUAL   –   The DB cluster uses both IPv4 and IPv6 addresses for communication. The DB subnet group associated with the cluster must support IPv6.
    *)
  2. storage_type : string_ option;
    (*

    The storage type to associate with the DB cluster.

    Valid Values:

    • standard   –   ( the default ) Configures cost-effective database storage for applications with moderate to small I/O usage.

    • iopt1   –   Enables I/O-Optimized storage that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput.

      Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.

    *)
  3. serverless_v2_scaling_configuration : serverless_v2_scaling_configuration option;
    (*

    Contains the scaling configuration of a Neptune Serverless DB cluster.

    For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

    *)
  4. copy_tags_to_snapshot : boolean_optional option;
    (*

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

    *)
  5. deletion_protection : boolean_optional option;
    (*

    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.

    *)
  6. db_instance_parameter_group_name : string_ option;
    (*

    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.
    *)
  7. allow_major_version_upgrade : boolean_ option;
    (*

    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.

    *)
  8. engine_version : string_ option;
    (*

    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.

    *)
  9. cloudwatch_logs_export_configuration : cloudwatch_logs_export_configuration option;
    (*

    The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. See Using the CLI to publish Neptune audit logs to CloudWatch Logs.

    *)
  10. enable_iam_database_authentication : boolean_optional option;
    (*

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

    Default: false

    *)
  11. preferred_maintenance_window : string_ option;
    (*

    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.

    *)
  12. preferred_backup_window : string_ option;
    (*

    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.
    *)
  13. option_group_name : string_ option;
    (*

    Not supported by Neptune.

    *)
  14. master_user_password : string_ option;
    (*

    Not supported by Neptune.

    *)
  15. port : integer_optional option;
    (*

    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.

    *)
  16. vpc_security_group_ids : vpc_security_group_id_list option;
    (*

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

    *)
  17. db_cluster_parameter_group_name : string_ option;
    (*

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

    *)
  18. backup_retention_period : integer_optional option;
    (*

    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
    *)
  19. apply_immediately : boolean_ option;
    (*

    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

    *)
  20. new_db_cluster_identifier : string_ option;
    (*

    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

    *)
  21. db_cluster_identifier : string_;
    (*

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

    Constraints:

    • Must match the identifier of an existing DBCluster.
    *)
}
type nonrec modify_db_cluster_endpoint_output = {
  1. db_cluster_endpoint_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the endpoint.

    *)
  2. excluded_members : string_list option;
    (*

    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.

    *)
  3. static_members : string_list option;
    (*

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

    *)
  4. custom_endpoint_type : string_ option;
    (*

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

    *)
  5. endpoint_type : string_ option;
    (*

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

    *)
  6. status : string_ option;
    (*

    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.

    *)
  7. endpoint : string_ option;
    (*

    The DNS address of the endpoint.

    *)
  8. db_cluster_endpoint_resource_identifier : string_ option;
    (*

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

    *)
  9. db_cluster_identifier : string_ option;
    (*

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

    *)
  10. db_cluster_endpoint_identifier : string_ option;
    (*

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

    *)
}

This data type represents the information you need to connect to an Amazon Neptune DB cluster. This data type is used as a response element in the following actions:

  • CreateDBClusterEndpoint
  • DescribeDBClusterEndpoints
  • ModifyDBClusterEndpoint
  • DeleteDBClusterEndpoint

For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.

type nonrec modify_db_cluster_endpoint_message = {
  1. excluded_members : string_list option;
    (*

    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.

    *)
  2. static_members : string_list option;
    (*

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

    *)
  3. endpoint_type : string_ option;
    (*

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

    *)
  4. db_cluster_endpoint_identifier : string_;
    (*

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

    *)
}
type nonrec invalid_db_cluster_endpoint_state_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The requested operation cannot be performed on the endpoint while the endpoint is in this state.

type nonrec db_cluster_endpoint_not_found_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The specified custom endpoint doesn't exist.

type nonrec invalid_db_subnet_group_state_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The DB subnet group cannot be deleted because it is in use.

type nonrec filter_value_list = string_ list
type nonrec filter = {
  1. values : filter_value_list;
    (*

    This parameter is not currently supported.

    *)
  2. name : string_;
    (*

    This parameter is not currently supported.

    *)
}

This type is not currently supported.

type nonrec filter_list = filter list
type nonrec list_tags_for_resource_message = {
  1. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  2. resource_name : string_;
    (*

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

    *)
}
type nonrec invalid_event_subscription_state_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The event subscription is in an invalid state.

type nonrec invalid_db_subnet_state_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The DB subnet is not in the available state.

type nonrec instance_quota_exceeded_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

Request would result in user exceeding the allowed number of DB instances.

type nonrec global_cluster_list = global_cluster list
type nonrec global_clusters_message = {
  1. global_clusters : global_cluster_list option;
    (*

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

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}
type nonrec global_cluster_quota_exceeded_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The number of global database clusters for this account is already at the maximum allowed.

type nonrec failover_global_cluster_result = {
  1. global_cluster : global_cluster option;
}
type nonrec failover_global_cluster_message = {
  1. switchover : boolean_optional option;
    (*

    Specifies whether to switch over this global database cluster.

    Constraints: Can't be specified together with the AllowDataLoss parameter.

    *)
  2. allow_data_loss : boolean_optional option;
    (*

    Specifies whether to allow data loss for this global database cluster operation. Allowing data loss triggers a global failover operation.

    If you don't specify AllowDataLoss, the global database cluster operation defaults to a switchover.

    Constraints: Can't be specified together with the Switchover parameter.

    *)
  3. target_db_cluster_identifier : string_;
    (*

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

    *)
  4. global_cluster_identifier : global_cluster_identifier;
    (*

    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.

    *)
}
type nonrec failover_db_cluster_result = {
  1. db_cluster : db_cluster option;
}
type nonrec failover_db_cluster_message = {
  1. target_db_instance_identifier : string_ option;
    (*

    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.

    *)
  2. db_cluster_identifier : string_ option;
    (*

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

    Constraints:

    • Must match the identifier of an existing DBCluster.
    *)
}
type nonrec event = {
  1. source_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the event.

    *)
  2. date : t_stamp option;
    (*

    Specifies the date and time of the event.

    *)
  3. event_categories : event_categories_list option;
    (*

    Specifies the category for the event.

    *)
  4. message : string_ option;
    (*

    Provides the text of this event.

    *)
  5. source_type : source_type option;
    (*

    Specifies the source type for this event.

    *)
  6. source_identifier : string_ option;
    (*

    Provides the identifier for the source of the event.

    *)
}

This data type is used as a response element in the DescribeEvents action.

type nonrec event_list = event list
type nonrec events_message = {
  1. events : event_list option;
    (*

    A list of Event instances.

    *)
  2. marker : string_ option;
    (*

    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 .

    *)
}
type nonrec event_subscriptions_list = event_subscription list
type nonrec event_subscriptions_message = {
  1. event_subscriptions_list : event_subscriptions_list option;
    (*

    A list of EventSubscriptions data types.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}
type nonrec event_categories_map = {
  1. event_categories : event_categories_list option;
    (*

    The event categories for the specified source type

    *)
  2. source_type : string_ option;
    (*

    The source type that the returned categories belong to

    *)
}

Contains the results of a successful invocation of the DescribeEventCategories action.

type nonrec event_categories_map_list = event_categories_map list
type nonrec event_categories_message = {
  1. event_categories_map_list : event_categories_map_list option;
    (*

    A list of EventCategoriesMap data types.

    *)
}
type nonrec engine_defaults = {
  1. parameters : parameters_list option;
    (*

    Contains a list of engine default parameters.

    *)
  2. marker : string_ option;
    (*

    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 .

    *)
  3. db_parameter_group_family : string_ option;
    (*

    Specifies the name of the DB parameter group family that the engine default parameters apply to.

    *)
}

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

type nonrec describe_valid_db_instance_modifications_result = {
  1. valid_db_instance_modifications_message : valid_db_instance_modifications_message option;
}
type nonrec describe_valid_db_instance_modifications_message = {
  1. db_instance_identifier : string_;
    (*

    The customer identifier or the ARN of your DB instance.

    *)
}
type nonrec describe_pending_maintenance_actions_message = {
  1. max_records : integer_optional option;
    (*

    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.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    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.
    *)
  4. resource_identifier : string_ option;
    (*

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

    *)
}
type nonrec describe_orderable_db_instance_options_message = {
  1. marker : string_ option;
    (*

    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 .

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  4. vpc : boolean_optional option;
    (*

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

    *)
  5. license_model : string_ option;
    (*

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

    *)
  6. db_instance_class : string_ option;
    (*

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

    *)
  7. engine_version : string_ option;
    (*

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

    *)
  8. engine : string_;
    (*

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

    *)
}
type nonrec describe_global_clusters_message = {
  1. marker : string_ option;
    (*

    (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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. global_cluster_identifier : global_cluster_identifier option;
    (*

    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.

    *)
}
type nonrec describe_events_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  4. event_categories : event_categories_list option;
    (*

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

    *)
  5. duration : integer_optional option;
    (*

    The number of minutes to retrieve events for.

    Default: 60

    *)
  6. end_time : t_stamp option;
    (*

    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

    *)
  7. start_time : t_stamp option;
    (*

    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

    *)
  8. source_type : source_type option;
    (*

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

    *)
  9. source_identifier : string_ option;
    (*

    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.
    *)
}
type nonrec describe_event_subscriptions_message = {
  1. marker : string_ option;
    (*

    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 .

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  4. subscription_name : string_ option;
    (*

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

    *)
}
type nonrec describe_event_categories_message = {
  1. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  2. source_type : string_ option;
    (*

    The type of source that is generating the events.

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

    *)
}
type nonrec describe_engine_default_parameters_result = {
  1. engine_defaults : engine_defaults option;
}
type nonrec describe_engine_default_parameters_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    Not currently supported.

    *)
  4. db_parameter_group_family : string_;
    (*

    The name of the DB parameter group family.

    *)
}
type nonrec describe_engine_default_cluster_parameters_result = {
  1. engine_defaults : engine_defaults option;
}
type nonrec describe_engine_default_cluster_parameters_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  4. db_parameter_group_family : string_;
    (*

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

    *)
}
type nonrec describe_db_subnet_groups_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  4. db_subnet_group_name : string_ option;
    (*

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

    *)
}
type nonrec db_subnet_groups = db_subnet_group list
type nonrec db_subnet_group_message = {
  1. db_subnet_groups : db_subnet_groups option;
    (*

    A list of DBSubnetGroup instances.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}
type nonrec describe_db_parameters_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  4. source : string_ option;
    (*

    The parameter types to return.

    Default: All parameter types returned

    Valid Values: user | system | engine-default

    *)
  5. db_parameter_group_name : string_;
    (*

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

    Constraints:

    • If supplied, must match the name of an existing DBParameterGroup.
    *)
}
type nonrec db_parameter_group_details = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. parameters : parameters_list option;
    (*

    A list of Parameter values.

    *)
}
type nonrec describe_db_parameter_groups_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  4. db_parameter_group_name : string_ option;
    (*

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

    Constraints:

    • If supplied, must match the name of an existing DBClusterParameterGroup.
    *)
}
type nonrec db_parameter_group = {
  1. db_parameter_group_arn : string_ option;
    (*

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

    *)
  2. description : string_ option;
    (*

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

    *)
  3. db_parameter_group_family : string_ option;
    (*

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

    *)
  4. db_parameter_group_name : string_ option;
    (*

    Provides the name of the DB parameter group.

    *)
}

Contains the details of an Amazon Neptune DB parameter group.

This data type is used as a response element in the DescribeDBParameterGroups action.

type nonrec db_parameter_group_list = db_parameter_group list
type nonrec db_parameter_groups_message = {
  1. db_parameter_groups : db_parameter_group_list option;
    (*

    A list of DBParameterGroup instances.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}
type nonrec describe_db_instances_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    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:

    *)
  4. db_instance_identifier : string_ option;
    (*

    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.
    *)
}
type nonrec db_instance_list = db_instance list
type nonrec db_instance_message = {
  1. db_instances : db_instance_list option;
    (*

    A list of DBInstance instances.

    *)
  2. marker : string_ option;
    (*

    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 .

    *)
}
type nonrec describe_db_engine_versions_message = {
  1. list_supported_timezones : boolean_optional option;
    (*

    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.

    *)
  2. list_supported_character_sets : boolean_optional option;
    (*

    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.

    *)
  3. default_only : boolean_ option;
    (*

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

    *)
  4. marker : string_ option;
    (*

    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.

    *)
  5. max_records : integer_optional option;
    (*

    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.

    *)
  6. filters : filter_list option;
    (*

    Not currently supported.

    *)
  7. db_parameter_group_family : string_ option;
    (*

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

    Constraints:

    • If supplied, must match an existing DBParameterGroupFamily.
    *)
  8. engine_version : string_ option;
    (*

    The database engine version to return.

    Example: 5.1.49

    *)
  9. engine : string_ option;
    (*

    The database engine to return.

    *)
}
type nonrec db_engine_version = {
  1. supports_global_databases : boolean_ option;
    (*

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

    *)
  2. supports_read_replica : boolean_ option;
    (*

    Indicates whether the database engine version supports read replicas.

    *)
  3. supports_log_exports_to_cloudwatch_logs : boolean_ option;
    (*

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

    *)
  4. exportable_log_types : log_type_list option;
    (*

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

    *)
  5. supported_timezones : supported_timezones_list option;
    (*

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

    *)
  6. valid_upgrade_target : valid_upgrade_target_list option;
    (*

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

    *)
  7. supported_character_sets : supported_character_sets_list option;
    (*

    (Not supported by Neptune)

    *)
  8. default_character_set : character_set option;
    (*

    (Not supported by Neptune)

    *)
  9. db_engine_version_description : string_ option;
    (*

    The description of the database engine version.

    *)
  10. db_engine_description : string_ option;
    (*

    The description of the database engine.

    *)
  11. db_parameter_group_family : string_ option;
    (*

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

    *)
  12. engine_version : string_ option;
    (*

    The version number of the database engine.

    *)
  13. engine : string_ option;
    (*

    The name of the database engine.

    *)
}

This data type is used as a response element in the action DescribeDBEngineVersions.

type nonrec db_engine_version_list = db_engine_version list
type nonrec db_engine_version_message = {
  1. db_engine_versions : db_engine_version_list option;
    (*

    A list of DBEngineVersion elements.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}
type nonrec describe_db_clusters_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    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:

    *)
  4. db_cluster_identifier : string_ option;
    (*

    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.
    *)
}
type nonrec db_cluster_list = db_cluster list
type nonrec db_cluster_message = {
  1. db_clusters : db_cluster_list option;
    (*

    Contains a list of DB clusters for the user.

    *)
  2. marker : string_ option;
    (*

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

    *)
}
type nonrec describe_db_cluster_snapshots_message = {
  1. include_public : boolean_ option;
    (*

    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.

    *)
  2. include_shared : boolean_ option;
    (*

    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.

    *)
  3. marker : string_ option;
    (*

    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.

    *)
  4. max_records : integer_optional option;
    (*

    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.

    *)
  5. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  6. snapshot_type : string_ option;
    (*

    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.

    *)
  7. db_cluster_snapshot_identifier : string_ option;
    (*

    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.
    *)
  8. db_cluster_identifier : string_ option;
    (*

    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.
    *)
}
type nonrec db_cluster_snapshot = {
  1. storage_type : string_ option;
    (*

    The storage type associated with the DB cluster snapshot.

    *)
  2. iam_database_authentication_enabled : boolean_ option;
    (*

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

    *)
  3. source_db_cluster_snapshot_arn : string_ option;
    (*

    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.

    *)
  4. db_cluster_snapshot_arn : string_ option;
    (*

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

    *)
  5. kms_key_id : string_ option;
    (*

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

    *)
  6. storage_encrypted : boolean_ option;
    (*

    Specifies whether the DB cluster snapshot is encrypted.

    *)
  7. percent_progress : integer option;
    (*

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

    *)
  8. snapshot_type : string_ option;
    (*

    Provides the type of the DB cluster snapshot.

    *)
  9. license_model : string_ option;
    (*

    Provides the license model information for this DB cluster snapshot.

    *)
  10. engine_version : string_ option;
    (*

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

    *)
  11. master_username : string_ option;
    (*

    Not supported by Neptune.

    *)
  12. cluster_create_time : t_stamp option;
    (*

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

    *)
  13. vpc_id : string_ option;
    (*

    Provides the VPC ID associated with the DB cluster snapshot.

    *)
  14. port : integer option;
    (*

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

    *)
  15. status : string_ option;
    (*

    Specifies the status of this DB cluster snapshot.

    *)
  16. allocated_storage : integer option;
    (*

    Specifies the allocated storage size in gibibytes (GiB).

    *)
  17. engine : string_ option;
    (*

    Specifies the name of the database engine.

    *)
  18. snapshot_create_time : t_stamp option;
    (*

    Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

    *)
  19. db_cluster_identifier : string_ option;
    (*

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

    *)
  20. db_cluster_snapshot_identifier : string_ option;
    (*

    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.

    *)
  21. availability_zones : availability_zones option;
    (*

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

    *)
}

Contains the details for an Amazon Neptune DB cluster snapshot

This data type is used as a response element in the DescribeDBClusterSnapshots action.

type nonrec db_cluster_snapshot_list = db_cluster_snapshot list
type nonrec db_cluster_snapshot_message = {
  1. db_cluster_snapshots : db_cluster_snapshot_list option;
    (*

    Provides a list of DB cluster snapshots for the user.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}
type nonrec describe_db_cluster_snapshot_attributes_result = {
  1. db_cluster_snapshot_attributes_result : db_cluster_snapshot_attributes_result option;
}
type nonrec describe_db_cluster_snapshot_attributes_message = {
  1. db_cluster_snapshot_identifier : string_;
    (*

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

    *)
}
type nonrec describe_db_cluster_parameters_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  4. source : string_ option;
    (*

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

    *)
  5. db_cluster_parameter_group_name : string_;
    (*

    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.
    *)
}
type nonrec db_cluster_parameter_group_details = {
  1. marker : string_ option;
    (*

    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 .

    *)
  2. parameters : parameters_list option;
    (*

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

    *)
}
type nonrec describe_db_cluster_parameter_groups_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    This parameter is not currently supported.

    *)
  4. db_cluster_parameter_group_name : string_ option;
    (*

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

    Constraints:

    • If supplied, must match the name of an existing DBClusterParameterGroup.
    *)
}
type nonrec db_cluster_parameter_group = {
  1. db_cluster_parameter_group_arn : string_ option;
    (*

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

    *)
  2. description : string_ option;
    (*

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

    *)
  3. db_parameter_group_family : string_ option;
    (*

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

    *)
  4. db_cluster_parameter_group_name : string_ option;
    (*

    Provides the name of the DB cluster parameter group.

    *)
}

Contains the details of an Amazon Neptune DB cluster parameter group.

This data type is used as a response element in the DescribeDBClusterParameterGroups action.

type nonrec db_cluster_parameter_group_list = db_cluster_parameter_group list
type nonrec db_cluster_parameter_groups_message = {
  1. db_cluster_parameter_groups : db_cluster_parameter_group_list option;
    (*

    A list of DB cluster parameter groups.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}
type nonrec describe_db_cluster_endpoints_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    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={i endpoint_type},Values={i endpoint_type1},{i 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.

    *)
  4. db_cluster_endpoint_identifier : string_ option;
    (*

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

    *)
  5. db_cluster_identifier : string_ option;
    (*

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

    *)
}
type nonrec db_cluster_endpoint = {
  1. db_cluster_endpoint_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the endpoint.

    *)
  2. excluded_members : string_list option;
    (*

    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.

    *)
  3. static_members : string_list option;
    (*

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

    *)
  4. custom_endpoint_type : string_ option;
    (*

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

    *)
  5. endpoint_type : string_ option;
    (*

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

    *)
  6. status : string_ option;
    (*

    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.

    *)
  7. endpoint : string_ option;
    (*

    The DNS address of the endpoint.

    *)
  8. db_cluster_endpoint_resource_identifier : string_ option;
    (*

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

    *)
  9. db_cluster_identifier : string_ option;
    (*

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

    *)
  10. db_cluster_endpoint_identifier : string_ option;
    (*

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

    *)
}

This data type represents the information you need to connect to an Amazon Neptune DB cluster. This data type is used as a response element in the following actions:

  • CreateDBClusterEndpoint
  • DescribeDBClusterEndpoints
  • ModifyDBClusterEndpoint
  • DeleteDBClusterEndpoint

For the data structure that represents Amazon Neptune DB instance endpoints, see Endpoint.

type nonrec db_cluster_endpoint_list = db_cluster_endpoint list
type nonrec db_cluster_endpoint_message = {
  1. db_cluster_endpoints : db_cluster_endpoint_list option;
    (*

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

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}
type nonrec delete_global_cluster_result = {
  1. global_cluster : global_cluster option;
}
type nonrec delete_global_cluster_message = {
  1. global_cluster_identifier : global_cluster_identifier;
    (*

    The cluster identifier of the global database cluster being deleted.

    *)
}
type nonrec delete_event_subscription_result = {
  1. event_subscription : event_subscription option;
}
type nonrec delete_event_subscription_message = {
  1. subscription_name : string_;
    (*

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

    *)
}
type nonrec delete_db_subnet_group_message = {
  1. db_subnet_group_name : string_;
    (*

    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

    *)
}
type nonrec delete_db_parameter_group_message = {
  1. db_parameter_group_name : string_;
    (*

    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
    *)
}
type nonrec delete_db_instance_result = {
  1. db_instance : db_instance option;
}
type nonrec delete_db_instance_message = {
  1. final_db_snapshot_identifier : string_ option;
    (*

    The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.

    Specifying this parameter and also setting the SkipFinalSnapshot 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.
    *)
  2. skip_final_snapshot : boolean_ option;
    (*

    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

    *)
  3. db_instance_identifier : string_;
    (*

    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.
    *)
}
type nonrec db_snapshot_already_exists_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

DBSnapshotIdentifier is already used by an existing snapshot.

type nonrec delete_db_cluster_snapshot_result = {
  1. db_cluster_snapshot : db_cluster_snapshot option;
}
type nonrec delete_db_cluster_snapshot_message = {
  1. db_cluster_snapshot_identifier : string_;
    (*

    The identifier of the DB cluster snapshot to delete.

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

    *)
}
type nonrec delete_db_cluster_result = {
  1. db_cluster : db_cluster option;
}
type nonrec delete_db_cluster_parameter_group_message = {
  1. db_cluster_parameter_group_name : string_;
    (*

    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.
    *)
}
type nonrec delete_db_cluster_message = {
  1. final_db_snapshot_identifier : string_ option;
    (*

    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 SkipFinalSnapshot 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
    *)
  2. skip_final_snapshot : boolean_ option;
    (*

    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

    *)
  3. db_cluster_identifier : string_;
    (*

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

    Constraints:

    • Must match an existing DBClusterIdentifier.
    *)
}
type nonrec delete_db_cluster_endpoint_output = {
  1. db_cluster_endpoint_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the endpoint.

    *)
  2. excluded_members : string_list option;
    (*

    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.

    *)
  3. static_members : string_list option;
    (*

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

    *)
  4. custom_endpoint_type : string_ option;
    (*

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

    *)
  5. endpoint_type : string_ option;
    (*

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

    *)
  6. status : string_ option;
    (*

    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.

    *)
  7. endpoint : string_ option;
    (*

    The DNS address of the endpoint.

    *)
  8. db_cluster_endpoint_resource_identifier : string_ option;
    (*

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

    *)
  9. db_cluster_identifier : string_ option;
    (*

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

    *)
  10. db_cluster_endpoint_identifier : string_ option;
    (*

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

    *)
}

This data type represents the information you need to connect to an Amazon Neptune DB cluster. This data type is used as a response element in the following actions:

  • CreateDBClusterEndpoint
  • DescribeDBClusterEndpoints
  • ModifyDBClusterEndpoint
  • DeleteDBClusterEndpoint

For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.

type nonrec delete_db_cluster_endpoint_message = {
  1. db_cluster_endpoint_identifier : string_;
    (*

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

    *)
}
type nonrec db_cluster_snapshot_already_exists_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

User already has a DB cluster snapshot with the given identifier.

type nonrec db_subnet_group_quota_exceeded_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

Request would result in user exceeding the allowed number of DB subnet groups.

type nonrec db_subnet_group_already_exists_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

DBSubnetGroupName is already used by an existing DB subnet group.

type nonrec db_parameter_group_quota_exceeded_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

Request would result in user exceeding the allowed number of DB parameter groups.

type nonrec db_parameter_group_already_exists_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

A DB parameter group with the same name exists.

type nonrec db_cluster_role_quota_exceeded_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.

type nonrec db_cluster_role_already_exists_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.

type nonrec db_cluster_endpoint_quota_exceeded_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The cluster already has the maximum number of custom endpoints.

type nonrec db_cluster_endpoint_already_exists_fault = {
  1. message : exception_message option;
    (*

    A message describing the details of the problem.

    *)
}

The specified custom endpoint cannot be created because it already exists.

type nonrec create_global_cluster_result = {
  1. global_cluster : global_cluster option;
}
type nonrec create_global_cluster_message = {
  1. storage_encrypted : boolean_optional option;
    (*

    The storage encryption setting for the new global database cluster.

    *)
  2. tags : tag_list option;
    (*

    Tags to assign to the global cluster.

    *)
  3. database_name : string_ option;
    (*

    The name for the new global database (up to 64 alpha-numeric characters).

    *)
  4. deletion_protection : boolean_optional option;
    (*

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

    *)
  5. engine_version : string_ option;
    (*

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

    Valid values: 1.2.0.0 or above.

    *)
  6. engine : string_ option;
    (*

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

    Valid values: neptune

    *)
  7. source_db_cluster_identifier : string_ option;
    (*

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

    *)
  8. global_cluster_identifier : global_cluster_identifier;
    (*

    The cluster identifier of the new global database cluster.

    *)
}
type nonrec create_event_subscription_result = {
  1. event_subscription : event_subscription option;
}
type nonrec create_event_subscription_message = {
  1. tags : tag_list option;
    (*

    The tags to be applied to the new event subscription.

    *)
  2. enabled : boolean_optional option;
    (*

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

    *)
  3. source_ids : source_ids_list option;
    (*

    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.
    *)
  4. event_categories : event_categories_list option;
    (*

    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.

    *)
  5. source_type : string_ option;
    (*

    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-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot

    *)
  6. sns_topic_arn : string_;
    (*

    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.

    *)
  7. subscription_name : string_;
    (*

    The name of the subscription.

    Constraints: The name must be less than 255 characters.

    *)
}
type nonrec create_db_subnet_group_result = {
  1. db_subnet_group : db_subnet_group option;
}
type nonrec create_db_subnet_group_message = {
  1. tags : tag_list option;
    (*

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

    *)
  2. subnet_ids : subnet_identifier_list;
    (*

    The EC2 Subnet IDs for the DB subnet group.

    *)
  3. db_subnet_group_description : string_;
    (*

    The description for the DB subnet group.

    *)
  4. db_subnet_group_name : string_;
    (*

    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

    *)
}
type nonrec create_db_parameter_group_result = {
  1. db_parameter_group : db_parameter_group option;
}
type nonrec create_db_parameter_group_message = {
  1. tags : tag_list option;
    (*

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

    *)
  2. description : string_;
    (*

    The description for the DB parameter group.

    *)
  3. db_parameter_group_family : string_;
    (*

    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.

    *)
  4. db_parameter_group_name : string_;
    (*

    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.

    *)
}
type nonrec create_db_instance_result = {
  1. db_instance : db_instance option;
}
type nonrec create_db_instance_message = {
  1. deletion_protection : boolean_optional option;
    (*

    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.

    *)
  2. enable_cloudwatch_logs_exports : log_type_list option;
    (*

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

    *)
  3. performance_insights_kms_key_id : string_ option;
    (*

    (Not supported by Neptune)

    *)
  4. enable_performance_insights : boolean_optional option;
    (*

    (Not supported by Neptune)

    *)
  5. enable_iam_database_authentication : boolean_optional option;
    (*

    Not supported by Neptune (ignored).

    *)
  6. timezone : string_ option;
    (*

    The time zone of the DB instance.

    *)
  7. promotion_tier : integer_optional option;
    (*

    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

    *)
  8. domain_iam_role_name : string_ option;
    (*

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

    *)
  9. monitoring_role_arn : string_ option;
    (*

    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.

    *)
  10. monitoring_interval : integer_optional option;
    (*

    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

    *)
  11. copy_tags_to_snapshot : boolean_optional option;
    (*

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

    *)
  12. domain : string_ option;
    (*

    Specify the Active Directory Domain to create the instance in.

    *)
  13. kms_key_id : string_ option;
    (*

    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 KMS 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.

    *)
  14. storage_encrypted : boolean_optional option;
    (*

    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

    *)
  15. tde_credential_password : sensitive_string option;
    (*

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

    *)
  16. tde_credential_arn : string_ option;
    (*

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

    *)
  17. storage_type : string_ option;
    (*

    Not applicable. In Neptune the storage type is managed at the DB Cluster level.

    *)
  18. db_cluster_identifier : string_;
    (*

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

    For information on creating a DB cluster, see CreateDBCluster.

    Type: String

    *)
  19. tags : tag_list option;
    (*

    The tags to assign to the new instance.

    *)
  20. publicly_accessible : boolean_optional option;
    (*

    Indicates whether the DB instance is publicly accessible.

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

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

    *)
  21. character_set_name : string_ option;
    (*

    (Not supported by Neptune)

    *)
  22. option_group_name : string_ option;
    (*

    (Not supported by Neptune)

    *)
  23. iops : integer_optional option;
    (*

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

    *)
  24. license_model : string_ option;
    (*

    License model information for this DB instance.

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

    *)
  25. auto_minor_version_upgrade : boolean_optional option;
    (*

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

    Default: true

    *)
  26. engine_version : string_ option;
    (*

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

    *)
  27. multi_a_z : boolean_optional option;
    (*

    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.

    *)
  28. port : integer_optional option;
    (*

    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

    *)
  29. preferred_backup_window : string_ option;
    (*

    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.

    *)
  30. backup_retention_period : integer_optional option;
    (*

    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
    *)
  31. db_parameter_group_name : string_ option;
    (*

    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
    *)
  32. preferred_maintenance_window : string_ option;
    (*

    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.

    *)
  33. db_subnet_group_name : string_ option;
    (*

    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.

    *)
  34. availability_zone : string_ option;
    (*

    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.

    *)
  35. vpc_security_group_ids : vpc_security_group_id_list option;
    (*

    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.

    *)
  36. db_security_groups : db_security_group_name_list option;
    (*

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

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

    *)
  37. master_user_password : string_ option;
    (*

    Not supported by Neptune.

    *)
  38. master_username : string_ option;
    (*

    Not supported by Neptune.

    *)
  39. engine : string_;
    (*

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

    Valid Values: neptune

    *)
  40. db_instance_class : string_;
    (*

    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.

    *)
  41. allocated_storage : integer_optional option;
    (*

    Not supported by Neptune.

    *)
  42. db_instance_identifier : string_;
    (*

    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

    *)
  43. db_name : string_ option;
    (*

    Not supported.

    *)
}
type nonrec create_db_cluster_snapshot_result = {
  1. db_cluster_snapshot : db_cluster_snapshot option;
}
type nonrec create_db_cluster_snapshot_message = {
  1. tags : tag_list option;
    (*

    The tags to be assigned to the DB cluster snapshot.

    *)
  2. db_cluster_identifier : string_;
    (*

    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

    *)
  3. db_cluster_snapshot_identifier : string_;
    (*

    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

    *)
}
type nonrec create_db_cluster_result = {
  1. db_cluster : db_cluster option;
}
type nonrec create_db_cluster_parameter_group_result = {
  1. db_cluster_parameter_group : db_cluster_parameter_group option;
}
type nonrec create_db_cluster_parameter_group_message = {
  1. tags : tag_list option;
    (*

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

    *)
  2. description : string_;
    (*

    The description for the DB cluster parameter group.

    *)
  3. db_parameter_group_family : string_;
    (*

    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.

    *)
  4. db_cluster_parameter_group_name : string_;
    (*

    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.

    *)
}
type nonrec create_db_cluster_message = {
  1. network_type : string_ option;
    (*

    The network type of the DB cluster.

    Valid Values:

    • IPV4   –   ( the default ) The DB cluster uses only IPv4 addresses for communication.
    • DUAL   –   The DB cluster uses both IPv4 and IPv6 addresses for communication. The DB subnet group associated with the cluster must support IPv6.
    *)
  2. storage_type : string_ option;
    (*

    The storage type for the new DB cluster.

    Valid Values:

    • standard   –   ( the default ) Configures cost-effective database storage for applications with moderate to small I/O usage. When set to standard, the storage type is not returned in the response.

    • iopt1   –   Enables I/O-Optimized storage that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput.

      Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.

    *)
  3. global_cluster_identifier : global_cluster_identifier option;
    (*

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

    *)
  4. serverless_v2_scaling_configuration : serverless_v2_scaling_configuration option;
    (*

    Contains the scaling configuration of a Neptune Serverless DB cluster.

    For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

    *)
  5. deletion_protection : boolean_optional option;
    (*

    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.

    *)
  6. enable_cloudwatch_logs_exports : log_type_list option;
    (*

    A list of the log types that this DB cluster should export to CloudWatch Logs. Valid log types are: audit (to publish audit logs) and slowquery (to publish slow-query logs). See Publishing Neptune logs to Amazon CloudWatch logs.

    *)
  7. enable_iam_database_authentication : boolean_optional option;
    (*

    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.

    *)
  8. pre_signed_url : string_ option;
    (*

    This parameter is not currently supported.

    *)
  9. kms_key_id : string_ option;
    (*

    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.

    *)
  10. storage_encrypted : boolean_optional option;
    (*

    Specifies whether the DB cluster is encrypted.

    *)
  11. tags : tag_list option;
    (*

    The tags to assign to the new DB cluster.

    *)
  12. replication_source_identifier : string_ option;
    (*

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

    *)
  13. preferred_maintenance_window : string_ option;
    (*

    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 Neptune Maintenance Window in the Amazon Neptune User Guide.

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

    Constraints: Minimum 30-minute window.

    *)
  14. preferred_backup_window : string_ option;
    (*

    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 Neptune 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.
    *)
  15. option_group_name : string_ option;
    (*

    (Not supported by Neptune)

    *)
  16. master_user_password : string_ option;
    (*

    Not supported by Neptune.

    *)
  17. master_username : string_ option;
    (*

    Not supported by Neptune.

    *)
  18. port : integer_optional option;
    (*

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

    Default: 8182

    *)
  19. engine_version : string_ option;
    (*

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

    Example: 1.2.1.0

    *)
  20. engine : string_;
    (*

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

    Valid Values: neptune

    *)
  21. db_subnet_group_name : string_ option;
    (*

    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

    *)
  22. vpc_security_group_ids : vpc_security_group_id_list option;
    (*

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

    *)
  23. db_cluster_parameter_group_name : string_ option;
    (*

    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.
    *)
  24. db_cluster_identifier : string_;
    (*

    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

    *)
  25. database_name : string_ option;
    (*

    Not supported by Neptune.

    *)
  26. copy_tags_to_snapshot : boolean_optional option;
    (*

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

    *)
  27. character_set_name : string_ option;
    (*

    (Not supported by Neptune)

    *)
  28. backup_retention_period : integer_optional option;
    (*

    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
    *)
  29. availability_zones : availability_zones option;
    (*

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

    *)
}
type nonrec create_db_cluster_endpoint_output = {
  1. db_cluster_endpoint_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the endpoint.

    *)
  2. excluded_members : string_list option;
    (*

    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.

    *)
  3. static_members : string_list option;
    (*

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

    *)
  4. custom_endpoint_type : string_ option;
    (*

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

    *)
  5. endpoint_type : string_ option;
    (*

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

    *)
  6. status : string_ option;
    (*

    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.

    *)
  7. endpoint : string_ option;
    (*

    The DNS address of the endpoint.

    *)
  8. db_cluster_endpoint_resource_identifier : string_ option;
    (*

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

    *)
  9. db_cluster_identifier : string_ option;
    (*

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

    *)
  10. db_cluster_endpoint_identifier : string_ option;
    (*

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

    *)
}

This data type represents the information you need to connect to an Amazon Neptune DB cluster. This data type is used as a response element in the following actions:

  • CreateDBClusterEndpoint
  • DescribeDBClusterEndpoints
  • ModifyDBClusterEndpoint
  • DeleteDBClusterEndpoint

For the data structure that represents Amazon Neptune DB instance endpoints, see Endpoint.

type nonrec create_db_cluster_endpoint_message = {
  1. tags : tag_list option;
    (*

    The tags to be assigned to the Amazon Neptune resource.

    *)
  2. excluded_members : string_list option;
    (*

    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.

    *)
  3. static_members : string_list option;
    (*

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

    *)
  4. endpoint_type : string_;
    (*

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

    *)
  5. db_cluster_endpoint_identifier : string_;
    (*

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

    *)
  6. db_cluster_identifier : string_;
    (*

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

    *)
}
type nonrec copy_db_parameter_group_result = {
  1. db_parameter_group : db_parameter_group option;
}
type nonrec copy_db_parameter_group_message = {
  1. tags : tag_list option;
    (*

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

    *)
  2. target_db_parameter_group_description : string_;
    (*

    A description for the copied DB parameter group.

    *)
  3. target_db_parameter_group_identifier : string_;
    (*

    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

    *)
  4. source_db_parameter_group_identifier : string_;
    (*

    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.
    • The source DB parameter group must be in the same Amazon Region as the copy. Neptune does not support cross-Region copying of parameter groups.
    *)
}
type nonrec copy_db_cluster_snapshot_result = {
  1. db_cluster_snapshot : db_cluster_snapshot option;
}
type nonrec copy_db_cluster_snapshot_message = {
  1. tags : tag_list option;
    (*

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

    *)
  2. copy_tags : boolean_optional option;
    (*

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

    *)
  3. pre_signed_url : string_ option;
    (*

    Not currently supported.

    *)
  4. kms_key_id : string_ option;
    (*

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

    *)
  5. target_db_cluster_snapshot_identifier : string_;
    (*

    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

    *)
  6. source_db_cluster_snapshot_identifier : string_;
    (*

    The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive. If the source DB cluster snapshot is in a different region or owned by another account, specify the snapshot ARN.

    Constraints:

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

    Example: my-cluster-snapshot1

    *)
}
type nonrec copy_db_cluster_parameter_group_result = {
  1. db_cluster_parameter_group : db_cluster_parameter_group option;
}
type nonrec copy_db_cluster_parameter_group_message = {
  1. tags : tag_list option;
    (*

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

    *)
  2. target_db_cluster_parameter_group_description : string_;
    (*

    A description for the copied DB cluster parameter group.

    *)
  3. target_db_cluster_parameter_group_identifier : string_;
    (*

    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

    *)
  4. source_db_cluster_parameter_group_identifier : string_;
    (*

    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.
    • Must specify a valid DB cluster parameter group identifier, for example my-db-cluster-param-group, or a valid ARN.
    • The source DB cluster parameter group must be in the same Amazon Region as the copy. Neptune does not support cross-Region copying of parameter groups.
    *)
}
type nonrec apply_pending_maintenance_action_result = {
  1. resource_pending_maintenance_actions : resource_pending_maintenance_actions option;
}
type nonrec apply_pending_maintenance_action_message = {
  1. opt_in_type : string_;
    (*

    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.
    *)
  2. apply_action : string_;
    (*

    The pending maintenance action to apply to this resource.

    Valid values: system-update, db-upgrade

    *)
  3. resource_identifier : string_;
    (*

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

    *)
}
type nonrec add_tags_to_resource_message = {
  1. tags : tag_list;
    (*

    The tags to be assigned to the Amazon Neptune resource.

    *)
  2. resource_name : string_;
    (*

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

    *)
}
type nonrec add_source_identifier_to_subscription_result = {
  1. event_subscription : event_subscription option;
}
type nonrec add_source_identifier_to_subscription_message = {
  1. source_identifier : string_;
    (*

    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.
    *)
  2. subscription_name : string_;
    (*

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

    *)
}
type nonrec add_role_to_db_cluster_message = {
  1. feature_name : string_ option;
    (*

    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.

    *)
  2. role_arn : string_;
    (*

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

    *)
  3. db_cluster_identifier : string_;
    (*

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

    *)
}