Module Awso_rds.Values_0Source

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval serviceAbbreviation : string
Sourceval xmlNamespace : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule String_ : sig ... end
Sourcemodule Double : sig ... end
Sourcemodule Integer : sig ... end
Sourcemodule StringList : sig ... end
Sourcemodule ScalarReferenceDetails : sig ... end

The metric reference details when the reference is a scalar.

A logical grouping of Performance Insights metrics for a related subject area. For example, the db.sql dimension group consists of the following dimensions: db.sql.id - The hash of a running SQL statement, generated by Performance Insights. db.sql.db_id - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with pi-. db.sql.statement - The full text of the SQL statement that is running, for example, SELECT * FROM employees. db.sql_tokenized.id - The hash of the SQL digest generated by Performance Insights. Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

Sourcemodule ReferenceDetails : sig ... end

The reference details of a metric.

A single Performance Insights metric query to process. You must provide the metric to the query. If other parameters aren't specified, Performance Insights returns all data points for the specified metric. Optionally, you can request the data points to be aggregated by dimension group (GroupBy) and return only those data points that match your criteria (Filter). Constraints: Must be a valid Performance Insights query.

Sourcemodule MetricReference : sig ... end

The reference (threshold) for a metric.

Sourcemodule IntegerOptional : sig ... end
Sourcemodule MetricQuery : sig ... end

The query to retrieve metric data points.

Sourcemodule MetricReferenceList : sig ... end
Sourcemodule DoubleRange : sig ... end

A range of double values.

Sourcemodule Range : sig ... end

A range of integer values.

Sourcemodule Metric : sig ... end

The representation of a metric.

Sourcemodule Boolean : sig ... end
Sourcemodule DoubleRangeList : sig ... end
Sourcemodule RangeList : sig ... end
Sourcemodule MetricList : sig ... end
Sourcemodule TStamp : sig ... end
Sourcemodule DBSecurityGroupMembership : sig ... end

This data type is used as a response element in the following actions: ModifyDBInstance RebootDBInstance RestoreDBInstanceFromDBSnapshot RestoreDBInstanceToPointInTime

Sourcemodule OptionSetting : sig ... end

Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.

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

The minimum DB engine version required for each corresponding allowed value for an option setting.

Sourcemodule ValidStorageOptions : sig ... end

Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action.

Sourcemodule ContextAttribute : sig ... end

The additional attributes of RecommendedAction data type.

Sourcemodule PerformanceIssueDetails : sig ... end

Details of the performance issue.

A single parameter to use with the RecommendedAction API operation to apply the action.

Sourcemodule AvailabilityZone : sig ... end

Contains Availability Zone information. This data type is used as an element in the OrderableDBInstanceOption data type.

Sourcemodule Outpost : sig ... end

A data type that represents an Outpost. For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

Sourcemodule DoubleOptional : sig ... end
Sourcemodule ReadersArnList : sig ... end
Sourcemodule WriteForwardingStatus : sig ... end
Sourcemodule ValidStorageOptionsList : sig ... end
Sourcemodule AuthScheme : sig ... end
Sourcemodule ClientPasswordAuthType : sig ... end
Sourcemodule IAMAuthMode : sig ... end
Sourcemodule LifecycleSupportName : sig ... end
Sourcemodule DatabaseArn : sig ... end
Sourcemodule SwitchoverDetailStatus : sig ... end
Sourcemodule ContextAttributeList : sig ... end
Sourcemodule IssueDetails : sig ... end

The details of an issue with your DB instances, DB clusters, and DB parameter groups.

Sourcemodule Subnet : sig ... end

This data type is used as a response element for the DescribeDBSubnetGroups operation.

Sourcemodule AdditionalStorageVolume : sig ... end

Contains details about an additional storage volume for a DB instance. RDS support additional storage volumes for RDS for Oracle and RDS for SQL Server.

Sourcemodule LogTypeList : sig ... end
Sourcemodule ProcessorFeature : sig ... end

Contains the processor features of a DB instance class. To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter. You can set the processor features of the DB instance class for a DB instance when you call one of the following actions: CreateDBInstance ModifyDBInstance RestoreDBInstanceFromDBSnapshot RestoreDBInstanceFromS3 RestoreDBInstanceToPointInTime You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter. In addition, you can use the following actions for DB instance class processor information: DescribeDBInstances DescribeDBSnapshots DescribeValidDBInstanceModifications If you call DescribeDBInstances, ProcessorFeature returns non-null values only if the following conditions are met: You are accessing an Oracle or SQL Server DB instance. Your Oracle or SQL Server DB instance class supports configuring the number of CPU cores and threads per core. The current number CPU cores and threads is set to a non-default value. For more information, see Configuring the processor for a DB instance class in RDS for Oracle, Optimizing your RDS for SQL Server CPU, and DB instance classes in the Amazon RDS User Guide.

Sourcemodule BooleanOptional : sig ... end
Sourcemodule EngineModeList : sig ... end
Sourcemodule ReplicaMode : sig ... end
Sourcemodule Tag : sig ... end

Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

Sourcemodule SensitiveString : sig ... end
Sourcemodule RecurringCharge : sig ... end

This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.

