# Data Types The Amazon Relational Database Service API contains several data types that various actions use. This section describes each data type in detail. **Note** The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: + [AccountQuota](API_AccountQuota.md) + [AdditionalStorageVolume](API_AdditionalStorageVolume.md) + [AdditionalStorageVolumeOutput](API_AdditionalStorageVolumeOutput.md) + [AvailabilityZone](API_AvailabilityZone.md) + [AvailableAdditionalStorageVolumesOption](API_AvailableAdditionalStorageVolumesOption.md) + [AvailableProcessorFeature](API_AvailableProcessorFeature.md) + [BlueGreenDeployment](API_BlueGreenDeployment.md) + [BlueGreenDeploymentTask](API_BlueGreenDeploymentTask.md) + [Certificate](API_Certificate.md) + [CertificateDetails](API_CertificateDetails.md) + [CharacterSet](API_CharacterSet.md) + [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md) + [ClusterPendingModifiedValues](API_ClusterPendingModifiedValues.md) + [ConnectionPoolConfiguration](API_ConnectionPoolConfiguration.md) + [ConnectionPoolConfigurationInfo](API_ConnectionPoolConfigurationInfo.md) + [ContextAttribute](API_ContextAttribute.md) + [CustomDBEngineVersionAMI](API_CustomDBEngineVersionAMI.md) + [DBCluster](API_DBCluster.md) + [DBClusterAutomatedBackup](API_DBClusterAutomatedBackup.md) + [DBClusterBacktrack](API_DBClusterBacktrack.md) + [DBClusterEndpoint](API_DBClusterEndpoint.md) + [DBClusterMember](API_DBClusterMember.md) + [DBClusterOptionGroupStatus](API_DBClusterOptionGroupStatus.md) + [DBClusterParameterGroup](API_DBClusterParameterGroup.md) + [DBClusterRole](API_DBClusterRole.md) + [DBClusterSnapshot](API_DBClusterSnapshot.md) + [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md) + [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) + [DBClusterStatusInfo](API_DBClusterStatusInfo.md) + [DBEngineVersion](API_DBEngineVersion.md) + [DBInstance](API_DBInstance.md) + [DBInstanceAutomatedBackup](API_DBInstanceAutomatedBackup.md) + [DBInstanceAutomatedBackupsReplication](API_DBInstanceAutomatedBackupsReplication.md) + [DBInstanceRole](API_DBInstanceRole.md) + [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md) + [DBMajorEngineVersion](API_DBMajorEngineVersion.md) + [DBParameterGroup](API_DBParameterGroup.md) + [DBParameterGroupStatus](API_DBParameterGroupStatus.md) + [DBProxy](API_DBProxy.md) + [DBProxyEndpoint](API_DBProxyEndpoint.md) + [DBProxyTarget](API_DBProxyTarget.md) + [DBProxyTargetGroup](API_DBProxyTargetGroup.md) + [DBRecommendation](API_DBRecommendation.md) + [DBSecurityGroup](API_DBSecurityGroup.md) + [DBSecurityGroupMembership](API_DBSecurityGroupMembership.md) + [DBShardGroup](API_DBShardGroup.md) + [DBSnapshot](API_DBSnapshot.md) + [DBSnapshotAttribute](API_DBSnapshotAttribute.md) + [DBSnapshotAttributesResult](API_DBSnapshotAttributesResult.md) + [DBSnapshotTenantDatabase](API_DBSnapshotTenantDatabase.md) + [DBSubnetGroup](API_DBSubnetGroup.md) + [DescribeDBLogFilesDetails](API_DescribeDBLogFilesDetails.md) + [DocLink](API_DocLink.md) + [DomainMembership](API_DomainMembership.md) + [DoubleRange](API_DoubleRange.md) + [EC2SecurityGroup](API_EC2SecurityGroup.md) + [Endpoint](API_Endpoint.md) + [EngineDefaults](API_EngineDefaults.md) + [Event](API_Event.md) + [EventCategoriesMap](API_EventCategoriesMap.md) + [EventSubscription](API_EventSubscription.md) + [ExportTask](API_ExportTask.md) + [FailoverState](API_FailoverState.md) + [Filter](API_Filter.md) + [GlobalCluster](API_GlobalCluster.md) + [GlobalClusterMember](API_GlobalClusterMember.md) + [Integration](API_Integration.md) + [IntegrationError](API_IntegrationError.md) + [IPRange](API_IPRange.md) + [IssueDetails](API_IssueDetails.md) + [LimitlessDatabase](API_LimitlessDatabase.md) + [MasterUserSecret](API_MasterUserSecret.md) + [Metric](API_Metric.md) + [MetricQuery](API_MetricQuery.md) + [MetricReference](API_MetricReference.md) + [MinimumEngineVersionPerAllowedValue](API_MinimumEngineVersionPerAllowedValue.md) + [ModifyAdditionalStorageVolume](API_ModifyAdditionalStorageVolume.md) + [Option](API_Option.md) + [OptionConfiguration](API_OptionConfiguration.md) + [OptionGroup](API_OptionGroup.md) + [OptionGroupMembership](API_OptionGroupMembership.md) + [OptionGroupOption](API_OptionGroupOption.md) + [OptionGroupOptionSetting](API_OptionGroupOptionSetting.md) + [OptionSetting](API_OptionSetting.md) + [OptionVersion](API_OptionVersion.md) + [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md) + [Outpost](API_Outpost.md) + [Parameter](API_Parameter.md) + [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md) + [PendingMaintenanceAction](API_PendingMaintenanceAction.md) + [PendingModifiedValues](API_PendingModifiedValues.md) + [PerformanceInsightsMetricDimensionGroup](API_PerformanceInsightsMetricDimensionGroup.md) + [PerformanceInsightsMetricQuery](API_PerformanceInsightsMetricQuery.md) + [PerformanceIssueDetails](API_PerformanceIssueDetails.md) + [ProcessorFeature](API_ProcessorFeature.md) + [Range](API_Range.md) + [RdsCustomClusterConfiguration](API_RdsCustomClusterConfiguration.md) + [RecommendedAction](API_RecommendedAction.md) + [RecommendedActionParameter](API_RecommendedActionParameter.md) + [RecommendedActionUpdate](API_RecommendedActionUpdate.md) + [RecurringCharge](API_RecurringCharge.md) + [ReferenceDetails](API_ReferenceDetails.md) + [ReservedDBInstance](API_ReservedDBInstance.md) + [ReservedDBInstancesOffering](API_ReservedDBInstancesOffering.md) + [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) + [RestoreWindow](API_RestoreWindow.md) + [ScalarReferenceDetails](API_ScalarReferenceDetails.md) + [ScalingConfiguration](API_ScalingConfiguration.md) + [ScalingConfigurationInfo](API_ScalingConfigurationInfo.md) + [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md) + [ServerlessV2PlatformVersionInfo](API_ServerlessV2PlatformVersionInfo.md) + [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) + [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md) + [SourceRegion](API_SourceRegion.md) + [Subnet](API_Subnet.md) + [SupportedEngineLifecycle](API_SupportedEngineLifecycle.md) + [SwitchoverDetail](API_SwitchoverDetail.md) + [Tag](API_Tag.md) + [TagSpecification](API_TagSpecification.md) + [TargetHealth](API_TargetHealth.md) + [TenantDatabase](API_TenantDatabase.md) + [TenantDatabasePendingModifiedValues](API_TenantDatabasePendingModifiedValues.md) + [Timezone](API_Timezone.md) + [UpgradeTarget](API_UpgradeTarget.md) + [UserAuthConfig](API_UserAuthConfig.md) + [UserAuthConfigInfo](API_UserAuthConfigInfo.md) + [ValidAdditionalStorageOptions](API_ValidAdditionalStorageOptions.md) + [ValidDBInstanceModificationsMessage](API_ValidDBInstanceModificationsMessage.md) + [ValidStorageOptions](API_ValidStorageOptions.md) + [ValidVolumeOptions](API_ValidVolumeOptions.md) + [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) # AccountQuota Describes a quota for an AWS 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 AWS 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html) in the *Amazon RDS User Guide* and [Quotas for Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html) in the *Amazon Aurora User Guide*. ## Contents **Note** In the following list, the required parameters are described first. ** AccountQuotaName ** The name of the Amazon RDS quota for this AWS account. Type: String Required: No ** Max ** The maximum allowed value for the quota. Type: Long Required: No ** Used ** The amount currently used toward the quota maximum. Type: Long Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/AccountQuota) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/AccountQuota) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/AccountQuota) # AdditionalStorageVolume 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. ## Contents **Note** In the following list, the required parameters are described first. ** VolumeName ** The name of the additional storage volume. Valid Values: `RDSDBDATA2 | RDSDBDATA3 | RDSDBDATA4` Type: String Required: Yes ** AllocatedStorage ** The amount of storage allocated for the additional storage volume, in gibibytes (GiB). The minimum is 20 GiB. The maximum is 65,536 GiB (64 TiB). Type: Integer Required: No ** IOPS ** The number of I/O operations per second (IOPS) provisioned for the additional storage volume. Type: Integer Required: No ** MaxAllocatedStorage ** The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume. Type: Integer Required: No ** StorageThroughput ** The storage throughput value for the additional storage volume, in mebibytes per second (MiBps). This setting applies only to the General Purpose SSD (`gp3`) storage type. Type: Integer Required: No ** StorageType ** The storage type for the additional storage volume. Valid Values: `GP3 | IO2` Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/AdditionalStorageVolume) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/AdditionalStorageVolume) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/AdditionalStorageVolume) # AdditionalStorageVolumeOutput Contains information about an additional storage volume for a DB instance. ## Contents **Note** In the following list, the required parameters are described first. ** AllocatedStorage ** The amount of storage allocated for the additional storage volume, in gibibytes (GiB). The minimum is 20 GiB. The maximum is 65,536 GiB (64 TiB). Type: Integer Required: No ** IOPS ** The number of I/O operations per second (IOPS) provisioned for the additional storage volume. Type: Integer Required: No ** MaxAllocatedStorage ** The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume. Type: Integer Required: No ** StorageThroughput ** The storage throughput value for the additional storage volume, in mebibytes per second (MiBps). Type: Integer Required: No ** StorageType ** The storage type for the additional storage volume. Valid Values: `GP3 | IO2` Type: String Required: No ** StorageVolumeStatus ** The status of the additional storage volume. Valid Values: `ACTIVE | CREATING | DELETING | MODIFYING | NOT-IN-USE | STORAGE-OPTIMIZATION | VOLUME-FULL` Type: String Required: No ** VolumeName ** The name of the additional storage volume. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/AdditionalStorageVolumeOutput) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/AdditionalStorageVolumeOutput) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/AdditionalStorageVolumeOutput) # AvailabilityZone Contains Availability Zone information. This data type is used as an element in the `OrderableDBInstanceOption` data type. ## Contents **Note** In the following list, the required parameters are described first. ** Name ** The name of the Availability Zone. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/AvailabilityZone) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/AvailabilityZone) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/AvailabilityZone) # AvailableAdditionalStorageVolumesOption Contains the available options for additional storage volumes for a DB instance class. ## Contents **Note** In the following list, the required parameters are described first. ** MaxIops ** The maximum number of I/O operations per second (IOPS) that the additional storage volume supports. Type: Integer Required: No ** MaxIopsPerGib ** The maximum ratio of I/O operations per second (IOPS) to gibibytes (GiB) of storage for the additional storage volume. Type: Double Required: No ** MaxStorageSize ** The maximum amount of storage that you can allocate for the additional storage volume, in gibibytes (GiB). Type: Integer Required: No ** MaxStorageThroughput ** The maximum storage throughput that the additional storage volume supports, in mebibytes per second (MiBps). Type: Integer Required: No ** MinIops ** The minimum number of I/O operations per second (IOPS) that the additional storage volume supports. Type: Integer Required: No ** MinIopsPerGib ** The minimum ratio of I/O operations per second (IOPS) to gibibytes (GiB) of storage for the additional storage volume. Type: Double Required: No ** MinStorageSize ** The minimum amount of storage that you can allocate for the additional storage volume, in gibibytes (GiB). Type: Integer Required: No ** MinStorageThroughput ** The minimum storage throughput that the additional storage volume supports, in mebibytes per second (MiBps). Type: Integer Required: No ** StorageType ** The storage type for the additional storage volume. Valid Values: `GP3 | IO2` Type: String Required: No ** SupportsIops ** Indicates whether the additional storage volume supports provisioned IOPS. Type: Boolean Required: No ** SupportsStorageAutoscaling ** Indicates whether the additional storage volume supports storage autoscaling. Type: Boolean Required: No ** SupportsStorageThroughput ** Indicates whether the additional storage volume supports configurable storage throughput. Type: Boolean Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/AvailableAdditionalStorageVolumesOption) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/AvailableAdditionalStorageVolumesOption) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/AvailableAdditionalStorageVolumesOption) # AvailableProcessorFeature 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor) in the *Amazon RDS User Guide. * ## Contents **Note** In the following list, the required parameters are described first. ** AllowedValues ** The allowed values for the processor feature of the DB instance class. Type: String Required: No ** DefaultValue ** The default value for the processor feature of the DB instance class. Type: String Required: No ** Name ** The name of the processor feature. Valid names are `coreCount` and `threadsPerCore`. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/AvailableProcessorFeature) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/AvailableProcessorFeature) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/AvailableProcessorFeature) # BlueGreenDeployment Details about a blue/green deployment. For more information, see [Using Amazon RDS Blue/Green Deployments for database updates](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) in the *Amazon RDS User Guide* and [Using Amazon RDS Blue/Green Deployments for database updates](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) in the *Amazon Aurora User Guide*. ## Contents **Note** In the following list, the required parameters are described first. ** BlueGreenDeploymentIdentifier ** The unique identifier of the blue/green deployment. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[A-Za-z][0-9A-Za-z-:._]*` Required: No ** BlueGreenDeploymentName ** The user-supplied name of the blue/green deployment. Type: String Length Constraints: Minimum length of 1. Maximum length of 60. Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*` Required: No ** CreateTime ** The time when the blue/green deployment was created, in Universal Coordinated Time (UTC). Type: Timestamp Required: No ** DeleteTime ** The time when the blue/green deployment was deleted, in Universal Coordinated Time (UTC). Type: Timestamp Required: No ** Source ** The source database for the blue/green deployment. Before switchover, the source database is the production database in the blue environment. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:[A-Za-z][0-9A-Za-z-:._]*` Required: No ** Status ** The status of the blue/green deployment. Valid Values: + `PROVISIONING` - Resources are being created in the green environment. + `AVAILABLE` - Resources are available in the green environment. + `SWITCHOVER_IN_PROGRESS` - The deployment is being switched from the blue environment to the green environment. + `SWITCHOVER_COMPLETED` - Switchover from the blue environment to the green environment is complete. + `INVALID_CONFIGURATION` - Resources in the green environment are invalid, so switchover isn't possible. + `SWITCHOVER_FAILED` - Switchover was attempted but failed. + `DELETING` - The blue/green deployment is being deleted. Type: String Required: No ** StatusDetails ** Additional information about the status of the blue/green deployment. Type: String Required: No ** SwitchoverDetails.member.N ** The details about each source and target resource in the blue/green deployment. Type: Array of [SwitchoverDetail](API_SwitchoverDetail.md) objects Required: No ** TagList.Tag.N ** A list of tags. For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*. Type: Array of [Tag](API_Tag.md) objects Required: No ** Target ** The target database for the blue/green deployment. Before switchover, the target database is the clone database in the green environment. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:[A-Za-z][0-9A-Za-z-:._]*` Required: No ** Tasks.member.N ** Either tasks to be performed or tasks that have been completed on the target database before switchover. Type: Array of [BlueGreenDeploymentTask](API_BlueGreenDeploymentTask.md) objects Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/BlueGreenDeployment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/BlueGreenDeployment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/BlueGreenDeployment) # BlueGreenDeploymentTask Details about a task for a blue/green deployment. For more information, see [Using Amazon RDS Blue/Green Deployments for database updates](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) in the *Amazon RDS User Guide* and [Using Amazon RDS Blue/Green Deployments for database updates](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) in the *Amazon Aurora User Guide*. ## Contents **Note** In the following list, the required parameters are described first. ** Name ** The name of the blue/green deployment task. Type: String Required: No ** Status ** The status of the blue/green deployment task. Valid Values: + `PENDING` - The resource is being prepared for deployment. + `IN_PROGRESS` - The resource is being deployed. + `COMPLETED` - The resource has been deployed. + `FAILED` - Deployment of the resource failed. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/BlueGreenDeploymentTask) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/BlueGreenDeploymentTask) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/BlueGreenDeploymentTask) # Certificate A CA certificate for an AWS account. For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [ Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*. ## Contents **Note** In the following list, the required parameters are described first. ** CertificateArn ** The Amazon Resource Name (ARN) for the certificate. Type: String Required: No ** CertificateIdentifier ** The unique key that identifies a certificate. Type: String Required: No ** CertificateType ** The type of the certificate. Type: String Required: No ** CustomerOverride ** Indicates whether there is an override for the default certificate identifier. Type: Boolean Required: No ** CustomerOverrideValidTill ** If there is an override for the default certificate identifier, when the override expires. Type: Timestamp Required: No ** Thumbprint ** The thumbprint of the certificate. Type: String Required: No ** ValidFrom ** The starting date from which the certificate is valid. Type: Timestamp Required: No ** ValidTill ** The final date that the certificate continues to be valid. Type: Timestamp Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/Certificate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/Certificate) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/Certificate) # CertificateDetails The details of the DB instance’s server certificate. For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [ Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*. ## Contents **Note** In the following list, the required parameters are described first. ** CAIdentifier ** The CA identifier of the CA certificate used for the DB instance's server certificate. Type: String Required: No ** ValidTill ** The expiration date of the DB instance’s server certificate. Type: Timestamp Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CertificateDetails) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CertificateDetails) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CertificateDetails) # CharacterSet This data type is used as a response element in the action `DescribeDBEngineVersions`. ## Contents **Note** In the following list, the required parameters are described first. ** CharacterSetDescription ** The description of the character set. Type: String Required: No ** CharacterSetName ** The name of the character set. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CharacterSet) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CharacterSet) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CharacterSet) # CloudwatchLogsExportConfiguration 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 ](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) 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](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Aurora User Guide*. ## Contents **Note** In the following list, the required parameters are described first. ** DisableLogTypes.member.N ** The list of log types to disable. The following values are valid for each DB engine: + Aurora MySQL - `audit | error | general | slowquery` + Aurora PostgreSQL - `postgresql` + RDS for MySQL - `error | general | slowquery` + RDS for PostgreSQL - `postgresql | upgrade` Type: Array of strings Required: No ** EnableLogTypes.member.N ** The list of log types to enable. The following values are valid for each DB engine: + Aurora MySQL - `audit | error | general | slowquery` + Aurora PostgreSQL - `postgresql` + RDS for MySQL - `error | general | slowquery` + RDS for PostgreSQL - `postgresql | upgrade` Type: Array of strings Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CloudwatchLogsExportConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CloudwatchLogsExportConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CloudwatchLogsExportConfiguration) # ClusterPendingModifiedValues 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. ## Contents **Note** In the following list, the required parameters are described first. ** AllocatedStorage ** The allocated storage size in gibibytes (GiB) for all database engines except Amazon Aurora. For Aurora, `AllocatedStorage` always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed. Type: Integer Required: No ** BackupRetentionPeriod ** The number of days for which automatic DB snapshots are retained. Type: Integer Required: No ** CertificateDetails ** The details of the DB instance’s server certificate. For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [ Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*. Type: [CertificateDetails](API_CertificateDetails.md) object Required: No ** DBClusterIdentifier ** The DBClusterIdentifier value for the DB cluster. Type: String Required: No ** EngineVersion ** The database engine version. Type: String Required: No ** IAMDatabaseAuthenticationEnabled ** Indicates whether mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Type: Boolean Required: No ** Iops ** The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters. Type: Integer Required: No ** MasterUserPassword ** The master credentials for the DB cluster. Type: String Required: No ** PendingCloudwatchLogsExports ** 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. Type: [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md) object Required: No ** RdsCustomClusterConfiguration ** Reserved for future use. Type: [RdsCustomClusterConfiguration](API_RdsCustomClusterConfiguration.md) object Required: No ** StorageType ** The storage type for the DB cluster. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ClusterPendingModifiedValues) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ClusterPendingModifiedValues) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ClusterPendingModifiedValues) # ConnectionPoolConfiguration Specifies the settings that control the size and behavior of the connection pool associated with a `DBProxyTargetGroup`. ## Contents **Note** In the following list, the required parameters are described first. ** ConnectionBorrowTimeout ** The number of seconds for a proxy to wait for a connection to become available in the connection pool. This setting only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions. Default: `120` Constraints: + Must be between 0 and 300. Type: Integer Required: No ** InitQuery ** Add an initialization query, or modify the current one. You can specify one or more SQL statements for the proxy to run when opening each new database connection. The setting is typically used with `SET` statements to make sure that each connection has identical settings. Make sure the query added here is valid. This is an optional field, so you can choose to leave it empty. For including multiple variables in a single SET statement, use a comma separator. For example: `SET variable1=value1, variable2=value2` Default: no initialization query Since you can access initialization query as part of target group configuration, it is not protected by authentication or cryptographic methods. Anyone with access to view or manage your proxy target group configuration can view the initialization query. You should not add sensitive data, such as passwords or long-lived encryption keys, to this option. Type: String Required: No ** MaxConnectionsPercent ** The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the `max_connections` setting for the RDS DB instance or Aurora DB cluster used by the target group. If you specify `MaxIdleConnectionsPercent`, then you must also include a value for this parameter. Default: `10` for RDS for Microsoft SQL Server, and `100` for all other engines Constraints: + Must be between 1 and 100. Type: Integer Required: No ** MaxIdleConnectionsPercent ** A value that controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the `max_connections` setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database. If you specify this parameter, then you must also include a value for `MaxConnectionsPercent`. Default: The default value is half of the value of `MaxConnectionsPercent`. For example, if `MaxConnectionsPercent` is 80, then the default value of `MaxIdleConnectionsPercent` is 40. If the value of `MaxConnectionsPercent` isn't specified, then for SQL Server, `MaxIdleConnectionsPercent` is `5`, and for all other engines, the default is `50`. Constraints: + Must be between 0 and the value of `MaxConnectionsPercent`. Type: Integer Required: No ** SessionPinningFilters.member.N ** Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior. Default: no session pinning filters Type: Array of strings Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ConnectionPoolConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ConnectionPoolConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ConnectionPoolConfiguration) # ConnectionPoolConfigurationInfo Displays the settings that control the size and behavior of the connection pool associated with a `DBProxyTarget`. ## Contents **Note** In the following list, the required parameters are described first. ** ConnectionBorrowTimeout ** The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions. Type: Integer Required: No ** InitQuery ** One or more SQL statements for the proxy to run when opening each new database connection. The setting is typically used with `SET` statements to make sure that each connection has identical settings. The query added here must be valid. For including multiple variables in a single SET statement, use a comma separator. This is an optional field. For example: `SET variable1=value1, variable2=value2` Since you can access initialization query as part of target group configuration, it is not protected by authentication or cryptographic methods. Anyone with access to view or manage your proxy target group configuration can view the initialization query. You should not add sensitive data, such as passwords or long-lived encryption keys, to this option. Type: String Required: No ** MaxConnectionsPercent ** The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the `max_connections` setting for the RDS DB instance or Aurora DB cluster used by the target group. Type: Integer Required: No ** MaxIdleConnectionsPercent ** Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the `max_connections` setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database. Type: Integer Required: No ** SessionPinningFilters.member.N ** Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior. This setting is only supported for MySQL engine family databases. Currently, the only allowed value is `EXCLUDE_VARIABLE_SETS`. Type: Array of strings Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ConnectionPoolConfigurationInfo) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ConnectionPoolConfigurationInfo) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ConnectionPoolConfigurationInfo) # ContextAttribute The additional attributes of `RecommendedAction` data type. ## Contents **Note** In the following list, the required parameters are described first. ** Key ** The key of `ContextAttribute`. Type: String Required: No ** Value ** The value of `ContextAttribute`. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ContextAttribute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ContextAttribute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ContextAttribute) # CustomDBEngineVersionAMI A value that indicates the AMI information. ## Contents **Note** In the following list, the required parameters are described first. ** ImageId ** A value that indicates the ID of the AMI. Type: String Required: No ** Status ** A value that indicates the status of a custom engine version (CEV). Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CustomDBEngineVersionAMI) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CustomDBEngineVersionAMI) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CustomDBEngineVersionAMI) # DBCluster 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?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide.* For more information on Multi-AZ DB clusters, see [ Multi-AZ deployments with two readable standby DB instances](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide.* ## Contents **Note** In the following list, the required parameters are described first. ** ActivityStreamKinesisStreamName ** The name of the Amazon Kinesis data stream used for the database activity stream. Type: String Required: No ** ActivityStreamKmsKeyId ** The AWS KMS key identifier used for encrypting messages in the database activity stream. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. Type: String Required: No ** ActivityStreamMode ** The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously. Type: String Valid Values: `sync | async` Required: No ** ActivityStreamStatus ** The status of the database activity stream. Type: String Valid Values: `stopped | starting | started | stopping` Required: No ** AllocatedStorage ** `AllocatedStorage` specifies the allocated storage size in gibibytes (GiB). For Aurora, `AllocatedStorage` can vary because Aurora DB cluster storage size adjusts as needed. Type: Integer Required: No ** AssociatedRoles.DBClusterRole.N ** A list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf. Type: Array of [DBClusterRole](API_DBClusterRole.md) objects Required: No ** AutomaticRestartTime ** The time when a stopped DB cluster is restarted automatically. Type: Timestamp Required: No ** AutoMinorVersionUpgrade ** Indicates whether minor version patches are applied automatically. This setting is for Aurora DB clusters and Multi-AZ DB clusters. For more information about automatic minor version upgrades, see [Automatically upgrading the minor engine version](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades). Type: Boolean Required: No ** AvailabilityZones.AvailabilityZone.N ** The list of Availability Zones (AZs) where instances in the DB cluster can be created. Type: Array of strings Required: No ** AwsBackupRecoveryPointArn ** The Amazon Resource Name (ARN) of the recovery point in AWS Backup. Type: String Required: No ** BacktrackConsumedChangeRecords ** The number of change records stored for Backtrack. Type: Long Required: No ** BacktrackWindow ** The target backtrack window, in seconds. If this value is set to `0`, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled. Type: Long Required: No ** BackupRetentionPeriod ** The number of days for which automatic DB snapshots are retained. Type: Integer Required: No ** Capacity ** The current capacity of an Aurora Serverless v1 DB cluster. The capacity is `0` (zero) when the cluster is paused. For more information about Aurora Serverless v1, see [Using Amazon Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) in the *Amazon Aurora User Guide*. Type: Integer Required: No ** CertificateDetails ** The details of the DB instance’s server certificate. For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [ Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*. Type: [CertificateDetails](API_CertificateDetails.md) object Required: No ** CharacterSetName ** If present, specifies the name of the character set that this cluster is associated with. Type: String Required: No ** CloneGroupId ** The ID of the clone group with which the DB cluster is associated. For newly created clusters, the ID is typically null. If you clone a DB cluster when the ID is null, the operation populates the ID value for the source cluster and the clone because both clusters become part of the same clone group. Even if you delete the clone cluster, the clone group ID remains for the lifetime of the source cluster to show that it was used in a cloning operation. For PITR, the clone group ID is inherited from the source cluster. For snapshot restore operations, the clone group ID isn't inherited from the source cluster. Type: String Required: No ** ClusterCreateTime ** The time when the DB cluster was created, in Universal Coordinated Time (UTC). Type: Timestamp Required: No ** ClusterScalabilityType ** The scalability mode of the Aurora DB cluster. When set to `limitless`, the cluster operates as an Aurora Limitless Database. When set to `standard` (the default), the cluster uses normal DB instance creation. Type: String Valid Values: `standard | limitless` Required: No ** CopyTagsToSnapshot ** Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster. Type: Boolean Required: No ** CrossAccountClone ** Indicates whether the DB cluster is a clone of a DB cluster owned by a different AWS account. Type: Boolean Required: No ** CustomEndpoints.member.N ** The custom endpoints associated with the DB cluster. Type: Array of strings Required: No ** DatabaseInsightsMode ** The mode of Database Insights that is enabled for the DB cluster. Type: String Valid Values: `standard | advanced` Required: No ** DatabaseName ** The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster. Type: String Required: No ** DBClusterArn ** The Amazon Resource Name (ARN) for the DB cluster. Type: String Required: No ** DBClusterIdentifier ** The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster. Type: String Required: No ** DBClusterInstanceClass ** The name of the compute and memory capacity class of the DB instance. This setting is only for non-Aurora Multi-AZ DB clusters. Type: String Required: No ** DBClusterMembers.DBClusterMember.N ** The list of DB instances that make up the DB cluster. Type: Array of [DBClusterMember](API_DBClusterMember.md) objects Required: No ** DBClusterOptionGroupMemberships.DBClusterOptionGroup.N ** The list of option group memberships for this DB cluster. Type: Array of [DBClusterOptionGroupStatus](API_DBClusterOptionGroupStatus.md) objects Required: No ** DBClusterParameterGroup ** The name of the DB cluster parameter group for the DB cluster. Type: String Required: No ** DbClusterResourceId ** The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed. Type: String Required: No ** DBSubnetGroup ** Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group. Type: String Required: No ** DBSystemId ** Reserved for future use. Type: String Required: No ** DeletionProtection ** Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. Type: Boolean Required: No ** DomainMemberships.DomainMembership.N ** The Active Directory Domain membership records associated with the DB cluster. Type: Array of [DomainMembership](API_DomainMembership.md) objects Required: No ** EarliestBacktrackTime ** The earliest time to which a DB cluster can be backtracked. Type: Timestamp Required: No ** EarliestRestorableTime ** The earliest time to which a database can be restored with point-in-time restore. Type: Timestamp Required: No ** EnabledCloudwatchLogsExports.member.N ** A list of log types that this DB cluster is configured to export to CloudWatch Logs. Log types vary by DB engine. For information about the log types for each DB engine, see [Amazon RDS Database Log Files](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html) in the *Amazon Aurora User Guide.* Type: Array of strings Required: No ** Endpoint ** The connection endpoint for the primary instance of the DB cluster. Type: String Required: No ** Engine ** The database engine used for this DB cluster. Type: String Required: No ** EngineLifecycleSupport ** The lifecycle type for the DB cluster. For more information, see CreateDBCluster. Type: String Required: No ** EngineMode ** The DB engine mode of the DB cluster, either `provisioned` or `serverless`. For more information, see [ CreateDBCluster](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html). Type: String Required: No ** EngineVersion ** The version of the database engine. Type: String Required: No ** GlobalClusterIdentifier ** Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[A-Za-z][0-9A-Za-z-:._]*` Required: No ** GlobalWriteForwardingRequested ** Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of `GlobalWriteForwardingStatus` to confirm that the request has completed before using the write forwarding feature for this cluster. Type: Boolean Required: No ** GlobalWriteForwardingStatus ** The status of write forwarding for a secondary cluster in an Aurora global database. Type: String Valid Values: `enabled | disabled | enabling | disabling | unknown` Required: No ** HostedZoneId ** The ID that Amazon Route 53 assigns when you create a hosted zone. Type: String Required: No ** HttpEndpointEnabled ** Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster. When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor. For more information, see [Using RDS Data API](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the *Amazon Aurora User Guide*. Type: Boolean Required: No ** IAMDatabaseAuthenticationEnabled ** Indicates whether the mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Type: Boolean Required: No ** InternetAccessGatewayEnabled ** Indicates whether the DB cluster has internet-based connectivity enabled through an internet access gateway. This setting is applicable only for Aurora PostgreSQL clusters created through express configuration. Type: Boolean Required: No ** IOOptimizedNextAllowedModificationTime ** The next time you can modify the DB cluster to use the `aurora-iopt1` storage type. This setting is only for Aurora DB clusters. Type: Timestamp Required: No ** Iops ** The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters. Type: Integer Required: No ** KmsKeyId ** If `StorageEncrypted` is enabled, the AWS KMS key identifier for the encrypted DB cluster. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. Type: String Required: No ** LatestRestorableTime ** The latest time to which a database can be restored with point-in-time restore. Type: Timestamp Required: No ** LimitlessDatabase ** The details for Aurora Limitless Database. Type: [LimitlessDatabase](API_LimitlessDatabase.md) object Required: No ** LocalWriteForwardingStatus ** Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it. Type: String Valid Values: `enabled | disabled | enabling | disabling | requested` Required: No ** MasterUsername ** The master username for the DB cluster. Type: String Required: No ** MasterUserSecret ** The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.* Type: [MasterUserSecret](API_MasterUserSecret.md) object Required: No ** MonitoringInterval ** The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. This setting is only for -Aurora DB clusters and Multi-AZ DB clusters. Type: Integer Required: No ** MonitoringRoleArn ** The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. Type: String Required: No ** MultiAZ ** Indicates whether the DB cluster has instances in multiple Availability Zones. Type: Boolean Required: No ** NetworkType ** The network type of the DB instance. The network type is determined by the `DBSubnetGroup` specified for the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (`DUAL`). For more information, see [ Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon Aurora User Guide.* This setting is only for Aurora DB clusters. Valid Values: `IPV4 | DUAL` Type: String Required: No ** PendingModifiedValues ** Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements. Type: [ClusterPendingModifiedValues](API_ClusterPendingModifiedValues.md) object Required: No ** PercentProgress ** The progress of the operation as a percentage. Type: String Required: No ** PerformanceInsightsEnabled ** Indicates whether Performance Insights is enabled for the DB cluster. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. Type: Boolean Required: No ** PerformanceInsightsKMSKeyId ** The AWS KMS key identifier for encryption of Performance Insights data. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. Type: String Required: No ** PerformanceInsightsRetentionPeriod ** The number of days to retain Performance Insights data. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. Valid Values: + `7` + *month* \$1 31, where *month* is a number of months from 1-23. Examples: `93` (3 months \$1 31), `341` (11 months \$1 31), `589` (19 months \$1 31) + `731` Default: `7` days Type: Integer Required: No ** Port ** The port that the database engine is listening on. Type: Integer Required: No ** PreferredBackupWindow ** The daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod`. Type: String Required: No ** PreferredMaintenanceWindow ** The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Type: String Required: No ** PubliclyAccessible ** Indicates whether the DB cluster is publicly accessible. When the DB cluster is publicly accessible and you connect from outside of the DB cluster'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 cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address. For more information, see [CreateDBCluster](API_CreateDBCluster.md). This setting is only for non-Aurora Multi-AZ DB clusters. Type: Boolean Required: No ** RdsCustomClusterConfiguration ** Reserved for future use. Type: [RdsCustomClusterConfiguration](API_RdsCustomClusterConfiguration.md) object Required: No ** ReaderEndpoint ** The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster. If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint. Type: String Required: No ** ReadReplicaIdentifiers.ReadReplicaIdentifier.N ** Contains one or more identifiers of the read replicas associated with this DB cluster. Type: Array of strings Required: No ** ReplicationSourceIdentifier ** The identifier of the source DB cluster if this DB cluster is a read replica. Type: String Required: No ** ScalingConfigurationInfo ** The scaling configuration for an Aurora DB cluster in `serverless` DB engine mode. For more information, see [Using Amazon Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) in the *Amazon Aurora User Guide*. Type: [ScalingConfigurationInfo](API_ScalingConfigurationInfo.md) object Required: No ** ServerlessV2PlatformVersion ** The version of the Aurora Serverless V2 platform used by the DB cluster. For more information, see [Using Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) in the *Amazon Aurora User Guide*. Type: String Required: No ** ServerlessV2ScalingConfiguration ** The scaling configuration for an Aurora Serverless v2 DB cluster. For more information, see [Using Amazon Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) in the *Amazon Aurora User Guide*. Type: [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md) object Required: No ** Status ** The current state of this DB cluster. Type: String Required: No ** StatusInfos.DBClusterStatusInfo.N ** Reserved for future use. Type: Array of [DBClusterStatusInfo](API_DBClusterStatusInfo.md) objects Required: No ** StorageEncrypted ** Indicates whether the DB cluster is encrypted. Type: Boolean Required: No ** StorageEncryptionType ** The type of encryption used to protect data at rest in the DB cluster. Possible values: + `none` - The DB cluster is not encrypted. + `sse-rds` - The DB cluster is encrypted using an AWS owned KMS key. + `sse-kms` - The DB cluster is encrypted using a customer managed KMS key or AWS managed KMS key. Type: String Valid Values: `none | sse-kms | sse-rds` Required: No ** StorageThroughput ** The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable. This setting is only for non-Aurora Multi-AZ DB clusters. Type: Integer Required: No ** StorageType ** The storage type associated with the DB cluster. Type: String Required: No ** TagList.Tag.N ** A list of tags. For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*. Type: Array of [Tag](API_Tag.md) objects Required: No ** UpgradeRolloutOrder ** This data type represents the order in which the clusters are upgraded. + [first] - Typically used for development or testing environments. + [second] - Default order for resources not specifically configured. + [last] - Usually reserved for production environments. Type: String Valid Values: `first | second | last` Required: No ** VPCNetworkingEnabled ** Indicates whether the DB cluster uses VPC-based networking. This setting is applicable only for Aurora PostgreSQL clusters created through express configuration. Type: Boolean Required: No ** VpcSecurityGroups.VpcSecurityGroupMembership.N ** The list of VPC security groups that the DB cluster belongs to. Type: Array of [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) objects Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBCluster) # DBClusterAutomatedBackup 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. ## Contents **Note** In the following list, the required parameters are described first. ** AllocatedStorage ** For all database engines except Amazon Aurora, `AllocatedStorage` specifies the allocated storage size in gibibytes (GiB). For Aurora, `AllocatedStorage` always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed. Type: Integer Required: No ** AvailabilityZones.AvailabilityZone.N ** The Availability Zones where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html). Type: Array of strings Required: No ** AwsBackupRecoveryPointArn ** The Amazon Resource Name (ARN) of the recovery point in AWS Backup. Type: String Required: No ** BackupRetentionPeriod ** The retention period for the automated backups. Type: Integer Required: No ** ClusterCreateTime ** The time when the DB cluster was created, in Universal Coordinated Time (UTC). Type: Timestamp Required: No ** DBClusterArn ** The Amazon Resource Name (ARN) for the source DB cluster. Type: String Required: No ** DBClusterAutomatedBackupsArn ** The Amazon Resource Name (ARN) for the automated backups. Type: String Required: No ** DBClusterIdentifier ** The identifier for the source DB cluster, which can't be changed and which is unique to an AWS Region. Type: String Required: No ** DbClusterResourceId ** The resource ID for the source DB cluster, which can't be changed and which is unique to an AWS Region. Type: String Required: No ** Engine ** The name of the database engine for this automated backup. Type: String Required: No ** EngineMode ** The engine mode of the database engine for the automated backup. Type: String Required: No ** EngineVersion ** The version of the database engine for the automated backup. Type: String Required: No ** IAMDatabaseAuthenticationEnabled ** Indicates whether mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Type: Boolean Required: No ** Iops ** The IOPS (I/O operations per second) value for the automated backup. This setting is only for non-Aurora Multi-AZ DB clusters. Type: Integer Required: No ** KmsKeyId ** The AWS KMS key ID for an automated backup. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. Type: String Required: No ** LicenseModel ** The license model information for this DB cluster automated backup. Type: String Required: No ** MasterUsername ** The master user name of the automated backup. Type: String Required: No ** Port ** The port number that the automated backup used for connections. Default: Inherits from the source DB cluster Valid Values: `1150-65535` Type: Integer Required: No ** PreferredBackupWindow ** The daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod`. Type: String Required: No ** Region ** The AWS Region associated with the automated backup. Type: String Required: No ** RestoreWindow ** Earliest and latest time an instance can be restored to: Type: [RestoreWindow](API_RestoreWindow.md) object Required: No ** Status ** A list of status information for an automated backup: + `retained` - Automated backups for deleted clusters. Type: String Required: No ** StorageEncrypted ** Indicates whether the source DB cluster is encrypted. Type: Boolean Required: No ** StorageEncryptionType ** The type of encryption used to protect data at rest in the automated backup. Possible values: + `none` - The automated backup is not encrypted. + `sse-rds` - The automated backup is encrypted using an AWS owned KMS key. + `sse-kms` - The automated backup is encrypted using a customer managed KMS key or AWS managed KMS key. Type: String Valid Values: `none | sse-kms | sse-rds` Required: No ** StorageThroughput ** The storage throughput for the automated backup. The throughput is automatically set based on the IOPS that you provision, and is not configurable. This setting is only for non-Aurora Multi-AZ DB clusters. Type: Integer Required: No ** StorageType ** The storage type associated with the DB cluster. This setting is only for non-Aurora Multi-AZ DB clusters. Type: String Required: No ** TagList.Tag.N ** A list of tags. For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*. Type: Array of [Tag](API_Tag.md) objects Required: No ** VpcId ** The VPC ID associated with the DB cluster. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBClusterAutomatedBackup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBClusterAutomatedBackup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBClusterAutomatedBackup) # DBClusterBacktrack This data type is used as a response element in the `DescribeDBClusterBacktracks` action. ## Contents **Note** In the following list, the required parameters are described first. ** BacktrackedFrom ** The timestamp of the time from which the DB cluster was backtracked. Type: Timestamp Required: No ** BacktrackIdentifier ** Contains the backtrack identifier. Type: String Required: No ** BacktrackRequestCreationTime ** The timestamp of the time at which the backtrack was requested. Type: Timestamp Required: No ** BacktrackTo ** The timestamp of the time to which the DB cluster was backtracked. Type: Timestamp Required: No ** DBClusterIdentifier ** Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster. Type: String Required: No ** Status ** The status of the backtrack. This property returns one of the following values: + `applying` - The backtrack is currently being applied to or rolled back from the DB cluster. + `completed` - The backtrack has successfully been applied to or rolled back from the DB cluster. + `failed` - An error occurred while the backtrack was applied to or rolled back from the DB cluster. + `pending` - The backtrack is currently pending application to or rollback from the DB cluster. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBClusterBacktrack) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBClusterBacktrack) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBClusterBacktrack) # DBClusterEndpoint 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`. ## Contents **Note** In the following list, the required parameters are described first. ** CustomEndpointType ** The type associated with a custom endpoint. One of: `READER`, `WRITER`, `ANY`. Type: String Required: No ** DBClusterEndpointArn ** The Amazon Resource Name (ARN) for the endpoint. Type: String Required: No ** DBClusterEndpointIdentifier ** The identifier associated with the endpoint. This parameter is stored as a lowercase string. Type: String Required: No ** DBClusterEndpointResourceIdentifier ** A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint. Type: String Required: No ** DBClusterIdentifier ** The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string. Type: String Required: No ** Endpoint ** The DNS address of the endpoint. Type: String Required: No ** EndpointType ** The type of the endpoint. One of: `READER`, `WRITER`, `CUSTOM`. Type: String Required: No ** ExcludedMembers.member.N ** 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. Type: Array of strings Required: No ** StaticMembers.member.N ** List of DB instance identifiers that are part of the custom endpoint group. Type: Array of strings Required: No ** Status ** The current status of the endpoint. One of: `creating`, `available`, `deleting`, `inactive`, `modifying`. The `inactive` state applies to an endpoint that can't be used for a certain kind of cluster, such as a `writer` endpoint for a read-only secondary cluster in a global database. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBClusterEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBClusterEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBClusterEndpoint) # DBClusterMember Contains information about an instance that is part of a DB cluster. ## Contents **Note** In the following list, the required parameters are described first. ** DBClusterParameterGroupStatus ** Specifies the status of the DB cluster parameter group for this member of the DB cluster. Type: String Required: No ** DBInstanceIdentifier ** Specifies the instance identifier for this member of the DB cluster. Type: String Required: No ** IsClusterWriter ** Indicates whether the cluster member is the primary DB instance for the DB cluster. Type: Boolean Required: No ** PromotionTier ** A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see [ Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*. Type: Integer Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBClusterMember) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBClusterMember) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBClusterMember) # DBClusterOptionGroupStatus Contains status information for a DB cluster option group. ## Contents **Note** In the following list, the required parameters are described first. ** DBClusterOptionGroupName ** Specifies the name of the DB cluster option group. Type: String Required: No ** Status ** Specifies the status of the DB cluster option group. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBClusterOptionGroupStatus) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBClusterOptionGroupStatus) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBClusterOptionGroupStatus) # DBClusterParameterGroup Contains the details of an Amazon RDS DB cluster parameter group. This data type is used as a response element in the `DescribeDBClusterParameterGroups` action. ## Contents **Note** In the following list, the required parameters are described first. ** DBClusterParameterGroupArn ** The Amazon Resource Name (ARN) for the DB cluster parameter group. Type: String Required: No ** DBClusterParameterGroupName ** The name of the DB cluster parameter group. Type: String Required: No ** DBParameterGroupFamily ** The name of the DB parameter group family that this DB cluster parameter group is compatible with. Type: String Required: No ** Description ** Provides the customer-specified description for this DB cluster parameter group. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBClusterParameterGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBClusterParameterGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBClusterParameterGroup) # DBClusterRole Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster. ## Contents **Note** In the following list, the required parameters are described first. ** FeatureName ** The name of the feature associated with the AWS Identity and Access Management (IAM) role. For information about supported feature names, see [DBEngineVersion](API_DBEngineVersion.md). Type: String Required: No ** RoleArn ** The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster. Type: String Required: No ** Status ** Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values: + `ACTIVE` - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf. + `PENDING` - the IAM role ARN is being associated with the DB cluster. + `INVALID` - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBClusterRole) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBClusterRole) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBClusterRole) # DBClusterSnapshot Contains the details for an Amazon RDS DB cluster snapshot This data type is used as a response element in the `DescribeDBClusterSnapshots` action. ## Contents **Note** In the following list, the required parameters are described first. ** AllocatedStorage ** The allocated storage size of the DB cluster snapshot in gibibytes (GiB). Type: Integer Required: No ** AvailabilityZones.AvailabilityZone.N ** The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored. Type: Array of strings Required: No ** BackupRetentionPeriod ** The number of days for which automatic DB snapshots are retained. Type: Integer Required: No ** ClusterCreateTime ** The time when the DB cluster was created, in Universal Coordinated Time (UTC). Type: Timestamp Required: No ** DBClusterIdentifier ** The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from. Type: String Required: No ** DbClusterResourceId ** The resource ID of the DB cluster that this DB cluster snapshot was created from. Type: String Required: No ** DBClusterSnapshotArn ** The Amazon Resource Name (ARN) for the DB cluster snapshot. Type: String Required: No ** DBClusterSnapshotIdentifier ** The identifier for the DB cluster snapshot. Type: String Required: No ** DBSystemId ** Reserved for future use. Type: String Required: No ** Engine ** The name of the database engine for this DB cluster snapshot. Type: String Required: No ** EngineMode ** The engine mode of the database engine for this DB cluster snapshot. Type: String Required: No ** EngineVersion ** The version of the database engine for this DB cluster snapshot. Type: String Required: No ** IAMDatabaseAuthenticationEnabled ** Indicates whether mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Type: Boolean Required: No ** KmsKeyId ** If `StorageEncrypted` is true, the AWS KMS key identifier for the encrypted DB cluster snapshot. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. Type: String Required: No ** LicenseModel ** The license model information for this DB cluster snapshot. Type: String Required: No ** MasterUsername ** The master username for this DB cluster snapshot. Type: String Required: No ** PercentProgress ** The percentage of the estimated data that has been transferred. Type: Integer Required: No ** Port ** The port that the DB cluster was listening on at the time of the snapshot. Type: Integer Required: No ** PreferredBackupWindow ** The daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod`. Type: String Required: No ** SnapshotCreateTime ** The time when the snapshot was taken, in Universal Coordinated Time (UTC). Type: Timestamp Required: No ** SnapshotType ** The type of the DB cluster snapshot. Type: String Required: No ** SourceDBClusterSnapshotArn ** 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. Type: String Required: No ** Status ** The status of this DB cluster snapshot. Valid statuses are the following: + `available` + `copying` + `creating` Type: String Required: No ** StorageEncrypted ** Indicates whether the DB cluster snapshot is encrypted. Type: Boolean Required: No ** StorageEncryptionType ** The type of encryption used to protect data at rest in the DB cluster snapshot. Possible values: + `none` - The DB cluster snapshot is not encrypted. + `sse-rds` - The DB cluster snapshot is encrypted using an AWS owned KMS key. + `sse-kms` - The DB cluster snapshot is encrypted using a customer managed KMS key or AWS managed KMS key. Type: String Valid Values: `none | sse-kms | sse-rds` Required: No ** StorageThroughput ** The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable. This setting is only for non-Aurora Multi-AZ DB clusters. Type: Integer Required: No ** StorageType ** The storage type associated with the DB cluster snapshot. This setting is only for Aurora DB clusters. Type: String Required: No ** TagList.Tag.N ** A list of tags. For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*. Type: Array of [Tag](API_Tag.md) objects Required: No ** VpcId ** The VPC ID associated with the DB cluster snapshot. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBClusterSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBClusterSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBClusterSnapshot) # DBClusterSnapshotAttribute Contains the name and values of a manual DB cluster snapshot attribute. Manual DB cluster snapshot attributes are used to authorize other AWS accounts to restore a manual DB cluster snapshot. For more information, see the `ModifyDBClusterSnapshotAttribute` API action. ## Contents **Note** In the following list, the required parameters are described first. ** AttributeName ** The name of the manual DB cluster snapshot attribute. The attribute named `restore` refers to the list of AWS accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the `ModifyDBClusterSnapshotAttribute` API action. Type: String Required: No ** AttributeValues.AttributeValue.N ** 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 AWS 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 AWS account to copy or restore. Type: Array of strings Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBClusterSnapshotAttribute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBClusterSnapshotAttribute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBClusterSnapshotAttribute) # DBClusterSnapshotAttributesResult Contains the results of a successful call to the `DescribeDBClusterSnapshotAttributes` API action. Manual DB cluster snapshot attributes are used to authorize other AWS accounts to copy or restore a manual DB cluster snapshot. For more information, see the `ModifyDBClusterSnapshotAttribute` API action. ## Contents **Note** In the following list, the required parameters are described first. ** DBClusterSnapshotAttributes.DBClusterSnapshotAttribute.N ** The list of attributes and values for the manual DB cluster snapshot. Type: Array of [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md) objects Required: No ** DBClusterSnapshotIdentifier ** The identifier of the manual DB cluster snapshot that the attributes apply to. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBClusterSnapshotAttributesResult) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBClusterSnapshotAttributesResult) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBClusterSnapshotAttributesResult) # DBClusterStatusInfo Reserved for future use. ## Contents **Note** In the following list, the required parameters are described first. ** Message ** Reserved for future use. Type: String Required: No ** Normal ** Reserved for future use. Type: Boolean Required: No ** Status ** Reserved for future use. Type: String Required: No ** StatusType ** Reserved for future use. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBClusterStatusInfo) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBClusterStatusInfo) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBClusterStatusInfo) # DBEngineVersion This data type is used as a response element in the action `DescribeDBEngineVersions`. ## Contents **Note** In the following list, the required parameters are described first. ** CreateTime ** The creation time of the DB engine version. Type: Timestamp Required: No ** CustomDBEngineVersionManifest ** JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see [JSON fields in the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.preparing.html#custom-cev.preparing.manifest.fields) in the *Amazon RDS User Guide*. Type: String Length Constraints: Minimum length of 1. Maximum length of 51000. Pattern: `[\s\S]*` Required: No ** DatabaseInstallationFiles.member.N ** The database installation files (ISO and EXE) uploaded to Amazon S3 for your database engine version to import to Amazon RDS. Required for `sqlserver-dev-ee`. Type: Array of strings Required: No ** DatabaseInstallationFilesS3BucketName ** The name of the Amazon S3 bucket that contains your database installation files. Type: String Required: No ** DatabaseInstallationFilesS3Prefix ** The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed. Type: String Required: No ** DBEngineDescription ** The description of the database engine. Type: String Required: No ** DBEngineMediaType ** A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server. Type: String Required: No ** DBEngineVersionArn ** The ARN of the custom engine version. Type: String Required: No ** DBEngineVersionDescription ** The description of the database engine version. Type: String Required: No ** DBParameterGroupFamily ** The name of the DB parameter group family for the database engine. Type: String Required: No ** DefaultCharacterSet ** The default character set for new instances of this engine version, if the `CharacterSetName` parameter of the CreateDBInstance API isn't specified. Type: [CharacterSet](API_CharacterSet.md) object Required: No ** Engine ** The name of the database engine. Type: String Required: No ** EngineVersion ** The version number of the database engine. Type: String Required: No ** ExportableLogTypes.member.N ** The types of logs that the database engine has available for export to CloudWatch Logs. Type: Array of strings Required: No ** FailureReason ** The reason that the custom engine version creation for `sqlserver-dev-ee` failed with an `incompatible-installation-media` status. Type: String Required: No ** Image ** The EC2 image Type: [CustomDBEngineVersionAMI](API_CustomDBEngineVersionAMI.md) object Required: No ** KMSKeyId ** The AWS KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS. Type: String Required: No ** MajorEngineVersion ** The major engine version of the CEV. Type: String Required: No ** ServerlessV2FeaturesSupport ** Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine 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. Type: [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md) object Required: No ** Status ** The status of the DB engine version, either `available` or `deprecated`. Type: String Required: No ** SupportedCACertificateIdentifiers.member.N ** A list of the supported CA certificate identifiers. For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [ Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*. Type: Array of strings Required: No ** SupportedCharacterSets.CharacterSet.N ** A list of the character sets supported by this engine for the `CharacterSetName` parameter of the `CreateDBInstance` operation. Type: Array of [CharacterSet](API_CharacterSet.md) objects Required: No ** SupportedEngineModes.member.N ** A list of the supported DB engine modes. Type: Array of strings Required: No ** SupportedFeatureNames.member.N ** A list of features supported by the DB engine. The supported features vary by DB engine and DB engine version. To determine the supported features for a specific DB engine and DB engine version using the AWS CLI, use the following command: `aws rds describe-db-engine-versions --engine --engine-version ` For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the AWS CLI, use the following command: `aws rds describe-db-engine-versions --engine postgres --engine-version 13.3` The supported features are listed under `SupportedFeatureNames` in the output. Type: Array of strings Required: No ** SupportedNcharCharacterSets.CharacterSet.N ** A list of the character sets supported by the Oracle DB engine for the `NcharCharacterSetName` parameter of the `CreateDBInstance` operation. Type: Array of [CharacterSet](API_CharacterSet.md) objects Required: No ** SupportedTimezones.Timezone.N ** A list of the time zones supported by this engine for the `Timezone` parameter of the `CreateDBInstance` action. Type: Array of [Timezone](API_Timezone.md) objects Required: No ** SupportsBabelfish ** Indicates whether the engine version supports Babelfish for Aurora PostgreSQL. Type: Boolean Required: No ** SupportsCertificateRotationWithoutRestart ** Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance. Type: Boolean Required: No ** SupportsGlobalDatabases ** Indicates whether you can use Aurora global databases with a specific DB engine version. Type: Boolean Required: No ** SupportsIntegrations ** Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift. Type: Boolean Required: No ** SupportsLimitlessDatabase ** Indicates whether the DB engine version supports Aurora Limitless Database. Type: Boolean Required: No ** SupportsLocalWriteForwarding ** Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances. Valid for: Aurora DB clusters only Type: Boolean Required: No ** SupportsLogExportsToCloudwatchLogs ** Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs. Type: Boolean Required: No ** SupportsParallelQuery ** Indicates whether you can use Aurora parallel query with a specific DB engine version. Type: Boolean Required: No ** SupportsReadReplica ** Indicates whether the database engine version supports read replicas. Type: Boolean Required: No ** TagList.Tag.N ** A list of tags. For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*. Type: Array of [Tag](API_Tag.md) objects Required: No ** ValidUpgradeTarget.UpgradeTarget.N ** A list of engine versions that this database engine version can be upgraded to. Type: Array of [UpgradeTarget](API_UpgradeTarget.md) objects Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBEngineVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBEngineVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBEngineVersion) # DBInstance 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`. ## Contents **Note** In the following list, the required parameters are described first. ** ActivityStreamEngineNativeAuditFieldsIncluded ** Indicates whether engine-native audit fields are included in the database activity stream. Type: Boolean Required: No ** ActivityStreamKinesisStreamName ** The name of the Amazon Kinesis data stream used for the database activity stream. Type: String Required: No ** ActivityStreamKmsKeyId ** The AWS KMS key identifier used for encrypting messages in the database activity stream. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. Type: String Required: No ** ActivityStreamMode ** The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously. Type: String Valid Values: `sync | async` Required: No ** ActivityStreamPolicyStatus ** The status of the policy state of the activity stream. Type: String Valid Values: `locked | unlocked | locking-policy | unlocking-policy` Required: No ** ActivityStreamStatus ** The status of the database activity stream. Type: String Valid Values: `stopped | starting | started | stopping` Required: No ** AdditionalStorageVolumes.member.N ** The additional storage volumes associated with the DB instance. RDS supports additional storage volumes for RDS for Oracle and RDS for SQL Server. Type: Array of [AdditionalStorageVolumeOutput](API_AdditionalStorageVolumeOutput.md) objects Required: No ** AllocatedStorage ** The amount of storage in gibibytes (GiB) allocated for the DB instance. Type: Integer Required: No ** AssociatedRoles.DBInstanceRole.N ** The AWS Identity and Access Management (IAM) roles associated with the DB instance. Type: Array of [DBInstanceRole](API_DBInstanceRole.md) objects Required: No ** AutomaticRestartTime ** The time when a stopped DB instance is restarted automatically. Type: Timestamp Required: No ** AutomationMode ** The automation mode of the RDS Custom DB instance: `full` or `all paused`. If `full`, the DB instance automates monitoring and instance recovery. If `all paused`, the instance pauses automation for the duration set by `--resume-full-automation-mode-minutes`. Type: String Valid Values: `full | all-paused` Required: No ** AutoMinorVersionUpgrade ** Indicates whether minor version patches are applied automatically. For more information about automatic minor version upgrades, see [Automatically upgrading the minor engine version](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades). Type: Boolean Required: No ** AvailabilityZone ** The name of the Availability Zone where the DB instance is located. Type: String Required: No ** AwsBackupRecoveryPointArn ** The Amazon Resource Name (ARN) of the recovery point in AWS Backup. Type: String Required: No ** BackupRetentionPeriod ** The number of days for which automatic DB snapshots are retained. Type: Integer Required: No ** BackupTarget ** The location where automated backups and manual snapshots are stored: Dedicated Local Zones, AWS Outposts or the AWS Region. Type: String Required: No ** CACertificateIdentifier ** The identifier of the CA certificate for this DB instance. For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [ Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*. Type: String Required: No ** CertificateDetails ** The details of the DB instance's server certificate. Type: [CertificateDetails](API_CertificateDetails.md) object Required: No ** CharacterSetName ** If present, specifies the name of the character set that this instance is associated with. Type: String Required: No ** CopyTagsToSnapshot ** Indicates whether tags are copied from the DB instance to snapshots of the DB instance. This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see `DBCluster`. Type: Boolean Required: No ** CustomerOwnedIpEnabled ** Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance. A *CoIP *provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network. For more information about RDS on Outposts, see [Working with Amazon RDS on AWS Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in the *Amazon RDS User Guide*. For more information about CoIPs, see [Customer-owned IP addresses](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing) in the * AWS Outposts User Guide*. Type: Boolean Required: No ** CustomIamInstanceProfile ** The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements: + The profile must exist in your account. + The profile must have an IAM role that Amazon EC2 has permissions to assume. + The instance profile name and the associated IAM role name must start with the prefix `AWSRDSCustom`. For the list of permissions required for the IAM role, see [ Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*. Type: String Required: No ** DatabaseInsightsMode ** The mode of Database Insights that is enabled for the instance. Type: String Valid Values: `standard | advanced` Required: No ** DBClusterIdentifier ** If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of. Type: String Required: No ** DBInstanceArn ** The Amazon Resource Name (ARN) for the DB instance. Type: String Required: No ** DBInstanceAutomatedBackupsReplications.DBInstanceAutomatedBackupsReplication.N ** The list of replicated automated backups associated with the DB instance. Type: Array of [DBInstanceAutomatedBackupsReplication](API_DBInstanceAutomatedBackupsReplication.md) objects Required: No ** DBInstanceClass ** The name of the compute and memory capacity class of the DB instance. Type: String Required: No ** DBInstanceIdentifier ** The user-supplied database identifier. This identifier is the unique key that identifies a DB instance. Type: String Required: No ** DbInstancePort ** 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. Type: Integer Required: No ** DBInstanceStatus ** The current state of this database. For information about DB instance statuses, see [Viewing DB instance status](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/accessing-monitoring.html#Overview.DBInstance.Status) in the *Amazon RDS User Guide.* Type: String Required: No ** DbiResourceId ** The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed. Type: String Required: No ** DBName ** The initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB. Type: String Required: No ** DBParameterGroups.DBParameterGroup.N ** The list of DB parameter groups applied to this DB instance. Type: Array of [DBParameterGroupStatus](API_DBParameterGroupStatus.md) objects Required: No ** DBSecurityGroups.DBSecurityGroup.N ** A list of DB security group elements containing `DBSecurityGroup.Name` and `DBSecurityGroup.Status` subelements. Type: Array of [DBSecurityGroupMembership](API_DBSecurityGroupMembership.md) objects Required: No ** DBSubnetGroup ** Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group. Type: [DBSubnetGroup](API_DBSubnetGroup.md) object Required: No ** DBSystemId ** The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is only valid for RDS Custom DB instances. Type: String Required: No ** DedicatedLogVolume ** Indicates whether the DB instance has a dedicated log volume (DLV) enabled. Type: Boolean Required: No ** DeletionProtection ** Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see [ Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). Type: Boolean Required: No ** DomainMemberships.DomainMembership.N ** The Active Directory Domain membership records associated with the DB instance. Type: Array of [DomainMembership](API_DomainMembership.md) objects Required: No ** EnabledCloudwatchLogsExports.member.N ** A list of log types that this DB instance is configured to export to CloudWatch Logs. Log types vary by DB engine. For information about the log types for each DB engine, see [Monitoring Amazon RDS log files](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html) in the *Amazon RDS User Guide.* Type: Array of strings Required: No ** Endpoint ** The connection endpoint for the DB instance. The endpoint might not be shown for instances with the status of `creating`. Type: [Endpoint](API_Endpoint.md) object Required: No ** Engine ** The database engine used for this DB instance. Type: String Required: No ** EngineLifecycleSupport ** The lifecycle type for the DB instance. For more information, see CreateDBInstance. Type: String Required: No ** EngineVersion ** The version of the database engine. Type: String Required: No ** EnhancedMonitoringResourceArn ** The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance. Type: String Required: No ** IAMDatabaseAuthenticationEnabled ** Indicates whether mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance. For a list of engine versions that support IAM database authentication, see [IAM database authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RDS_Fea_Regions_DB-eng.Feature.IamDatabaseAuthentication.html) in the *Amazon RDS User Guide* and [IAM database authentication in Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.Aurora_Fea_Regions_DB-eng.Feature.IAMdbauth.html) in the *Amazon Aurora User Guide*. Type: Boolean Required: No ** InstanceCreateTime ** The date and time when the DB instance was created. Type: Timestamp Required: No ** Iops ** The Provisioned IOPS (I/O operations per second) value for the DB instance. Type: Integer Required: No ** IsStorageConfigUpgradeAvailable ** Indicates whether an upgrade is recommended for the storage file system configuration on the DB instance. To migrate to the preferred configuration, you can either create a blue/green deployment, or create a read replica from the DB instance. For more information, see [Upgrading the storage file system for a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.UpgradeFileSystem). Type: Boolean Required: No ** KmsKeyId ** If `StorageEncrypted` is enabled, the AWS KMS key identifier for the encrypted DB instance. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. Type: String Required: No ** LatestRestorableTime ** The latest time to which a database in this DB instance can be restored with point-in-time restore. Type: Timestamp Required: No ** LicenseModel ** The license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. Type: String Required: No ** ListenerEndpoint ** The listener connection endpoint for SQL Server Always On. Type: [Endpoint](API_Endpoint.md) object Required: No ** MasterUsername ** The master username for the DB instance. Type: String Required: No ** MasterUserSecret ** The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* Type: [MasterUserSecret](API_MasterUserSecret.md) object Required: No ** MaxAllocatedStorage ** The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. Type: Integer Required: No ** MonitoringInterval ** The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. Type: Integer Required: No ** MonitoringRoleArn ** The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. Type: String Required: No ** MultiAZ ** Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances. Type: Boolean Required: No ** MultiTenant ** Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). Type: Boolean Required: No ** NcharCharacterSetName ** The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2. Type: String Required: No ** NetworkType ** The network type of the DB instance. The network type is determined by the `DBSubnetGroup` specified for the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (`DUAL`). For more information, see [ Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide* and [ Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon Aurora User Guide.* Valid Values: `IPV4 | DUAL` Type: String Required: No ** OptionGroupMemberships.OptionGroupMembership.N ** The list of option group memberships for this DB instance. Type: Array of [OptionGroupMembership](API_OptionGroupMembership.md) objects Required: No ** PendingModifiedValues ** Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements. Type: [PendingModifiedValues](API_PendingModifiedValues.md) object Required: No ** PercentProgress ** The progress of the storage optimization operation as a percentage. Type: String Required: No ** PerformanceInsightsEnabled ** Indicates whether Performance Insights is enabled for the DB instance. Type: Boolean Required: No ** PerformanceInsightsKMSKeyId ** The AWS KMS key identifier for encryption of Performance Insights data. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. Type: String Required: No ** PerformanceInsightsRetentionPeriod ** The number of days to retain Performance Insights data. Valid Values: + `7` + *month* \$1 31, where *month* is a number of months from 1-23. Examples: `93` (3 months \$1 31), `341` (11 months \$1 31), `589` (19 months \$1 31) + `731` Default: `7` days Type: Integer Required: No ** PreferredBackupWindow ** The daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod`. Type: String Required: No ** PreferredMaintenanceWindow ** The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Type: String Required: No ** ProcessorFeatures.ProcessorFeature.N ** The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. Type: Array of [ProcessorFeature](API_ProcessorFeature.md) objects Required: No ** PromotionTier ** The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see [ Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*. Type: Integer Required: No ** PubliclyAccessible ** 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 cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see [CreateDBInstance](API_CreateDBInstance.md). Type: Boolean Required: No ** ReadReplicaDBClusterIdentifiers.ReadReplicaDBClusterIdentifier.N ** The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas. Currently, each RDS DB instance can have only one Aurora read replica. Type: Array of strings Required: No ** ReadReplicaDBInstanceIdentifiers.ReadReplicaDBInstanceIdentifier.N ** The identifiers of the read replicas associated with this DB instance. Type: Array of strings Required: No ** ReadReplicaSourceDBClusterIdentifier ** The identifier of the source DB cluster if this DB instance is a read replica. Type: String Required: No ** ReadReplicaSourceDBInstanceIdentifier ** The identifier of the source DB instance if this DB instance is a read replica. Type: String Required: No ** ReplicaMode ** The open mode of a Db2 or an Oracle read replica. The default is `open-read-only`. For more information, see [Working with replicas for Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html) and [Working with read replicas for Amazon RDS for Oracle](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*. This attribute is only supported in RDS for Db2, RDS for Oracle, and RDS Custom for Oracle. Type: String Valid Values: `open-read-only | mounted` Required: No ** ResumeFullAutomationModeTime ** The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440. Type: Timestamp Required: No ** SecondaryAvailabilityZone ** If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support. Type: String Required: No ** StatusInfos.DBInstanceStatusInfo.N ** The status of a read replica. If the DB instance isn't a read replica, the value is blank. Type: Array of [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md) objects Required: No ** StorageEncrypted ** Indicates whether the DB instance is encrypted. Type: Boolean Required: No ** StorageEncryptionType ** The type of encryption used to protect data at rest in the DB instance. Possible values: + `none` - The DB instance is not encrypted. + `sse-rds` - The DB instance is encrypted using an AWS owned KMS key. + `sse-kms` - The DB instance is encrypted using a customer managed KMS key or AWS managed KMS key. Type: String Valid Values: `none | sse-kms | sse-rds` Required: No ** StorageThroughput ** The storage throughput for the DB instance. This setting applies only to the `gp3` storage type. Type: Integer Required: No ** StorageType ** The storage type associated with the DB instance. Type: String Required: No ** StorageVolumeStatus ** The detailed status information for storage volumes associated with the DB instance. This information helps identify which specific volume is causing the instance to be in a storage-full state. Type: String Required: No ** TagList.Tag.N ** A list of tags. For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*. Type: Array of [Tag](API_Tag.md) objects Required: No ** TdeCredentialArn ** The ARN from the key store with which the instance is associated for TDE encryption. Type: String Required: No ** Timezone ** The time zone of the DB instance. In most cases, the `Timezone` element is empty. `Timezone` content appears only for RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified. Type: String Required: No ** UpgradeRolloutOrder ** This data type represents the order in which the instances are upgraded. + [first] - Typically used for development or testing environments. + [second] - Default order for resources not specifically configured. + [last] - Usually reserved for production environments. Type: String Valid Values: `first | second | last` Required: No ** VpcSecurityGroups.VpcSecurityGroupMembership.N ** The list of Amazon EC2 VPC security groups that the DB instance belongs to. Type: Array of [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) objects Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBInstance) # DBInstanceAutomatedBackup 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. ## Contents **Note** In the following list, the required parameters are described first. ** AdditionalStorageVolumes.member.N ** The additional storage volumes associated with the automated backup. Valid Values: `GP3 | IO2` Type: Array of [AdditionalStorageVolume](API_AdditionalStorageVolume.md) objects Required: No ** AllocatedStorage ** The allocated storage size for the automated backup in gibibytes (GiB). Type: Integer Required: No ** AvailabilityZone ** The Availability Zone that the automated backup was created in. For information on AWS Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html). Type: String Required: No ** AwsBackupRecoveryPointArn ** The Amazon Resource Name (ARN) of the recovery point in AWS Backup. Type: String Required: No ** BackupRetentionPeriod ** The retention period for the automated backups. Type: Integer Required: No ** BackupTarget ** The location where automated backups are stored: Dedicated Local Zones, AWS Outposts or the AWS Region. Type: String Required: No ** DBInstanceArn ** The Amazon Resource Name (ARN) for the automated backups. Type: String Required: No ** DBInstanceAutomatedBackupsArn ** The Amazon Resource Name (ARN) for the replicated automated backups. Type: String Required: No ** DBInstanceAutomatedBackupsReplications.DBInstanceAutomatedBackupsReplication.N ** The list of replications to different AWS Regions associated with the automated backup. Type: Array of [DBInstanceAutomatedBackupsReplication](API_DBInstanceAutomatedBackupsReplication.md) objects Required: No ** DBInstanceIdentifier ** The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region. Type: String Required: No ** DbiResourceId ** The resource ID for the source DB instance, which can't be changed and which is unique to an AWS Region. Type: String Required: No ** DedicatedLogVolume ** Indicates whether the DB instance has a dedicated log volume (DLV) enabled. Type: Boolean Required: No ** Encrypted ** Indicates whether the automated backup is encrypted. Type: Boolean Required: No ** Engine ** The name of the database engine for this automated backup. Type: String Required: No ** EngineVersion ** The version of the database engine for the automated backup. Type: String Required: No ** IAMDatabaseAuthenticationEnabled ** True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. Type: Boolean Required: No ** InstanceCreateTime ** The date and time when the DB instance was created. Type: Timestamp Required: No ** Iops ** The IOPS (I/O operations per second) value for the automated backup. Type: Integer Required: No ** KmsKeyId ** The AWS KMS key ID for an automated backup. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. Type: String Required: No ** LicenseModel ** The license model information for the automated backup. Type: String Required: No ** MasterUsername ** The master user name of an automated backup. Type: String Required: No ** MultiTenant ** Specifies whether the automatic backup is for a DB instance in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). Type: Boolean Required: No ** OptionGroupName ** The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used. Type: String Required: No ** Port ** The port number that the automated backup used for connections. Default: Inherits from the source DB instance Valid Values: `1150-65535` Type: Integer Required: No ** PreferredBackupWindow ** The daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod`. Type: String Required: No ** Region ** The AWS Region associated with the automated backup. Type: String Required: No ** RestoreWindow ** The earliest and latest time a DB instance can be restored to. Type: [RestoreWindow](API_RestoreWindow.md) object Required: No ** Status ** A list of status information for an automated backup: + `active` - Automated backups for current instances. + `retained` - Automated backups for deleted instances. + `creating` - Automated backups that are waiting for the first automated snapshot to be available. Type: String Required: No ** StorageEncryptionType ** The type of encryption used to protect data at rest in the automated backup. Possible values: + `none` - The automated backup is not encrypted. + `sse-rds` - The automated backup is encrypted using an AWS owned KMS key. + `sse-kms` - The automated backup is encrypted using a customer managed KMS key or AWS managed KMS key. Type: String Valid Values: `none | sse-kms | sse-rds` Required: No ** StorageThroughput ** The storage throughput for the automated backup. Type: Integer Required: No ** StorageType ** The storage type associated with the automated backup. Type: String Required: No ** TagList.Tag.N ** A list of tags. For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*. Type: Array of [Tag](API_Tag.md) objects Required: No ** TdeCredentialArn ** The ARN from the key store with which the automated backup is associated for TDE encryption. Type: String Required: No ** Timezone ** The time zone of the automated backup. In most cases, the `Timezone` element is empty. `Timezone` content appears only for Microsoft SQL Server DB instances that were created with a time zone specified. Type: String Required: No ** VpcId ** The VPC ID associated with the DB instance. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBInstanceAutomatedBackup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBInstanceAutomatedBackup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBInstanceAutomatedBackup) # DBInstanceAutomatedBackupsReplication Automated backups of a DB instance replicated to another AWS Region. They consist of system backups, transaction logs, and database instance properties. ## Contents **Note** In the following list, the required parameters are described first. ** DBInstanceAutomatedBackupsArn ** The Amazon Resource Name (ARN) of the replicated automated backups. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBInstanceAutomatedBackupsReplication) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBInstanceAutomatedBackupsReplication) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBInstanceAutomatedBackupsReplication) # DBInstanceRole Information about an AWS Identity and Access Management (IAM) role that is associated with a DB instance. ## Contents **Note** In the following list, the required parameters are described first. ** FeatureName ** The name of the feature associated with the AWS Identity and Access Management (IAM) role. For information about supported feature names, see `DBEngineVersion`. Type: String Required: No ** RoleArn ** The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance. Type: String Required: No ** Status ** Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values: + `ACTIVE` - the IAM role ARN is associated with the DB instance and can be used to access other AWS services on your behalf. + `PENDING` - the IAM role ARN is being associated with the DB instance. + `INVALID` - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other AWS services on your behalf. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBInstanceRole) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBInstanceRole) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBInstanceRole) # DBInstanceStatusInfo Provides a list of status information for a DB instance. ## Contents **Note** In the following list, the required parameters are described first. ** Message ** Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank. Type: String Required: No ** Normal ** Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE). Type: Boolean Required: No ** Status ** The status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated. Type: String Required: No ** StatusType ** This value is currently "read replication." Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBInstanceStatusInfo) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBInstanceStatusInfo) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBInstanceStatusInfo) # DBMajorEngineVersion This data type is used as a response element in the operation `DescribeDBMajorEngineVersions`. ## Contents **Note** In the following list, the required parameters are described first. ** Engine ** The name of the database engine. Type: String Required: No ** MajorEngineVersion ** The major version number of the database engine. Type: String Required: No ** SupportedEngineLifecycles.SupportedEngineLifecycle.N ** A list of the lifecycles supported by this engine for the `DescribeDBMajorEngineVersions` operation. Type: Array of [SupportedEngineLifecycle](API_SupportedEngineLifecycle.md) objects Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBMajorEngineVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBMajorEngineVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBMajorEngineVersion) # DBParameterGroup Contains the details of an Amazon RDS DB parameter group. This data type is used as a response element in the `DescribeDBParameterGroups` action. ## Contents **Note** In the following list, the required parameters are described first. ** DBParameterGroupArn ** The Amazon Resource Name (ARN) for the DB parameter group. Type: String Required: No ** DBParameterGroupFamily ** The name of the DB parameter group family that this DB parameter group is compatible with. Type: String Required: No ** DBParameterGroupName ** The name of the DB parameter group. Type: String Required: No ** Description ** Provides the customer-specified description for this DB parameter group. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBParameterGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBParameterGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBParameterGroup) # DBParameterGroupStatus 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` ## Contents **Note** In the following list, the required parameters are described first. ** DBParameterGroupName ** The name of the DB parameter group. Type: String Required: No ** ParameterApplyStatus ** The status of parameter updates. Valid values are: + `applying`: The parameter group change is being applied to the database. + `failed-to-apply`: The parameter group is in an invalid state. + `in-sync`: The parameter group change is synchronized with the database. + `pending-database-upgrade`: The parameter group change will be applied after the DB instance is upgraded. + `pending-reboot`: The parameter group change will be applied after the DB instance reboots. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBParameterGroupStatus) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBParameterGroupStatus) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBParameterGroupStatus) # DBProxy The data structure representing a proxy managed by the RDS Proxy. This data type is used as a response element in the `DescribeDBProxies` action. ## Contents **Note** In the following list, the required parameters are described first. ** Auth.member.N ** One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster. Type: Array of [UserAuthConfigInfo](API_UserAuthConfigInfo.md) objects Required: No ** CreatedDate ** The date and time when the proxy was first created. Type: Timestamp Required: No ** DBProxyArn ** The Amazon Resource Name (ARN) for the proxy. Type: String Required: No ** DBProxyName ** The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region. Type: String Required: No ** DebugLogging ** Specifies whether the proxy logs detailed connection and query information. When you enable `DebugLogging`, the proxy captures connection details and connection pool behavior from your queries. Debug logging increases CloudWatch costs and can impact proxy performance. Enable this option only when you need to troubleshoot connection or performance issues. Type: Boolean Required: No ** DefaultAuthScheme ** The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are `NONE` and `IAM_AUTH`. When set to `IAM_AUTH`, the proxy uses end-to-end IAM authentication to connect to the database. Type: String Required: No ** Endpoint ** The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application. Type: String Required: No ** EndpointNetworkType ** The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports. Valid values: + `IPV4` - The proxy endpoint supports IPv4 only. + `IPV6` - The proxy endpoint supports IPv6 only. + `DUAL` - The proxy endpoint supports both IPv4 and IPv6. Type: String Valid Values: `IPV4 | IPV6 | DUAL` Required: No ** EngineFamily ** The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. `MYSQL` supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. `POSTGRESQL` supports Aurora PostgreSQL and RDS for PostgreSQL databases. `SQLSERVER` supports RDS for Microsoft SQL Server databases. Type: String Required: No ** IdleClientTimeout ** The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests. Default: 1800 (30 minutes) Constraints: 1 to 28,800 Type: Integer Required: No ** RequireTLS ** Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy. Type: Boolean Required: No ** RoleArn ** The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager. Type: String Required: No ** Status ** The current status of this proxy. A status of `available` means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue. Type: String Valid Values: `available | modifying | incompatible-network | insufficient-resource-limits | creating | deleting | suspended | suspending | reactivating` Required: No ** TargetConnectionNetworkType ** The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database. Valid values: + `IPV4` - The proxy connects to the database using IPv4 only. + `IPV6` - The proxy connects to the database using IPv6 only. Type: String Valid Values: `IPV4 | IPV6` Required: No ** UpdatedDate ** The date and time when the proxy was last updated. Type: Timestamp Required: No ** VpcId ** Provides the VPC ID of the DB proxy. Type: String Required: No ** VpcSecurityGroupIds.member.N ** Provides a list of VPC security groups that the proxy belongs to. Type: Array of strings Required: No ** VpcSubnetIds.member.N ** The EC2 subnet IDs for the proxy. Type: Array of strings Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBProxy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBProxy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBProxy) # DBProxyEndpoint 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. ## Contents **Note** In the following list, the required parameters are described first. ** CreatedDate ** The date and time when the DB proxy endpoint was first created. Type: Timestamp Required: No ** DBProxyEndpointArn ** The Amazon Resource Name (ARN) for the DB proxy endpoint. Type: String Required: No ** DBProxyEndpointName ** The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens. Type: String Required: No ** DBProxyName ** The identifier for the DB proxy that is associated with this DB proxy endpoint. Type: String Required: No ** Endpoint ** The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application. Type: String Required: No ** EndpointNetworkType ** The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports. Valid values: + `IPV4` - The proxy endpoint supports IPv4 only. + `IPV6` - The proxy endpoint supports IPv6 only. + `DUAL` - The proxy endpoint supports both IPv4 and IPv6. Type: String Valid Values: `IPV4 | IPV6 | DUAL` Required: No ** IsDefault ** Indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only. Type: Boolean Required: No ** Status ** The current status of this DB proxy endpoint. A status of `available` means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue. Type: String Valid Values: `available | modifying | incompatible-network | insufficient-resource-limits | creating | deleting` Required: No ** TargetRole ** A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. Type: String Valid Values: `READ_WRITE | READ_ONLY` Required: No ** VpcId ** Provides the VPC ID of the DB proxy endpoint. Type: String Required: No ** VpcSecurityGroupIds.member.N ** Provides a list of VPC security groups that the DB proxy endpoint belongs to. Type: Array of strings Required: No ** VpcSubnetIds.member.N ** The EC2 subnet IDs for the DB proxy endpoint. Type: Array of strings Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBProxyEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBProxyEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBProxyEndpoint) # DBProxyTarget 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. ## Contents **Note** In the following list, the required parameters are described first. ** Endpoint ** The writer endpoint for the RDS DB instance or Aurora DB cluster. Type: String Required: No ** Port ** The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster. Type: Integer Required: No ** RdsResourceId ** The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster. Type: String Required: No ** Role ** A value that indicates whether the target of the proxy can be used for read/write or read-only operations. Type: String Valid Values: `READ_WRITE | READ_ONLY | UNKNOWN` Required: No ** TargetArn ** The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster. Type: String Required: No ** TargetHealth ** Information about the connection health of the RDS Proxy target. Type: [TargetHealth](API_TargetHealth.md) object Required: No ** TrackedClusterId ** The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance. Type: String Required: No ** Type ** Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents. Type: String Valid Values: `RDS_INSTANCE | RDS_SERVERLESS_ENDPOINT | TRACKED_CLUSTER` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBProxyTarget) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBProxyTarget) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBProxyTarget) # DBProxyTargetGroup 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. ## Contents **Note** In the following list, the required parameters are described first. ** ConnectionPoolConfig ** The settings that determine the size and behavior of the connection pool for the target group. Type: [ConnectionPoolConfigurationInfo](API_ConnectionPoolConfigurationInfo.md) object Required: No ** CreatedDate ** The date and time when the target group was first created. Type: Timestamp Required: No ** DBProxyName ** The identifier for the RDS proxy associated with this target group. Type: String Required: No ** IsDefault ** Indicates whether this target group is the first one used for connection requests by the associated proxy. Because each proxy is currently associated with a single target group, currently this setting is always `true`. Type: Boolean Required: No ** Status ** The current status of this target group. A status of `available` means the target group is correctly associated with a database. Other values indicate that you must wait for the target group to be ready, or take some action to resolve an issue. Type: String Required: No ** TargetGroupArn ** The Amazon Resource Name (ARN) representing the target group. Type: String Required: No ** TargetGroupName ** The identifier for the target group. This name must be unique for all target groups owned by your AWS account in the specified AWS Region. Type: String Required: No ** UpdatedDate ** The date and time when the target group was last updated. Type: Timestamp Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBProxyTargetGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBProxyTargetGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBProxyTargetGroup) # DBRecommendation The recommendation for your DB instances, DB clusters, and DB parameter groups. ## Contents **Note** In the following list, the required parameters are described first. ** AdditionalInfo ** Additional information about the recommendation. The information might contain markdown. Type: String Required: No ** Category ** The category of the recommendation. Valid values: + `performance efficiency` + `security` + `reliability` + `cost optimization` + `operational excellence` + `sustainability` Type: String Required: No ** CreatedTime ** The time when the recommendation was created. For example, `2023-09-28T01:13:53.931000+00:00`. Type: Timestamp Required: No ** Description ** A detailed description of the recommendation. The description might contain markdown. Type: String Required: No ** Detection ** A short description of the issue identified for this recommendation. The description might contain markdown. Type: String Required: No ** Impact ** A short description that explains the possible impact of an issue. Type: String Required: No ** IssueDetails ** Details of the issue that caused the recommendation. Type: [IssueDetails](API_IssueDetails.md) object Required: No ** Links.member.N ** A link to documentation that provides additional information about the recommendation. Type: Array of [DocLink](API_DocLink.md) objects Required: No ** Reason ** The reason why this recommendation was created. The information might contain markdown. Type: String Required: No ** Recommendation ** A short description of the recommendation to resolve an issue. The description might contain markdown. Type: String Required: No ** RecommendationId ** The unique identifier of the recommendation. Type: String Required: No ** RecommendedActions.member.N ** A list of recommended actions. Type: Array of [RecommendedAction](API_RecommendedAction.md) objects Required: No ** ResourceArn ** The Amazon Resource Name (ARN) of the RDS resource associated with the recommendation. Type: String Required: No ** Severity ** The severity level of the recommendation. The severity level can help you decide the urgency with which to address the recommendation. Valid values: + `high` + `medium` + `low` + `informational` Type: String Required: No ** Source ** The AWS service that generated the recommendations. Type: String Required: No ** Status ** The current status of the recommendation. Valid values: + `active` - The recommendations which are ready for you to apply. + `pending` - The applied or scheduled recommendations which are in progress. + `resolved` - The recommendations which are completed. + `dismissed` - The recommendations that you dismissed. Type: String Required: No ** TypeDetection ** A short description of the recommendation type. The description might contain markdown. Type: String Required: No ** TypeId ** A value that indicates the type of recommendation. This value determines how the description is rendered. Type: String Required: No ** TypeRecommendation ** A short description that summarizes the recommendation to fix all the issues of the recommendation type. The description might contain markdown. Type: String Required: No ** UpdatedTime ** The time when the recommendation was last updated. Type: Timestamp Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBRecommendation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBRecommendation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBRecommendation) # DBSecurityGroup Contains the details for an Amazon RDS DB security group. This data type is used as a response element in the `DescribeDBSecurityGroups` action. ## Contents **Note** In the following list, the required parameters are described first. ** DBSecurityGroupArn ** The Amazon Resource Name (ARN) for the DB security group. Type: String Required: No ** DBSecurityGroupDescription ** Provides the description of the DB security group. Type: String Required: No ** DBSecurityGroupName ** Specifies the name of the DB security group. Type: String Required: No ** EC2SecurityGroups.EC2SecurityGroup.N ** Contains a list of `EC2SecurityGroup` elements. Type: Array of [EC2SecurityGroup](API_EC2SecurityGroup.md) objects Required: No ** IPRanges.IPRange.N ** Contains a list of `IPRange` elements. Type: Array of [IPRange](API_IPRange.md) objects Required: No ** OwnerId ** Provides the AWS ID of the owner of a specific DB security group. Type: String Required: No ** VpcId ** Provides the VpcId of the DB security group. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBSecurityGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBSecurityGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBSecurityGroup) # DBSecurityGroupMembership This data type is used as a response element in the following actions: + `ModifyDBInstance` + `RebootDBInstance` + `RestoreDBInstanceFromDBSnapshot` + `RestoreDBInstanceToPointInTime` ## Contents **Note** In the following list, the required parameters are described first. ** DBSecurityGroupName ** The name of the DB security group. Type: String Required: No ** Status ** The status of the DB security group. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBSecurityGroupMembership) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBSecurityGroupMembership) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBSecurityGroupMembership) # DBShardGroup Contains the details for an Amazon RDS DB shard group. ## Contents **Note** In the following list, the required parameters are described first. ** ComputeRedundancy ** Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following: + 0 - Creates a DB shard group without a standby DB shard group. This is the default value. + 1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ). + 2 - Creates a DB shard group with two standby DB shard groups in two different AZs. Type: Integer Required: No ** DBClusterIdentifier ** The name of the primary DB cluster for the DB shard group. Type: String Required: No ** DBShardGroupArn ** The Amazon Resource Name (ARN) for the DB shard group. Type: String Required: No ** DBShardGroupIdentifier ** The name of the DB shard group. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*` Required: No ** DBShardGroupResourceId ** The AWS Region-unique, immutable identifier for the DB shard group. Type: String Required: No ** Endpoint ** The connection endpoint for the DB shard group. Type: String Required: No ** MaxACU ** The maximum capacity of the DB shard group in Aurora capacity units (ACUs). Type: Double Required: No ** MinACU ** The minimum capacity of the DB shard group in Aurora capacity units (ACUs). Type: Double Required: No ** PubliclyAccessible ** Indicates whether the DB shard group is publicly accessible. When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB shard group doesn't permit it. When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address. For more information, see [CreateDBShardGroup](API_CreateDBShardGroup.md). This setting is only for Aurora Limitless Database. Type: Boolean Required: No ** Status ** The status of the DB shard group. Type: String Required: No ** TagList.Tag.N ** A list of tags. For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*. Type: Array of [Tag](API_Tag.md) objects Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBShardGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBShardGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBShardGroup) # DBSnapshot Contains the details of an Amazon RDS DB snapshot. This data type is used as a response element in the `DescribeDBSnapshots` action. ## Contents **Note** In the following list, the required parameters are described first. ** AdditionalStorageVolumes.member.N ** The additional storage volumes associated with the DB snapshot. RDS supports additional storage volumes for RDS for Oracle and RDS for SQL Server. Type: Array of [AdditionalStorageVolume](API_AdditionalStorageVolume.md) objects Required: No ** AllocatedStorage ** Specifies the allocated storage size in gibibytes (GiB). Type: Integer Required: No ** AvailabilityZone ** Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot. Type: String Required: No ** BackupRetentionPeriod ** The number of days for which automatic DB snapshots are retained. Type: Integer Required: No ** DBInstanceIdentifier ** Specifies the DB instance identifier of the DB instance this DB snapshot was created from. Type: String Required: No ** DbiResourceId ** The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region. Type: String Required: No ** DBSnapshotArn ** The Amazon Resource Name (ARN) for the DB snapshot. Type: String Required: No ** DBSnapshotIdentifier ** Specifies the identifier for the DB snapshot. Type: String Required: No ** DBSystemId ** The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB. Type: String Required: No ** DedicatedLogVolume ** Indicates whether the DB instance has a dedicated log volume (DLV) enabled. Type: Boolean Required: No ** Encrypted ** Indicates whether the DB snapshot is encrypted. Type: Boolean Required: No ** Engine ** Specifies the name of the database engine. Type: String Required: No ** EngineVersion ** Specifies the version of the database engine. Type: String Required: No ** IAMDatabaseAuthenticationEnabled ** Indicates whether mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Type: Boolean Required: No ** InstanceCreateTime ** Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created. Type: Timestamp Required: No ** Iops ** Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot. Type: Integer Required: No ** KmsKeyId ** If `Encrypted` is true, the AWS KMS key identifier for the encrypted DB snapshot. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. Type: String Required: No ** LicenseModel ** License model information for the restored DB instance. Type: String Required: No ** MasterUsername ** Provides the master username for the DB snapshot. Type: String Required: No ** MultiTenant ** Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). Type: Boolean Required: No ** OptionGroupName ** Provides the option group name for the DB snapshot. Type: String Required: No ** OriginalSnapshotCreateTime ** Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied. Type: Timestamp Required: No ** PercentProgress ** The percentage of the estimated data that has been transferred. Type: Integer Required: No ** Port ** Specifies the port that the database engine was listening on at the time of the snapshot. Type: Integer Required: No ** PreferredBackupWindow ** The daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod`. Type: String Required: No ** ProcessorFeatures.ProcessorFeature.N ** The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created. Type: Array of [ProcessorFeature](API_ProcessorFeature.md) objects Required: No ** SnapshotAvailabilityZone ** Specifies the name of the Availability Zone where RDS stores the DB snapshot. This value is valid only for snapshots that RDS stores on a Dedicated Local Zone. Type: String Required: No ** SnapshotCreateTime ** Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied. Type: Timestamp Required: No ** SnapshotDatabaseTime ** The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed. If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours. Type: Timestamp Required: No ** SnapshotTarget ** Specifies where manual snapshots are stored: Dedicated Local Zones, AWS Outposts or the AWS Region. Type: String Required: No ** SnapshotType ** Provides the type of the DB snapshot. Type: String Required: No ** SourceDBSnapshotIdentifier ** The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy. Type: String Required: No ** SourceRegion ** The AWS Region that the DB snapshot was created in or copied from. Type: String Required: No ** Status ** Specifies the status of this DB snapshot. Type: String Required: No ** StorageEncryptionType ** The type of encryption used to protect data at rest in the DB snapshot. Possible values: + `none` - The DB snapshot is not encrypted. + `sse-rds` - The DB snapshot is encrypted using an AWS owned KMS key. + `sse-kms` - The DB snapshot is encrypted using a customer managed KMS key or AWS managed KMS key. Type: String Valid Values: `none | sse-kms | sse-rds` Required: No ** StorageThroughput ** Specifies the storage throughput for the DB snapshot. Type: Integer Required: No ** StorageType ** Specifies the storage type associated with DB snapshot. Type: String Required: No ** TagList.Tag.N ** A list of tags. For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*. Type: Array of [Tag](API_Tag.md) objects Required: No ** TdeCredentialArn ** The ARN from the key store with which to associate the instance for TDE encryption. Type: String Required: No ** Timezone ** The time zone of the DB snapshot. In most cases, the `Timezone` element is empty. `Timezone` content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified. Type: String Required: No ** VpcId ** Provides the VPC ID associated with the DB snapshot. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBSnapshot) # DBSnapshotAttribute Contains the name and values of a manual DB snapshot attribute Manual DB snapshot attributes are used to authorize other AWS accounts to restore a manual DB snapshot. For more information, see the `ModifyDBSnapshotAttribute` API. ## Contents **Note** In the following list, the required parameters are described first. ** AttributeName ** The name of the manual DB snapshot attribute. The attribute named `restore` refers to the list of AWS accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the `ModifyDBSnapshotAttribute` API action. Type: String Required: No ** AttributeValues.AttributeValue.N ** The value or values for the manual DB snapshot attribute. If the `AttributeName` field is set to `restore`, then this element returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual DB snapshot. If a value of `all` is in the list, then the manual DB snapshot is public and available for any AWS account to copy or restore. Type: Array of strings Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBSnapshotAttribute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBSnapshotAttribute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBSnapshotAttribute) # DBSnapshotAttributesResult Contains the results of a successful call to the `DescribeDBSnapshotAttributes` API action. Manual DB snapshot attributes are used to authorize other AWS accounts to copy or restore a manual DB snapshot. For more information, see the `ModifyDBSnapshotAttribute` API action. ## Contents **Note** In the following list, the required parameters are described first. ** DBSnapshotAttributes.DBSnapshotAttribute.N ** The list of attributes and values for the manual DB snapshot. Type: Array of [DBSnapshotAttribute](API_DBSnapshotAttribute.md) objects Required: No ** DBSnapshotIdentifier ** The identifier of the manual DB snapshot that the attributes apply to. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBSnapshotAttributesResult) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBSnapshotAttributesResult) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBSnapshotAttributesResult) # DBSnapshotTenantDatabase Contains the details of a tenant database in a snapshot of a DB instance. ## Contents **Note** In the following list, the required parameters are described first. ** CharacterSetName ** The name of the character set of a tenant database. Type: String Required: No ** DBInstanceIdentifier ** The ID for the DB instance that contains the tenant databases. Type: String Required: No ** DbiResourceId ** The resource identifier of the source CDB instance. This identifier can't be changed and is unique to an AWS Region. Type: String Required: No ** DBSnapshotIdentifier ** The identifier for the snapshot of the DB instance. Type: String Required: No ** DBSnapshotTenantDatabaseARN ** The Amazon Resource Name (ARN) for the snapshot tenant database. Type: String Required: No ** EngineName ** The name of the database engine. Type: String Required: No ** MasterUsername ** The master username of the tenant database. Type: String Required: No ** NcharCharacterSetName ** The `NCHAR` character set name of the tenant database. Type: String Required: No ** SnapshotType ** The type of DB snapshot. Type: String Required: No ** TagList.Tag.N ** A list of tags. For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*. Type: Array of [Tag](API_Tag.md) objects Required: No ** TenantDatabaseCreateTime ** The time the DB snapshot was taken, specified in Coordinated Universal Time (UTC). If you copy the snapshot, the creation time changes. Type: Timestamp Required: No ** TenantDatabaseResourceId ** The resource ID of the tenant database. Type: String Required: No ** TenantDBName ** The name of the tenant database. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBSnapshotTenantDatabase) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBSnapshotTenantDatabase) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBSnapshotTenantDatabase) # DBSubnetGroup Contains the details of an Amazon RDS DB subnet group. This data type is used as a response element in the `DescribeDBSubnetGroups` action. ## Contents **Note** In the following list, the required parameters are described first. ** DBSubnetGroupArn ** The Amazon Resource Name (ARN) for the DB subnet group. Type: String Required: No ** DBSubnetGroupDescription ** Provides the description of the DB subnet group. Type: String Required: No ** DBSubnetGroupName ** The name of the DB subnet group. Type: String Required: No ** SubnetGroupStatus ** Provides the status of the DB subnet group. Type: String Required: No ** Subnets.Subnet.N ** Contains a list of `Subnet` elements. The list of subnets shown here might not reflect the current state of your VPC. For the most up-to-date information, we recommend checking your VPC configuration directly. Type: Array of [Subnet](API_Subnet.md) objects Required: No ** SupportedNetworkTypes.member.N ** The network type of the DB subnet group. Valid values: + `IPV4` + `DUAL` A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (`DUAL`). For more information, see [ Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.* Type: Array of strings Required: No ** VpcId ** Provides the VpcId of the DB subnet group. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DBSubnetGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DBSubnetGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DBSubnetGroup) # DescribeDBLogFilesDetails This data type is used as a response element to `DescribeDBLogFiles`. ## Contents **Note** In the following list, the required parameters are described first. ** LastWritten ** A POSIX timestamp when the last log entry was written. Type: Long Required: No ** LogFileName ** The name of the log file for the specified DB instance. Type: String Required: No ** Size ** The size, in bytes, of the log file for the specified DB instance. Type: Long Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBLogFilesDetails) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBLogFilesDetails) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBLogFilesDetails) # DocLink A link to documentation that provides additional information for a recommendation. ## Contents **Note** In the following list, the required parameters are described first. ** Text ** The text with the link to documentation for the recommendation. Type: String Required: No ** Url ** The URL for the documentation for the recommendation. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DocLink) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DocLink) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DocLink) # DomainMembership An Active Directory Domain membership record associated with the DB instance or cluster. ## Contents **Note** In the following list, the required parameters are described first. ** AuthSecretArn ** The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain. Type: String Required: No ** DnsIps.member.N ** The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers. Type: Array of strings Required: No ** Domain ** The identifier of the Active Directory Domain. Type: String Required: No ** FQDN ** The fully qualified domain name (FQDN) of the Active Directory Domain. Type: String Required: No ** IAMRoleName ** The name of the IAM role used when making API calls to the Directory Service. Type: String Required: No ** OU ** The Active Directory organizational unit for the DB instance or cluster. Type: String Required: No ** Status ** The status of the Active Directory Domain membership for the DB instance or cluster. Values include `joined`, `pending-join`, `failed`, and so on. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DomainMembership) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DomainMembership) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DomainMembership) # DoubleRange A range of double values. ## Contents **Note** In the following list, the required parameters are described first. ** From ** The minimum value in the range. Type: Double Required: No ** To ** The maximum value in the range. Type: Double Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DoubleRange) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DoubleRange) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DoubleRange) # EC2SecurityGroup This data type is used as a response element in the following actions: + `AuthorizeDBSecurityGroupIngress` + `DescribeDBSecurityGroups` + `RevokeDBSecurityGroupIngress` ## Contents **Note** In the following list, the required parameters are described first. ** EC2SecurityGroupId ** Specifies the id of the EC2 security group. Type: String Required: No ** EC2SecurityGroupName ** Specifies the name of the EC2 security group. Type: String Required: No ** EC2SecurityGroupOwnerId ** Specifies the AWS ID of the owner of the EC2 security group specified in the `EC2SecurityGroupName` field. Type: String Required: No ** Status ** Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked". Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/EC2SecurityGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/EC2SecurityGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/EC2SecurityGroup) # Endpoint 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`. ## Contents **Note** In the following list, the required parameters are described first. ** Address ** Specifies the DNS address of the DB instance. Type: String Required: No ** HostedZoneId ** Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. Type: String Required: No ** Port ** Specifies the port that the database engine is listening on. Type: Integer Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/Endpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/Endpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/Endpoint) # EngineDefaults Contains the result of a successful invocation of the `DescribeEngineDefaultParameters` action. ## Contents **Note** In the following list, the required parameters are described first. ** DBParameterGroupFamily ** Specifies the name of the DB parameter group family that the engine default parameters apply to. Type: String Required: No ** Marker ** 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` . Type: String Required: No ** Parameters.Parameter.N ** Contains a list of engine default parameters. Type: Array of [Parameter](API_Parameter.md) objects Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/EngineDefaults) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/EngineDefaults) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/EngineDefaults) # Event This data type is used as a response element in the [DescribeEvents](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeEvents.html) action. ## Contents **Note** In the following list, the required parameters are described first. ** Date ** Specifies the date and time of the event. Type: Timestamp Required: No ** EventCategories.EventCategory.N ** Specifies the category for the event. Type: Array of strings Required: No ** Message ** Provides the text of this event. Type: String Required: No ** SourceArn ** The Amazon Resource Name (ARN) for the event. Type: String Required: No ** SourceIdentifier ** Provides the identifier for the source of the event. Type: String Required: No ** SourceType ** Specifies the source type for this event. Type: String Valid Values: `db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot | custom-engine-version | db-proxy | blue-green-deployment | db-shard-group | zero-etl` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/Event) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/Event) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/Event) # EventCategoriesMap Contains the results of a successful invocation of the [DescribeEventCategories](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeEventCategories.html) operation. ## Contents **Note** In the following list, the required parameters are described first. ** EventCategories.EventCategory.N ** The event categories for the specified source type Type: Array of strings Required: No ** SourceType ** The source type that the returned categories belong to Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/EventCategoriesMap) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/EventCategoriesMap) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/EventCategoriesMap) # EventSubscription Contains the results of a successful invocation of the `DescribeEventSubscriptions` action. ## Contents **Note** In the following list, the required parameters are described first. ** CustomerAwsId ** The AWS customer account associated with the RDS event notification subscription. Type: String Required: No ** CustSubscriptionId ** The RDS event notification subscription Id. Type: String Required: No ** Enabled ** Specifies whether the subscription is enabled. True indicates the subscription is enabled. Type: Boolean Required: No ** EventCategoriesList.EventCategory.N ** A list of event categories for the RDS event notification subscription. Type: Array of strings Required: No ** EventSubscriptionArn ** The Amazon Resource Name (ARN) for the event subscription. Type: String Required: No ** SnsTopicArn ** The topic ARN of the RDS event notification subscription. Type: String Required: No ** SourceIdsList.SourceId.N ** A list of source IDs for the RDS event notification subscription. Type: Array of strings Required: No ** SourceType ** The source type for the RDS event notification subscription. Type: String Required: No ** Status ** The status of the RDS event notification subscription. Constraints: Can be one of the following: creating \$1 modifying \$1 deleting \$1 active \$1 no-permission \$1 topic-not-exist The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created. Type: String Required: No ** SubscriptionCreationTime ** The time the RDS event notification subscription was created. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/EventSubscription) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/EventSubscription) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/EventSubscription) # ExportTask 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. ## Contents **Note** In the following list, the required parameters are described first. ** ExportOnly.member.N ** The data exported from the snapshot or cluster. Valid Values: + `database` - Export all the data from a specified database. + `database.table` *table-name* - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL. + `database.schema` *schema-name* - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. + `database.schema.table` *table-name* - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. Type: Array of strings Required: No ** ExportTaskIdentifier ** A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for the Amazon S3 bucket where the data is exported. Type: String Required: No ** FailureCause ** The reason the export failed, if it failed. Type: String Required: No ** IamRoleArn ** The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster. Type: String Required: No ** KmsKeyId ** The key identifier of the AWS KMS key that is used to encrypt the data when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key. Type: String Required: No ** PercentProgress ** The progress of the snapshot or cluster export task as a percentage. Type: Integer Required: No ** S3Bucket ** The Amazon S3 bucket where the snapshot or cluster is exported to. Type: String Required: No ** S3Prefix ** The Amazon S3 bucket prefix that is the file name and path of the exported data. Type: String Required: No ** SnapshotTime ** The time when the snapshot was created. Type: Timestamp Required: No ** SourceArn ** The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. Type: String Required: No ** SourceType ** The type of source for the export. Type: String Valid Values: `SNAPSHOT | CLUSTER` Required: No ** Status ** The progress status of the export task. The status can be one of the following: + `CANCELED` + `CANCELING` + `COMPLETE` + `FAILED` + `IN_PROGRESS` + `STARTING` Type: String Required: No ** TaskEndTime ** The time when the snapshot or cluster export task ended. Type: Timestamp Required: No ** TaskStartTime ** The time when the snapshot or cluster export task started. Type: Timestamp Required: No ** TotalExtractedDataInGB ** The total amount of data exported, in gigabytes. Type: Integer Required: No ** WarningMessage ** A warning about the snapshot or cluster export task. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ExportTask) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ExportTask) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ExportTask) # FailoverState 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. ## Contents **Note** In the following list, the required parameters are described first. ** FromDbClusterArn ** The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state. Type: String Required: No ** IsDataLossAllowed ** 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. Type: Boolean Required: No ** Status ** 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 – Aurora is promoting the chosen secondary Aurora 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 Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states. + switching-over – This status covers the range of Aurora internal operations that take place during the switchover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB cluster, and synchronizing replicas. Type: String Valid Values: `pending | failing-over | cancelling` Required: No ** ToDbClusterArn ** The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/FailoverState) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/FailoverState) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/FailoverState) # Filter 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. **Note** Currently, wildcards are not supported in filters. The following actions can be filtered: + `DescribeDBClusterBacktracks` + `DescribeDBClusterEndpoints` + `DescribeDBClusters` + `DescribeDBInstances` + `DescribeDBRecommendations` + `DescribeDBShardGroups` + `DescribePendingMaintenanceActions` ## Contents **Note** In the following list, the required parameters are described first. ** Name ** The name of the filter. Filter names are case-sensitive. Type: String Required: Yes ** Values.Value.N ** One or more filter values. Filter values are case-sensitive. Type: Array of strings Required: Yes ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/Filter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/Filter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/Filter) # GlobalCluster A data type representing an Aurora global database. ## Contents **Note** In the following list, the required parameters are described first. ** DatabaseName ** The default database name within the new global database cluster. Type: String Required: No ** DeletionProtection ** The deletion protection setting for the new global database cluster. Type: Boolean Required: No ** Endpoint ** The writer endpoint for the new global database cluster. This endpoint always points to the writer DB instance in the current primary cluster. Type: String Required: No ** Engine ** The Aurora database engine used by the global database cluster. Type: String Required: No ** EngineLifecycleSupport ** The lifecycle type for the global cluster. For more information, see CreateGlobalCluster. Type: String Required: No ** EngineVersion ** Indicates the database engine version. Type: String Required: No ** FailoverState ** A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Aurora global database). This object is empty unless the `SwitchoverGlobalCluster` or `FailoverGlobalCluster` operation was called on this global cluster. Type: [FailoverState](API_FailoverState.md) object Required: No ** GlobalClusterArn ** The Amazon Resource Name (ARN) for the global database cluster. Type: String Required: No ** GlobalClusterIdentifier ** Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[A-Za-z][0-9A-Za-z-:._]*` Required: No ** GlobalClusterMembers.GlobalClusterMember.N ** The list of primary and secondary clusters within the global database cluster. Type: Array of [GlobalClusterMember](API_GlobalClusterMember.md) objects Required: No ** GlobalClusterResourceId ** The AWS [partition](https://docs.aws.amazon.com/glossary/latest/reference/glos-chap.html?id=docs_gateway#partition)-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed. Type: String Required: No ** Status ** Specifies the current state of this global database cluster. Type: String Required: No ** StorageEncrypted ** The storage encryption setting for the global database cluster. Type: Boolean Required: No ** StorageEncryptionType ** The type of encryption used to protect data at rest in the global database cluster. Possible values: + `none` - The global database cluster is not encrypted. + `sse-rds` - The global database cluster is encrypted using an AWS owned KMS key. + `sse-kms` - The global database cluster is encrypted using a customer managed KMS key or AWS managed KMS key. Type: String Valid Values: `none | sse-kms | sse-rds` Required: No ** TagList.Tag.N ** A list of tags. For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*. Type: Array of [Tag](API_Tag.md) objects Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/GlobalCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/GlobalCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/GlobalCluster) # GlobalClusterMember A data structure with information about any primary and secondary clusters associated with a global cluster (Aurora global database). ## Contents **Note** In the following list, the required parameters are described first. ** DBClusterArn ** The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster. Type: String Required: No ** GlobalWriteForwardingStatus ** The status of write forwarding for a secondary cluster in the global cluster. Type: String Valid Values: `enabled | disabled | enabling | disabling | unknown` Required: No ** IsWriter ** Indicates whether the Aurora DB cluster is the primary cluster (that is, has read-write capability) for the global cluster with which it is associated. Type: Boolean Required: No ** Readers.member.N ** The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the global cluster. Type: Array of strings Required: No ** SynchronizationStatus ** The status of synchronization of each Aurora DB cluster in the global cluster. Type: String Valid Values: `connected | pending-resync` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/GlobalClusterMember) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/GlobalClusterMember) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/GlobalClusterMember) # Integration A zero-ETL integration with Amazon Redshift. ## Contents **Note** In the following list, the required parameters are described first. ** AdditionalEncryptionContext ** AdditionalEncryptionContext.entry.N.key (key) AdditionalEncryptionContext.entry.N.value (value) The encryption context for the integration. For more information, see [Encryption context](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) in the * AWS Key Management Service Developer Guide*. Type: String to string map Required: No ** CreateTime ** The time when the integration was created, in Universal Coordinated Time (UTC). Type: Timestamp Required: No ** DataFilter ** Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse. Type: String Length Constraints: Minimum length of 1. Maximum length of 25600. Pattern: `[a-zA-Z0-9_ "\\\-$,*.:?+\/]*` Required: No ** Description ** A description of the integration. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Pattern: `.*` Required: No ** Errors.IntegrationError.N ** Any errors associated with the integration. Type: Array of [IntegrationError](API_IntegrationError.md) objects Required: No ** IntegrationArn ** The ARN of the integration. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `arn:aws[a-z\-]*:rds(-[a-z]*)?:[a-z0-9\-]*:[0-9]*:integration:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: No ** IntegrationName ** The name of the integration. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*` Required: No ** KMSKeyId ** The AWS Key Management System (AWS KMS) key identifier for the key used to to encrypt the integration. Type: String Required: No ** SourceArn ** The Amazon Resource Name (ARN) of the database used as the source for replication. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `arn:aws[a-z\-]*:rds(-[a-z]*)?:[a-z0-9\-]*:[0-9]*:(cluster|db):[a-z][a-z0-9]*(-[a-z0-9]+)*` Required: No ** Status ** The current status of the integration. Type: String Valid Values: `creating | active | modifying | failed | deleting | syncing | needs_attention` Required: No ** Tags.Tag.N ** A list of tags. For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*. Type: Array of [Tag](API_Tag.md) objects Required: No ** TargetArn ** The ARN of the Redshift data warehouse used as the target for replication. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/Integration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/Integration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/Integration) # IntegrationError An error associated with a zero-ETL integration with Amazon Redshift. ## Contents **Note** In the following list, the required parameters are described first. ** ErrorCode ** The error code associated with the integration. Type: String Required: Yes ** ErrorMessage ** A message explaining the error. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/IntegrationError) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/IntegrationError) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/IntegrationError) # IPRange This data type is used as a response element in the `DescribeDBSecurityGroups` action. ## Contents **Note** In the following list, the required parameters are described first. ** CIDRIP ** The IP range. Type: String Required: No ** Status ** The status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked". Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/IPRange) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/IPRange) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/IPRange) # IssueDetails The details of an issue with your DB instances, DB clusters, and DB parameter groups. ## Contents **Note** In the following list, the required parameters are described first. ** PerformanceIssueDetails ** A detailed description of the issue when the recommendation category is `performance`. Type: [PerformanceIssueDetails](API_PerformanceIssueDetails.md) object Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/IssueDetails) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/IssueDetails) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/IssueDetails) # LimitlessDatabase Contains details for Aurora Limitless Database. ## Contents **Note** In the following list, the required parameters are described first. ** MinRequiredACU ** The minimum required capacity for Aurora Limitless Database in Aurora capacity units (ACUs). Type: Double Required: No ** Status ** The status of Aurora Limitless Database. Type: String Valid Values: `active | not-in-use | enabled | disabled | enabling | disabling | modifying-max-capacity | error` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/LimitlessDatabase) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/LimitlessDatabase) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/LimitlessDatabase) # MasterUserSecret Contains the secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.* ## Contents **Note** In the following list, the required parameters are described first. ** KmsKeyId ** The AWS KMS key identifier that is used to encrypt the secret. Type: String Required: No ** SecretArn ** The Amazon Resource Name (ARN) of the secret. Type: String Required: No ** SecretStatus ** The status of the secret. The possible status values include the following: + `creating` - The secret is being created. + `active` - The secret is available for normal use and rotation. + `rotating` - The secret is being rotated. + `impaired` - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/MasterUserSecret) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/MasterUserSecret) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/MasterUserSecret) # Metric The representation of a metric. ## Contents **Note** In the following list, the required parameters are described first. ** MetricQuery ** The query to retrieve metric data points. Type: [MetricQuery](API_MetricQuery.md) object Required: No ** Name ** The name of a metric. Type: String Required: No ** References.member.N ** A list of metric references (thresholds). Type: Array of [MetricReference](API_MetricReference.md) objects Required: No ** StatisticsDetails ** The details of different statistics for a metric. The description might contain markdown. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/Metric) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/Metric) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/Metric) # MetricQuery The query to retrieve metric data points. ## Contents **Note** In the following list, the required parameters are described first. ** PerformanceInsightsMetricQuery ** The Performance Insights query that you can use to retrieve Performance Insights metric data points. Type: [PerformanceInsightsMetricQuery](API_PerformanceInsightsMetricQuery.md) object Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/MetricQuery) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/MetricQuery) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/MetricQuery) # MetricReference The reference (threshold) for a metric. ## Contents **Note** In the following list, the required parameters are described first. ** Name ** The name of the metric reference. Type: String Required: No ** ReferenceDetails ** The details of a performance issue. Type: [ReferenceDetails](API_ReferenceDetails.md) object Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/MetricReference) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/MetricReference) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/MetricReference) # MinimumEngineVersionPerAllowedValue The minimum DB engine version required for each corresponding allowed value for an option setting. ## Contents **Note** In the following list, the required parameters are described first. ** AllowedValue ** The allowed value for an option setting. Type: String Required: No ** MinimumEngineVersion ** The minimum DB engine version required for the allowed value. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/MinimumEngineVersionPerAllowedValue) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/MinimumEngineVersionPerAllowedValue) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/MinimumEngineVersionPerAllowedValue) # ModifyAdditionalStorageVolume Contains details about the modification of an additional storage volume. ## Contents **Note** In the following list, the required parameters are described first. ** VolumeName ** The name of the additional storage volume that you want to modify. Valid Values: `RDSDBDATA2 | RDSDBDATA3 | RDSDBDATA4` Type: String Required: Yes ** AllocatedStorage ** The amount of storage allocated for the additional storage volume, in gibibytes (GiB). The minimum is 20 GiB. The maximum is 65,536 GiB (64 TiB). Type: Integer Required: No ** IOPS ** The number of I/O operations per second (IOPS) provisioned for the additional storage volume. This setting is only supported for Provisioned IOPS SSD (`io1` and `io2`) storage types. Type: Integer Required: No ** MaxAllocatedStorage ** The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume. You must provide a value greater than or equal to `AllocatedStorage`. Type: Integer Required: No ** SetForDelete ** Indicates whether to delete the additional storage volume. The value `true` schedules the volume for deletion. You can delete an additional storage volume only when it doesn't contain database files or other data. Type: Boolean Required: No ** StorageThroughput ** The storage throughput value for the additional storage volume, in mebibytes per second (MiBps). This setting applies only to the General Purpose SSD (`gp3`) storage type. Type: Integer Required: No ** StorageType ** The new storage type for the additional storage volume. Valid Values: `GP3 | IO2` Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ModifyAdditionalStorageVolume) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyAdditionalStorageVolume) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ModifyAdditionalStorageVolume) # Option The details of an option. ## Contents **Note** In the following list, the required parameters are described first. ** DBSecurityGroupMemberships.DBSecurityGroup.N ** If the option requires access to a port, then this DB security group allows access to the port. Type: Array of [DBSecurityGroupMembership](API_DBSecurityGroupMembership.md) objects Required: No ** OptionDescription ** The description of the option. Type: String Required: No ** OptionName ** The name of the option. Type: String Required: No ** OptionSettings.OptionSetting.N ** The option settings for this option. Type: Array of [OptionSetting](API_OptionSetting.md) objects Required: No ** OptionVersion ** The version of the option. Type: String Required: No ** Permanent ** Indicates whether this option is permanent. Type: Boolean Required: No ** Persistent ** Indicates whether this option is persistent. Type: Boolean Required: No ** Port ** If required, the port configured for this option to use. Type: Integer Required: No ** VpcSecurityGroupMemberships.VpcSecurityGroupMembership.N ** If the option requires access to a port, then this VPC security group allows access to the port. Type: Array of [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) objects Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/Option) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/Option) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/Option) # OptionConfiguration A list of all available options for an option group. ## Contents **Note** In the following list, the required parameters are described first. ** OptionName ** The configuration of options to include in a group. Type: String Required: Yes ** DBSecurityGroupMemberships.DBSecurityGroupName.N ** A list of DB security groups used for this option. Type: Array of strings Required: No ** OptionSettings.OptionSetting.N ** The option settings to include in an option group. Type: Array of [OptionSetting](API_OptionSetting.md) objects Required: No ** OptionVersion ** The version for the option. Type: String Required: No ** Port ** The optional port for the option. Type: Integer Required: No ** VpcSecurityGroupMemberships.VpcSecurityGroupId.N ** A list of VPC security group names used for this option. Type: Array of strings Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/OptionConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/OptionConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/OptionConfiguration) # OptionGroup ## Contents **Note** In the following list, the required parameters are described first. ** AllowsVpcAndNonVpcInstanceMemberships ** Indicates whether this option group can be applied to both VPC and non-VPC instances. The value `true` indicates the option group can be applied to both VPC and non-VPC instances. Type: Boolean Required: No ** CopyTimestamp ** Indicates when the option group was copied. Type: Timestamp Required: No ** EngineName ** Indicates the name of the engine that this option group can be applied to. Type: String Required: No ** MajorEngineVersion ** Indicates the major engine version associated with this option group. Type: String Required: No ** OptionGroupArn ** Specifies the Amazon Resource Name (ARN) for the option group. Type: String Required: No ** OptionGroupDescription ** Provides a description of the option group. Type: String Required: No ** OptionGroupName ** Specifies the name of the option group. Type: String Required: No ** Options.Option.N ** Indicates what options are available in the option group. Type: Array of [Option](API_Option.md) objects Required: No ** SourceAccountId ** Specifies the AWS account ID for the option group from which this option group is copied. Type: String Required: No ** SourceOptionGroup ** Specifies the name of the option group from which this option group is copied. Type: String Required: No ** VpcId ** If **AllowsVpcAndNonVpcInstanceMemberships** is `false`, this field is blank. If **AllowsVpcAndNonVpcInstanceMemberships** is `true` and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/OptionGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/OptionGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/OptionGroup) # OptionGroupMembership Provides information on the option groups the DB instance is a member of. ## Contents **Note** In the following list, the required parameters are described first. ** OptionGroupName ** The name of the option group that the instance belongs to. Type: String Required: No ** Status ** The status of the DB instance's option group membership. Valid values are: `in-sync`, `pending-apply`, `pending-removal`, `pending-maintenance-apply`, `pending-maintenance-removal`, `applying`, `removing`, and `failed`. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/OptionGroupMembership) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/OptionGroupMembership) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/OptionGroupMembership) # OptionGroupOption Available option. ## Contents **Note** In the following list, the required parameters are described first. ** CopyableCrossAccount ** Indicates whether the option can be copied across AWS accounts. Type: Boolean Required: No ** DefaultPort ** If the option requires a port, specifies the default port for the option. Type: Integer Required: No ** Description ** The description of the option. Type: String Required: No ** EngineName ** The name of the engine that this option can be applied to. Type: String Required: No ** MajorEngineVersion ** Indicates the major engine version that the option is available for. Type: String Required: No ** MinimumRequiredMinorEngineVersion ** The minimum required engine version for the option to be applied. Type: String Required: No ** Name ** The name of the option. Type: String Required: No ** OptionGroupOptionSettings.OptionGroupOptionSetting.N ** The option settings that are available (and the default value) for each option in an option group. Type: Array of [OptionGroupOptionSetting](API_OptionGroupOptionSetting.md) objects Required: No ** OptionGroupOptionVersions.OptionVersion.N ** The versions that are available for the option. Type: Array of [OptionVersion](API_OptionVersion.md) objects Required: No ** OptionsConflictsWith.OptionConflictName.N ** The options that conflict with this option. Type: Array of strings Required: No ** OptionsDependedOn.OptionName.N ** The options that are prerequisites for this option. Type: Array of strings Required: No ** Permanent ** Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance. Type: Boolean Required: No ** Persistent ** Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group. Type: Boolean Required: No ** PortRequired ** Indicates whether the option requires a port. Type: Boolean Required: No ** RequiresAutoMinorEngineVersionUpgrade ** If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later. Type: Boolean Required: No ** SupportsOptionVersionDowngrade ** If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available. Type: Boolean Required: No ** VpcOnly ** If true, you can only use this option with a DB instance that is in a VPC. Type: Boolean Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/OptionGroupOption) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/OptionGroupOption) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/OptionGroupOption) # OptionGroupOptionSetting 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. ## Contents **Note** In the following list, the required parameters are described first. ** AllowedValues ** Indicates the acceptable values for the option group option. Type: String Required: No ** ApplyType ** The DB engine specific parameter type for the option group option. Type: String Required: No ** DefaultValue ** The default value for the option group option. Type: String Required: No ** IsModifiable ** Indicates whether this option group option can be changed from the default value. Type: Boolean Required: No ** IsRequired ** Indicates whether a value must be specified for this option setting of the option group option. Type: Boolean Required: No ** MinimumEngineVersionPerAllowedValue.MinimumEngineVersionPerAllowedValue.N ** The minimum DB engine version required for the corresponding allowed value for this option setting. Type: Array of [MinimumEngineVersionPerAllowedValue](API_MinimumEngineVersionPerAllowedValue.md) objects Required: No ** SettingDescription ** The description of the option group option. Type: String Required: No ** SettingName ** The name of the option group option. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/OptionGroupOptionSetting) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/OptionGroupOptionSetting) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/OptionGroupOptionSetting) # OptionSetting 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\$1NETWORK\$1ENCRYPTION option has a setting called SQLNET.ENCRYPTION\$1SERVER that can have several different values. ## Contents **Note** In the following list, the required parameters are described first. ** AllowedValues ** The allowed values of the option setting. Type: String Required: No ** ApplyType ** The DB engine specific parameter type. Type: String Required: No ** DataType ** The data type of the option setting. Type: String Required: No ** DefaultValue ** The default value of the option setting. Type: String Required: No ** Description ** The description of the option setting. Type: String Required: No ** IsCollection ** Indicates whether the option setting is part of a collection. Type: Boolean Required: No ** IsModifiable ** Indicates whether the option setting can be modified from the default. Type: Boolean Required: No ** Name ** The name of the option that has settings that you can set. Type: String Required: No ** Value ** The current value of the option setting. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/OptionSetting) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/OptionSetting) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/OptionSetting) # OptionVersion The version for an option. Option group option versions are returned by the `DescribeOptionGroupOptions` action. ## Contents **Note** In the following list, the required parameters are described first. ** IsDefault ** Indicates whether the version is the default version of the option. Type: Boolean Required: No ** Version ** The version of the option. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/OptionVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/OptionVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/OptionVersion) # OrderableDBInstanceOption Contains a list of available options for a DB instance. This data type is used as a response element in the `DescribeOrderableDBInstanceOptions` action. ## Contents **Note** In the following list, the required parameters are described first. ** AvailabilityZoneGroup ** The Availability Zone group for a DB instance. Type: String Required: No ** AvailabilityZones.AvailabilityZone.N ** A list of Availability Zones for a DB instance. Type: Array of [AvailabilityZone](API_AvailabilityZone.md) objects Required: No ** AvailableAdditionalStorageVolumesOptions.AvailableAdditionalStorageVolumesOption.N ** The available options for additional storage volumes for the DB instance class. Type: Array of [AvailableAdditionalStorageVolumesOption](API_AvailableAdditionalStorageVolumesOption.md) objects Required: No ** AvailableProcessorFeatures.AvailableProcessorFeature.N ** A list of the available processor features for the DB instance class of a DB instance. Type: Array of [AvailableProcessorFeature](API_AvailableProcessorFeature.md) objects Required: No ** DBInstanceClass ** The DB instance class for a DB instance. Type: String Required: No ** Engine ** The engine type of a DB instance. Type: String Required: No ** EngineVersion ** The engine version of a DB instance. Type: String Required: No ** LicenseModel ** The license model for a DB instance. Type: String Required: No ** MaxIopsPerDbInstance ** Maximum total provisioned IOPS for a DB instance. Type: Integer Required: No ** MaxIopsPerGib ** Maximum provisioned IOPS per GiB for a DB instance. Type: Double Required: No ** MaxStorageSize ** Maximum storage size for a DB instance. Type: Integer Required: No ** MaxStorageThroughputPerDbInstance ** Maximum storage throughput for a DB instance. Type: Integer Required: No ** MaxStorageThroughputPerIops ** Maximum storage throughput to provisioned IOPS ratio for a DB instance. Type: Double Required: No ** MinIopsPerDbInstance ** Minimum total provisioned IOPS for a DB instance. Type: Integer Required: No ** MinIopsPerGib ** Minimum provisioned IOPS per GiB for a DB instance. Type: Double Required: No ** MinStorageSize ** Minimum storage size for a DB instance. Type: Integer Required: No ** MinStorageThroughputPerDbInstance ** Minimum storage throughput for a DB instance. Type: Integer Required: No ** MinStorageThroughputPerIops ** Minimum storage throughput to provisioned IOPS ratio for a DB instance. Type: Double Required: No ** MultiAZCapable ** Indicates whether a DB instance is Multi-AZ capable. Type: Boolean Required: No ** OutpostCapable ** Indicates whether a DB instance supports RDS on Outposts. For more information about RDS on Outposts, see [Amazon RDS on AWS Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in the *Amazon RDS User Guide.* Type: Boolean Required: No ** ReadReplicaCapable ** Indicates whether a DB instance can have a read replica. Type: Boolean Required: No ** StorageType ** The storage type for a DB instance. Type: String Required: No ** SupportedActivityStreamModes.member.N ** The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value `[sync, async]`. Aurora MySQL and RDS for Oracle return `[async]` only. If Database Activity Streams isn't supported, the return value is an empty list. Type: Array of strings Required: No ** SupportedEngineModes.member.N ** A list of the supported DB engine modes. Type: Array of strings Required: No ** SupportedNetworkTypes.member.N ** The network types supported by the DB instance (`IPV4` or `DUAL`). A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (`DUAL`). For more information, see [ Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.* Type: Array of strings Required: No ** SupportsAdditionalStorageVolumes ** Indicates whether the DB instance class supports additional storage volumes. Type: Boolean Required: No ** SupportsClusters ** Indicates whether DB instances can be configured as a Multi-AZ DB cluster. For more information on Multi-AZ DB clusters, see [ Multi-AZ deployments with two readable standby DB instances](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide.* Type: Boolean Required: No ** SupportsDedicatedLogVolume ** Indicates whether a DB instance supports using a dedicated log volume (DLV). Type: Boolean Required: No ** SupportsEnhancedMonitoring ** Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds. Type: Boolean Required: No ** SupportsGlobalDatabases ** Indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes. Type: Boolean Required: No ** SupportsHttpEndpoint ** Indicates whether a DB instance supports HTTP endpoints. Type: Boolean Required: No ** SupportsIAMDatabaseAuthentication ** Indicates whether a DB instance supports IAM database authentication. Type: Boolean Required: No ** SupportsIops ** Indicates whether a DB instance supports provisioned IOPS. Type: Boolean Required: No ** SupportsKerberosAuthentication ** Indicates whether a DB instance supports Kerberos Authentication. Type: Boolean Required: No ** SupportsPerformanceInsights ** Indicates whether a DB instance supports Performance Insights. Type: Boolean Required: No ** SupportsStorageAutoscaling ** Indicates whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class. Type: Boolean Required: No ** SupportsStorageEncryption ** Indicates whether a DB instance supports encrypted storage. Type: Boolean Required: No ** SupportsStorageThroughput ** Indicates whether a DB instance supports storage throughput. Type: Boolean Required: No ** Vpc ** Indicates whether a DB instance is in a VPC. Type: Boolean Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/OrderableDBInstanceOption) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/OrderableDBInstanceOption) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/OrderableDBInstanceOption) # Outpost A data type that represents an Outpost. For more information about RDS on Outposts, see [Amazon RDS on AWS Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in the *Amazon RDS User Guide.* ## Contents **Note** In the following list, the required parameters are described first. ** Arn ** The Amazon Resource Name (ARN) of the Outpost. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/Outpost) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/Outpost) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/Outpost) # Parameter 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. ## Contents **Note** In the following list, the required parameters are described first. ** AllowedValues ** Specifies the valid range of values for the parameter. Type: String Required: No ** ApplyMethod ** Indicates when to apply parameter updates. Type: String Valid Values: `immediate | pending-reboot` Required: No ** ApplyType ** Specifies the engine specific parameters type. Type: String Required: No ** DataType ** Specifies the valid data type for the parameter. Type: String Required: No ** Description ** Provides a description of the parameter. Type: String Required: No ** IsModifiable ** Indicates whether (`true`) or not (`false`) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed. Type: Boolean Required: No ** MinimumEngineVersion ** The earliest engine version to which the parameter can apply. Type: String Required: No ** ParameterName ** The name of the parameter. Type: String Required: No ** ParameterValue ** The value of the parameter. Type: String Required: No ** Source ** The source of the parameter value. Type: String Required: No ** SupportedEngineModes.member.N ** The valid DB engine modes. Type: Array of strings Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/Parameter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/Parameter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/Parameter) # PendingCloudwatchLogsExports 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. ## Contents **Note** In the following list, the required parameters are described first. ** LogTypesToDisable.member.N ** Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs. Type: Array of strings Required: No ** LogTypesToEnable.member.N ** Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs. Type: Array of strings Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/PendingCloudwatchLogsExports) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/PendingCloudwatchLogsExports) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/PendingCloudwatchLogsExports) # PendingMaintenanceAction Provides information about a pending maintenance action for a resource. ## Contents **Note** In the following list, the required parameters are described first. ** Action ** The type of pending maintenance action that is available for the resource. For more information about maintenance actions, see [Maintaining a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html). Valid Values: + `ca-certificate-rotation` + `db-upgrade` + `hardware-maintenance` + `os-upgrade` + `serverless-platform-version-update` + `system-update` For more information about these actions, see [Maintenance actions for Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#maintenance-actions-aurora) or [Maintenance actions for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#maintenance-actions-rds). Type: String Required: No ** AutoAppliedAfterDate ** 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. Type: Timestamp Required: No ** CurrentApplyDate ** 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`. Type: Timestamp Required: No ** Description ** A description providing more detail about the maintenance action. Type: String Required: No ** ForcedApplyDate ** The date when the maintenance action is automatically applied. On this date, the maintenance action is applied to the resource as soon as possible, regardless of the maintenance window for the resource. There might be a delay of one or more days from this date before the maintenance action is applied. Type: Timestamp Required: No ** OptInStatus ** Indicates the type of opt-in request that has been received for the resource. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/PendingMaintenanceAction) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/PendingMaintenanceAction) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/PendingMaintenanceAction) # PendingModifiedValues 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. ## Contents **Note** In the following list, the required parameters are described first. ** AdditionalStorageVolumes.member.N ** The additional storage volume modifications that are pending for the DB instance. Type: Array of [AdditionalStorageVolume](API_AdditionalStorageVolume.md) objects Required: No ** AllocatedStorage ** The allocated storage size for the DB instance specified in gibibytes (GiB). Type: Integer Required: No ** AutomationMode ** The automation mode of the RDS Custom DB instance: `full` or `all-paused`. If `full`, the DB instance automates monitoring and instance recovery. If `all-paused`, the instance pauses automation for the duration set by `--resume-full-automation-mode-minutes`. Type: String Valid Values: `full | all-paused` Required: No ** BackupRetentionPeriod ** The number of days for which automated backups are retained. Type: Integer Required: No ** CACertificateIdentifier ** The identifier of the CA certificate for the DB instance. For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [ Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*. Type: String Required: No ** DBInstanceClass ** The name of the compute and memory capacity class for the DB instance. Type: String Required: No ** DBInstanceIdentifier ** The database identifier for the DB instance. Type: String Required: No ** DBSubnetGroupName ** The DB subnet group for the DB instance. Type: String Required: No ** DedicatedLogVolume ** Indicates whether the DB instance has a dedicated log volume (DLV) enabled.> Type: Boolean Required: No ** Engine ** The database engine of the DB instance. Type: String Required: No ** EngineVersion ** The database engine version. Type: String Required: No ** IAMDatabaseAuthenticationEnabled ** Indicates whether mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Type: Boolean Required: No ** Iops ** The Provisioned IOPS value for the DB instance. Type: Integer Required: No ** LicenseModel ** The license model for the DB instance. Valid values: `license-included` \$1 `bring-your-own-license` \$1 `general-public-license` Type: String Required: No ** MasterUserPassword ** The master credentials for the DB instance. Type: String Required: No ** MultiAZ ** Indicates whether the Single-AZ DB instance will change to a Multi-AZ deployment. Type: Boolean Required: No ** MultiTenant ** Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). Type: Boolean Required: No ** PendingCloudwatchLogsExports ** 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. Type: [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md) object Required: No ** Port ** The port for the DB instance. Type: Integer Required: No ** ProcessorFeatures.ProcessorFeature.N ** The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. Type: Array of [ProcessorFeature](API_ProcessorFeature.md) objects Required: No ** ResumeFullAutomationModeTime ** The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440. Type: Timestamp Required: No ** StorageThroughput ** The storage throughput of the DB instance. Type: Integer Required: No ** StorageType ** The storage type of the DB instance. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/PendingModifiedValues) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/PendingModifiedValues) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/PendingModifiedValues) # PerformanceInsightsMetricDimensionGroup 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. **Note** Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned. ## Contents **Note** In the following list, the required parameters are described first. ** Dimensions.member.N ** A list of specific dimensions from a dimension group. If this list isn't included, then all of the dimensions in the group were requested, or are present in the response. Type: Array of strings Required: No ** Group ** The available dimension groups for Performance Insights metric type. Type: String Required: No ** Limit ** The maximum number of items to fetch for this dimension group. Type: Integer Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/PerformanceInsightsMetricDimensionGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/PerformanceInsightsMetricDimensionGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/PerformanceInsightsMetricDimensionGroup) # PerformanceInsightsMetricQuery 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. ## Contents **Note** In the following list, the required parameters are described first. ** GroupBy ** A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension. Type: [PerformanceInsightsMetricDimensionGroup](API_PerformanceInsightsMetricDimensionGroup.md) object Required: No ** Metric ** The name of a Performance Insights metric to be measured. Valid Values: + `db.load.avg` - A scaled representation of the number of active sessions for the database engine. + `db.sampledload.avg` - The raw number of active sessions for the database engine. + The counter metrics listed in [Performance Insights operating system counters](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights_Counters.html#USER_PerfInsights_Counters.OS) in the *Amazon Aurora User Guide*. If the number of active sessions is less than an internal Performance Insights threshold, `db.load.avg` and `db.sampledload.avg` are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with `db.load.avg` showing the scaled values, `db.sampledload.avg` showing the raw values, and `db.sampledload.avg` less than `db.load.avg`. For most use cases, you can query `db.load.avg` only. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/PerformanceInsightsMetricQuery) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/PerformanceInsightsMetricQuery) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/PerformanceInsightsMetricQuery) # PerformanceIssueDetails Details of the performance issue. ## Contents **Note** In the following list, the required parameters are described first. ** Analysis ** The analysis of the performance issue. The information might contain markdown. Type: String Required: No ** EndTime ** The time when the performance issue stopped. Type: Timestamp Required: No ** Metrics.member.N ** The metrics that are relevant to the performance issue. Type: Array of [Metric](API_Metric.md) objects Required: No ** StartTime ** The time when the performance issue started. Type: Timestamp Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/PerformanceIssueDetails) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/PerformanceIssueDetails) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/PerformanceIssueDetails) # ProcessorFeature 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor), [ Optimizing your RDS for SQL Server CPU](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.Concepts.General.OptimizeCPU.html), and [DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide. * ## Contents **Note** In the following list, the required parameters are described first. ** Name ** The name of the processor feature. Valid names are `coreCount` and `threadsPerCore`. Type: String Required: No ** Value ** The value of a processor feature. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ProcessorFeature) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ProcessorFeature) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ProcessorFeature) # Range A range of integer values. ## Contents **Note** In the following list, the required parameters are described first. ** From ** The minimum value in the range. Type: Integer Required: No ** Step ** 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... Type: Integer Required: No ** To ** The maximum value in the range. Type: Integer Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/Range) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/Range) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/Range) # RdsCustomClusterConfiguration Reserved for future use. ## Contents **Note** In the following list, the required parameters are described first. ** InterconnectSubnetId ** Reserved for future use. Type: String Required: No ** ReplicaMode ** Reserved for future use. Type: String Valid Values: `open-read-only | mounted` Required: No ** TransitGatewayMulticastDomainId ** Reserved for future use. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/RdsCustomClusterConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/RdsCustomClusterConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/RdsCustomClusterConfiguration) # RecommendedAction The recommended actions to apply to resolve the issues associated with your DB instances, DB clusters, and DB parameter groups. ## Contents **Note** In the following list, the required parameters are described first. ** ActionId ** The unique identifier of the recommended action. Type: String Required: No ** ApplyModes.member.N ** The methods to apply the recommended action. Valid values: + `manual` - The action requires you to resolve the recommendation manually. + `immediately` - The action is applied immediately. + `next-maintainance-window` - The action is applied during the next scheduled maintainance. Type: Array of strings Required: No ** ContextAttributes.member.N ** The supporting attributes to explain the recommended action. Type: Array of [ContextAttribute](API_ContextAttribute.md) objects Required: No ** Description ** A detailed description of the action. The description might contain markdown. Type: String Required: No ** IssueDetails ** The details of the issue. Type: [IssueDetails](API_IssueDetails.md) object Required: No ** Operation ** An API operation for the action. Type: String Required: No ** Parameters.member.N ** The parameters for the API operation. Type: Array of [RecommendedActionParameter](API_RecommendedActionParameter.md) objects Required: No ** Status ** The status of the action. + `ready` + `applied` + `scheduled` + `resolved` Type: String Required: No ** Title ** A short description to summarize the action. The description might contain markdown. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/RecommendedAction) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/RecommendedAction) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/RecommendedAction) # RecommendedActionParameter A single parameter to use with the `RecommendedAction` API operation to apply the action. ## Contents **Note** In the following list, the required parameters are described first. ** Key ** The key of the parameter to use with the `RecommendedAction` API operation. Type: String Required: No ** Value ** The value of the parameter to use with the `RecommendedAction` API operation. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/RecommendedActionParameter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/RecommendedActionParameter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/RecommendedActionParameter) # RecommendedActionUpdate The recommended status to update for the specified recommendation action ID. ## Contents **Note** In the following list, the required parameters are described first. ** ActionId ** A unique identifier of the updated recommendation action. Type: String Required: Yes ** Status ** The status of the updated recommendation action. + `applied` + `scheduled` Type: String Required: Yes ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/RecommendedActionUpdate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/RecommendedActionUpdate) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/RecommendedActionUpdate) # RecurringCharge This data type is used as a response element in the `DescribeReservedDBInstances` and `DescribeReservedDBInstancesOfferings` actions. ## Contents **Note** In the following list, the required parameters are described first. ** RecurringChargeAmount ** The amount of the recurring charge. Type: Double Required: No ** RecurringChargeFrequency ** The frequency of the recurring charge. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/RecurringCharge) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/RecurringCharge) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/RecurringCharge) # ReferenceDetails The reference details of a metric. ## Contents **Note** In the following list, the required parameters are described first. ** ScalarReferenceDetails ** The metric reference details when the reference is a scalar. Type: [ScalarReferenceDetails](API_ScalarReferenceDetails.md) object Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ReferenceDetails) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ReferenceDetails) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ReferenceDetails) # ReservedDBInstance This data type is used as a response element in the `DescribeReservedDBInstances` and `PurchaseReservedDBInstancesOffering` actions. ## Contents **Note** In the following list, the required parameters are described first. ** CurrencyCode ** The currency code for the reserved DB instance. Type: String Required: No ** DBInstanceClass ** The DB instance class for the reserved DB instance. Type: String Required: No ** DBInstanceCount ** The number of reserved DB instances. Type: Integer Required: No ** Duration ** The duration of the reservation in seconds. Type: Integer Required: No ** FixedPrice ** The fixed price charged for this reserved DB instance. Type: Double Required: No ** LeaseId ** The unique identifier for the lease associated with the reserved DB instance. AWS Support might request the lease ID for an issue related to a reserved DB instance. Type: String Required: No ** MultiAZ ** Indicates whether the reservation applies to Multi-AZ deployments. Type: Boolean Required: No ** OfferingType ** The offering type of this reserved DB instance. Type: String Required: No ** ProductDescription ** The description of the reserved DB instance. Type: String Required: No ** RecurringCharges.RecurringCharge.N ** The recurring price charged to run this reserved DB instance. Type: Array of [RecurringCharge](API_RecurringCharge.md) objects Required: No ** ReservedDBInstanceArn ** The Amazon Resource Name (ARN) for the reserved DB instance. Type: String Required: No ** ReservedDBInstanceId ** The unique identifier for the reservation. Type: String Required: No ** ReservedDBInstancesOfferingId ** The offering identifier. Type: String Required: No ** StartTime ** The time the reservation started. Type: Timestamp Required: No ** State ** The state of the reserved DB instance. Type: String Required: No ** UsagePrice ** The hourly price charged for this reserved DB instance. Type: Double Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ReservedDBInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ReservedDBInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ReservedDBInstance) # ReservedDBInstancesOffering This data type is used as a response element in the `DescribeReservedDBInstancesOfferings` action. ## Contents **Note** In the following list, the required parameters are described first. ** CurrencyCode ** The currency code for the reserved DB instance offering. Type: String Required: No ** DBInstanceClass ** The DB instance class for the reserved DB instance. Type: String Required: No ** Duration ** The duration of the offering in seconds. Type: Integer Required: No ** FixedPrice ** The fixed price charged for this offering. Type: Double Required: No ** MultiAZ ** Indicates whether the offering applies to Multi-AZ deployments. Type: Boolean Required: No ** OfferingType ** The offering type. Type: String Required: No ** ProductDescription ** The database engine used by the offering. Type: String Required: No ** RecurringCharges.RecurringCharge.N ** The recurring price charged to run this reserved DB instance. Type: Array of [RecurringCharge](API_RecurringCharge.md) objects Required: No ** ReservedDBInstancesOfferingId ** The offering identifier. Type: String Required: No ** UsagePrice ** The hourly price charged for this offering. Type: Double Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ReservedDBInstancesOffering) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ReservedDBInstancesOffering) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ReservedDBInstancesOffering) # ResourcePendingMaintenanceActions Describes the pending maintenance actions for a resource. ## Contents **Note** In the following list, the required parameters are described first. ** PendingMaintenanceActionDetails.PendingMaintenanceAction.N ** A list that provides details about the pending maintenance actions for the resource. Type: Array of [PendingMaintenanceAction](API_PendingMaintenanceAction.md) objects Required: No ** ResourceIdentifier ** The ARN of the resource that has pending maintenance actions. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ResourcePendingMaintenanceActions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ResourcePendingMaintenanceActions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ResourcePendingMaintenanceActions) # RestoreWindow Earliest and latest time an instance can be restored to: ## Contents **Note** In the following list, the required parameters are described first. ** EarliestTime ** The earliest time you can restore an instance to. Type: Timestamp Required: No ** LatestTime ** The latest time you can restore an instance to. Type: Timestamp Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/RestoreWindow) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/RestoreWindow) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/RestoreWindow) # ScalarReferenceDetails The metric reference details when the reference is a scalar. ## Contents **Note** In the following list, the required parameters are described first. ** Value ** The value of a scalar reference. Type: Double Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ScalarReferenceDetails) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ScalarReferenceDetails) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ScalarReferenceDetails) # ScalingConfiguration Contains the scaling configuration of an Aurora Serverless v1 DB cluster. For more information, see [Using Amazon Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) in the *Amazon Aurora User Guide*. ## Contents **Note** In the following list, the required parameters are described first. ** AutoPause ** Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in `serverless` DB engine mode. A DB cluster can be paused only when it's idle (it has no connections). If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it. Type: Boolean Required: No ** MaxCapacity ** The maximum capacity for an Aurora DB cluster in `serverless` DB engine mode. For Aurora MySQL, valid capacity values are `1`, `2`, `4`, `8`, `16`, `32`, `64`, `128`, and `256`. For Aurora PostgreSQL, valid capacity values are `2`, `4`, `8`, `16`, `32`, `64`, `192`, and `384`. The maximum capacity must be greater than or equal to the minimum capacity. Type: Integer Required: No ** MinCapacity ** The minimum capacity for an Aurora DB cluster in `serverless` DB engine mode. For Aurora MySQL, valid capacity values are `1`, `2`, `4`, `8`, `16`, `32`, `64`, `128`, and `256`. For Aurora PostgreSQL, valid capacity values are `2`, `4`, `8`, `16`, `32`, `64`, `192`, and `384`. The minimum capacity must be less than or equal to the maximum capacity. Type: Integer Required: No ** SecondsBeforeTimeout ** The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300. Specify a value between 60 and 600 seconds. Type: Integer Required: No ** SecondsUntilAutoPause ** The time, in seconds, before an Aurora DB cluster in `serverless` mode is paused. Specify a value between 300 and 86,400 seconds. Type: Integer Required: No ** TimeoutAction ** The action to take when the timeout is reached, either `ForceApplyCapacityChange` or `RollbackCapacityChange`. `ForceApplyCapacityChange` sets the capacity to the specified value as soon as possible. `RollbackCapacityChange`, the default, ignores the capacity change if a scaling point isn't found in the timeout period. If you specify `ForceApplyCapacityChange`, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information, see [ Autoscaling for Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling) in the *Amazon Aurora User Guide*. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ScalingConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ScalingConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ScalingConfiguration) # ScalingConfigurationInfo The scaling configuration for an Aurora DB cluster in `serverless` DB engine mode. For more information, see [Using Amazon Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) in the *Amazon Aurora User Guide*. ## Contents **Note** In the following list, the required parameters are described first. ** AutoPause ** Indicates whether automatic pause is allowed for the Aurora DB cluster in `serverless` DB engine mode. When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes. Type: Boolean Required: No ** MaxCapacity ** The maximum capacity for an Aurora DB cluster in `serverless` DB engine mode. Type: Integer Required: No ** MinCapacity ** The minimum capacity for an Aurora DB cluster in `serverless` DB engine mode. Type: Integer Required: No ** SecondsBeforeTimeout ** The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the `TimeoutAction` setting. Type: Integer Required: No ** SecondsUntilAutoPause ** The remaining amount of time, in seconds, before the Aurora DB cluster in `serverless` mode is paused. A DB cluster can be paused only when it's idle (it has no connections). Type: Integer Required: No ** TimeoutAction ** The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either `ForceApplyCapacityChange` or `RollbackCapacityChange`. `ForceApplyCapacityChange`, the default, sets the capacity to the specified value as soon as possible. `RollbackCapacityChange` ignores the capacity change if a scaling point isn't found in the timeout period. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ScalingConfigurationInfo) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ScalingConfigurationInfo) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ScalingConfigurationInfo) # ServerlessV2FeaturesSupport 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. ## Contents **Note** In the following list, the required parameters are described first. ** MaxCapacity ** Specifies the upper Aurora Serverless v2 capacity limit for a particular engine version or platform version. Depending on the engine version, the maximum capacity for an Aurora Serverless v2 cluster might be `256` or `128`. Type: Double Required: No ** MinCapacity ** If the minimum capacity is 0 ACUs, the engine version or platform version supports the automatic pause/resume feature of Aurora Serverless v2. Type: Double Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ServerlessV2FeaturesSupport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ServerlessV2FeaturesSupport) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ServerlessV2FeaturesSupport) # ServerlessV2PlatformVersionInfo This data type is used as a response element in the action `DescribeServerlessV2PlatformVersions`. ## Contents **Note** In the following list, the required parameters are described first. ** Engine ** The name of the database engine. Type: String Required: No ** IsDefault ** Indicates whether this platform version is the default version for the engine. The default platform version is the version used for new DB clusters. Type: Boolean Required: No ** ServerlessV2FeaturesSupport ** Specifies any Aurora Serverless v2 properties or limits that differ between Aurora Serverless v2 platform versions. You can retrieve the platform version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features. Type: [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md) object Required: No ** ServerlessV2PlatformVersion ** The version number of the serverless platform. Type: String Required: No ** ServerlessV2PlatformVersionDescription ** The description of the serverless platform. Type: String Required: No ** Status ** The status of the serverless platform. Valid statuses are the following: + `enabled` - The platform version is in use. + `disabled` - The platform version is not in use. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ServerlessV2PlatformVersionInfo) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ServerlessV2PlatformVersionInfo) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ServerlessV2PlatformVersionInfo) # ServerlessV2ScalingConfiguration Contains the scaling configuration of an Aurora Serverless v2 DB cluster. For more information, see [Using Amazon Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) in the *Amazon Aurora User Guide*. ## Contents **Note** In the following list, the required parameters are described first. ** MaxCapacity ** The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 32, 32.5, 33, and so on. The largest value that you can use is 256 for recent Aurora versions, or 128 for older versions. You can check the attributes of your engine version or platform version to determine the specific maximum capacity supported. Type: Double Required: No ** MinCapacity ** The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5. Type: Double Required: No ** SecondsUntilAutoPause ** Specifies the number of seconds an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it. Specify a value between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 seconds. Type: Integer Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ServerlessV2ScalingConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ServerlessV2ScalingConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ServerlessV2ScalingConfiguration) # ServerlessV2ScalingConfigurationInfo The scaling configuration for an Aurora Serverless v2 DB cluster. For more information, see [Using Amazon Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) in the *Amazon Aurora User Guide*. ## Contents **Note** In the following list, the required parameters are described first. ** MaxCapacity ** The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 32, 32.5, 33, and so on. The largest value that you can use is 256 for recent Aurora versions, or 128 for older versions. You can check the attributes of your engine version or platform version to determine the specific maximum capacity supported. Type: Double Required: No ** MinCapacity ** The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5. Type: Double Required: No ** SecondsUntilAutoPause ** The number of seconds an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it. This property is only shown when the minimum capacity for the cluster is set to 0 ACUs. Changing the minimum capacity to a nonzero value removes this property. If you later change the minimum capacity back to 0 ACUs, this property is reset to its default value unless you specify it again. This value ranges between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 seconds. Type: Integer Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ServerlessV2ScalingConfigurationInfo) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ServerlessV2ScalingConfigurationInfo) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ServerlessV2ScalingConfigurationInfo) # SourceRegion Contains an AWS Region name as the result of a successful call to the `DescribeSourceRegions` action. ## Contents **Note** In the following list, the required parameters are described first. ** Endpoint ** The endpoint for the source AWS Region endpoint. Type: String Required: No ** RegionName ** The name of the source AWS Region. Type: String Required: No ** Status ** The status of the source AWS Region. Type: String Required: No ** SupportsDBInstanceAutomatedBackupsReplication ** Indicates whether the source AWS Region supports replicating automated backups to the current AWS Region. Type: Boolean Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/SourceRegion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/SourceRegion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/SourceRegion) # Subnet This data type is used as a response element for the `DescribeDBSubnetGroups` operation. ## Contents **Note** In the following list, the required parameters are described first. ** SubnetAvailabilityZone ** Contains Availability Zone information. This data type is used as an element in the `OrderableDBInstanceOption` data type. Type: [AvailabilityZone](API_AvailabilityZone.md) object Required: No ** SubnetIdentifier ** The identifier of the subnet. Type: String Required: No ** SubnetOutpost ** If the subnet is associated with an Outpost, this value specifies the Outpost. For more information about RDS on Outposts, see [Amazon RDS on AWS Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in the *Amazon RDS User Guide.* Type: [Outpost](API_Outpost.md) object Required: No ** SubnetStatus ** The status of the subnet. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/Subnet) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/Subnet) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/Subnet) # SupportedEngineLifecycle 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. ## Contents **Note** In the following list, the required parameters are described first. ** LifecycleSupportEndDate ** The end date for the type of support returned by `LifecycleSupportName`. Type: Timestamp Required: Yes ** LifecycleSupportName ** The type of lifecycle support that the engine version is in. This parameter returns the following values: + `open-source-rds-standard-support` - Indicates RDS standard support or Aurora standard support. + `open-source-rds-extended-support` - Indicates Amazon RDS Extended Support. For Amazon RDS for MySQL, Amazon RDS for PostgreSQL, Aurora MySQL, and Aurora PostgreSQL, this parameter returns both `open-source-rds-standard-support` and `open-source-rds-extended-support`. For Amazon RDS for MariaDB, this parameter only returns the value `open-source-rds-standard-support`. For information about Amazon RDS Extended Support, see [Amazon RDS Extended Support with Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide* and [Amazon RDS Extended Support with Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html) in the *Amazon Aurora User Guide*. Type: String Valid Values: `open-source-rds-standard-support | open-source-rds-extended-support` Required: Yes ** LifecycleSupportStartDate ** The start date for the type of support returned by `LifecycleSupportName`. Type: Timestamp Required: Yes ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/SupportedEngineLifecycle) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/SupportedEngineLifecycle) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/SupportedEngineLifecycle) # SwitchoverDetail Contains the details about a blue/green deployment. For more information, see [Using Amazon RDS Blue/Green Deployments for database updates](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) in the *Amazon RDS User Guide* and [Using Amazon RDS Blue/Green Deployments for database updates](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) in the *Amazon Aurora User Guide*. ## Contents **Note** In the following list, the required parameters are described first. ** SourceMember ** The Amazon Resource Name (ARN) of a resource in the blue environment. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:[A-Za-z][0-9A-Za-z-:._]*` Required: No ** Status ** The switchover status of a resource in a blue/green deployment. Values: + `PROVISIONING` - The resource is being prepared to switch over. + `AVAILABLE` - The resource is ready to switch over. + `SWITCHOVER_IN_PROGRESS` - The resource is being switched over. + `SWITCHOVER_COMPLETED` - The resource has been switched over. + `SWITCHOVER_FAILED` - The resource attempted to switch over but failed. + `MISSING_SOURCE` - The source resource has been deleted. + `MISSING_TARGET` - The target resource has been deleted. Type: String Required: No ** TargetMember ** The Amazon Resource Name (ARN) of a resource in the green environment. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:[A-Za-z][0-9A-Za-z-:._]*` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/SwitchoverDetail) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/SwitchoverDetail) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/SwitchoverDetail) # Tag Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*. ## Contents **Note** In the following list, the required parameters are described first. ** Key ** A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with `aws:` or `rds:`. The string can only contain only the set of Unicode letters, digits, white-space, '\$1', '.', ':', '/', '=', '\$1', '-', '@' (Java regex: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-@]\$1)\$1"). Type: String Required: No ** Value ** A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with `aws:` or `rds:`. The string can only contain only the set of Unicode letters, digits, white-space, '\$1', '.', ':', '/', '=', '\$1', '-', '@' (Java regex: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-@]\$1)\$1"). Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/Tag) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/Tag) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/Tag) # TagSpecification 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. ## Contents **Note** In the following list, the required parameters are described first. ** ResourceType ** The type of resource to tag on creation. Valid Values: + `auto-backup` - The DB instance's automated backup. + `cluster-auto-backup` - The DB cluster's automated backup. Type: String Required: No ** Tags.Tag.N ** A list of tags. For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*. Type: Array of [Tag](API_Tag.md) objects Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/TagSpecification) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/TagSpecification) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/TagSpecification) # TargetHealth Information about the connection health of an RDS Proxy target. ## Contents **Note** In the following list, the required parameters are described first. ** Description ** A description of the health of the RDS Proxy target. If the `State` is `AVAILABLE`, a description is not included. Type: String Required: No ** Reason ** The reason for the current health `State` of the RDS Proxy target. Type: String Valid Values: `UNREACHABLE | CONNECTION_FAILED | AUTH_FAILURE | PENDING_PROXY_CAPACITY | INVALID_REPLICATION_STATE | PROMOTED` Required: No ** State ** The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target: `registering` > `unavailable` > `available` > `unavailable` > `available` Type: String Valid Values: `REGISTERING | AVAILABLE | UNAVAILABLE | UNUSED` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/TargetHealth) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/TargetHealth) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/TargetHealth) # TenantDatabase A tenant database in the DB instance. This data type is an element in the response to the `DescribeTenantDatabases` action. ## Contents **Note** In the following list, the required parameters are described first. ** CharacterSetName ** The character set of the tenant database. Type: String Required: No ** DBInstanceIdentifier ** The ID of the DB instance that contains the tenant database. Type: String Required: No ** DbiResourceId ** The AWS Region-unique, immutable identifier for the DB instance. Type: String Required: No ** DeletionProtection ** Specifies whether deletion protection is enabled for the DB instance. Type: Boolean Required: No ** MasterUsername ** The master username of the tenant database. Type: String Required: No ** MasterUserSecret ** Contains the secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.* Type: [MasterUserSecret](API_MasterUserSecret.md) object Required: No ** NcharCharacterSetName ** The `NCHAR` character set name of the tenant database. Type: String Required: No ** PendingModifiedValues ** Information about pending changes for a tenant database. Type: [TenantDatabasePendingModifiedValues](API_TenantDatabasePendingModifiedValues.md) object Required: No ** Status ** The status of the tenant database. Type: String Required: No ** TagList.Tag.N ** A list of tags. For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*. Type: Array of [Tag](API_Tag.md) objects Required: No ** TenantDatabaseARN ** The Amazon Resource Name (ARN) for the tenant database. Type: String Required: No ** TenantDatabaseCreateTime ** The creation time of the tenant database. Type: Timestamp Required: No ** TenantDatabaseResourceId ** The AWS Region-unique, immutable identifier for the tenant database. Type: String Required: No ** TenantDBName ** The database name of the tenant database. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/TenantDatabase) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/TenantDatabase) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/TenantDatabase) # TenantDatabasePendingModifiedValues A response element in the `ModifyTenantDatabase` operation that describes changes that will be applied. Specific changes are identified by subelements. ## Contents **Note** In the following list, the required parameters are described first. ** MasterUserPassword ** The master password for the tenant database. Type: String Required: No ** TenantDBName ** The name of the tenant database. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/TenantDatabasePendingModifiedValues) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/TenantDatabasePendingModifiedValues) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/TenantDatabasePendingModifiedValues) # Timezone 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. ## Contents **Note** In the following list, the required parameters are described first. ** TimezoneName ** The name of the time zone. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/Timezone) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/Timezone) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/Timezone) # UpgradeTarget The version of the database engine that a DB instance can be upgraded to. ## Contents **Note** In the following list, the required parameters are described first. ** AutoUpgrade ** Indicates whether the target version is applied to any source DB instances that have `AutoMinorVersionUpgrade` set to true. This parameter is dynamic, and is set by RDS. Type: Boolean Required: No ** Description ** The version of the database engine that a DB instance can be upgraded to. Type: String Required: No ** Engine ** The name of the upgrade target database engine. Type: String Required: No ** EngineVersion ** The version number of the upgrade target database engine. Type: String Required: No ** IsMajorVersionUpgrade ** Indicates whether upgrading to the target version requires upgrading the major version of the database engine. Type: Boolean Required: No ** SupportedEngineModes.member.N ** A list of the supported DB engine modes for the target engine version. Type: Array of strings Required: No ** SupportsBabelfish ** Indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version. Type: Boolean Required: No ** SupportsGlobalDatabases ** Indicates whether you can use Aurora global databases with the target engine version. Type: Boolean Required: No ** SupportsIntegrations ** Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift. Type: Boolean Required: No ** SupportsLimitlessDatabase ** Indicates whether the DB engine version supports Aurora Limitless Database. Type: Boolean Required: No ** SupportsLocalWriteForwarding ** Indicates whether the target engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances. Valid for: Aurora DB clusters only Type: Boolean Required: No ** SupportsParallelQuery ** Indicates whether you can use Aurora parallel query with the target engine version. Type: Boolean Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/UpgradeTarget) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/UpgradeTarget) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/UpgradeTarget) # UserAuthConfig Specifies the details of authentication used by a proxy to log in as a specific database user. ## Contents **Note** In the following list, the required parameters are described first. ** AuthScheme ** The type of authentication that the proxy uses for connections from the proxy to the underlying database. Type: String Valid Values: `SECRETS` Required: No ** ClientPasswordAuthType ** The type of authentication the proxy uses for connections from clients. The following values are defaults for the corresponding engines: + RDS for MySQL: `MYSQL_CACHING_SHA2_PASSWORD` + RDS for SQL Server: `SQL_SERVER_AUTHENTICATION` + RDS for PostgreSQL: `POSTGRES_SCRAM_SHA2_256` Type: String Valid Values: `MYSQL_NATIVE_PASSWORD | MYSQL_CACHING_SHA2_PASSWORD | POSTGRES_SCRAM_SHA_256 | POSTGRES_MD5 | SQL_SERVER_AUTHENTICATION` Required: No ** Description ** A user-specified description about the authentication used by a proxy to log in as a specific database user. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `.*` Required: No ** IAMAuth ** A value that indicates whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy. The `ENABLED` value is valid only for proxies with RDS for Microsoft SQL Server. Type: String Valid Values: `DISABLED | REQUIRED | ENABLED` Required: No ** SecretArn ** The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Required: No ** UserName ** The name of the database user to which the proxy connects. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/UserAuthConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/UserAuthConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/UserAuthConfig) # UserAuthConfigInfo Returns the details of authentication used by a proxy to log in as a specific database user. ## Contents **Note** In the following list, the required parameters are described first. ** AuthScheme ** The type of authentication that the proxy uses for connections from the proxy to the underlying database. Type: String Valid Values: `SECRETS` Required: No ** ClientPasswordAuthType ** The type of authentication the proxy uses for connections from clients. Type: String Valid Values: `MYSQL_NATIVE_PASSWORD | MYSQL_CACHING_SHA2_PASSWORD | POSTGRES_SCRAM_SHA_256 | POSTGRES_MD5 | SQL_SERVER_AUTHENTICATION` Required: No ** Description ** A user-specified description about the authentication used by a proxy to log in as a specific database user. Type: String Required: No ** IAMAuth ** Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy. Type: String Valid Values: `DISABLED | REQUIRED | ENABLED` Required: No ** SecretArn ** The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager. Type: String Required: No ** UserName ** The name of the database user to which the proxy connects. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/UserAuthConfigInfo) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/UserAuthConfigInfo) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/UserAuthConfigInfo) # ValidAdditionalStorageOptions Contains the valid options for additional storage volumes for a DB instance. ## Contents **Note** In the following list, the required parameters are described first. ** SupportsAdditionalStorageVolumes ** Indicates whether the DB instance supports additional storage volumes. Type: Boolean Required: No ** Volumes.member.N ** The valid additional storage volume options for the DB instance. Type: Array of [ValidVolumeOptions](API_ValidVolumeOptions.md) objects Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ValidAdditionalStorageOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ValidAdditionalStorageOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ValidAdditionalStorageOptions) # ValidDBInstanceModificationsMessage 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`. ## Contents **Note** In the following list, the required parameters are described first. ** AdditionalStorage ** The valid additional storage options for the DB instance. Type: [ValidAdditionalStorageOptions](API_ValidAdditionalStorageOptions.md) object Required: No ** Storage.ValidStorageOptions.N ** Valid storage options for your DB instance. Type: Array of [ValidStorageOptions](API_ValidStorageOptions.md) objects Required: No ** SupportsDedicatedLogVolume ** Indicates whether a DB instance supports using a dedicated log volume (DLV). Type: Boolean Required: No ** ValidProcessorFeatures.AvailableProcessorFeature.N ** Valid processor features for your DB instance. Type: Array of [AvailableProcessorFeature](API_AvailableProcessorFeature.md) objects Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ValidDBInstanceModificationsMessage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ValidDBInstanceModificationsMessage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ValidDBInstanceModificationsMessage) # ValidStorageOptions Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the `DescribeValidDBInstanceModifications` action. ## Contents **Note** In the following list, the required parameters are described first. ** IopsToStorageRatio.DoubleRange.N ** The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage. Type: Array of [DoubleRange](API_DoubleRange.md) objects Required: No ** ProvisionedIops.Range.N ** The valid range of provisioned IOPS. For example, 1000-256,000. Type: Array of [Range](API_Range.md) objects Required: No ** ProvisionedStorageThroughput.Range.N ** The valid range of provisioned storage throughput. For example, 500-4,000 mebibytes per second (MiBps). Type: Array of [Range](API_Range.md) objects Required: No ** StorageSize.Range.N ** The valid range of storage in gibibytes (GiB). For example, 100 to 16,384. Type: Array of [Range](API_Range.md) objects Required: No ** StorageThroughputToIopsRatio.DoubleRange.N ** The valid range of storage throughput to provisioned IOPS ratios. For example, 0-0.25. Type: Array of [DoubleRange](API_DoubleRange.md) objects Required: No ** StorageType ** The valid storage types for your DB instance. For example: gp2, gp3, io1, io2. Type: String Required: No ** SupportsStorageAutoscaling ** Indicates whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class. Type: Boolean Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ValidStorageOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ValidStorageOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ValidStorageOptions) # ValidVolumeOptions Contains the valid options for an additional storage volume. ## Contents **Note** In the following list, the required parameters are described first. ** Storage.ValidStorageOptions.N ** The valid storage options for the additional storage volume. Type: Array of [ValidStorageOptions](API_ValidStorageOptions.md) objects Required: No ** VolumeName ** The name of the additional storage volume. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ValidVolumeOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ValidVolumeOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ValidVolumeOptions) # VpcSecurityGroupMembership This data type is used as a response element for queries on VPC security group membership. ## Contents **Note** In the following list, the required parameters are described first. ** Status ** The membership status of the VPC security group. Currently, the only valid status is `active`. Type: String Required: No ** VpcSecurityGroupId ** The name of the VPC security group. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/VpcSecurityGroupMembership) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/VpcSecurityGroupMembership) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/VpcSecurityGroupMembership)