Sourcemodule TargetHealthReason : sig ... end
Sourcemodule TargetState : sig ... end
Sourcemodule PendingMaintenanceAction : sig ... end

Provides information about a pending maintenance action for a resource.

Contains the available options for additional storage volumes for a DB instance class.

Sourcemodule AvailableProcessorFeature : sig ... end

Contains the available processor feature information for the DB instance class of a DB instance. For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.

Sourcemodule Option_ : sig ... end

The details of an option.

Sourcemodule OptionGroupOptionSetting : sig ... end

Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.

Sourcemodule OptionVersion : sig ... end

The version for an option. Option group option versions are returned by the DescribeOptionGroupOptions action.

Sourcemodule AttributeValueList : sig ... end
Sourcemodule FailoverStatus : sig ... end
Sourcemodule GlobalClusterMember : sig ... end

A data structure with information about any primary and secondary clusters associated with a global cluster (Aurora global database).

Sourcemodule ValidVolumeOptions : sig ... end

Contains the valid options for an additional storage volume.

Sourcemodule IntegrationError : sig ... end

An error associated with a zero-ETL integration with Amazon Redshift.

Sourcemodule ApplyMethod : sig ... end
Sourcemodule OperatorSensitiveString : sig ... end
Sourcemodule UserAuthConfigInfo : sig ... end

Returns the details of authentication used by a proxy to log in as a specific database user.

Sourcemodule SupportedEngineLifecycle : sig ... end

This data type is used as a response element in the operation DescribeDBMajorEngineVersions. You can use the information that this data type returns to plan for upgrades. This data type only returns information for the open source engines Amazon RDS for MariaDB, Amazon RDS for MySQL, Amazon RDS for PostgreSQL, Aurora MySQL, and Aurora PostgreSQL.

Sourcemodule BlueGreenDeploymentTask : sig ... end

Details about a task for a blue/green deployment. For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.

Sourcemodule SwitchoverDetail : sig ... end

Contains the details about a blue/green deployment. For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.

Sourcemodule EC2SecurityGroup : sig ... end

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

Sourcemodule IPRange : sig ... end

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

A link to documentation that provides additional information for a recommendation.

Sourcemodule RecommendedAction : sig ... end

The recommended actions to apply to resolve the issues associated with your DB instances, DB clusters, and DB parameter groups.

Contains information about an additional storage volume for a DB instance.

Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.

Sourcemodule DBInstanceRole : sig ... end

Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.

Sourcemodule DBInstanceStatusInfo : sig ... end

Provides a list of status information for a DB instance.

Sourcemodule DBParameterGroupStatus : sig ... end

The status of the DB parameter group. This data type is used as a response element in the following actions: CreateDBInstance CreateDBInstanceReadReplica DeleteDBInstance ModifyDBInstance RebootDBInstance RestoreDBInstanceFromDBSnapshot

Sourcemodule SubnetList : sig ... end
Sourcemodule DomainMembership : sig ... end

An Active Directory Domain membership record associated with the DB instance or cluster.

Sourcemodule OptionGroupMembership : sig ... end

Provides information on the option groups the DB instance is a member of.

Sourcemodule AutomationMode : sig ... end

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.

Sourcemodule ProcessorFeatureList : sig ... end
Sourcemodule CharacterSet : sig ... end

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

Sourcemodule Timezone : sig ... end

A time zone associated with a DBInstance or a DBSnapshot. This data type is an element in the response to the DescribeDBInstances, the DescribeDBSnapshots, and the DescribeDBEngineVersions actions.

Sourcemodule UpgradeTarget : sig ... end

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

Sourcemodule CertificateDetails : sig ... end

The details of the DB instanceโ€™s server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

Reserved for future use.

Sourcemodule DBClusterMember : sig ... end

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

Contains status information for a DB cluster option group.

Sourcemodule DBClusterRole : sig ... end

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

Sourcemodule DBClusterStatusInfo : sig ... end

Reserved for future use.

Sourcemodule LimitlessDatabaseStatus : sig ... end
Sourcemodule MasterUserSecret : sig ... end

Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password. For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.

Sourcemodule TagList : sig ... end

A response element in the ModifyTenantDatabase operation that describes changes that will be applied. Specific changes are identified by subelements.

Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions and platform versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features.

Sourcemodule RecurringChargeList : sig ... end
Sourcemodule TargetHealth : sig ... end

Information about the connection health of an RDS Proxy target.

Sourcemodule TargetRole : sig ... end
Sourcemodule TargetType : sig ... end
Sourcemodule ActivityStreamModeList : sig ... end
Sourcemodule AvailabilityZoneList : sig ... end
Sourcemodule OptionsList : sig ... end
Sourcemodule OptionsConflictsWith : sig ... end
Sourcemodule OptionsDependedOn : sig ... end
Sourcemodule DBSecurityGroupNameList : sig ... end
Sourcemodule OptionSettingsList : sig ... end
Sourcemodule VpcSecurityGroupIdList : sig ... end
Sourcemodule DBSnapshotAttribute : sig ... end

Contains the name and values of a manual DB snapshot attribute Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API.

Sourcemodule Arn : sig ... end
Sourcemodule AuthUserName : sig ... end
Sourcemodule Description : sig ... end

Contains the name and values of a manual DB cluster snapshot attribute. Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

Sourcemodule FilterValueList : sig ... end
Sourcemodule FailoverState : sig ... end

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

Sourcemodule GlobalClusterIdentifier : sig ... end
Sourcemodule GlobalClusterMemberList : sig ... end
Sourcemodule StorageEncryptionType : sig ... end
Sourcemodule DBClusterNotFoundFault : sig ... end

DBClusterIdentifier doesn't refer to an existing DB cluster.

DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.

Sourcemodule DBSnapshotNotFoundFault : sig ... end

DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

Sourcemodule ExportSourceType : sig ... end

You can't start an export task that's already running.

Sourcemodule ExportTaskNotFoundFault : sig ... end

The export task doesn't exist.

The IAM role requires additional permissions to export to an Amazon S3 bucket.

Sourcemodule IamRoleNotFoundFault : sig ... end

The IAM role is missing for exporting to an Amazon S3 bucket.

Sourcemodule InvalidExportOnlyFault : sig ... end

The export is invalid for exporting to an Amazon S3 bucket.

The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.

You can't cancel an export task that has completed.

Sourcemodule InvalidS3BucketFault : sig ... end

The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.

Sourcemodule KMSKeyNotAccessibleFault : sig ... end

An error occurred accessing an Amazon Web Services KMS key.

Sourcemodule EventCategoriesList : sig ... end
Sourcemodule SourceType : sig ... end
Sourcemodule SourceIdsList : sig ... end
Sourcemodule ValidVolumeOptionsList : sig ... end
Sourcemodule DBInstanceNotFoundFault : sig ... end

DBInstanceIdentifier doesn't refer to an existing DB instance.

Sourcemodule DataFilter : sig ... end
Sourcemodule EncryptionContextMap : sig ... end

The integration you are trying to create already exists.

Sourcemodule IntegrationArn : sig ... end

A conflicting conditional operation is currently in progress against this resource. Typically occurs when there are multiple requests being made to the same resource at the same time, and these requests conflict with each other.

Sourcemodule IntegrationDescription : sig ... end
Sourcemodule IntegrationErrorList : sig ... end
Sourcemodule IntegrationName : sig ... end
Sourcemodule IntegrationNotFoundFault : sig ... end

The specified integration could not be found.

You can't crate any more zero-ETL integrations because the quota has been reached.

Sourcemodule IntegrationStatus : sig ... end

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

Sourcemodule SourceArn : sig ... end
Sourcemodule Parameter : sig ... end

This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions. This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

The specified DB shard group name must be unique in your Amazon Web Services account in the specified Amazon Web Services Region.

Sourcemodule DBShardGroupIdentifier : sig ... end
Sourcemodule DBShardGroupNotFoundFault : sig ... end

The specified DB shard group name wasn't found.

The requested operation can't be performed while the cluster is in this state.

The DB shard group must be in the available state.

The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

The maximum number of DB shard groups for your Amazon Web Services account in the specified Amazon Web Services Region has been reached.

Sourcemodule NetworkTypeNotSupported : sig ... end

The network type is invalid for the DB instance. Valid nework type values are IPV4 and DUAL.

The specified DB engine version isn't supported for Aurora Limitless Database.

Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget.

Sourcemodule DBProxyEndpointStatus : sig ... end
Sourcemodule DBProxyEndpointTargetRole : sig ... end
Sourcemodule EndpointNetworkType : sig ... end
Sourcemodule DBProxyStatus : sig ... end
Sourcemodule UserAuthConfigInfoList : sig ... end
Sourcemodule Long : sig ... end
Sourcemodule BlueGreenDeploymentName : sig ... end
Sourcemodule BlueGreenDeploymentStatus : sig ... end
Sourcemodule SwitchoverDetailList : sig ... end
Sourcemodule EC2SecurityGroupList : sig ... end
Sourcemodule IPRangeList : sig ... end
Sourcemodule RecommendedActionList : sig ... end
Sourcemodule ActivityStreamMode : sig ... end
Sourcemodule ActivityStreamStatus : sig ... end
Sourcemodule DBInstanceRoles : sig ... end
Sourcemodule DBInstanceStatusInfoList : sig ... end
Sourcemodule DBSubnetGroup : sig ... end

Contains the details of an Amazon RDS DB subnet group. This data type is used as a response element in the DescribeDBSubnetGroups action.

Sourcemodule DatabaseInsightsMode : sig ... end
Sourcemodule DomainMembershipList : sig ... end
Sourcemodule Endpoint : sig ... end

This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions: CreateDBInstance DescribeDBInstances DeleteDBInstance For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.

Sourcemodule OptionGroupMembershipList : sig ... end
Sourcemodule PendingModifiedValues : sig ... end

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

Sourcemodule UpgradeRolloutOrder : sig ... end
Sourcemodule RestoreWindow : sig ... end

Earliest and latest time an instance can be restored to:

An error occurred while trying to create the CEV.

Sourcemodule CustomDBEngineVersionAMI : sig ... end

A value that indicates the AMI information.

A CEV with the specified name already exists.

The specified CEV was not found.

You have exceeded your CEV quota.

The AMI configuration prerequisite has not been met.

Sourcemodule FeatureNameList : sig ... end

You can't delete the CEV.

Sourcemodule SupportedTimezonesList : sig ... end
Sourcemodule ValidUpgradeTargetList : sig ... end
Sourcemodule AvailabilityZones : sig ... end

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.

Sourcemodule ClusterScalabilityType : sig ... end
Sourcemodule DBClusterMemberList : sig ... end
Sourcemodule DBClusterRoles : sig ... end
Sourcemodule DBClusterStatusInfoList : sig ... end
Sourcemodule LimitlessDatabase : sig ... end

Contains details for Aurora Limitless Database.

Sourcemodule LongOptional : sig ... end
Sourcemodule ReadReplicaIdentifierList : sig ... end
Sourcemodule ScalingConfigurationInfo : sig ... end

The scaling configuration for an Aurora DB cluster in serverless DB engine mode. For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.

The scaling configuration for an Aurora Serverless v2 DB cluster. For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.

The specified custom endpoint can't be created because it already exists.

The specified custom endpoint doesn't exist.

The cluster already has the maximum number of custom endpoints.

The requested operation can't be performed on the endpoint while the endpoint is in this state.

The DB instance isn't in a valid state.

Sourcemodule TenantDatabase : sig ... end

A tenant database in the DB instance. This data type is an element in the response to the DescribeTenantDatabases action.

Sourcemodule SourceRegion : sig ... end

Contains an Amazon Web Services Region name as the result of a successful call to the DescribeSourceRegions action.

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

Sourcemodule TagSpecification : sig ... end

The tags to apply to resources when creating or modifying a DB instance or DB cluster. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.

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

Sourcemodule ReservedDBInstance : sig ... end

This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.

Sourcemodule DBProxyTarget : sig ... end

Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group. This data type is used as a response element in the DescribeDBProxyTargets action.

Describes the pending maintenance actions for a resource.

Sourcemodule OrderableDBInstanceOption : sig ... end

Contains a list of available options for a DB instance. This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

Sourcemodule OptionGroup : sig ... end
Sourcemodule OptionGroupOption : sig ... end

Available option.

Sourcemodule OptionConfiguration : sig ... end

A list of all available options for an option group.

Sourcemodule DBSnapshotAttributeList : sig ... end
Sourcemodule RecommendedActionUpdate : sig ... end

The recommended status to update for the specified recommendation action ID.

Sourcemodule UserAuthConfig : sig ... end

Specifies the details of authentication used by a proxy to log in as a specific database user.

Contains details about the modification of an additional storage volume.

Sourcemodule Filter : sig ... end

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation. Currently, wildcards are not supported in filters. The following actions can be filtered: DescribeDBClusterBacktracks DescribeDBClusterEndpoints DescribeDBClusters DescribeDBInstances DescribeDBRecommendations DescribeDBShardGroups DescribePendingMaintenanceActions

Sourcemodule GlobalCluster : sig ... end

A data type representing an Aurora global database.

Sourcemodule ExportTask : sig ... end

Contains the details of a snapshot or cluster export to Amazon S3. This data type is used as a response element in the DescribeExportTasks operation.

Sourcemodule Event : sig ... end

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

Sourcemodule EventSubscription : sig ... end

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

Sourcemodule EventCategoriesMap : sig ... end

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

Contains the valid options for additional storage volumes for a DB instance.

Sourcemodule Integration : sig ... end

A zero-ETL integration with Amazon Redshift.

Sourcemodule ParametersList : sig ... end
Sourcemodule DBShardGroup : sig ... end

Contains the details for an Amazon RDS DB shard group.

Sourcemodule DBProxyTargetGroup : sig ... end

Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group is associated with exactly one RDS DB instance or Aurora DB cluster. This data type is used as a response element in the DescribeDBProxyTargetGroups action.

Sourcemodule DBProxyEndpoint : sig ... end

The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the associated DB proxy. This data type is used as a response element in the DescribeDBProxyEndpoints operation.

Sourcemodule DBProxy : sig ... end

The data structure representing a proxy managed by the RDS Proxy. This data type is used as a response element in the DescribeDBProxies action.

Sourcemodule DBMajorEngineVersion : sig ... end

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

Sourcemodule DescribeDBLogFilesDetails : sig ... end

This data type is used as a response element to DescribeDBLogFiles.

Sourcemodule BlueGreenDeployment : sig ... end

Details about a blue/green deployment. For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.

Sourcemodule DBSnapshotTenantDatabase : sig ... end

Contains the details of a tenant database in a snapshot of a DB instance.

Sourcemodule DBSnapshot : sig ... end

Contains the details of an Amazon RDS DB snapshot. This data type is used as a response element in the DescribeDBSnapshots action.

Sourcemodule DBSecurityGroup : sig ... end

Contains the details for an Amazon RDS DB security group. This data type is used as a response element in the DescribeDBSecurityGroups action.

Sourcemodule DBRecommendation : sig ... end

The recommendation for your DB instances, DB clusters, and DB parameter groups.

Sourcemodule DBParameterGroup : sig ... end

Contains the details of an Amazon RDS DB parameter group. This data type is used as a response element in the DescribeDBParameterGroups action.

Sourcemodule DBInstance : sig ... end

Contains the details of an Amazon RDS DB instance. This data type is used as a response element in the operations CreateDBInstance, CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance, PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.

Sourcemodule DBInstanceAutomatedBackup : sig ... end

An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.

Sourcemodule DBEngineVersion : sig ... end

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

Sourcemodule DBClusterSnapshot : sig ... end

Contains the details for an Amazon RDS DB cluster snapshot This data type is used as a response element in the DescribeDBClusterSnapshots action.

Sourcemodule DBClusterParameterGroup : sig ... end

Contains the details of an Amazon RDS DB cluster parameter group. This data type is used as a response element in the DescribeDBClusterParameterGroups action.

Sourcemodule DBCluster : sig ... end

Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster. For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster. For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

Sourcemodule DBClusterEndpoint : sig ... end

This data type represents the information you need to connect to an Amazon Aurora 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.

Sourcemodule DBClusterBacktrack : sig ... end

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

Sourcemodule DBClusterAutomatedBackup : sig ... end

An automated backup of a DB cluster. It consists of system backups, transaction logs, and the database cluster properties that existed at the time you deleted the source cluster.

Sourcemodule Certificate : sig ... end

A CA certificate for an Amazon Web Services account. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

Sourcemodule AccountQuota : sig ... end

Describes a quota for an Amazon Web Services account. The following are account quotas: AllocatedStorage - The total allocated storage per account, in GiB. The used value is the total allocated storage in the account, in GiB. AuthorizationsPerDBSecurityGroup - The number of ingress rules per DB security group. The used value is the highest number of ingress rules in a DB security group in the account. Other DB security groups in the account might have a lower number of ingress rules. CustomEndpointsPerDBCluster - The number of custom endpoints per DB cluster. The used value is the highest number of custom endpoints in a DB clusters in the account. Other DB clusters in the account might have a lower number of custom endpoints. DBClusterParameterGroups - The number of DB cluster parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB cluster parameter groups in the account. DBClusterRoles - The number of associated Amazon Web Services Identity and Access Management (IAM) roles per DB cluster. The used value is the highest number of associated IAM roles for a DB cluster in the account. Other DB clusters in the account might have a lower number of associated IAM roles. DBClusters - The number of DB clusters per account. The used value is the count of DB clusters in the account. DBInstanceRoles - The number of associated IAM roles per DB instance. The used value is the highest number of associated IAM roles for a DB instance in the account. Other DB instances in the account might have a lower number of associated IAM roles. DBInstances - The number of DB instances per account. The used value is the count of the DB instances in the account. Amazon RDS DB instances, Amazon Aurora DB instances, Amazon Neptune instances, and Amazon DocumentDB instances apply to this quota. DBParameterGroups - The number of DB parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB parameter groups in the account. DBSecurityGroups - The number of DB security groups (not VPC security groups) per account, excluding the default security group. The used value is the count of nondefault DB security groups in the account. DBSubnetGroups - The number of DB subnet groups per account. The used value is the count of the DB subnet groups in the account. EventSubscriptions - The number of event subscriptions per account. The used value is the count of the event subscriptions in the account. ManualClusterSnapshots - The number of manual DB cluster snapshots per account. The used value is the count of the manual DB cluster snapshots in the account. ManualSnapshots - The number of manual DB instance snapshots per account. The used value is the count of the manual DB instance snapshots in the account. OptionGroups - The number of DB option groups per account, excluding default option groups. The used value is the count of nondefault DB option groups in the account. ReadReplicasPerMaster - The number of read replicas per DB instance. The used value is the highest number of read replicas for a DB instance in the account. Other DB instances in the account might have a lower number of read replicas. ReservedDBInstances - The number of reserved DB instances per account. The used value is the count of the active reserved DB instances in the account. SubnetsPerDBSubnetGroup - The number of subnets per DB subnet group. The used value is highest number of subnets for a DB subnet group in the account. Other DB subnet groups in the account might have a lower number of subnets. For more information, see Quotas for Amazon RDS in the Amazon RDS User Guide and Quotas for Amazon Aurora in the Amazon Aurora User Guide.

Sourcemodule TenantDatabasesList : sig ... end

BlueGreenDeploymentIdentifier doesn't refer to an existing blue/green deployment.

The DB proxy endpoint doesn't exist.

Sourcemodule DBProxyNotFoundFault : sig ... end

The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

The specified snapshot tenant database wasn't found.

The specified tenant database wasn't found in the DB instance.

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

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

Sourcemodule DBClusterIdentifier : sig ... end

The blue/green deployment can't be switched over or deleted because there is an invalid configuration in the green environment.

Sourcemodule SwitchoverTimeout : sig ... end

DBSnapshotIdentifier is already used by an existing snapshot.

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

Sourcemodule ResourceNotFoundFault : sig ... end

The specified resource ID was not found.

The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group. Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.

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

DBSubnetGroupName doesn't refer to an existing DB subnet group.

The specified DB instance class isn't available in the specified Availability Zone.

Sourcemodule InvalidSubnet : sig ... end

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

The operation violates VPC encryption control settings. Make sure that your DB instance type supports the Nitro encryption-in-transit capability, or modify your VPC's encryption controls to not enforce encryption-in-transit.

The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB instance quota.

The automated backup is in an invalid state. For example, this automated backup is associated with an active instance.

The specified StorageType can't be associated with the DB instance.

Sourcemodule SourceRegionList : sig ... end

DBSecurityGroupName doesn't refer to an existing DB security group.

The state of the DB security group doesn't allow deletion.

Sourcemodule BackupPolicyNotFoundFault : sig ... end
Sourcemodule CertificateNotFoundFault : sig ... end

CertificateIdentifier doesn't refer to an existing certificate.

The user already has a DB instance with the given identifier.

No automated backup for this DB instance was found.

DBParameterGroupName doesn't refer to an existing DB parameter group.

Sourcemodule DomainNotFoundFault : sig ... end

Domain doesn't refer to an existing Active Directory domain.

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

Sourcemodule InvalidRestoreFault : sig ... end

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

Sourcemodule OptionGroupNotFoundFault : sig ... end

The specified option group could not be found.

SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.

Provisioned IOPS not available in the specified Availability Zone.

Sourcemodule StorageQuotaExceededFault : sig ... end

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

You attempted to create more tenant databases than are permitted in your Amazon Web Services account.

Sourcemodule TagSpecificationList : sig ... end

The state of the DB snapshot doesn't allow deletion.

The user already has a DB cluster with the given identifier.

No automated backup for this DB cluster was found.

DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.

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

The DB cluster doesn't have enough capacity for the current operation.

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

The supplied value isn't a valid DB cluster snapshot state.

Sourcemodule ScalingConfiguration : sig ... end

Contains the scaling configuration of an Aurora Serverless v1 DB cluster. For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.

Contains the scaling configuration of an Aurora Serverless v2 DB cluster. For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.

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

Specified offering does not exist.

Sourcemodule ReservedDBInstanceList : sig ... end

The specified reserved DB Instance not found.

Sourcemodule KeyList : sig ... end
Sourcemodule SourceNotFoundFault : sig ... end

The requested source could not be found.

Sourcemodule SubscriptionNotFoundFault : sig ... end

The subscription name does not exist.

The proxy is already associated with the specified RDS DB instance or Aurora DB cluster.

The requested operation can't be performed because there aren't enough available IP addresses in the proxy's subnets. Add more CIDR blocks to the VPC or remove IP address that aren't required from the subnets.

Sourcemodule InvalidDBProxyStateFault : sig ... end

The requested operation can't be performed while the proxy is in this state.

Sourcemodule TargetList : sig ... end
Sourcemodule DBProxyName : sig ... end
Sourcemodule DBProxyTargetGroupName : sig ... end

User already has a reservation with the given identifier.

Request would exceed the user's DB Instance quota.

Sourcemodule PendingMaintenanceActions : sig ... end
Sourcemodule OptionGroupsList : sig ... end
Sourcemodule OptionGroupOptionsList : sig ... end

You attempted to either create a tenant database that already exists or modify a tenant database to use the name of an existing tenant database.

The option group isn't in the available state.

Sourcemodule OptionConfigurationList : sig ... end
Sourcemodule OptionNamesList : sig ... end
Sourcemodule IntegrationIdentifier : sig ... end

The GlobalClusterIdentifier already exists. Specify a new global database identifier (unique name) to create a new global database cluster or to rename an existing one.

You have reached the maximum number of event subscriptions.

Sourcemodule SNSInvalidTopicFault : sig ... end

SNS has responded that there is a problem with the SNS topic specified.

Sourcemodule SNSNoAuthorizationFault : sig ... end

You do not have permission to publish to the SNS topic ARN.

Sourcemodule SNSTopicArnNotFoundFault : sig ... end

The SNS topic ARN does not exist.

The supplied category does not exist.

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

Sourcemodule SubnetAlreadyInUse : sig ... end

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

Sourcemodule SubnetIdentifierList : sig ... end

Contains the results of a successful call to the DescribeDBSnapshotAttributes API action. Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API action.

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

Specifies the settings that control the size and behavior of the connection pool associated with a DBProxyTargetGroup.

Sourcemodule DBProxyAlreadyExistsFault : sig ... end

The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.

Sourcemodule DefaultAuthScheme : sig ... end
Sourcemodule UserAuthConfigList : sig ... end

The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web Services account in the specified Amazon Web Services Region.

You can't perform this operation while the DB proxy endpoint is in a particular state.

Sourcemodule DBProxyEndpointName : sig ... end

The DB upgrade failed because a resource the DB depends on can't be modified.

Sourcemodule AwsBackupRecoveryPointArn : sig ... end

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. The values within these arrays depend on the DB engine being used. For more information about exporting CloudWatch Logs for Amazon RDS DB instances, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. For more information about exporting CloudWatch Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action. Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

The aurora-iopt1 storage type isn't available, because you modified the DB cluster to use this storage type less than one month ago.

Sourcemodule CustomEngineName : sig ... end
Sourcemodule CustomEngineVersion : sig ... end
Sourcemodule CustomEngineVersionStatus : sig ... end
Sourcemodule AuditPolicyState : sig ... end
Sourcemodule FilterList : sig ... end
Sourcemodule GlobalClusterList : sig ... end
Sourcemodule ExportTasksList : sig ... end
Sourcemodule EventList : sig ... end
Sourcemodule EventSubscriptionsList : sig ... end
Sourcemodule EventCategoriesMapList : sig ... end
Sourcemodule InvalidResourceStateFault : sig ... end

The operation can't be performed because another operation is in progress.

Sourcemodule DBInstanceNotReadyFault : sig ... end

An attempt to download or examine log files didn't succeed because an Aurora Serverless v2 instance was paused.

Sourcemodule DBLogFileNotFoundFault : sig ... end

LogFileName doesn't refer to an existing DB log file.

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.

Sourcemodule IntegrationList : sig ... end
Sourcemodule Marker : sig ... end
Sourcemodule MaxRecords : sig ... end
Sourcemodule EngineDefaults : sig ... end

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

Sourcemodule DBShardGroupsList : sig ... end

The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

Sourcemodule TargetGroupList : sig ... end
Sourcemodule DBProxyEndpointList : sig ... end
Sourcemodule DBProxyList : sig ... end
Sourcemodule DBMajorEngineVersionsList : sig ... end
Sourcemodule Engine : sig ... end
Sourcemodule MajorEngineVersion : sig ... end
Sourcemodule DescribeDBLogFilesList : sig ... end
Sourcemodule BlueGreenDeploymentList : sig ... end

This error can occur if someone else is modifying a subscription. You should retry the action.

The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB cluster quota.

The user already has a DB cluster snapshot with the given identifier.

The automated backup is in an invalid state. For example, this automated backup is associated with an active cluster.

Sourcemodule DBSubnetGroups : sig ... end
Sourcemodule DBSnapshotList : sig ... end
Sourcemodule DBSecurityGroups : sig ... end
Sourcemodule DBRecommendationList : sig ... end
Sourcemodule DBParameterGroupList : sig ... end

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

Sourcemodule DBInstanceList : sig ... end
Sourcemodule DBEngineVersionList : sig ... end
Sourcemodule DBClusterSnapshotList : sig ... end
Sourcemodule DBClusterList : sig ... end
Sourcemodule DBClusterEndpointList : sig ... end

Capacity isn't a valid Aurora Serverless DB cluster capacity. Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

Sourcemodule DBClusterBacktrackList : sig ... end

BacktrackIdentifier doesn't refer to an existing backtrack.

The option group you are trying to create already exists.

The quota of 20 option groups was exceeded for this Amazon Web Services account.

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

The supplied subscription name already exists.

DBSubnetGroupName is already used by an existing DB subnet group.

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

A DB security group with the name specified in DBSecurityGroupName already exists.

A DB security group isn't allowed for this action.

The request would result in the user exceeding the allowed number of DB security groups.

Sourcemodule DBProxyQuotaExceededFault : sig ... end

Your Amazon Web Services account already has the maximum number of proxies in the specified Amazon Web Services Region.

Sourcemodule EngineFamily : sig ... end

The DB proxy already has the maximum number of endpoints.

A DB parameter group with the same name exists.

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

The DBSubnetGroup shouldn't be specified while creating read replicas that lie in the same region as the source instance.

Sourcemodule InvalidDBSubnetGroupFault : sig ... end

The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the same source instance.

Sourcemodule BucketName : sig ... end
Sourcemodule KmsKeyIdOrArn : sig ... end
Sourcemodule String255 : sig ... end

A blue/green deployment with the specified name already exists.

The source DB cluster isn't supported for a blue/green deployment.

The source DB instance isn't supported for a blue/green deployment.

Sourcemodule TargetDBInstanceClass : sig ... end
Sourcemodule TargetEngineVersion : sig ... end
Sourcemodule TargetStorageType : sig ... end

CustomAvailabilityZoneId doesn't refer to an existing custom Availability Zone identifier.

Sourcemodule CertificateList : sig ... end

The specified CIDR IP range or Amazon EC2 security group is already authorized for the specified DB security group.

The DB security group authorization quota has been reached.

Sourcemodule AccountQuotaList : sig ... end
Sourcemodule TenantDatabasesMessage : sig ... end

Describes the tenant databases in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle CDB instances are supported.

Sourcemodule TagListMessage : sig ... end

Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new primary database. Issue this command in the Region that hosts the current standby database.

Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new primary database. Issue this command in the Region that hosts the current standby database.

Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster. Switchover operations were previously called "managed planned failovers." Aurora promotes the specified secondary cluster to assume full read/write capabilities and demotes the current primary cluster to a secondary (read-only) cluster, maintaining the orginal replication topology. All secondary clusters are synchronized with the primary at the beginning of the process so the new primary continues operations for the Aurora global database without losing any data. Your database is unavailable for a short time while the primary and selected secondary clusters are assuming their new roles. For more information about switching over an Aurora global database, see Performing switchovers for Amazon Aurora global databases in the Amazon Aurora User Guide. This operation is intended for controlled environments, for operations such as "regional rotation" or to fall back to the original primary after a global database failover.

Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster. Switchover operations were previously called "managed planned failovers." Aurora promotes the specified secondary cluster to assume full read/write capabilities and demotes the current primary cluster to a secondary (read-only) cluster, maintaining the orginal replication topology. All secondary clusters are synchronized with the primary at the beginning of the process so the new primary continues operations for the Aurora global database without losing any data. Your database is unavailable for a short time while the primary and selected secondary clusters are assuming their new roles. For more information about switching over an Aurora global database, see Performing switchovers for Amazon Aurora global databases in the Amazon Aurora User Guide. This operation is intended for controlled environments, for operations such as "regional rotation" or to fall back to the original primary after a global database failover.

Switches over a blue/green deployment. Before you switch over, production traffic is routed to the databases in the blue environment. After you switch over, production traffic is routed to the databases in the green environment. For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.

Switches over a blue/green deployment. Before you switch over, production traffic is routed to the databases in the blue environment. After you switch over, production traffic is routed to the databases in the green environment. For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.

Sourcemodule StopDBInstanceResult : sig ... end

Stops an Amazon RDS DB instance temporarily. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary. The instance restarts automatically after 7 days. For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide. This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.

Sourcemodule StopDBInstanceMessage : sig ... end

Stops an Amazon RDS DB instance temporarily. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary. The instance restarts automatically after 7 days. For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide. This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.

Stops automated backup replication for a DB instance. This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.

Stops automated backup replication for a DB instance. This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.

Sourcemodule StopDBClusterResult : sig ... end

Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide. This operation only applies to Aurora DB clusters.

Sourcemodule StopDBClusterMessage : sig ... end

Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide. This operation only applies to Aurora DB clusters.

Stops a database activity stream that was started using the Amazon Web Services console, the start-activity-stream CLI command, or the StartActivityStream operation. For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.

Sourcemodule StopActivityStreamRequest : sig ... end

Stops a database activity stream that was started using the Amazon Web Services console, the start-activity-stream CLI command, or the StartActivityStream operation. For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.

Sourcemodule StartExportTaskMessage : sig ... end

Starts an export of DB snapshot or DB cluster data to Amazon S3. The provided IAM role must have access to the S3 bucket. You can't export snapshot data from RDS Custom DB instances. For more information, see Supported Regions and DB engines for exporting snapshots to S3 in Amazon RDS. For more information on exporting DB snapshot data, see Exporting DB snapshot data to Amazon S3 in the Amazon RDS User Guide or Exporting DB cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide. For more information on exporting DB cluster data, see Exporting DB cluster data to Amazon S3 in the Amazon Aurora User Guide.

Sourcemodule StartDBInstanceResult : sig ... end

Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance operation. For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide. This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.

Sourcemodule StartDBInstanceMessage : sig ... end

Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance operation. For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide. This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.

Enables replication of automated backups to a different Amazon Web Services Region. This command doesn't apply to RDS Custom. For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.

Enables replication of automated backups to a different Amazon Web Services Region. This command doesn't apply to RDS Custom. For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.

Sourcemodule StartDBClusterResult : sig ... end

Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the StopDBCluster operation. For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide. This operation only applies to Aurora DB clusters.

Sourcemodule StartDBClusterMessage : sig ... end

Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the StopDBCluster operation. For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide. This operation only applies to Aurora DB clusters.

Starts a database activity stream to monitor activity on the database. For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.

Starts a database activity stream to monitor activity on the database. For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.

Sourcemodule SourceRegionMessage : sig ... end

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

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

Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId). EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring โ€“ Hereโ€™s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.

Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property. The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment. This operation doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.

Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Restoring a backup into an Amazon RDS for MySQL DB instance in the Amazon RDS User Guide. This operation doesn't apply to RDS Custom.

Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Restoring a backup into an Amazon RDS for MySQL DB instance in the Amazon RDS User Guide. This operation doesn't apply to RDS Custom.

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most of the source's original configuration, including the default security group and DB parameter group. By default, the new DB instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment. If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot operation. RDS doesn't allow two DB instances with the same name. After you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot operation. The result is that you replace the original DB instance with the DB instance created from the snapshot. If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot. To restore from a DB snapshot with an unsupported engine version, you must first upgrade the engine version of the snapshot. For more information about upgrading a RDS for MySQL DB snapshot engine version, see Upgrading a MySQL DB snapshot engine version. For more information about upgrading a RDS for PostgreSQL DB snapshot engine version, Upgrading a PostgreSQL DB snapshot engine version. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.

Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. Unless the RestoreType is set to copy-on-write, the restore may occur in a different Availability Zone (AZ) from the original DB cluster. The AZ where RDS restores the DB cluster depends on the AZs in the specified subnet group. You can use the EnableVPCNetworking and EnableInternetAccessGateway parameters together to restore an Aurora PostgreSQL cluster without VPC networking and with internet-based connectivity. These two parameters must always be specified together. Set EnableVPCNetworking to false to disable the VPC network interface (ENI) for the cluster. EnableInternetAccessGateway enables internet-based connectivity through an internet access gateway. IAM database authentication is required and must be enabled using EnableIAMDatabaseAuthentication. Once the cluster is restored, you need to modify the DB cluster to update MasterUserAuthenticationType to iam-db-auth. For Aurora, this operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime operation has completed and the DB cluster is available. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.