A list of AccountQuota objects. Within this list, each quota has a name, \n a count of usage toward the quota maximum, and a maximum value for the quota.
Data returned by the DescribeAccountAttributes action.
" } }, "com.amazonaws.rds#AccountQuota": { "type": "structure", "members": { "AccountQuotaName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the Amazon RDS quota for this AWS account.
" } }, "Used": { "target": "com.amazonaws.rds#Long", "traits": { "smithy.api#documentation": "The amount currently used toward the quota maximum.
" } }, "Max": { "target": "com.amazonaws.rds#Long", "traits": { "smithy.api#documentation": "The maximum allowed value for the quota.
" } } }, "traits": { "smithy.api#documentation": "Describes a quota for an AWS account.
\nThe following are account quotas:
\n\n AllocatedStorage - The total allocated storage per account, in GiB.\n The used value is the total allocated storage in the account, in GiB.
\n AuthorizationsPerDBSecurityGroup - The number of ingress rules per DB security group. \n The used value is the highest number of ingress rules in a DB security group in the account. Other \n DB security groups in the account might have a lower number of ingress rules.
\n CustomEndpointsPerDBCluster - The number of custom endpoints per DB cluster. \n The used value is the highest number of custom endpoints in a DB clusters in the account. Other \n DB clusters in the account might have a lower number of custom endpoints.
\n DBClusterParameterGroups - The number of DB cluster parameter groups\n per account, excluding default parameter groups. The used value is the count of\n nondefault DB cluster parameter groups in the account.
\n DBClusterRoles - The number of associated AWS Identity and Access Management (IAM) roles per DB cluster. \n The used value is the highest number of associated IAM roles for a DB cluster in the account. Other \n DB clusters in the account might have a lower number of associated IAM roles.
\n DBClusters - The number of DB clusters per account. \n The used value is the count of DB clusters in the account.
\n DBInstanceRoles - The number of associated IAM roles per DB instance. \n The used value is the highest number of associated IAM roles for a DB instance in the account. Other \n DB instances in the account might have a lower number of associated IAM roles.
\n DBInstances - The number of DB instances per account. \n 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 \n instances apply to this quota.
\n\n DBParameterGroups - The number of DB parameter groups per account,\n excluding default parameter groups. The used value is the count of nondefault DB\n parameter groups in the account.
\n DBSecurityGroups - The number of DB security groups (not VPC\n security groups) per account, excluding the default security group. The used\n value is the count of nondefault DB security groups in the account.
\n DBSubnetGroups - The number of DB subnet groups per account. \n The used value is the count of the DB subnet groups in the account.
\n EventSubscriptions - The number of event subscriptions per account. \n The used value is the count of the event subscriptions in the account.
\n ManualClusterSnapshots - The number of manual DB cluster snapshots per account. \n The used value is the count of the manual DB cluster snapshots in the account.
\n ManualSnapshots - The number of manual DB instance snapshots per account. \n The used value is the count of the manual DB instance snapshots in the account.
\n OptionGroups - The number of DB option groups per account, excluding\n default option groups. The used value is the count of nondefault DB option\n groups in the account.
\n ReadReplicasPerMaster - The number of read replicas per DB\n instance. The used value is the highest number of read replicas for a DB\n instance in the account. Other DB instances in the account might have a lower\n number of read replicas.
\n ReservedDBInstances - The number of reserved DB instances per account. \n The used value is the count of the active reserved DB instances in the account.
\n SubnetsPerDBSubnetGroup - The number of subnets per DB subnet group. \n The used value is highest number of subnets for a DB subnet group in the account. Other \n DB subnet groups in the account might have a lower number of subnets.
For more information, see Quotas for Amazon RDS in the\n Amazon RDS User Guide and Quotas for Amazon Aurora in the\n Amazon Aurora User Guide.
" } }, "com.amazonaws.rds#AccountQuotaList": { "type": "list", "member": { "target": "com.amazonaws.rds#AccountQuota", "traits": { "smithy.api#xmlName": "AccountQuota" } } }, "com.amazonaws.rds#ActivityStreamMode": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "sync", "name": "sync" }, { "value": "async", "name": "async" } ] } }, "com.amazonaws.rds#ActivityStreamStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "stopped", "name": "stopped" }, { "value": "starting", "name": "starting" }, { "value": "started", "name": "started" }, { "value": "stopping", "name": "stopping" } ] } }, "com.amazonaws.rds#AddRoleToDBCluster": { "type": "operation", "input": { "target": "com.amazonaws.rds#AddRoleToDBClusterMessage" }, "errors": [ { "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, { "target": "com.amazonaws.rds#DBClusterRoleAlreadyExistsFault" }, { "target": "com.amazonaws.rds#DBClusterRoleQuotaExceededFault" }, { "target": "com.amazonaws.rds#InvalidDBClusterStateFault" } ], "traits": { "smithy.api#documentation": "Associates an Identity and Access Management (IAM) role from an Amazon Aurora DB cluster.\n For more information, see Authorizing Amazon Aurora MySQL \n to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide.
\nThis action only applies to Aurora DB clusters.
\nThe name of the DB cluster to associate the IAM role with.
", "smithy.api#required": {} } }, "RoleArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB\n cluster, for example, arn:aws:iam::123456789012:role/AuroraAccessRole.
The name of the feature for the DB cluster that the IAM role is to be associated with. \n For the list of supported feature names, see DBEngineVersion.
" } } } }, "com.amazonaws.rds#AddRoleToDBInstance": { "type": "operation", "input": { "target": "com.amazonaws.rds#AddRoleToDBInstanceMessage" }, "errors": [ { "target": "com.amazonaws.rds#DBInstanceNotFoundFault" }, { "target": "com.amazonaws.rds#DBInstanceRoleAlreadyExistsFault" }, { "target": "com.amazonaws.rds#DBInstanceRoleQuotaExceededFault" }, { "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" } ], "traits": { "smithy.api#documentation": "Associates an AWS Identity and Access Management (IAM) role with a DB instance.
\nTo add a role to a DB instance, the status of the DB instance must be available.
The name of the DB instance to associate the IAM role with.
", "smithy.api#required": {} } }, "RoleArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for\n example arn:aws:iam::123456789012:role/AccessRole.
The name of the feature for the DB instance that the IAM role is to be associated with. \n For the list of supported feature names, see DBEngineVersion.\n
", "smithy.api#required": {} } } } }, "com.amazonaws.rds#AddSourceIdentifierToSubscription": { "type": "operation", "input": { "target": "com.amazonaws.rds#AddSourceIdentifierToSubscriptionMessage" }, "output": { "target": "com.amazonaws.rds#AddSourceIdentifierToSubscriptionResult" }, "errors": [ { "target": "com.amazonaws.rds#SourceNotFoundFault" }, { "target": "com.amazonaws.rds#SubscriptionNotFoundFault" } ], "traits": { "smithy.api#documentation": "Adds a source identifier to an existing RDS event notification subscription.
" } }, "com.amazonaws.rds#AddSourceIdentifierToSubscriptionMessage": { "type": "structure", "members": { "SubscriptionName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the RDS event notification subscription you want to add a source identifier to.
", "smithy.api#required": {} } }, "SourceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The identifier of the event source to be added.
\nConstraints:
\nIf the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.
\nFor an overview on tagging Amazon RDS resources, \n see Tagging Amazon RDS Resources.
" } }, "com.amazonaws.rds#AddTagsToResourceMessage": { "type": "structure", "members": { "ResourceName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about \n creating an ARN, \n see \n Constructing an RDS Amazon Resource Name (ARN).
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.rds#TagList", "traits": { "smithy.api#documentation": "The tags to be assigned to the Amazon RDS resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#AmazonRDSv19": { "type": "service", "version": "2014-10-31", "operations": [ { "target": "com.amazonaws.rds#AddRoleToDBCluster" }, { "target": "com.amazonaws.rds#AddRoleToDBInstance" }, { "target": "com.amazonaws.rds#AddSourceIdentifierToSubscription" }, { "target": "com.amazonaws.rds#AddTagsToResource" }, { "target": "com.amazonaws.rds#ApplyPendingMaintenanceAction" }, { "target": "com.amazonaws.rds#AuthorizeDBSecurityGroupIngress" }, { "target": "com.amazonaws.rds#BacktrackDBCluster" }, { "target": "com.amazonaws.rds#CancelExportTask" }, { "target": "com.amazonaws.rds#CopyDBClusterParameterGroup" }, { "target": "com.amazonaws.rds#CopyDBClusterSnapshot" }, { "target": "com.amazonaws.rds#CopyDBParameterGroup" }, { "target": "com.amazonaws.rds#CopyDBSnapshot" }, { "target": "com.amazonaws.rds#CopyOptionGroup" }, { "target": "com.amazonaws.rds#CreateCustomAvailabilityZone" }, { "target": "com.amazonaws.rds#CreateDBCluster" }, { "target": "com.amazonaws.rds#CreateDBClusterEndpoint" }, { "target": "com.amazonaws.rds#CreateDBClusterParameterGroup" }, { "target": "com.amazonaws.rds#CreateDBClusterSnapshot" }, { "target": "com.amazonaws.rds#CreateDBInstance" }, { "target": "com.amazonaws.rds#CreateDBInstanceReadReplica" }, { "target": "com.amazonaws.rds#CreateDBParameterGroup" }, { "target": "com.amazonaws.rds#CreateDBProxy" }, { "target": "com.amazonaws.rds#CreateDBProxyEndpoint" }, { "target": "com.amazonaws.rds#CreateDBSecurityGroup" }, { "target": "com.amazonaws.rds#CreateDBSnapshot" }, { "target": "com.amazonaws.rds#CreateDBSubnetGroup" }, { "target": "com.amazonaws.rds#CreateEventSubscription" }, { "target": "com.amazonaws.rds#CreateGlobalCluster" }, { "target": "com.amazonaws.rds#CreateOptionGroup" }, { "target": "com.amazonaws.rds#DeleteCustomAvailabilityZone" }, { "target": "com.amazonaws.rds#DeleteDBCluster" }, { "target": "com.amazonaws.rds#DeleteDBClusterEndpoint" }, { "target": "com.amazonaws.rds#DeleteDBClusterParameterGroup" }, { "target": "com.amazonaws.rds#DeleteDBClusterSnapshot" }, { "target": "com.amazonaws.rds#DeleteDBInstance" }, { "target": "com.amazonaws.rds#DeleteDBInstanceAutomatedBackup" }, { "target": "com.amazonaws.rds#DeleteDBParameterGroup" }, { "target": "com.amazonaws.rds#DeleteDBProxy" }, { "target": "com.amazonaws.rds#DeleteDBProxyEndpoint" }, { "target": "com.amazonaws.rds#DeleteDBSecurityGroup" }, { "target": "com.amazonaws.rds#DeleteDBSnapshot" }, { "target": "com.amazonaws.rds#DeleteDBSubnetGroup" }, { "target": "com.amazonaws.rds#DeleteEventSubscription" }, { "target": "com.amazonaws.rds#DeleteGlobalCluster" }, { "target": "com.amazonaws.rds#DeleteInstallationMedia" }, { "target": "com.amazonaws.rds#DeleteOptionGroup" }, { "target": "com.amazonaws.rds#DeregisterDBProxyTargets" }, { "target": "com.amazonaws.rds#DescribeAccountAttributes" }, { "target": "com.amazonaws.rds#DescribeCertificates" }, { "target": "com.amazonaws.rds#DescribeCustomAvailabilityZones" }, { "target": "com.amazonaws.rds#DescribeDBClusterBacktracks" }, { "target": "com.amazonaws.rds#DescribeDBClusterEndpoints" }, { "target": "com.amazonaws.rds#DescribeDBClusterParameterGroups" }, { "target": "com.amazonaws.rds#DescribeDBClusterParameters" }, { "target": "com.amazonaws.rds#DescribeDBClusters" }, { "target": "com.amazonaws.rds#DescribeDBClusterSnapshotAttributes" }, { "target": "com.amazonaws.rds#DescribeDBClusterSnapshots" }, { "target": "com.amazonaws.rds#DescribeDBEngineVersions" }, { "target": "com.amazonaws.rds#DescribeDBInstanceAutomatedBackups" }, { "target": "com.amazonaws.rds#DescribeDBInstances" }, { "target": "com.amazonaws.rds#DescribeDBLogFiles" }, { "target": "com.amazonaws.rds#DescribeDBParameterGroups" }, { "target": "com.amazonaws.rds#DescribeDBParameters" }, { "target": "com.amazonaws.rds#DescribeDBProxies" }, { "target": "com.amazonaws.rds#DescribeDBProxyEndpoints" }, { "target": "com.amazonaws.rds#DescribeDBProxyTargetGroups" }, { "target": "com.amazonaws.rds#DescribeDBProxyTargets" }, { "target": "com.amazonaws.rds#DescribeDBSecurityGroups" }, { "target": "com.amazonaws.rds#DescribeDBSnapshotAttributes" }, { "target": "com.amazonaws.rds#DescribeDBSnapshots" }, { "target": "com.amazonaws.rds#DescribeDBSubnetGroups" }, { "target": "com.amazonaws.rds#DescribeEngineDefaultClusterParameters" }, { "target": "com.amazonaws.rds#DescribeEngineDefaultParameters" }, { "target": "com.amazonaws.rds#DescribeEventCategories" }, { "target": "com.amazonaws.rds#DescribeEvents" }, { "target": "com.amazonaws.rds#DescribeEventSubscriptions" }, { "target": "com.amazonaws.rds#DescribeExportTasks" }, { "target": "com.amazonaws.rds#DescribeGlobalClusters" }, { "target": "com.amazonaws.rds#DescribeInstallationMedia" }, { "target": "com.amazonaws.rds#DescribeOptionGroupOptions" }, { "target": "com.amazonaws.rds#DescribeOptionGroups" }, { "target": "com.amazonaws.rds#DescribeOrderableDBInstanceOptions" }, { "target": "com.amazonaws.rds#DescribePendingMaintenanceActions" }, { "target": "com.amazonaws.rds#DescribeReservedDBInstances" }, { "target": "com.amazonaws.rds#DescribeReservedDBInstancesOfferings" }, { "target": "com.amazonaws.rds#DescribeSourceRegions" }, { "target": "com.amazonaws.rds#DescribeValidDBInstanceModifications" }, { "target": "com.amazonaws.rds#DownloadDBLogFilePortion" }, { "target": "com.amazonaws.rds#FailoverDBCluster" }, { "target": "com.amazonaws.rds#FailoverGlobalCluster" }, { "target": "com.amazonaws.rds#ImportInstallationMedia" }, { "target": "com.amazonaws.rds#ListTagsForResource" }, { "target": "com.amazonaws.rds#ModifyCertificates" }, { "target": "com.amazonaws.rds#ModifyCurrentDBClusterCapacity" }, { "target": "com.amazonaws.rds#ModifyDBCluster" }, { "target": "com.amazonaws.rds#ModifyDBClusterEndpoint" }, { "target": "com.amazonaws.rds#ModifyDBClusterParameterGroup" }, { "target": "com.amazonaws.rds#ModifyDBClusterSnapshotAttribute" }, { "target": "com.amazonaws.rds#ModifyDBInstance" }, { "target": "com.amazonaws.rds#ModifyDBParameterGroup" }, { "target": "com.amazonaws.rds#ModifyDBProxy" }, { "target": "com.amazonaws.rds#ModifyDBProxyEndpoint" }, { "target": "com.amazonaws.rds#ModifyDBProxyTargetGroup" }, { "target": "com.amazonaws.rds#ModifyDBSnapshot" }, { "target": "com.amazonaws.rds#ModifyDBSnapshotAttribute" }, { "target": "com.amazonaws.rds#ModifyDBSubnetGroup" }, { "target": "com.amazonaws.rds#ModifyEventSubscription" }, { "target": "com.amazonaws.rds#ModifyGlobalCluster" }, { "target": "com.amazonaws.rds#ModifyOptionGroup" }, { "target": "com.amazonaws.rds#PromoteReadReplica" }, { "target": "com.amazonaws.rds#PromoteReadReplicaDBCluster" }, { "target": "com.amazonaws.rds#PurchaseReservedDBInstancesOffering" }, { "target": "com.amazonaws.rds#RebootDBInstance" }, { "target": "com.amazonaws.rds#RegisterDBProxyTargets" }, { "target": "com.amazonaws.rds#RemoveFromGlobalCluster" }, { "target": "com.amazonaws.rds#RemoveRoleFromDBCluster" }, { "target": "com.amazonaws.rds#RemoveRoleFromDBInstance" }, { "target": "com.amazonaws.rds#RemoveSourceIdentifierFromSubscription" }, { "target": "com.amazonaws.rds#RemoveTagsFromResource" }, { "target": "com.amazonaws.rds#ResetDBClusterParameterGroup" }, { "target": "com.amazonaws.rds#ResetDBParameterGroup" }, { "target": "com.amazonaws.rds#RestoreDBClusterFromS3" }, { "target": "com.amazonaws.rds#RestoreDBClusterFromSnapshot" }, { "target": "com.amazonaws.rds#RestoreDBClusterToPointInTime" }, { "target": "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshot" }, { "target": "com.amazonaws.rds#RestoreDBInstanceFromS3" }, { "target": "com.amazonaws.rds#RestoreDBInstanceToPointInTime" }, { "target": "com.amazonaws.rds#RevokeDBSecurityGroupIngress" }, { "target": "com.amazonaws.rds#StartActivityStream" }, { "target": "com.amazonaws.rds#StartDBCluster" }, { "target": "com.amazonaws.rds#StartDBInstance" }, { "target": "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplication" }, { "target": "com.amazonaws.rds#StartExportTask" }, { "target": "com.amazonaws.rds#StopActivityStream" }, { "target": "com.amazonaws.rds#StopDBCluster" }, { "target": "com.amazonaws.rds#StopDBInstance" }, { "target": "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplication" } ], "traits": { "aws.api#service": { "sdkId": "RDS", "arnNamespace": "rds", "cloudFormationName": "RDS", "cloudTrailEventSource": "rds.amazonaws.com", "endpointPrefix": "rds" }, "aws.auth#sigv4": { "name": "rds" }, "aws.protocols#awsQuery": {}, "smithy.api#documentation": "\n
Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and \n scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational \n database and manages common database administration tasks, freeing up developers to focus on what makes their applications \n and businesses unique.
\nAmazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, \n Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools \n you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS \n automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS \n is flexible: you can scale your DB instance's compute resources and storage capacity to meet your \n application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for \n the resources you use.
\nThis interface reference for Amazon RDS contains documentation for a programming or command line interface \n you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might \n require techniques such as polling or callback functions to determine when a command has been applied. In this \n reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, \n or during the maintenance window. The reference structure is as follows, and we list following some related topics \n from the user guide.
\n \n\n Amazon RDS API Reference\n
\n \nFor the alphabetical list of API actions, see \n API Actions.
\nFor the alphabetical list of data types, see \n Data Types.
\nFor a list of common query parameters, see \n Common Parameters.
\nFor descriptions of the error codes, see \n Common Errors.
\n\n Amazon RDS User Guide\n
\n \nFor a summary of the Amazon RDS interfaces, see \n Available RDS Interfaces.
\nFor more information about how to use the Query API, see \n Using the Query API.
\nApplies a pending maintenance action to a resource (for example, to a DB instance).
" } }, "com.amazonaws.rds#ApplyPendingMaintenanceActionMessage": { "type": "structure", "members": { "ResourceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The RDS Amazon Resource Name (ARN) of the resource that the \n pending maintenance action applies to. For information about \n creating an ARN, \n see \n Constructing an RDS Amazon Resource Name (ARN).
", "smithy.api#required": {} } }, "ApplyAction": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The pending maintenance action to apply to this resource.
\nValid values: system-update, db-upgrade, \n hardware-maintenance, ca-certificate-rotation\n
A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in \n request of type immediate can't be undone.
Valid values:
\n\n immediate - Apply the maintenance action immediately.
\n next-maintenance - Apply the maintenance action during\n the next maintenance window for the resource.
\n undo-opt-in - Cancel any existing next-maintenance\n opt-in requests.
The specified CIDR IP range or Amazon EC2 security group is already authorized for\n the specified DB security group.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#AuthorizationNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The specified CIDR IP range or Amazon EC2 security group might not be authorized\n for the specified DB security group.
\nOr, RDS might not be authorized to perform necessary actions using IAM on your\n behalf.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.rds#AuthorizationQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The DB security group authorization quota has been reached.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#AuthorizeDBSecurityGroupIngress": { "type": "operation", "input": { "target": "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressMessage" }, "output": { "target": "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressResult" }, "errors": [ { "target": "com.amazonaws.rds#AuthorizationAlreadyExistsFault" }, { "target": "com.amazonaws.rds#AuthorizationQuotaExceededFault" }, { "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" } ], "traits": { "smithy.api#documentation": "Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security \n groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC \n instances. Second, IP ranges are available if the application accessing your database is running on the Internet. \n Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId \n and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
\nYou can't authorize ingress from an EC2 security group in one AWS Region to an Amazon RDS DB instance in \n another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.
\nFor an overview of CIDR ranges, go to the \n Wikipedia Tutorial.\n
" } }, "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressMessage": { "type": "structure", "members": { "DBSecurityGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the DB security group to add authorization to.
", "smithy.api#required": {} } }, "CIDRIP": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The IP range to authorize.
" } }, "EC2SecurityGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n Name of the EC2 security group to authorize.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName \n or EC2SecurityGroupId must be provided.\n
\n Id of the EC2 security group to authorize.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.\n
\n AWS account number of the owner of the EC2 security group\n specified in the EC2SecurityGroupName parameter.\n The AWS access key ID isn't an acceptable value.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.\n
The name of the Availability Zone.
" } } }, "traits": { "smithy.api#documentation": "Contains Availability Zone information.
\n This data type is used as an element in the OrderableDBInstanceOption\n data type.
The name of the processor feature. Valid names are coreCount \n and threadsPerCore.
The default value for the processor feature of the DB instance class.
" } }, "AllowedValues": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The allowed values for the processor feature of the DB instance class.
" } } }, "traits": { "smithy.api#documentation": "Contains the available processor feature information for the DB instance class of a DB instance.
\nFor more information, see Configuring the\n Processor of the DB Instance Class in the Amazon RDS User Guide.\n \n
" } }, "com.amazonaws.rds#AvailableProcessorFeatureList": { "type": "list", "member": { "target": "com.amazonaws.rds#AvailableProcessorFeature", "traits": { "smithy.api#xmlName": "AvailableProcessorFeature" } } }, "com.amazonaws.rds#AwsBackupRecoveryPointArn": { "type": "string", "traits": { "smithy.api#length": { "min": 43, "max": 350 }, "smithy.api#pattern": "^arn:aws[a-z-]*:backup:[-a-z0-9]+:[0-9]{12}:[-a-z]+:([a-z0-9\\-]+:)?[a-z][a-z0-9\\-]{0,255}$" } }, "com.amazonaws.rds#BacktrackDBCluster": { "type": "operation", "input": { "target": "com.amazonaws.rds#BacktrackDBClusterMessage" }, "output": { "target": "com.amazonaws.rds#DBClusterBacktrack" }, "errors": [ { "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidDBClusterStateFault" } ], "traits": { "smithy.api#documentation": "Backtracks a DB cluster to a specific time, without creating a new DB cluster.
\nFor more information on backtracking, see \n \n Backtracking an Aurora DB Cluster in the \n Amazon Aurora User Guide.\n
\nThis action only applies to Aurora MySQL DB clusters.
\nThe DB cluster identifier of the DB cluster to be backtracked. This parameter is\n stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 alphanumeric characters or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: my-cluster1\n
The timestamp of the time to backtrack the DB cluster to, specified in ISO\n 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia\n page.\n
\nIf the specified time isn't a consistent time for the DB cluster, \n Aurora automatically chooses the nearest possible consistent time for the DB cluster.
\nConstraints:
\nMust contain a valid ISO 8601 timestamp.
\nCan't contain a timestamp set in the future.
\nExample: 2017-07-08T18:00Z\n
A value that indicates whether to force the DB cluster to backtrack when binary logging is\n enabled. Otherwise, an error occurs when binary logging is enabled.
" } }, "UseEarliestTimeOnPointInTimeUnavailable": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to backtrack the DB cluster to the earliest possible\n backtrack time when BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time, an error occurs.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#BackupPolicyNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#deprecated": { "message": "Please avoid using this fault" }, "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.rds#Boolean": { "type": "boolean" }, "com.amazonaws.rds#BooleanOptional": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.rds#CancelExportTask": { "type": "operation", "input": { "target": "com.amazonaws.rds#CancelExportTaskMessage" }, "output": { "target": "com.amazonaws.rds#ExportTask" }, "errors": [ { "target": "com.amazonaws.rds#ExportTaskNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidExportTaskStateFault" } ], "traits": { "smithy.api#documentation": "Cancels an export task in progress that is exporting a snapshot to Amazon S3. \n Any data that has already been written to the S3 bucket isn't removed.\n
" } }, "com.amazonaws.rds#CancelExportTaskMessage": { "type": "structure", "members": { "ExportTaskIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The identifier of the snapshot export task to cancel.
", "smithy.api#required": {} } } } }, "com.amazonaws.rds#Certificate": { "type": "structure", "members": { "CertificateIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The unique key that identifies a certificate.
" } }, "CertificateType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The type of the certificate.
" } }, "Thumbprint": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The thumbprint of the certificate.
" } }, "ValidFrom": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "The starting date from which the certificate is valid.
" } }, "ValidTill": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "The final date that the certificate continues to be valid.
" } }, "CertificateArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the certificate.
" } }, "CustomerOverride": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "Whether there is an override for the default certificate identifier.
" } }, "CustomerOverrideValidTill": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "If there is an override for the default certificate identifier, when the override\n expires.
" } } }, "traits": { "smithy.api#documentation": "A CA certificate for an AWS account.
" } }, "com.amazonaws.rds#CertificateList": { "type": "list", "member": { "target": "com.amazonaws.rds#Certificate", "traits": { "smithy.api#xmlName": "Certificate" } } }, "com.amazonaws.rds#CertificateMessage": { "type": "structure", "members": { "Certificates": { "target": "com.amazonaws.rds#CertificateList", "traits": { "smithy.api#documentation": "The list of Certificate objects for the AWS account.
\n An optional pagination token provided by a previous\n DescribeCertificates request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n
Data returned by the DescribeCertificates action.
" } }, "com.amazonaws.rds#CertificateNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "\n CertificateIdentifier doesn't refer to an\n existing certificate.\n
The name of the character set.
" } }, "CharacterSetDescription": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The description of the character set.
" } } }, "traits": { "smithy.api#documentation": "\n This data type is used as a response element in the action DescribeDBEngineVersions. \n
The list of log types to enable.
" } }, "DisableLogTypes": { "target": "com.amazonaws.rds#LogTypeList", "traits": { "smithy.api#documentation": "The list of log types to disable.
" } } }, "traits": { "smithy.api#documentation": "The configuration setting for the log types to be enabled for export to CloudWatch\n Logs for a specific DB instance or DB cluster.
\nThe EnableLogTypes and DisableLogTypes arrays determine which logs will be exported\n (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB\n engine being used.
For more information about exporting CloudWatch Logs for Amazon RDS DB instances, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nFor more information about exporting CloudWatch Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
" } }, "com.amazonaws.rds#ClusterPendingModifiedValues": { "type": "structure", "members": { "PendingCloudwatchLogsExports": { "target": "com.amazonaws.rds#PendingCloudwatchLogsExports" }, "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The DBClusterIdentifier value for the DB cluster.
" } }, "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The master credentials for the DB cluster.
" } }, "IAMDatabaseAuthenticationEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The database engine version.
" } } }, "traits": { "smithy.api#documentation": "This data type is used as a response element in the ModifyDBCluster operation and \n contains changes that will be applied during the next maintenance window.
The maximum size of the connection pool for each target in a target group. For Aurora MySQL, it is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
Default: 100
\nConstraints: between 1 and 100
" } }, "MaxIdleConnectionsPercent": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "\n Controls how actively the proxy closes idle database connections in the connection pool.\n A high value enables the proxy to leave a high percentage of idle connections open.\n A low value causes the proxy to close idle client connections and return the underlying\n database connections to the connection pool. For Aurora MySQL, it is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n
Default: 50
\nConstraints: between 0 and MaxConnectionsPercent\n
The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the\n proxy has opened its maximum number of connections and all connections are busy with client sessions.
\nDefault: 120
\nConstraints: between 1 and 3600, or 0 representing unlimited
" } }, "SessionPinningFilters": { "target": "com.amazonaws.rds#StringList", "traits": { "smithy.api#documentation": "Each item in the list represents a class of SQL operations that normally cause all later statements\n in a session using a proxy to be pinned to the same underlying database connection. Including an item\n in the list exempts that class of SQL operations from the pinning behavior.
\nDefault: no session pinning filters
" } }, "InitQuery": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n One or more SQL statements for the proxy to run when opening each new database connection.\n Typically used with SET statements to make sure that each connection has identical\n settings such as time zone and character set. For multiple statements, use semicolons as the separator.\n You can also include multiple variables in a single SET statement, such as\n SET x=1, y=2.\n
Default: no initialization query
" } } }, "traits": { "smithy.api#documentation": "Specifies the settings that control the size and behavior of the connection pool associated with a DBProxyTargetGroup.
The maximum size of the connection pool for each target in a target group. For Aurora MySQL, it is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
\n Controls how actively the proxy closes idle database connections in the connection pool.\n A high value enables the proxy to leave a high percentage of idle connections open.\n A low value causes the proxy to close idle client connections and return the underlying database connections to the connection pool.\n For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n
The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the\n proxy has opened its maximum number of connections and all connections are busy with client sessions.
" } }, "SessionPinningFilters": { "target": "com.amazonaws.rds#StringList", "traits": { "smithy.api#documentation": "Each item in the list represents a class of SQL operations that normally cause all later statements\n in a session using a proxy to be pinned to the same underlying database connection. Including an item\n in the list exempts that class of SQL operations from the pinning behavior. Currently, the only\n allowed value is EXCLUDE_VARIABLE_SETS.
\n One or more SQL statements for the proxy to run when opening each new database connection.\n Typically used with SET statements to make sure that each connection has identical\n settings such as time zone and character set. This setting is empty by default.\n For multiple statements, use semicolons as the separator.\n You can also include multiple variables in a single SET statement, such as\n SET x=1, y=2.\n
Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget.
Copies the specified DB cluster parameter group.
\nThis action only applies to Aurora DB clusters.
\nThe identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group.\n For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide.\n
\nConstraints:
\nMust specify a valid DB cluster parameter group.
\nThe identifier for the copied DB cluster parameter group.
\nConstraints:
\nCan't be null, empty, or blank
\nMust contain from 1 to 255 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-cluster-param-group1\n
A description for the copied DB cluster parameter group.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.rds#TagList" } } }, "com.amazonaws.rds#CopyDBClusterParameterGroupResult": { "type": "structure", "members": { "DBClusterParameterGroup": { "target": "com.amazonaws.rds#DBClusterParameterGroup" } } }, "com.amazonaws.rds#CopyDBClusterSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.rds#CopyDBClusterSnapshotMessage" }, "output": { "target": "com.amazonaws.rds#CopyDBClusterSnapshotResult" }, "errors": [ { "target": "com.amazonaws.rds#DBClusterSnapshotAlreadyExistsFault" }, { "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" }, { "target": "com.amazonaws.rds#InvalidDBClusterStateFault" }, { "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" }, { "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "Copies a snapshot of a DB cluster.
\nTo copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier\n must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.
You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you call the CopyDBClusterSnapshot action \n is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, \n you must provide the following values:
\n KmsKeyId - The AWS Key Management System (AWS KMS) key identifier for the key to use to \n encrypt the copy of the DB cluster snapshot in the destination AWS Region.
\n PreSignedUrl - A URL that contains a Signature Version 4 signed request for the \n CopyDBClusterSnapshot action to be called in the source AWS Region where the DB cluster snapshot is copied from. \n The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the \n source AWS Region that contains the encrypted DB cluster snapshot to be copied.
The pre-signed URL request must contain the following parameter values:
\n\n KmsKeyId - The AWS KMS key identifier for the customer master key (CMK) to use to encrypt the copy of the DB \n cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot \n action that is called in the destination AWS Region, and the action contained in the pre-signed URL.
\n DestinationRegion - The name of the AWS Region that the DB cluster snapshot is to be created in.
\n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster \n snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, \n if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier\n looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see \n\n \n Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and\n \n Signature Version 4 Signing Process.
\nIf you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source AWS Region.
\n TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination AWS Region.
\n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. \n This identifier must be in the ARN format for the source AWS Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified\n by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in \"copying\" status.
For more information on copying encrypted DB cluster snapshots from one AWS Region to another, see \n \n Copying a Snapshot in the Amazon Aurora User Guide.\n
\nFor more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nThe identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.
\nYou can't copy an encrypted, shared DB cluster snapshot from one AWS Region to another.
\nConstraints:
\nMust specify a valid system snapshot in the \"available\" state.
\nIf the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier.
\nIf the source snapshot is in a different AWS Region than the copy,\n specify a valid DB cluster snapshot ARN. For more information, go to\n \n Copying Snapshots Across AWS Regions in the Amazon Aurora User Guide.\n
\nExample: my-cluster-snapshot1\n
The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: my-cluster-snapshot2\n
The AWS KMS key identifier for an encrypted DB cluster snapshot. \n The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
\n \nIf you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new AWS KMS CMK. \n If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same AWS KMS key as the source DB cluster snapshot. \n
If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId.
To copy an encrypted DB cluster snapshot to another AWS Region, you must set KmsKeyId to the AWS KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot \n in the destination AWS Region. AWS KMS CMKs are specific to the AWS Region that they are created in, and you can't use CMKs from one AWS Region \n in another AWS Region.
If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, \n an error is returned.
The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS Region that contains the \n source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another AWS Region. \n Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same AWS Region.
The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be\n executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. \n The pre-signed URL request must contain the following parameter values:
\n KmsKeyId - The AWS KMS key identifier for the customer master key (CMK) to use to encrypt the copy of the DB \n cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot \n action that is called in the destination AWS Region, and the action contained in the pre-signed URL.
\n DestinationRegion - The name of the AWS Region that the DB cluster snapshot is to be created in.
\n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster \n snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, \n if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier\n looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see \n\n \n Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and\n \n Signature Version 4 Signing Process.
\n \nIf you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source AWS Region.
A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. \n By default, tags are not copied.
" } }, "Tags": { "target": "com.amazonaws.rds#TagList" } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#CopyDBClusterSnapshotResult": { "type": "structure", "members": { "DBClusterSnapshot": { "target": "com.amazonaws.rds#DBClusterSnapshot" } } }, "com.amazonaws.rds#CopyDBParameterGroup": { "type": "operation", "input": { "target": "com.amazonaws.rds#CopyDBParameterGroupMessage" }, "output": { "target": "com.amazonaws.rds#CopyDBParameterGroupResult" }, "errors": [ { "target": "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault" }, { "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" }, { "target": "com.amazonaws.rds#DBParameterGroupQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "Copies the specified DB parameter group.
" } }, "com.amazonaws.rds#CopyDBParameterGroupMessage": { "type": "structure", "members": { "SourceDBParameterGroupIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n The identifier or ARN for the source DB parameter group.\n For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.\n
\nConstraints:
\nMust specify a valid DB parameter group.
\nThe identifier for the copied DB parameter group.
\nConstraints:
\nCan't be null, empty, or blank
\nMust contain from 1 to 255 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-db-parameter-group\n
A description for the copied DB parameter group.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.rds#TagList" } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#CopyDBParameterGroupResult": { "type": "structure", "members": { "DBParameterGroup": { "target": "com.amazonaws.rds#DBParameterGroup" } } }, "com.amazonaws.rds#CopyDBSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.rds#CopyDBSnapshotMessage" }, "output": { "target": "com.amazonaws.rds#CopyDBSnapshotResult" }, "errors": [ { "target": "com.amazonaws.rds#CustomAvailabilityZoneNotFoundFault" }, { "target": "com.amazonaws.rds#DBSnapshotAlreadyExistsFault" }, { "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" }, { "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" }, { "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "Copies the specified DB snapshot. The source DB snapshot must be in the available state.
You can copy a snapshot from one AWS Region to another. In that case, the AWS Region\n where you call the CopyDBSnapshot action is the destination AWS Region for the\n DB snapshot copy.
For more information about copying snapshots, see \n Copying a DB Snapshot in the Amazon RDS User Guide.\n
" } }, "com.amazonaws.rds#CopyDBSnapshotMessage": { "type": "structure", "members": { "SourceDBSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The identifier for the source DB snapshot.
\n \nIf the source snapshot is in the same AWS Region as the copy, specify a valid DB\n snapshot identifier. For example, you might specify\n rds:mysql-instance1-snapshot-20130805.
If the source snapshot is in a different AWS Region than the copy, specify a valid DB\n snapshot ARN. For example, you might specify\n arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.
If you are copying from a shared manual DB snapshot, \n this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.\n
\n \nIf you are copying an encrypted snapshot\n this parameter must be in the ARN format for the source AWS Region, \n and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.\n
Constraints:
\nMust specify a valid system snapshot in the \"available\" state.
\nExample: rds:mydb-2012-04-02-00-01\n
Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805\n
The identifier for the copy of the snapshot.\n
\n \nConstraints:
\n \nCan't be null, empty, or blank
\nMust contain from 1 to 255 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-db-snapshot\n
The AWS KMS key identifier for an encrypted DB snapshot. \n The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). \n
\n \nIf you copy an encrypted DB snapshot from your AWS account, \n you can specify a value for this parameter to encrypt the copy with a new AWS KMS CMK. \n If you don't specify a value for this parameter, \n then the copy of the DB snapshot is encrypted with the same AWS KMS key as the source DB snapshot. \n
\n\nIf you copy an encrypted DB snapshot that is shared from another AWS account, \n then you must specify a value for this parameter.\n
\n \nIf you specify this parameter when you copy an unencrypted snapshot, \n the copy is encrypted.\n
\n \nIf you copy an encrypted snapshot to a different AWS Region, then you must specify\n a AWS KMS key identifier for the destination AWS Region. AWS KMS CMKs are specific to the AWS Region\n that they are created in, and you can't use CMKs from one AWS Region in another\n AWS Region.\n
" } }, "Tags": { "target": "com.amazonaws.rds#TagList" }, "CopyTags": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags are not copied.
" } }, "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The URL that contains a Signature Version 4 signed request for the\n CopyDBSnapshot API action in the source AWS Region that contains the\n source DB snapshot to copy.
You must specify this parameter when you copy an encrypted DB snapshot from another\n AWS Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are \n copying an encrypted DB snapshot in the same AWS Region.
The presigned URL must be a valid request for the CopyDBSnapshot API action \n that can be executed in the source AWS Region that contains the encrypted DB snapshot to be copied. \n The presigned URL request must contain the following parameter values:\n
\n DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. \n This AWS Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL.\n
For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region\n to the us-east-1 AWS Region, then you call the CopyDBSnapshot action in\n the us-east-1 AWS Region and provide a presigned URL that contains a call to the\n CopyDBSnapshot action in the us-west-2 AWS Region. For this\n example, the DestinationRegion in the presigned URL must be set to\n the us-east-1 AWS Region.
\n KmsKeyId - The AWS KMS key identifier for the customer master key (CMK) to use to encrypt the copy of the DB snapshot in the destination AWS Region. \n This is the same identifier for both the CopyDBSnapshot action that is called in the destination AWS Region, \n and the action contained in the presigned URL.\n
\n SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. \n For example, if you are copying an encrypted DB snapshot from the us-west-2 AWS Region, then your SourceDBSnapshotIdentifier looks like\n the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.\n
To learn how to generate a Signature Version 4 signed request, see \n\t\tAuthenticating Requests: Using Query Parameters (AWS Signature Version 4) and\n\t\tSignature Version 4 Signing Process.\n\t
\n \nIf you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source AWS Region.
The name of an option group to associate with the copy of the snapshot.
\n \nSpecify this option if you are copying a snapshot from one AWS Region to another,\n and your DB instance uses a nondefault option group. \n If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, \n you must specify this option when copying across AWS Regions. \n For more information, see \n Option group considerations in the Amazon RDS User Guide.\n
" } }, "TargetCustomAvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The external custom Availability Zone (CAZ) identifier for the target CAZ.
\nExample: rds-caz-aiqhTgQv.
Copies the specified option group.
" } }, "com.amazonaws.rds#CopyOptionGroupMessage": { "type": "structure", "members": { "SourceOptionGroupIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The identifier for the source option group.\n
\nConstraints:
\nMust specify a valid option group.
\nThe identifier for the copied option group.
\nConstraints:
\nCan't be null, empty, or blank
\nMust contain from 1 to 255 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-option-group\n
The description for the copied option group.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.rds#TagList" } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#CopyOptionGroupResult": { "type": "structure", "members": { "OptionGroup": { "target": "com.amazonaws.rds#OptionGroup" } } }, "com.amazonaws.rds#CreateCustomAvailabilityZone": { "type": "operation", "input": { "target": "com.amazonaws.rds#CreateCustomAvailabilityZoneMessage" }, "output": { "target": "com.amazonaws.rds#CreateCustomAvailabilityZoneResult" }, "errors": [ { "target": "com.amazonaws.rds#CustomAvailabilityZoneAlreadyExistsFault" }, { "target": "com.amazonaws.rds#CustomAvailabilityZoneQuotaExceededFault" }, { "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" } ], "traits": { "smithy.api#documentation": "Creates a custom Availability Zone (AZ).
\nA custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.
\nFor more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n
" } }, "com.amazonaws.rds#CreateCustomAvailabilityZoneMessage": { "type": "structure", "members": { "CustomAvailabilityZoneName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the custom Availability Zone (AZ).
", "smithy.api#required": {} } }, "ExistingVpnId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The ID of an existing virtual private network (VPN) between the Amazon RDS website and\n the VMware vSphere cluster.
" } }, "NewVpnTunnelName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of a new VPN tunnel between the Amazon RDS website and the VMware vSphere cluster.
\nSpecify this parameter only if ExistingVpnId isn't specified.
The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.
\nSpecify this parameter only if ExistingVpnId isn't specified.
Creates a new Amazon Aurora DB cluster.
\nYou can use the ReplicationSourceIdentifier parameter to create the DB\n cluster as a read replica of another DB cluster or Amazon RDS MySQL DB instance. For\n cross-region replication where the DB cluster identified by\n ReplicationSourceIdentifier is encrypted, you must also specify the\n PreSignedUrl parameter.
For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nCreates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
\nThis action only applies to Aurora DB clusters.
\nThe DB cluster identifier of the DB cluster associated with the endpoint. This parameter is\n stored as a lowercase string.
", "smithy.api#required": {} } }, "DBClusterEndpointIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
", "smithy.api#required": {} } }, "EndpointType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The type of the endpoint. One of: READER, WRITER, ANY.
List of DB instance identifiers that are part of the custom endpoint group.
" } }, "ExcludedMembers": { "target": "com.amazonaws.rds#StringList", "traits": { "smithy.api#documentation": "List of DB instance identifiers that aren't part of the custom endpoint group.\n All other eligible instances are reachable through the custom endpoint.\n Only relevant if the list of static members is empty.
" } }, "Tags": { "target": "com.amazonaws.rds#TagList", "traits": { "smithy.api#documentation": "The tags to be assigned to the Amazon RDS resource.
" } } } }, "com.amazonaws.rds#CreateDBClusterMessage": { "type": "structure", "members": { "AvailabilityZones": { "target": "com.amazonaws.rds#AvailabilityZones", "traits": { "smithy.api#documentation": "A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on\n AWS Regions and Availability Zones, see \n Choosing the Regions and \n Availability Zones in the Amazon Aurora User Guide.\n
" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The number of days for which automated backups are retained.
\nDefault: 1
\nConstraints:
\nMust be a value from 1 to 35
\nA value that indicates that the DB cluster should be associated with the specified CharacterSet.
" } }, "DatabaseName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name for your database of up to 64 alphanumeric characters. If you do not\n provide a name, Amazon RDS doesn't create a database in the DB cluster you are\n creating.
" } }, "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The DB cluster identifier. This parameter is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: my-cluster1\n
\n The name of the DB cluster parameter group to associate\n with this DB cluster. If you do not specify a value, then \n the default DB cluster parameter group for the specified DB engine and version is used.\n
\nConstraints:
\nIf supplied, must match the name of an existing DB cluster parameter group.
\nA list of EC2 VPC security groups to associate with this DB cluster.
" } }, "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "A DB subnet group to associate with this DB cluster.
\nConstraints: Must match the name of an existing DBSubnetGroup. Must not be default.
\nExample: mySubnetgroup\n
The name of the database engine to be used for this DB cluster.
\nValid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql \n
The version number of the database engine to use.
\nTo list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for aurora-postgresql, use the following command:
\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n
\n Aurora MySQL\n
\nExample: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5\n
\n Aurora PostgreSQL\n
\nExample: 9.6.3, 10.7\n
The port number on which the instances in the DB cluster accept connections.
\n\n Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.\n
The name of the master user for the DB cluster.
\nConstraints:
\nMust be 1 to 16 letters or numbers.
\nFirst character must be a letter.
\nCan't be a reserved word for the chosen database engine.
\nThe password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
\nConstraints: Must contain from 8 to 41 characters.
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "A value that indicates that the DB cluster should be associated with the specified option group.
\nPermanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
" } }, "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.\n
The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.\n
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nThe weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
\nFormat: ddd:hh24:mi-ddd:hh24:mi\n
The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.\n
\nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
\nConstraints: Minimum 30-minute window.
" } }, "ReplicationSourceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB\n cluster is created as a read replica.
" } }, "Tags": { "target": "com.amazonaws.rds#TagList", "traits": { "smithy.api#documentation": "Tags to assign to the DB cluster.
" } }, "StorageEncrypted": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether the DB cluster is encrypted.
" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The AWS KMS key identifier for an encrypted DB cluster.
\nThe AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).\n To use a CMK in a different AWS account, specify the key ARN or alias ARN.
\nWhen a CMK isn't specified in KmsKeyId:
If ReplicationSourceIdentifier identifies an encrypted\n source, then Amazon RDS will use the CMK used to encrypt the\n source. Otherwise, Amazon RDS will use your default CMK.
If the StorageEncrypted parameter is enabled and\n ReplicationSourceIdentifier isn't specified, then Amazon RDS\n will use your default CMK.
There is a default CMK for your AWS account. Your AWS account\n has a different default CMK for each AWS Region.
\nIf you create a read replica of an encrypted DB cluster in another AWS Region, you\n must set KmsKeyId to a AWS KMS key identifier that is valid in the destination AWS\n Region. This CMK is used to encrypt the read replica in that AWS Region.
A URL that contains a Signature Version 4 signed request for \n the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. \n You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.
The pre-signed URL must be a valid request for the CreateDBCluster API action \n that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied.
The pre-signed URL request must contain the following parameter values:
\n\n KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of \n the DB cluster in the destination AWS Region. This should refer to the same AWS KMS CMK for both the CreateDBCluster \n action that is called in the destination AWS Region, and the action contained in the pre-signed URL.
\n DestinationRegion - The name of the AWS Region that Aurora read replica will\n be created in.
\n ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an \n encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like\n Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.
To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and\n \n Signature Version 4 Signing Process.
\nIf you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source AWS Region.
A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n
" } }, "BacktrackWindow": { "target": "com.amazonaws.rds#LongOptional", "traits": { "smithy.api#documentation": "The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.
\nCurrently, Backtrack is only supported for Aurora MySQL DB clusters.
\nDefault: 0
\nConstraints:
\nIf specified, this value must be set to a number from 0 to 259,200 (72 hours).
\nThe list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
\n\n Aurora MySQL\n
\nPossible values are audit, error, general, and slowquery. \n
\n Aurora PostgreSQL\n
\nPossible value is postgresql.\n
The DB engine mode of the DB cluster, either provisioned, serverless, \n parallelquery, global, or multimaster.
The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, \n and version 2.09 and higher 2.x versions.
The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, \n and global engine mode isn't required for any 2.x versions.
The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.
For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery \n and the multimaster engine modes currently aren't supported.
Limitations and requirements apply to some DB engine modes. For more information, see the \n following sections in the Amazon Aurora User Guide:
\nFor DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled.
" } }, "GlobalClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n The global cluster ID of an Aurora cluster that becomes the primary cluster\n in the new global database cluster.\n
" } }, "EnableHttpEndpoint": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint \n is disabled.
\nWhen enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless DB cluster. You can also query your database\n from inside the RDS console with the query editor.
\nFor more information, see Using the Data API for Aurora Serverless in the \n Amazon Aurora User Guide.
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.
" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Active Directory directory ID to create the DB cluster in.
\n\n For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.\n
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
" } }, "EnableGlobalWriteForwarding": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an\n Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.
\nYou can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the\n primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.\n
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#CreateDBClusterParameterGroup": { "type": "operation", "input": { "target": "com.amazonaws.rds#CreateDBClusterParameterGroupMessage" }, "output": { "target": "com.amazonaws.rds#CreateDBClusterParameterGroupResult" }, "errors": [ { "target": "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault" }, { "target": "com.amazonaws.rds#DBParameterGroupQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "Creates a new DB cluster parameter group.
\nParameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
\n\n A DB cluster parameter group is initially created with the default parameters for the\n database engine used by instances in the DB cluster. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to\n associate it with your DB cluster using ModifyDBCluster. When you associate\n a new DB cluster parameter group with a running DB cluster, you need to reboot the DB\n instances in the DB cluster without failover for the new DB cluster parameter group and \n associated settings to take effect. \n
After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster\n that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters action to verify \n that your DB cluster parameter group has been created or modified.
For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nThe name of the DB cluster parameter group.
\nConstraints:
\nMust match the name of an existing DB cluster parameter group.
\nThis value is stored as a lowercase string.
\nThe DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster \n parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
\n\n Aurora MySQL\n
\nExample: aurora5.6, aurora-mysql5.7\n
\n Aurora PostgreSQL\n
\nExample: aurora-postgresql9.6\n
The description for the DB cluster parameter group.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.rds#TagList", "traits": { "smithy.api#documentation": "Tags to assign to the DB cluster parameter group.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#CreateDBClusterParameterGroupResult": { "type": "structure", "members": { "DBClusterParameterGroup": { "target": "com.amazonaws.rds#DBClusterParameterGroup" } } }, "com.amazonaws.rds#CreateDBClusterResult": { "type": "structure", "members": { "DBCluster": { "target": "com.amazonaws.rds#DBCluster" } } }, "com.amazonaws.rds#CreateDBClusterSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.rds#CreateDBClusterSnapshotMessage" }, "output": { "target": "com.amazonaws.rds#CreateDBClusterSnapshotResult" }, "errors": [ { "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, { "target": "com.amazonaws.rds#DBClusterSnapshotAlreadyExistsFault" }, { "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" }, { "target": "com.amazonaws.rds#InvalidDBClusterStateFault" }, { "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nThe identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: my-cluster1-snapshot1\n
The identifier of the DB cluster to create a snapshot for. This parameter isn't case-sensitive.
\nConstraints:
\nMust match the identifier of an existing DBCluster.
\nExample: my-cluster1\n
The tags to be assigned to the DB cluster snapshot.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#CreateDBClusterSnapshotResult": { "type": "structure", "members": { "DBClusterSnapshot": { "target": "com.amazonaws.rds#DBClusterSnapshot" } } }, "com.amazonaws.rds#CreateDBInstance": { "type": "operation", "input": { "target": "com.amazonaws.rds#CreateDBInstanceMessage" }, "output": { "target": "com.amazonaws.rds#CreateDBInstanceResult" }, "errors": [ { "target": "com.amazonaws.rds#AuthorizationNotFoundFault" }, { "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" }, { "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, { "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" }, { "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" }, { "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" }, { "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" }, { "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" }, { "target": "com.amazonaws.rds#DomainNotFoundFault" }, { "target": "com.amazonaws.rds#InstanceQuotaExceededFault" }, { "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" }, { "target": "com.amazonaws.rds#InvalidDBClusterStateFault" }, { "target": "com.amazonaws.rds#InvalidSubnet" }, { "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" }, { "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" }, { "target": "com.amazonaws.rds#OptionGroupNotFoundFault" }, { "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" }, { "target": "com.amazonaws.rds#StorageQuotaExceededFault" }, { "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" } ], "traits": { "smithy.api#documentation": "Creates a new DB instance.
" } }, "com.amazonaws.rds#CreateDBInstanceMessage": { "type": "structure", "members": { "DBName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The meaning of this parameter differs according to the database engine you use.
\n\n MySQL\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
\nConstraints:
\nMust contain 1 to 64 letters or numbers.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n MariaDB\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
\nConstraints:
\nMust contain 1 to 64 letters or numbers.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n PostgreSQL\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres \n is created in the DB instance.
Constraints:
\nMust contain 1 to 63 letters, numbers, or underscores.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n Oracle\n
\nThe Oracle System ID (SID) of the created DB instance.\n If you specify null, the default value ORCL is used.\n You can't specify the string NULL, or any other reserved word, for DBName. \n
Default: ORCL\n
Constraints:
\nCan't be longer than 8 characters
\n\n SQL Server\n
\nNot applicable. Must be null.
\n\n Amazon Aurora MySQL\n
\nThe name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created \n in the DB cluster.
\nConstraints:
\nIt must contain 1 to 64 alphanumeric characters.
\nIt can't be a word reserved by the database engine.
\n\n Amazon Aurora PostgreSQL\n
\nThe name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, \n a database named postgres is created in the DB cluster.
Constraints:
\nIt must contain 1 to 63 alphanumeric characters.
\nIt must begin with a letter or an underscore.\n Subsequent characters can be letters, underscores, or digits\n (0 to 9).
\nIt can't be a word reserved by the\n database engine.
\nThe DB instance identifier. This parameter is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: mydbinstance\n
The amount of storage (in gibibytes) to allocate for the DB instance.
\nType: Integer
\n\n Amazon Aurora\n
\nNot applicable. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.
\n\n\n MySQL\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\n\n MariaDB\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\n\n PostgreSQL\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\n\n Oracle\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 10 to 3072.
\n\n SQL Server\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2):
\nEnterprise and Standard editions: Must be an integer from 200 to 16384.
\nWeb and Express editions: Must be an integer from 20 to 16384.
\nProvisioned IOPS storage (io1):
\nEnterprise and Standard editions: Must be an integer from 200 to 16384.
\nWeb and Express editions: Must be an integer from 100 to 16384.
\nMagnetic storage (standard):
\nEnterprise and Standard editions: Must be an integer from 200 to 1024.
\nWeb and Express editions: Must be an integer from 20 to 1024.
\nThe compute and memory capacity of the DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all AWS Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n
The name of the database engine to be used for this instance.\n
\n \nNot every database engine is available for every AWS Region.\n
\n\nValid Values:\n
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible Aurora)
\n aurora-postgresql\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-se2\n
\n oracle-se1\n
\n oracle-se\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The name for the master user.
\n\n\n Amazon Aurora\n
\nNot applicable. The name for the master user is managed by the DB cluster.\n
\n\n\n MariaDB\n
\nConstraints:
\nRequired for MariaDB.
\nMust be 1 to 16 letters or numbers.
\nCan't be a reserved word for the chosen database engine.
\n\n Microsoft SQL Server\n
\nConstraints:
\nRequired for SQL Server.
\nMust be 1 to 128 letters or numbers.
\nThe first character must be a letter.
\nCan't be a reserved word for the chosen database engine.
\n\n MySQL\n
\nConstraints:
\nRequired for MySQL.
\nMust be 1 to 16 letters or numbers.
\nFirst character must be a letter.
\nCan't be a reserved word for the chosen database engine.
\n\n Oracle\n
\nConstraints:
\nRequired for Oracle.
\nMust be 1 to 30 letters or numbers.
\nFirst character must be a letter.
\nCan't be a reserved word for the chosen database engine.
\n\n PostgreSQL\n
\nConstraints:
\nRequired for PostgreSQL.
\nMust be 1 to 63 letters or numbers.
\nFirst character must be a letter.
\nCan't be a reserved word for the chosen database engine.
\nThe password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".
\n\n\n Amazon Aurora\n
\nNot applicable. The password for the master user is managed by the DB\n cluster.
\n\n\n MariaDB\n
\nConstraints: Must contain from 8 to 41 characters.
\n\n\n Microsoft SQL Server\n
\nConstraints: Must contain from 8 to 128 characters.
\n \n\n MySQL\n
\nConstraints: Must contain from 8 to 41 characters.
\n\n\n Oracle\n
\nConstraints: Must contain from 8 to 30 characters.
\n\n\n PostgreSQL\n
\nConstraints: Must contain from 8 to 128 characters.
" } }, "DBSecurityGroups": { "target": "com.amazonaws.rds#DBSecurityGroupNameList", "traits": { "smithy.api#documentation": "A list of DB security groups to associate with this DB instance.
\nDefault: The default DB security group for the database engine.
" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { "smithy.api#documentation": "A list of Amazon EC2 VPC security groups to associate with this DB instance.
\n \n\n Amazon Aurora\n
\nNot applicable. The associated list of EC2 VPC security groups is managed by\n the DB cluster.
\n \nDefault: The default EC2 VPC security group for the DB subnet group's VPC.
" } }, "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n The Availability Zone (AZ) where the database will be created. For information on\n AWS Regions and Availability Zones, see \n Regions\n and Availability Zones.\n
\nDefault: A random, system-chosen Availability Zone in the endpoint's AWS Region.
\n\n Example: us-east-1d\n
\n Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same AWS Region as the current endpoint.\n
If you're creating a DB instance in an RDS on VMware environment,\n specify the identifier of the custom Availability Zone to create the DB instance\n in.
\nFor more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n
\nA DB subnet group to associate with this DB instance.
\nIf there is no DB subnet group, then it is a non-VPC DB instance.
" } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The time range each week during which system maintenance can occur, \n in Universal Coordinated Time (UTC). \n For more information, see Amazon RDS Maintenance Window.\n
\n\n Format: ddd:hh24:mi-ddd:hh24:mi\n
The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region, occurring on a random day of the\n week.\n
\nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
\nConstraints: Minimum 30-minute window.
" } }, "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then \n the default DB parameter group for the specified DB engine and version is used.
\nConstraints:
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nThe number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
\n\n Amazon Aurora\n
\nNot applicable. The retention period for automated backups is managed by the DB\n cluster.
\nDefault: 1
\nConstraints:
\nMust be a value from 0 to 35
\nCan't be set to 0 if the DB instance is a source to read replicas
\n\n The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region. For more information, see Backup window in the Amazon RDS User Guide.\n
\n Amazon Aurora\n
\nNot applicable. The daily time range for creating automated backups is managed by\n the DB cluster.
\n \nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nThe port number on which the database accepts connections.
\n\n MySQL\n
\n\n Default: 3306\n
Valid values: 1150-65535\n
Type: Integer
\n\n MariaDB\n
\n\n Default: 3306\n
Valid values: 1150-65535\n
Type: Integer
\n\n PostgreSQL\n
\n\n Default: 5432\n
Valid values: 1150-65535\n
Type: Integer
\n\n Oracle\n
\n\n Default: 1521\n
Valid values: 1150-65535\n
\n SQL Server\n
\n\n Default: 1433\n
Valid values: 1150-65535 except 1234, 1434,\n 3260, 3343, 3389, 47001, and\n 49152-49156.
\n Amazon Aurora\n
\n\n Default: 3306\n
Valid values: 1150-65535\n
Type: Integer
" } }, "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set \n the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
The version number of the database engine to use.
\nFor a list of valid engine versions, use the DescribeDBEngineVersions action.
The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every AWS Region.
\n \n\n Amazon Aurora\n
\nNot applicable. The version number of the database engine to be used by the DB\n instance is managed by the DB cluster.
\n \n\n MariaDB\n
\n\nSee MariaDB on Amazon RDS Versions in the \n Amazon RDS User Guide.\n
\n \n\n Microsoft SQL Server\n
\n \nSee Microsoft SQL Server Versions on Amazon RDS in the \n Amazon RDS User Guide.\n
\n \n\n MySQL\n
\n\nSee MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n
\n \n\n Oracle\n
\n \nSee Oracle Database Engine Release Notes in the \n Amazon RDS User Guide.\n
\n\n\n PostgreSQL\n
\n\nSee Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. \n By default, minor engine upgrades are applied automatically.
" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "License model information for this DB instance.
\n\n Valid values: license-included | bring-your-own-license | general-public-license\n
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.\n For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.\n
\nConstraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. \n For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.\n
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "A value that indicates that the DB instance should be associated with the specified option group.
\nPermanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance
" } }, "CharacterSetName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
\n \n\n Amazon Aurora\n
\nNot applicable. The character set is managed by\n the DB cluster. For more information, see CreateDBCluster.
The name of the NCHAR character set for the Oracle DB instance.
" } }, "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nDefault: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private.
\nIf the default VPC in the target region has an Internet gateway attached to it, the DB instance is public.
\nIf DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private.
\nIf the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public.
\nTags to assign to the DB instance.
" } }, "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The identifier of the DB cluster that the instance will belong to.
" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the storage type to be associated with the DB instance.
\n\n Valid values: standard | gp2 | io1\n
\n If you specify io1, you must also include a value for the\n Iops parameter.\n
\n Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
The ARN from the key store with which to associate the instance for TDE encryption.
" } }, "TdeCredentialPassword": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The password for the given ARN from the key store in order to access the device.
" } }, "StorageEncrypted": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
\n \n\n Amazon Aurora\n
\nNot applicable. The encryption for DB instances is managed by\n the DB cluster.
" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The AWS KMS key identifier for an encrypted DB instance.
\nThe AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).\n To use a CMK in a different AWS account, specify the key ARN or alias ARN.
\n\n Amazon Aurora\n
\nNot applicable. The AWS KMS key identifier is managed by\n the DB cluster. For more information, see CreateDBCluster.
If StorageEncrypted is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS uses your default CMK. There is a \n default CMK for your AWS account. Your AWS account has a different\n default CMK for each AWS Region.
The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
\n\n Amazon Aurora\n
\nNot applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting.
" } }, "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
\nIf MonitoringRoleArn is specified, then you must also set MonitoringInterval\n to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60\n
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
Specify the name of the IAM role to be used when making API calls to the Directory Service.
" } }, "PromotionTier": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.\n
\nDefault: 1
\nValid Values: 0 - 15
" } }, "Timezone": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The time zone of the DB instance. \n The time zone parameter is currently supported only by\n Microsoft SQL Server.\n
" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nThis setting doesn't apply to Amazon Aurora. Mapping AWS IAM accounts to database accounts is managed by the DB\n cluster.
\n \nFor more information, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" } }, "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to enable Performance Insights for the DB instance.\n
\nFor more information, see \n Using Amazon Performance Insights in the Amazon Relational Database Service\n User Guide.\n
" } }, "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The AWS KMS key identifier for encryption of Performance Insights data.
\nThe AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default CMK. There is a default CMK for your AWS account. \n Your AWS account has a different default CMK for each AWS Region.
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
" } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { "smithy.api#documentation": "The list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database\n Service User Guide.
\n\n Amazon Aurora\n
\nNot applicable. CloudWatch Logs exports are managed by the DB cluster.\n
\n\n MariaDB\n
\nPossible values are audit, error, general, and slowquery. \n
\n Microsoft SQL Server\n
\nPossible values are agent and error.\n
\n MySQL\n
\nPossible values are audit, error, general, and slowquery. \n
\n Oracle\n
\nPossible values are alert, audit, listener, trace, and\n oemagent.\n
\n PostgreSQL\n
\nPossible values are postgresql and upgrade.\n
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled. For more information, see \n \n Deleting a DB Instance.\n
\n\n Amazon Aurora\n
\nNot applicable. You can enable or disable deletion protection for the DB cluster. \n For more information, see CreateDBCluster. DB instances in a DB \n cluster can be deleted even when deletion protection is enabled for the DB cluster.\n
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
\nFor more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.
" } }, "EnableCustomerOwnedIp": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the AWS Outposts User Guide.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#CreateDBInstanceReadReplica": { "type": "operation", "input": { "target": "com.amazonaws.rds#CreateDBInstanceReadReplicaMessage" }, "output": { "target": "com.amazonaws.rds#CreateDBInstanceReadReplicaResult" }, "errors": [ { "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" }, { "target": "com.amazonaws.rds#DBInstanceNotFoundFault" }, { "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" }, { "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" }, { "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" }, { "target": "com.amazonaws.rds#DBSubnetGroupNotAllowedFault" }, { "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" }, { "target": "com.amazonaws.rds#DomainNotFoundFault" }, { "target": "com.amazonaws.rds#InstanceQuotaExceededFault" }, { "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" }, { "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" }, { "target": "com.amazonaws.rds#InvalidDBSubnetGroupFault" }, { "target": "com.amazonaws.rds#InvalidSubnet" }, { "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" }, { "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" }, { "target": "com.amazonaws.rds#OptionGroupNotFoundFault" }, { "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" }, { "target": "com.amazonaws.rds#StorageQuotaExceededFault" }, { "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" } ], "traits": { "smithy.api#documentation": "Creates a new DB instance that acts as a read replica for an existing source DB\n instance. You can create a read replica for a DB instance running MySQL, MariaDB,\n Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read\n Replicas in the Amazon RDS User Guide.
\n\nAmazon Aurora doesn't support this action. Call the CreateDBInstance\n action to create a DB instance for an Aurora DB cluster.
All read replica DB instances are created with backups disabled. All other DB\n instance attributes (including DB security groups and DB parameter groups) are inherited\n from the source DB instance, except as specified.
\n\nYour source DB instance must have backup retention enabled.\n
\nThe DB instance identifier of the read replica. This identifier is the unique key\n that identifies a DB instance. This parameter is stored as a lowercase string.
", "smithy.api#required": {} } }, "SourceDBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The identifier of the DB instance that will act as the source for the read replica.\n Each DB instance can have up to five read replicas.
\nConstraints:
\nMust be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB\n instance.
\nCan specify a DB instance that is a MySQL read replica only if the source is running MySQL\n 5.6 or later.
\nFor the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the\n Amazon RDS User Guide.
\nFor the limitations of SQL Server read replicas, see Read Replica\n Limitations with Microsoft SQL Server in the Amazon RDS User Guide.
\nCan specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or\n later (9.4.7 and higher for cross-region replication).
\nThe specified DB instance must have automatic backups enabled, that is, its backup\n retention period must be greater than 0.
\nIf the source DB instance is in the same AWS Region as the read replica, specify a valid DB\n instance identifier.
\nIf the source DB instance is in a different AWS Region from the read replica, specify a valid DB instance ARN. \n For more information, see Constructing an ARN for Amazon RDS \n in the Amazon RDS User Guide. This doesn't apply to SQL Server, which doesn't support cross-region replicas.
\nThe compute and memory capacity of the read replica, for example,\n db.m4.large. Not all DB instance classes are available in all AWS\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.\n
Default: Inherits from the source DB instance.
" } }, "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Availability Zone (AZ) where the read replica will be created.
\nDefault: A random, system-chosen Availability Zone in the endpoint's AWS Region.
\n\n Example: us-east-1d\n
The port number that the DB instance uses for connections.
\nDefault: Inherits from the source DB instance
\nValid Values: 1150-65535\n
A value that indicates whether the read replica is in a Multi-AZ deployment.
\n \nYou can create a read replica as a Multi-AZ DB instance. RDS creates a standby of\n your replica in another Availability Zone for failover support for the replica. Creating\n your read replica as a Multi-AZ DB instance is independent of whether the source\n database is a Multi-AZ DB instance.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether minor engine upgrades are applied automatically to the\n read replica during the maintenance window.
\nDefault: Inherits from the source DB instance
" } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.
\nFor SQL Server, you must use the option group associated with the source\n instance.
\nThe name of the DB parameter group to associate with this DB instance.
\nIf you do not specify a value for DBParameterGroupName, then Amazon RDS\n uses the DBParameterGroup of source DB instance for a same region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross region read replica.
Currently, specifying a parameter group for this operation is only supported for Oracle DB instances.
\nConstraints:
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nA value that indicates whether the DB instance is publicly accessible.
\nWhen the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" } }, "Tags": { "target": "com.amazonaws.rds#TagList" }, "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.
\nConstraints:
\nCan only be specified if the source DB instance identifier specifies a DB instance in another AWS Region.
\nIf supplied, must match the name of an existing DBSubnetGroup.
\nThe specified DB subnet group must be in the same AWS Region in which the operation is running.
\nAll read replicas in one AWS Region that are created from the same source DB\n instance must either:>
\nSpecify DB subnet groups from the same VPC. All these read replicas are created in the same\n VPC.
\nNot specify a DB subnet group. All these read replicas are created outside of any\n VPC.
\nExample: mySubnetgroup\n
A list of EC2 VPC security groups to associate with the read replica.
\n\n Default: The default EC2 VPC security group for the DB subnet group's VPC.\n
" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the storage type to be associated with the read replica.
\n\n Valid values: standard | gp2 | io1\n
\n If you specify io1, you must also include a value for the\n Iops parameter.\n
\n Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
A value that indicates whether to copy all tags from the read replica to snapshots of\n the read replica. By default, tags are not copied.
" } }, "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The interval, in seconds, between points when Enhanced Monitoring metrics are\n collected for the read replica. To disable collecting Enhanced Monitoring metrics,\n specify 0. The default is 0.
\nIf MonitoringRoleArn is specified, then you must also set MonitoringInterval\n to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60\n
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
The AWS KMS key identifier for an encrypted read replica.
\nThe AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS CMK.
\nIf you create an encrypted read replica in the same AWS Region as the source DB\n instance, then do not specify a value for this parameter. A read replica in the same Region\n is always encrypted with the same AWS KMS CMK as the source DB instance.
\nIf you create an encrypted read replica in a different AWS Region, then you must\n specify a AWS KMS key identifier for the destination AWS Region. AWS KMS CMKs are specific to\n the AWS Region that they are created in, and you can't use CMKs from one\n AWS Region in another AWS Region.
\nYou can't create an encrypted read replica from an unencrypted DB instance.
" } }, "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action \n in the source AWS Region that contains the source DB instance.\n
You must specify this parameter when you create an encrypted read replica from\n another AWS Region by using the Amazon RDS API. Don't specify\n PreSignedUrl when you are creating an encrypted read replica in the\n same AWS Region.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action \n that can be executed in the source AWS Region that contains the encrypted source DB instance. \n The presigned URL request must contain the following parameter values:\n
\n DestinationRegion - The AWS Region that the encrypted read\n replica is created in. This AWS Region is the same one where the\n CreateDBInstanceReadReplica action is called that contains this presigned URL.
For example, if you create an encrypted DB instance in the us-west-1 AWS Region,\n from a source DB instance in the us-east-2 AWS Region, \n then you call the CreateDBInstanceReadReplica action in\n the us-east-1 AWS Region and provide a presigned URL that contains a call to the\n CreateDBInstanceReadReplica action in the us-west-2 AWS Region. For this\n example, the DestinationRegion in the presigned URL must be set to\n the us-east-1 AWS Region.\n
\n KmsKeyId - The AWS KMS key identifier for the key to use to\n encrypt the read replica in the destination AWS Region. This is the same\n identifier for both the CreateDBInstanceReadReplica action that is\n called in the destination AWS Region, and the action contained in the presigned\n URL.
\n SourceDBInstanceIdentifier - The DB instance identifier for\n the encrypted DB instance to be replicated. This identifier must be in the\n Amazon Resource Name (ARN) format for the source AWS Region. For example, if you\n are creating an encrypted read replica from a DB instance in the us-west-2 AWS\n Region, then your SourceDBInstanceIdentifier looks like the\n following example:\n arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.
To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and\n Signature Version 4 Signing Process.\n
\n \nIf you are using an AWS SDK tool or the AWS CLI, you can specify\n SourceRegion (or --source-region for the AWS CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can be executed in the source AWS Region.
\n SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS\n doesn't support cross-region read replicas.
A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" } }, "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to enable Performance Insights for the read replica.
\nFor more information, see Using\n Amazon Performance Insights in the Amazon RDS User Guide.\n
" } }, "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The AWS KMS key identifier for encryption of Performance Insights data.
\nThe AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default CMK. There is a default CMK for your AWS account. \n Your AWS account has a different default CMK for each AWS Region.
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
" } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { "smithy.api#documentation": "The list of logs that the new DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing\n Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
" } }, "ProcessorFeatures": { "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
" } }, "UseDefaultProcessorFeatures": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.
" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled. For more information, see \n \n Deleting a DB Instance.\n
" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
" } }, "ReplicaMode": { "target": "com.amazonaws.rds#ReplicaMode", "traits": { "smithy.api#documentation": "The open mode of the replica database: mounted or read-only.
\nThis parameter is only supported for Oracle DB instances.
\nMounted DB replicas are included in Oracle Enterprise Edition. The main use case for\n mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active\n Data Guard to transmit information to the mounted replica. Because it doesn't accept\n user connections, a mounted replica can't serve a read-only workload.
\nYou can create a combination of mounted and read-only DB replicas for the same primary DB instance.\n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.
" } }, "MaxAllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
\nFor more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.
" } } } }, "com.amazonaws.rds#CreateDBInstanceReadReplicaResult": { "type": "structure", "members": { "DBInstance": { "target": "com.amazonaws.rds#DBInstance" } } }, "com.amazonaws.rds#CreateDBInstanceResult": { "type": "structure", "members": { "DBInstance": { "target": "com.amazonaws.rds#DBInstance" } } }, "com.amazonaws.rds#CreateDBParameterGroup": { "type": "operation", "input": { "target": "com.amazonaws.rds#CreateDBParameterGroupMessage" }, "output": { "target": "com.amazonaws.rds#CreateDBParameterGroupResult" }, "errors": [ { "target": "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault" }, { "target": "com.amazonaws.rds#DBParameterGroupQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "Creates a new DB parameter group.
\n\n A DB parameter group is initially created with the default parameters for the\n database engine used by the DB instance. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBParameterGroup. Once you've created a DB parameter group, you need to\n associate it with your DB instance using ModifyDBInstance. When you associate\n a new DB parameter group with a running DB instance, you need to reboot the DB\n instance without failover for the new DB parameter group and associated settings to take effect. \n
\nAfter you create a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.
The name of the DB parameter group.
\nConstraints:
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nThis value is stored as a lowercase string.
\nThe DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
\nTo list all of the available parameter group families, use the following command:
\n\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\"\n
The output contains duplicates.
\nThe description for the DB parameter group.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.rds#TagList", "traits": { "smithy.api#documentation": "Tags to assign to the DB parameter group.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#CreateDBParameterGroupResult": { "type": "structure", "members": { "DBParameterGroup": { "target": "com.amazonaws.rds#DBParameterGroup" } } }, "com.amazonaws.rds#CreateDBProxy": { "type": "operation", "input": { "target": "com.amazonaws.rds#CreateDBProxyRequest" }, "output": { "target": "com.amazonaws.rds#CreateDBProxyResponse" }, "errors": [ { "target": "com.amazonaws.rds#DBProxyAlreadyExistsFault" }, { "target": "com.amazonaws.rds#DBProxyQuotaExceededFault" }, { "target": "com.amazonaws.rds#InvalidSubnet" } ], "traits": { "smithy.api#documentation": "Creates a new DB proxy.
" } }, "com.amazonaws.rds#CreateDBProxyEndpoint": { "type": "operation", "input": { "target": "com.amazonaws.rds#CreateDBProxyEndpointRequest" }, "output": { "target": "com.amazonaws.rds#CreateDBProxyEndpointResponse" }, "errors": [ { "target": "com.amazonaws.rds#DBProxyEndpointAlreadyExistsFault" }, { "target": "com.amazonaws.rds#DBProxyEndpointQuotaExceededFault" }, { "target": "com.amazonaws.rds#DBProxyNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidDBProxyStateFault" }, { "target": "com.amazonaws.rds#InvalidSubnet" } ], "traits": { "smithy.api#documentation": "\n Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters.\n You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use\n DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC.\n
The name of the DB proxy associated with the DB proxy endpoint that you create.
", "smithy.api#required": {} } }, "DBProxyEndpointName": { "target": "com.amazonaws.rds#DBProxyEndpointName", "traits": { "smithy.api#documentation": "The name of the DB proxy endpoint to create.
", "smithy.api#required": {} } }, "VpcSubnetIds": { "target": "com.amazonaws.rds#StringList", "traits": { "smithy.api#documentation": "The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a\n different set of subnet IDs than for the original DB proxy.
", "smithy.api#required": {} } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#StringList", "traits": { "smithy.api#documentation": "The VPC security group IDs for the DB proxy endpoint that you create. You can\n specify a different set of security group IDs than for the original DB proxy.\n The default is the default security group for the VPC.
" } }, "TargetRole": { "target": "com.amazonaws.rds#DBProxyEndpointTargetRole", "traits": { "smithy.api#documentation": "A value that indicates whether the DB proxy endpoint can be used for read/write\n or read-only operations. The default is READ_WRITE.
The DBProxyEndpoint object that is created by the API operation.\n The DB proxy endpoint that you create might provide capabilities such as read/write\n or read-only operations, or using a different VPC than the proxy's default VPC.
The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region. 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.
", "smithy.api#required": {} } }, "EngineFamily": { "target": "com.amazonaws.rds#EngineFamily", "traits": { "smithy.api#documentation": "The kinds of databases that the proxy can connect to. \n This value determines which database network protocol the proxy recognizes when it interprets\n network traffic to and from the database. \n The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.
", "smithy.api#required": {} } }, "Auth": { "target": "com.amazonaws.rds#UserAuthConfigList", "traits": { "smithy.api#documentation": "The authorization mechanism that the proxy uses.
", "smithy.api#required": {} } }, "RoleArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
", "smithy.api#required": {} } }, "VpcSubnetIds": { "target": "com.amazonaws.rds#StringList", "traits": { "smithy.api#documentation": "One or more VPC subnet IDs to associate with the new proxy.
", "smithy.api#required": {} } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#StringList", "traits": { "smithy.api#documentation": "One or more VPC security group IDs to associate with the new proxy.
" } }, "RequireTLS": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.\n By enabling this setting, you can enforce encrypted TLS connections to the proxy.
" } }, "IdleClientTimeout": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this\n value higher or lower than the connection timeout limit for the associated database.
" } }, "DebugLogging": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.
" } }, "Tags": { "target": "com.amazonaws.rds#TagList", "traits": { "smithy.api#documentation": "An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
" } } } }, "com.amazonaws.rds#CreateDBProxyResponse": { "type": "structure", "members": { "DBProxy": { "target": "com.amazonaws.rds#DBProxy", "traits": { "smithy.api#documentation": "The DBProxy structure corresponding to the new proxy.
Creates a new DB security group. DB security groups control access to a DB instance.
\nA DB security group controls access to EC2-Classic DB instances that are not in a VPC.
\nThe name for the DB security group. This value is stored as a lowercase string.
\nConstraints:
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nMust not be \"Default\"
\nExample: mysecuritygroup\n
The description for the DB security group.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.rds#TagList", "traits": { "smithy.api#documentation": "Tags to assign to the DB security group.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#CreateDBSecurityGroupResult": { "type": "structure", "members": { "DBSecurityGroup": { "target": "com.amazonaws.rds#DBSecurityGroup" } } }, "com.amazonaws.rds#CreateDBSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.rds#CreateDBSnapshotMessage" }, "output": { "target": "com.amazonaws.rds#CreateDBSnapshotResult" }, "errors": [ { "target": "com.amazonaws.rds#DBInstanceNotFoundFault" }, { "target": "com.amazonaws.rds#DBSnapshotAlreadyExistsFault" }, { "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" }, { "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "Creates a snapshot of a DB instance. The source DB instance must be in the available or\n storage-optimization state.
The identifier for the DB snapshot.
\nConstraints:
\nCan't be null, empty, or blank
\nMust contain from 1 to 255 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-snapshot-id\n
The identifier of the DB instance that you want to create the snapshot of.
\nConstraints:
\nMust match the identifier of an existing DBInstance.
\nCreates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.
" } }, "com.amazonaws.rds#CreateDBSubnetGroupMessage": { "type": "structure", "members": { "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name for the DB subnet group. This value is stored as a lowercase string.
\nConstraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.
\nExample: mySubnetgroup\n
The description for the DB subnet group.
", "smithy.api#required": {} } }, "SubnetIds": { "target": "com.amazonaws.rds#SubnetIdentifierList", "traits": { "smithy.api#documentation": "The EC2 Subnet IDs for the DB subnet group.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.rds#TagList", "traits": { "smithy.api#documentation": "Tags to assign to the DB subnet group.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#CreateDBSubnetGroupResult": { "type": "structure", "members": { "DBSubnetGroup": { "target": "com.amazonaws.rds#DBSubnetGroup" } } }, "com.amazonaws.rds#CreateEventSubscription": { "type": "operation", "input": { "target": "com.amazonaws.rds#CreateEventSubscriptionMessage" }, "output": { "target": "com.amazonaws.rds#CreateEventSubscriptionResult" }, "errors": [ { "target": "com.amazonaws.rds#EventSubscriptionQuotaExceededFault" }, { "target": "com.amazonaws.rds#SNSInvalidTopicFault" }, { "target": "com.amazonaws.rds#SNSNoAuthorizationFault" }, { "target": "com.amazonaws.rds#SNSTopicArnNotFoundFault" }, { "target": "com.amazonaws.rds#SourceNotFoundFault" }, { "target": "com.amazonaws.rds#SubscriptionAlreadyExistFault" }, { "target": "com.amazonaws.rds#SubscriptionCategoryNotFoundFault" } ], "traits": { "smithy.api#documentation": "Creates an RDS event notification subscription. This action requires a topic Amazon\n Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API.\n To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the\n topic. The ARN is displayed in the SNS console.
\nYou can specify the type of source (SourceType) that you want to be\n notified of and provide a list of RDS sources (SourceIds) that triggers the\n events. You can also provide a list of event categories (EventCategories)\n for events that you want to be notified of. For example, you can specify\n SourceType = db-instance, SourceIds =\n mydbinstance1, mydbinstance2 and\n EventCategories = Availability,\n Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance\n and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for\n the specified source. If you specify a SourceType but do not specify a SourceIdentifier,\n you receive notice of the events for that source type for all your RDS sources. If you\n don't specify either the SourceType or the SourceIdentifier, you are notified of events\n generated from all RDS sources belonging to your customer account.
RDS event notification is only available for unencrypted SNS topics. If you specify an \n encrypted SNS topic, event notifications aren't sent for the topic.
\nThe name of the subscription.
\nConstraints: The name must be less than 255 characters.
", "smithy.api#required": {} } }, "SnsTopicArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
", "smithy.api#required": {} } }, "SourceType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The type of source that is generating the events. For example, if you want to be\n notified of events generated by a DB instance, you set this parameter to\n db-instance. If this value isn't specified, all events are\n returned.
Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot \n
A list of event categories for a particular source type (SourceType)\n that you want to subscribe to. You can see a list of the categories for a given source\n type in Events in the\n Amazon RDS User Guide or by using the DescribeEventCategories operation.
The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. \n 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.
\nConstraints:
\nIf SourceIds are supplied, SourceType must also be provided.
If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
\n A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.\n
" } }, "Tags": { "target": "com.amazonaws.rds#TagList" } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#CreateEventSubscriptionResult": { "type": "structure", "members": { "EventSubscription": { "target": "com.amazonaws.rds#EventSubscription" } } }, "com.amazonaws.rds#CreateGlobalCluster": { "type": "operation", "input": { "target": "com.amazonaws.rds#CreateGlobalClusterMessage" }, "output": { "target": "com.amazonaws.rds#CreateGlobalClusterResult" }, "errors": [ { "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, { "target": "com.amazonaws.rds#GlobalClusterAlreadyExistsFault" }, { "target": "com.amazonaws.rds#GlobalClusterQuotaExceededFault" }, { "target": "com.amazonaws.rds#InvalidDBClusterStateFault" } ], "traits": { "smithy.api#documentation": "\n Creates an Aurora global database\n spread across multiple AWS Regions. The global database\n contains a single primary cluster with read-write capability,\n and a read-only secondary cluster that receives\n data from the primary cluster through high-speed replication\n performed by the Aurora storage subsystem.\n
\n\n You can create a global database that is initially empty, and then\n add a primary cluster and a secondary cluster to it.\n Or you can specify an existing Aurora cluster during the create operation,\n and this cluster becomes the primary cluster of the global database.\n
\nThis action only applies to Aurora DB clusters.
\nThe cluster identifier of the new global database cluster.
" } }, "SourceDBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n The Amazon Resource Name (ARN) to use as the primary cluster of the global database.\n This parameter is optional.\n
" } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the database engine to be used for this DB cluster.
" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The engine version of the Aurora global database.
" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "\n The deletion protection setting for the new global database.\n The global database can't be deleted when deletion protection is enabled.\n
" } }, "DatabaseName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon\n Aurora will not create a database in the global database cluster you are creating.\n
" } }, "StorageEncrypted": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "\n The storage encryption setting for the new global database cluster.\n
" } } } }, "com.amazonaws.rds#CreateGlobalClusterResult": { "type": "structure", "members": { "GlobalCluster": { "target": "com.amazonaws.rds#GlobalCluster" } } }, "com.amazonaws.rds#CreateOptionGroup": { "type": "operation", "input": { "target": "com.amazonaws.rds#CreateOptionGroupMessage" }, "output": { "target": "com.amazonaws.rds#CreateOptionGroupResult" }, "errors": [ { "target": "com.amazonaws.rds#OptionGroupAlreadyExistsFault" }, { "target": "com.amazonaws.rds#OptionGroupQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "Creates a new option group. You can create up to 20 option groups.
" } }, "com.amazonaws.rds#CreateOptionGroupMessage": { "type": "structure", "members": { "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the name of the option group to be created.
\nConstraints:
\nMust be 1 to 255 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: myoptiongroup\n
Specifies the name of the engine that this option group should be associated with.
\nValid Values:\n
\n\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-se2\n
\n oracle-se1\n
\n oracle-se\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
Specifies the major version of the engine that this option group should be associated with.
", "smithy.api#required": {} } }, "OptionGroupDescription": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The description of the option group.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.rds#TagList", "traits": { "smithy.api#documentation": "Tags to assign to the option group.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#CreateOptionGroupResult": { "type": "structure", "members": { "OptionGroup": { "target": "com.amazonaws.rds#OptionGroup" } } }, "com.amazonaws.rds#CustomAvailabilityZone": { "type": "structure", "members": { "CustomAvailabilityZoneId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The identifier of the custom AZ.
\nAmazon RDS generates a unique identifier when a custom AZ is created.
" } }, "CustomAvailabilityZoneName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the custom AZ.
" } }, "CustomAvailabilityZoneStatus": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The status of the custom AZ.
" } }, "VpnDetails": { "target": "com.amazonaws.rds#VpnDetails", "traits": { "smithy.api#documentation": "Information about the virtual private network (VPN) between the VMware vSphere cluster\n and the AWS website.
" } } }, "traits": { "smithy.api#documentation": "A custom Availability Zone (AZ) is an on-premises AZ that is integrated with a VMware vSphere cluster.
\nFor more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n
" } }, "com.amazonaws.rds#CustomAvailabilityZoneAlreadyExistsFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "\n CustomAvailabilityZoneName is already used by an existing custom\n Availability Zone.
An optional pagination token provided by a previous\n DescribeCustomAvailabilityZones request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.
The list of CustomAvailabilityZone objects for the AWS account.
" } } } }, "com.amazonaws.rds#CustomAvailabilityZoneNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "\n CustomAvailabilityZoneId doesn't refer to an existing custom\n Availability Zone identifier.
You have exceeded the maximum number of custom Availability Zones.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#DBCluster": { "type": "structure", "members": { "AllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). \n For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically\n adjusts as needed.
Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "Specifies the number of days for which automatic DB snapshots are retained.
" } }, "CharacterSetName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "If present, specifies the name of the character set that this cluster is associated with.
" } }, "DatabaseName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
" } }, "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
" } }, "DBClusterParameterGroup": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the name of the DB cluster parameter group for the DB cluster.
" } }, "DBSubnetGroup": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
" } }, "Status": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the current state of this DB cluster.
" } }, "PercentProgress": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the progress of the operation as a percentage.
" } }, "EarliestRestorableTime": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "The earliest time to which a database can be restored with point-in-time\n restore.
" } }, "Endpoint": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the connection endpoint for the primary instance of the DB cluster.
" } }, "ReaderEndpoint": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances \n connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections \n to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. \n This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
\nIf a failover occurs, and the Aurora Replica that you are connected to is promoted \n to be the primary instance, your connection is dropped. To \n continue sending your read workload to other Aurora Replicas in the cluster,\n you can then reconnect to the reader endpoint.
" } }, "CustomEndpoints": { "target": "com.amazonaws.rds#StringList", "traits": { "smithy.api#documentation": "Identifies all custom endpoints associated with the cluster.
" } }, "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "Specifies whether the DB cluster has instances in multiple Availability Zones.
" } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the database engine to be used for this DB cluster.
" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Indicates the database engine version.
" } }, "LatestRestorableTime": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "Specifies the latest time to which a database can be restored with point-in-time restore.
" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "Specifies the port that the database engine is listening on.
" } }, "MasterUsername": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Contains the master username for the DB cluster.
" } }, "DBClusterOptionGroupMemberships": { "target": "com.amazonaws.rds#DBClusterOptionGroupMemberships", "traits": { "smithy.api#documentation": "Provides the list of option group memberships for this DB cluster.
" } }, "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.\n
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
" } }, "ReplicationSourceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Contains the identifier of the source DB cluster if this DB cluster is a read\n replica.
" } }, "ReadReplicaIdentifiers": { "target": "com.amazonaws.rds#ReadReplicaIdentifierList", "traits": { "smithy.api#documentation": "Contains one or more identifiers of the read replicas associated with this DB\n cluster.
" } }, "DBClusterMembers": { "target": "com.amazonaws.rds#DBClusterMemberList", "traits": { "smithy.api#documentation": "Provides the list of instances that make up the DB cluster.
" } }, "VpcSecurityGroups": { "target": "com.amazonaws.rds#VpcSecurityGroupMembershipList", "traits": { "smithy.api#documentation": "Provides a list of VPC security groups that the DB cluster belongs to.
" } }, "HostedZoneId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
" } }, "StorageEncrypted": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the DB cluster is encrypted.
" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "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 AWS KMS customer master key (CMK).
" } }, "DbClusterResourceId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever \n the AWS KMS CMK for the DB cluster is accessed.
" } }, "DBClusterArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the DB cluster.
" } }, "AssociatedRoles": { "target": "com.amazonaws.rds#DBClusterRoles", "traits": { "smithy.api#documentation": "Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. \n IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services\n on your behalf.
" } }, "IAMDatabaseAuthenticationEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether the mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
" } }, "CloneGroupId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Identifies the clone group to which the DB cluster is associated.
" } }, "ClusterCreateTime": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
" } }, "EarliestBacktrackTime": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "The earliest time to which a DB cluster can be backtracked.
" } }, "BacktrackWindow": { "target": "com.amazonaws.rds#LongOptional", "traits": { "smithy.api#documentation": "The target backtrack window, in seconds. If this value is set to 0, backtracking is\n disabled for the DB cluster. Otherwise, backtracking is enabled.
" } }, "BacktrackConsumedChangeRecords": { "target": "com.amazonaws.rds#LongOptional", "traits": { "smithy.api#documentation": "The number of change records stored for Backtrack.
" } }, "EnabledCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { "smithy.api#documentation": "A list of log types that this DB cluster is configured to export to CloudWatch Logs.
\nLog types vary by DB engine. For information about the log types for each DB engine, see\n Amazon RDS Database Log Files in the Amazon Aurora User Guide.\n
" } }, "Capacity": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) \n when the cluster is paused.
\nFor more information about Aurora Serverless, see Using Amazon Aurora Serverless in the \n Amazon Aurora User Guide.
" } }, "EngineMode": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The DB engine mode of the DB cluster, either provisioned, serverless,\n parallelquery, global, or multimaster.
For more information, see \n CreateDBCluster.
" } }, "ScalingConfigurationInfo": { "target": "com.amazonaws.rds#ScalingConfigurationInfo" }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "Indicates if the DB cluster has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.\n
" } }, "HttpEndpointEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
\nWhen enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless DB cluster. You can also query your database\n from inside the RDS console with the query editor.
\nFor more information, see Using the Data API for Aurora Serverless in the \n Amazon Aurora User Guide.
" } }, "ActivityStreamMode": { "target": "com.amazonaws.rds#ActivityStreamMode", "traits": { "smithy.api#documentation": "The mode of the database activity stream.\n Database events such as a change or access generate an activity stream event.\n The database session can handle these events either synchronously or asynchronously.\n
" } }, "ActivityStreamStatus": { "target": "com.amazonaws.rds#ActivityStreamStatus", "traits": { "smithy.api#documentation": "The status of the database activity stream.
" } }, "ActivityStreamKmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The AWS KMS key identifier used for encrypting messages in the database activity stream.
\nThe AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
" } }, "ActivityStreamKinesisStreamName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the Amazon Kinesis data stream used for the database activity stream.
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
" } }, "CrossAccountClone": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "Specifies whether the DB cluster is a clone of a DB cluster owned by a different AWS account.
" } }, "DomainMemberships": { "target": "com.amazonaws.rds#DomainMembershipList", "traits": { "smithy.api#documentation": "The Active Directory Domain membership records associated with the DB cluster.
" } }, "TagList": { "target": "com.amazonaws.rds#TagList" }, "GlobalWriteForwardingStatus": { "target": "com.amazonaws.rds#WriteForwardingStatus", "traits": { "smithy.api#documentation": "Specifies whether a secondary cluster in an Aurora global database has\n write forwarding enabled, not enabled, or is in the process of enabling it.
" } }, "GlobalWriteForwardingRequested": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "Specifies whether you have requested to enable write forwarding for a secondary cluster\n in an Aurora global database. Because write forwarding takes time to enable, check the\n value of GlobalWriteForwardingStatus to confirm that the request has completed\n before using the write forwarding feature for this cluster.
A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. \n Specific changes are identified by subelements.
" } } }, "traits": { "smithy.api#documentation": "Contains the details of an Amazon Aurora DB cluster.\n
\nThis data type is used as a response element in the DescribeDBClusters,\n StopDBCluster, and StartDBCluster actions.\n
The user already has a DB cluster with the given identifier.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#DBClusterBacktrack": { "type": "structure", "members": { "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
" } }, "BacktrackIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Contains the backtrack identifier.
" } }, "BacktrackTo": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "The timestamp of the time to which the DB cluster was backtracked.
" } }, "BacktrackedFrom": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "The timestamp of the time from which the DB cluster was backtracked.
" } }, "BacktrackRequestCreationTime": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "The timestamp of the time at which the backtrack was requested.
" } }, "Status": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The status of the backtrack. This property returns one of the following\n values:
\n\n applying - The backtrack is currently being applied to or rolled back from the DB cluster.
\n completed - The backtrack has successfully been applied to or rolled back from the DB cluster.
\n failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.
\n pending - The backtrack is currently pending application to or rollback from the DB cluster.
This data type is used as a response element in the DescribeDBClusterBacktracks action.
A pagination token that can be used in a later DescribeDBClusterBacktracks request.
Contains a list of backtracks for the user.
" } } }, "traits": { "smithy.api#documentation": "Contains the result of a successful invocation of the DescribeDBClusterBacktracks action.
\n BacktrackIdentifier doesn't refer to an existing backtrack.
A user-supplied DB cluster identifier. This identifier is the unique key that\n identifies a DB cluster.
" } }, "PendingCapacity": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "A value that specifies the capacity that the DB cluster scales to next.
" } }, "CurrentCapacity": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The current capacity of the DB cluster.
" } }, "SecondsBeforeTimeout": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.
The timeout action of a call to ModifyCurrentDBClusterCapacity, either \n ForceApplyCapacityChange or RollbackCapacityChange.
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
" } }, "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is\n stored as a lowercase string.
" } }, "DBClusterEndpointResourceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
" } }, "Endpoint": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The DNS address of the endpoint.
" } }, "Status": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "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,\n such as a writer endpoint for a read-only secondary cluster in a global database.
The type of the endpoint. One of: READER, WRITER, CUSTOM.
The type associated with a custom endpoint. One of: READER,\n WRITER, ANY.
List of DB instance identifiers that are part of the custom endpoint group.
" } }, "ExcludedMembers": { "target": "com.amazonaws.rds#StringList", "traits": { "smithy.api#documentation": "List of DB instance identifiers that aren't part of the custom endpoint group.\n All other eligible instances are reachable through the custom endpoint.\n Only relevant if the list of static members is empty.
" } }, "DBClusterEndpointArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the endpoint.
" } } }, "traits": { "smithy.api#documentation": "This data type represents the information you need to connect to an Amazon Aurora DB cluster.\n This data type is used as a response element in the following actions:
\n\n CreateDBClusterEndpoint\n
\n DescribeDBClusterEndpoints\n
\n ModifyDBClusterEndpoint\n
\n DeleteDBClusterEndpoint\n
For the data structure that represents Amazon RDS DB instance endpoints,\n see Endpoint.
The specified custom endpoint can't be created because it already exists.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#DBClusterEndpointList": { "type": "list", "member": { "target": "com.amazonaws.rds#DBClusterEndpoint", "traits": { "smithy.api#xmlName": "DBClusterEndpointList" } } }, "com.amazonaws.rds#DBClusterEndpointMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": " An optional pagination token provided by a previous\n DescribeDBClusterEndpoints request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
Contains the details of the endpoints associated with the cluster\n and matching any filter conditions.
" } } } }, "com.amazonaws.rds#DBClusterEndpointNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The specified custom endpoint doesn't exist.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#DBClusterEndpointQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The cluster already has the maximum number of custom endpoints.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.rds#DBClusterIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "[A-Za-z][0-9A-Za-z-:._]*" } }, "com.amazonaws.rds#DBClusterList": { "type": "list", "member": { "target": "com.amazonaws.rds#DBCluster", "traits": { "smithy.api#xmlName": "DBCluster" } } }, "com.amazonaws.rds#DBClusterMember": { "type": "structure", "members": { "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the instance identifier for this member of the DB cluster.
" } }, "IsClusterWriter": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
" } }, "PromotionTier": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.\n
" } } }, "traits": { "smithy.api#documentation": "Contains information about an instance that is part of a DB cluster.
" } }, "com.amazonaws.rds#DBClusterMemberList": { "type": "list", "member": { "target": "com.amazonaws.rds#DBClusterMember", "traits": { "smithy.api#xmlName": "DBClusterMember" } } }, "com.amazonaws.rds#DBClusterMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "A pagination token that can be used in a later DescribeDBClusters request.
" } }, "DBClusters": { "target": "com.amazonaws.rds#DBClusterList", "traits": { "smithy.api#documentation": "Contains a list of DB clusters for the user.
" } } }, "traits": { "smithy.api#documentation": "Contains the result of a successful invocation of the DescribeDBClusters action.
\n DBClusterIdentifier doesn't refer to an existing DB cluster.\n
Specifies the name of the DB cluster option group.
" } }, "Status": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the status of the DB cluster option group.
" } } }, "traits": { "smithy.api#documentation": "Contains status information for a DB cluster option group.
" } }, "com.amazonaws.rds#DBClusterParameterGroup": { "type": "structure", "members": { "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the DB cluster parameter group.
" } }, "DBParameterGroupFamily": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the DB parameter group family that this DB cluster parameter group is compatible with.
" } }, "Description": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Provides the customer-specified description for this DB cluster parameter group.
" } }, "DBClusterParameterGroupArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the DB cluster parameter group.
" } } }, "traits": { "smithy.api#documentation": "Contains the details of an Amazon RDS DB cluster parameter group.\n
\nThis data type is used as a response element in the DescribeDBClusterParameterGroups action.\n
Provides a list of parameters for the DB cluster parameter group.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous\n DescribeDBClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n
Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.
" } }, "com.amazonaws.rds#DBClusterParameterGroupList": { "type": "list", "member": { "target": "com.amazonaws.rds#DBClusterParameterGroup", "traits": { "smithy.api#xmlName": "DBClusterParameterGroup" } } }, "com.amazonaws.rds#DBClusterParameterGroupNameMessage": { "type": "structure", "members": { "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the DB cluster parameter group.
\nConstraints:
\nMust be 1 to 255 letters or numbers.
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nThis value is stored as a lowercase string.
\n\n DBClusterParameterGroupName doesn't refer to an existing DB\n cluster parameter group.
\n An optional pagination token provided by a previous\n DescribeDBClusterParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
A list of DB cluster parameter groups.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#DBClusterQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The user attempted to create a new DB cluster and the user has already reached the\n maximum allowed DB cluster quota.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.rds#DBClusterRole": { "type": "structure", "members": { "RoleArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
" } }, "Status": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following\n values:
\n\n ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to\n access other AWS services on your behalf.
\n PENDING - the IAM role ARN is being associated with the DB cluster.
\n INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable\n to assume the IAM role in order to access other AWS services on your behalf.
The name of the feature associated with the AWS Identity and Access Management (IAM) role.\n For the list of supported feature names, see DBEngineVersion.\n
" } } }, "traits": { "smithy.api#documentation": "Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.
" } }, "com.amazonaws.rds#DBClusterRoleAlreadyExistsFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#DBClusterRoleNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The specified IAM role Amazon Resource Name (ARN) isn't associated with the specified DB cluster.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.rds#DBClusterRoleQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#DBClusterRoles": { "type": "list", "member": { "target": "com.amazonaws.rds#DBClusterRole", "traits": { "smithy.api#xmlName": "DBClusterRole" } } }, "com.amazonaws.rds#DBClusterSnapshot": { "type": "structure", "members": { "AvailabilityZones": { "target": "com.amazonaws.rds#AvailabilityZones", "traits": { "smithy.api#documentation": "Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
" } }, "DBClusterSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the identifier for the DB cluster snapshot.
" } }, "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
" } }, "SnapshotCreateTime": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
" } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the name of the database engine for this DB cluster snapshot.
" } }, "EngineMode": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Provides the engine mode of the database engine for this DB cluster snapshot.
" } }, "AllocatedStorage": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#documentation": "Specifies the allocated storage size in gibibytes (GiB).
" } }, "Status": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the status of this DB cluster snapshot.
" } }, "Port": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#documentation": "Specifies the port that the DB cluster was listening on at the time of the snapshot.
" } }, "VpcId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Provides the VPC ID associated with the DB cluster snapshot.
" } }, "ClusterCreateTime": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
" } }, "MasterUsername": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Provides the master username for this DB cluster snapshot.
" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Provides the version of the database engine for this DB cluster snapshot.
" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Provides the license model information for this DB cluster snapshot.
" } }, "SnapshotType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Provides the type of the DB cluster snapshot.
" } }, "PercentProgress": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#documentation": "Specifies the percentage of the estimated data that has been transferred.
" } }, "StorageEncrypted": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the DB cluster snapshot is encrypted.
" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "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 AWS KMS customer master key (CMK).
" } }, "DBClusterSnapshotArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the DB cluster snapshot.
" } }, "SourceDBClusterSnapshotArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon\n Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
" } }, "IAMDatabaseAuthenticationEnabled": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
" } }, "TagList": { "target": "com.amazonaws.rds#TagList" } }, "traits": { "smithy.api#documentation": "Contains the details for an Amazon RDS DB cluster snapshot\n
\nThis data type is used as a response element \n in the DescribeDBClusterSnapshots action.\n
The user already has a DB cluster snapshot with the given identifier.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#DBClusterSnapshotAttribute": { "type": "structure", "members": { "AttributeName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the manual DB cluster snapshot attribute.
\nThe attribute named restore refers to the list of AWS accounts that\n have permission to copy or restore the manual DB cluster snapshot. For more information, \n see the ModifyDBClusterSnapshotAttribute\n API action.
The value(s) for the manual DB cluster snapshot attribute.
\nIf the AttributeName field is set to restore, then this element\n returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual\n DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot\n is public and available for any AWS account to copy or restore.
Contains the name and values of a manual DB cluster snapshot attribute.
\nManual DB cluster snapshot attributes are used to authorize other AWS accounts\n to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute\n API action.
The identifier of the manual DB cluster snapshot that the attributes apply to.
" } }, "DBClusterSnapshotAttributes": { "target": "com.amazonaws.rds#DBClusterSnapshotAttributeList", "traits": { "smithy.api#documentation": "The list of attributes and values for the manual DB cluster snapshot.
" } } }, "traits": { "smithy.api#documentation": "Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes\n API action.
Manual DB cluster snapshot attributes are used to authorize other AWS accounts\n to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute\n API action.
\n An optional pagination token provided by a previous\n DescribeDBClusterSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
Provides a list of DB cluster snapshots for the user.
" } } }, "traits": { "smithy.api#documentation": "\n Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.\n
\n DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.\n
The name of the database engine.
" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The version number of the database engine.
" } }, "DBParameterGroupFamily": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the DB parameter group family for the database engine.
" } }, "DBEngineDescription": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The description of the database engine.
" } }, "DBEngineVersionDescription": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The description of the database engine version.
" } }, "DefaultCharacterSet": { "target": "com.amazonaws.rds#CharacterSet", "traits": { "smithy.api#documentation": "\n The default character set for new instances of this engine version,\n if the CharacterSetName parameter of the CreateDBInstance API\n isn't specified.\n
A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation. \n
A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation. \n
A list of engine versions that this database engine version can be upgraded to.
" } }, "SupportedTimezones": { "target": "com.amazonaws.rds#SupportedTimezonesList", "traits": { "smithy.api#documentation": "A list of the time zones supported by this engine for the\n Timezone parameter of the CreateDBInstance action. \n
The types of logs that the database engine has available for export to CloudWatch Logs.
" } }, "SupportsLogExportsToCloudwatchLogs": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
" } }, "SupportsReadReplica": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Indicates whether the database engine version supports read replicas.
" } }, "SupportedEngineModes": { "target": "com.amazonaws.rds#EngineModeList", "traits": { "smithy.api#documentation": "A list of the supported DB engine modes.
" } }, "SupportedFeatureNames": { "target": "com.amazonaws.rds#FeatureNameList", "traits": { "smithy.api#documentation": "\n A list of features supported by the DB engine. Supported feature names include the following.\n
\ns3Import
\nThe status of the DB engine version, either available or deprecated.
A value that indicates whether you can use Aurora parallel query with a specific DB engine version.
" } }, "SupportsGlobalDatabases": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "A value that indicates whether you can use Aurora global databases with a specific DB engine version.
" } } }, "traits": { "smithy.api#documentation": "\n This data type is used as a response element in the action DescribeDBEngineVersions.\n
\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
\n A list of DBEngineVersion elements.\n
\n Contains the result of a successful invocation of the DescribeDBEngineVersions action.\n
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
" } }, "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Contains the name of the compute and memory capacity class of the DB instance.
" } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the database engine to be used for this DB instance.
" } }, "DBInstanceStatus": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the current state of this database.
\nFor information about DB instance statuses, see\n DB Instance Status in the Amazon RDS User Guide.\n
" } }, "MasterUsername": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Contains the master username for the DB instance.
" } }, "DBName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The meaning of this parameter differs according to the database engine you use.
\n\n MySQL, MariaDB, SQL Server, PostgreSQL\n
\nContains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
\nType: String
\n\n Oracle\n
\nContains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
" } }, "Endpoint": { "target": "com.amazonaws.rds#Endpoint", "traits": { "smithy.api#documentation": "Specifies the connection endpoint.
" } }, "AllocatedStorage": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#documentation": "Specifies the allocated storage size specified in gibibytes.
" } }, "InstanceCreateTime": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "Provides the date and time the DB instance was created.
" } }, "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.\n
Specifies the number of days for which automatic DB snapshots are retained.
" } }, "DBSecurityGroups": { "target": "com.amazonaws.rds#DBSecurityGroupMembershipList", "traits": { "smithy.api#documentation": "\n A list of DB security group elements containing \n DBSecurityGroup.Name and DBSecurityGroup.Status subelements.\n
Provides a list of VPC security group elements that the DB instance belongs to.
" } }, "DBParameterGroups": { "target": "com.amazonaws.rds#DBParameterGroupStatusList", "traits": { "smithy.api#documentation": "Provides the list of DB parameter groups applied to this DB instance.
" } }, "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the name of the Availability Zone the DB instance is located in.
" } }, "DBSubnetGroup": { "target": "com.amazonaws.rds#DBSubnetGroup", "traits": { "smithy.api#documentation": "Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
" } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
" } }, "PendingModifiedValues": { "target": "com.amazonaws.rds#PendingModifiedValues", "traits": { "smithy.api#documentation": "A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
" } }, "LatestRestorableTime": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "Specifies the latest time to which a database can be restored with point-in-time restore.
" } }, "MultiAZ": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Specifies if the DB instance is a Multi-AZ deployment.
" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Indicates the database engine version.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "A value that indicates that minor version patches are applied automatically.
" } }, "ReadReplicaSourceDBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Contains the identifier of the source DB instance if this DB instance is a read\n replica.
" } }, "ReadReplicaDBInstanceIdentifiers": { "target": "com.amazonaws.rds#ReadReplicaDBInstanceIdentifierList", "traits": { "smithy.api#documentation": "Contains one or more identifiers of the read replicas associated with this DB\n instance.
" } }, "ReadReplicaDBClusterIdentifiers": { "target": "com.amazonaws.rds#ReadReplicaDBClusterIdentifierList", "traits": { "smithy.api#documentation": "Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance\n is replicated as a read replica. For example, when you create an Aurora read replica of\n an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is\n shown. This output does not contain information about cross region Aurora read\n replicas.
\nCurrently, each RDS DB instance can have only one Aurora read replica.
\nThe open mode of an Oracle read replica. The default is open-read-only. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.
This attribute is only supported in RDS for Oracle.
\nLicense model information for this DB instance.
" } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "Specifies the Provisioned IOPS (I/O operations per second) value.
" } }, "OptionGroupMemberships": { "target": "com.amazonaws.rds#OptionGroupMembershipList", "traits": { "smithy.api#documentation": "Provides the list of option group memberships for this DB instance.
" } }, "CharacterSetName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "If present, specifies the name of the character set that this instance is associated with.
" } }, "NcharCharacterSetName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the NCHAR character set for the Oracle DB instance. This character set specifies the\n Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.\n
" } }, "SecondaryAvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
" } }, "PubliclyAccessible": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Specifies the accessibility options for the DB instance.
\nWhen the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" } }, "StatusInfos": { "target": "com.amazonaws.rds#DBInstanceStatusInfoList", "traits": { "smithy.api#documentation": "The status of a read replica. If the instance isn't a read replica, this is\n blank.
" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the storage type associated with DB instance.
" } }, "TdeCredentialArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The ARN from the key store with which the instance is associated for TDE encryption.
" } }, "DbInstancePort": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#documentation": "Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
" } }, "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
" } }, "StorageEncrypted": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the DB instance is encrypted.
" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n If StorageEncrypted is true, the AWS KMS key identifier \n for the encrypted DB instance.\n
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
" } }, "DbiResourceId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log \n entries whenever the AWS KMS customer master key (CMK) for the DB instance is accessed.
" } }, "CACertificateIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The identifier of the CA certificate for this DB instance.
" } }, "DomainMemberships": { "target": "com.amazonaws.rds#DomainMembershipList", "traits": { "smithy.api#documentation": "The Active Directory Domain membership records associated with the DB instance.
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
\n\n Amazon Aurora\n
\nNot applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see DBCluster.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
" } }, "EnhancedMonitoringResourceArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
" } }, "MonitoringRoleArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
" } }, "PromotionTier": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.\n
" } }, "DBInstanceArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the DB instance.
" } }, "Timezone": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The time zone of the DB instance.\n In most cases, the Timezone element is empty.\n Timezone content appears only for\n Microsoft SQL Server DB instances \n that were created with a time zone specified.\n
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
\n\nIAM database authentication can be enabled for the following database engines
\nFor MySQL 5.6, minor version 5.6.34 or higher
\nFor MySQL 5.7, minor version 5.7.16 or higher
\nAurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
\nTrue if Performance Insights is enabled for the DB instance, and otherwise false.
" } }, "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The AWS KMS key identifier for encryption of Performance Insights data.
\nThe AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
" } }, "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
" } }, "EnabledCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { "smithy.api#documentation": "A list of log types that this DB instance is configured to export to CloudWatch Logs.
\nLog types vary by DB engine. For information about the log types for each DB engine, see\n Amazon RDS Database Log Files in the Amazon RDS User Guide.\n
" } }, "ProcessorFeatures": { "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
" } }, "DeletionProtection": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Indicates if the DB instance has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.\n For more information, see \n \n Deleting a DB Instance.\n
" } }, "AssociatedRoles": { "target": "com.amazonaws.rds#DBInstanceRoles", "traits": { "smithy.api#documentation": "\n The AWS Identity and Access Management (IAM) roles associated with the DB instance.\n
" } }, "ListenerEndpoint": { "target": "com.amazonaws.rds#Endpoint", "traits": { "smithy.api#documentation": "Specifies the listener connection endpoint for SQL Server Always On.
" } }, "MaxAllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
" } }, "TagList": { "target": "com.amazonaws.rds#TagList" }, "DBInstanceAutomatedBackupsReplications": { "target": "com.amazonaws.rds#DBInstanceAutomatedBackupsReplicationList", "traits": { "smithy.api#documentation": "The list of replicated automated backups associated with the DB instance.
" } }, "CustomerOwnedIpEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the AWS Outposts User Guide.
" } }, "AwsBackupRecoveryPointArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recovery point in AWS Backup.
" } } }, "traits": { "smithy.api#documentation": "Contains the details of an Amazon RDS DB instance.\n
\nThis data type is used as a response element in the DescribeDBInstances action.\n
The user already has a DB instance with the given identifier.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#DBInstanceAutomatedBackup": { "type": "structure", "members": { "DBInstanceArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the automated backups.
" } }, "DbiResourceId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.
" } }, "Region": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The AWS Region associated with the automated backup.
" } }, "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The customer id of the instance that is/was associated with the automated backup.\n
" } }, "RestoreWindow": { "target": "com.amazonaws.rds#RestoreWindow", "traits": { "smithy.api#documentation": "Earliest and latest time an instance can be restored to.
" } }, "AllocatedStorage": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#documentation": "Specifies the allocated storage size in gibibytes (GiB).
" } }, "Status": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Provides a list of status information for an automated backup:
\n\n active - automated backups for current instances
\n retained - automated backups for deleted instances
\n creating - automated backups that are waiting\n for the first automated snapshot to be available.
The port number that the automated backup used for connections.
\nDefault: Inherits from the source DB instance
\nValid Values: 1150-65535\n
The Availability Zone that the automated backup was created in. For information on\n AWS Regions and Availability Zones, see \n Regions\n and Availability Zones.
" } }, "VpcId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Provides the VPC ID associated with the DB instance
" } }, "InstanceCreateTime": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "Provides the date and time that the DB instance was created.\n
" } }, "MasterUsername": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The license model of an automated backup.
" } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the database engine for this automated backup.
" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The version of the database engine for the automated backup.
" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "License model information for the automated backup.
" } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The IOPS (I/O operations per second) value for the automated backup.
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.
" } }, "TdeCredentialArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The ARN from the key store with which the automated backup is associated for TDE encryption.
" } }, "Encrypted": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the automated backup is encrypted.
" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the storage type associated with the automated backup.
" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The AWS KMS key ID for an automated backup.
\nThe AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
" } }, "Timezone": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The time zone of the automated backup. In most cases, the Timezone element is empty.\n Timezone content appears only for Microsoft SQL Server DB instances \n that were created with a time zone specified.
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, \n and otherwise false.
" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The retention period for the automated backups.
" } }, "DBInstanceAutomatedBackupsArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the replicated automated backups.
" } }, "DBInstanceAutomatedBackupsReplications": { "target": "com.amazonaws.rds#DBInstanceAutomatedBackupsReplicationList", "traits": { "smithy.api#documentation": "The list of replications to different AWS Regions associated with the automated backup.
" } } }, "traits": { "smithy.api#documentation": "An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that\n existed at the time you deleted the source instance.
" } }, "com.amazonaws.rds#DBInstanceAutomatedBackupList": { "type": "list", "member": { "target": "com.amazonaws.rds#DBInstanceAutomatedBackup", "traits": { "smithy.api#xmlName": "DBInstanceAutomatedBackup" } } }, "com.amazonaws.rds#DBInstanceAutomatedBackupMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n
\n A list of DBInstanceAutomatedBackup instances.\n
\n Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.\n
No automated backup for this DB instance was found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.rds#DBInstanceAutomatedBackupQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The quota for retained automated backups was exceeded. This prevents you\n from retaining any additional automated backups. The retained automated backups \n quota is the same as your DB Instance quota.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#DBInstanceAutomatedBackupsReplication": { "type": "structure", "members": { "DBInstanceAutomatedBackupsArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the replicated automated backups.
" } } }, "traits": { "smithy.api#documentation": "Automated backups of a DB instance replicated to another AWS Region. They consist of system backups, transaction logs, and database instance properties.
" } }, "com.amazonaws.rds#DBInstanceAutomatedBackupsReplicationList": { "type": "list", "member": { "target": "com.amazonaws.rds#DBInstanceAutomatedBackupsReplication", "traits": { "smithy.api#xmlName": "DBInstanceAutomatedBackupsReplication" } } }, "com.amazonaws.rds#DBInstanceList": { "type": "list", "member": { "target": "com.amazonaws.rds#DBInstance", "traits": { "smithy.api#xmlName": "DBInstance" } } }, "com.amazonaws.rds#DBInstanceMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n
\n A list of DBInstance instances.\n
\n Contains the result of a successful invocation of the DescribeDBInstances action.\n
\n DBInstanceIdentifier doesn't refer to an existing DB instance.\n
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB\n instance.
" } }, "FeatureName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the feature associated with the AWS Identity and Access Management (IAM) role.\n For the list of supported feature names, see DBEngineVersion.\n
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following\n values:
\n\n ACTIVE - the IAM role ARN is associated with the DB instance and can be used to\n access other AWS services on your behalf.
\n PENDING - the IAM role ARN is being associated with the DB instance.
\n INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable\n to assume the IAM role in order to access other AWS services on your behalf.
Describes an AWS Identity and Access Management (IAM) role that is associated with a DB instance.
" } }, "com.amazonaws.rds#DBInstanceRoleAlreadyExistsFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The specified RoleArn or FeatureName value is already associated with the DB instance.
The specified RoleArn value doesn't match the specified feature for\n the DB instance.
You can't associate any more AWS Identity and Access Management (IAM) roles with the DB instance because the quota has been reached.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#DBInstanceRoles": { "type": "list", "member": { "target": "com.amazonaws.rds#DBInstanceRole", "traits": { "smithy.api#xmlName": "DBInstanceRole" } } }, "com.amazonaws.rds#DBInstanceStatusInfo": { "type": "structure", "members": { "StatusType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "This value is currently \"read replication.\"
" } }, "Normal": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
" } }, "Status": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Status of the DB instance. For a StatusType of read replica, the values can be\n replicating, replication stop point set, replication stop point reached, error, stopped,\n or terminated.
" } }, "Message": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "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.
" } } }, "traits": { "smithy.api#documentation": "Provides a list of status information for a DB instance.
" } }, "com.amazonaws.rds#DBInstanceStatusInfoList": { "type": "list", "member": { "target": "com.amazonaws.rds#DBInstanceStatusInfo", "traits": { "smithy.api#xmlName": "DBInstanceStatusInfo" } } }, "com.amazonaws.rds#DBLogFileNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "\n LogFileName doesn't refer to an existing DB log file.
The name of the DB parameter group.
" } }, "DBParameterGroupFamily": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the DB parameter group family that this DB parameter group is compatible with.
" } }, "Description": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Provides the customer-specified description for this DB parameter group.
" } }, "DBParameterGroupArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the DB parameter group.
" } } }, "traits": { "smithy.api#documentation": "Contains the details of an Amazon RDS DB parameter group.\n
\nThis data type is used as a response element in the DescribeDBParameterGroups action.\n
A DB parameter group with the same name exists.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#DBParameterGroupDetails": { "type": "structure", "members": { "Parameters": { "target": "com.amazonaws.rds#ParametersList", "traits": { "smithy.api#documentation": "\n A list of Parameter values.\n
\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
\n Contains the result of a successful invocation of the DescribeDBParameters action.\n
The name of the DB parameter group.
" } } }, "traits": { "smithy.api#documentation": "\n Contains the result of a successful invocation of the \n ModifyDBParameterGroup or ResetDBParameterGroup action.\n
\n DBParameterGroupName doesn't refer to an\n existing DB parameter group.\n
The request would result in the user exceeding the allowed number of DB parameter\n groups.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#DBParameterGroupStatus": { "type": "structure", "members": { "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the DB parameter group.
" } }, "ParameterApplyStatus": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The status of parameter updates.
" } } }, "traits": { "smithy.api#documentation": "The status of the DB parameter group.
\nThis data type is used as a response element in the following actions:
\n\n CreateDBInstance\n
\n CreateDBInstanceReadReplica\n
\n DeleteDBInstance\n
\n ModifyDBInstance\n
\n RebootDBInstance\n
\n RestoreDBInstanceFromDBSnapshot\n
\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
\n A list of DBParameterGroup instances.\n
\n Contains the result of a successful invocation of the DescribeDBParameterGroups action.\n
The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
" } }, "DBProxyArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the proxy.
" } }, "Status": { "target": "com.amazonaws.rds#DBProxyStatus", "traits": { "smithy.api#documentation": "The current status of this proxy. A status of available means the\n proxy is ready to handle requests. Other values indicate that you must wait for\n the proxy to be ready, or take some action to resolve an issue.
The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.
" } }, "VpcId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Provides the VPC ID of the DB proxy.
" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#StringList", "traits": { "smithy.api#documentation": "Provides a list of VPC security groups that the proxy belongs to.
" } }, "VpcSubnetIds": { "target": "com.amazonaws.rds#StringList", "traits": { "smithy.api#documentation": "The EC2 subnet IDs for the proxy.
" } }, "Auth": { "target": "com.amazonaws.rds#UserAuthConfigInfoList", "traits": { "smithy.api#documentation": "One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance\n or Aurora DB cluster.
" } }, "RoleArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
" } }, "Endpoint": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the\n connection string for a database client application.
" } }, "RequireTLS": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
" } }, "IdleClientTimeout": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#documentation": "The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.\n The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by\n later connection requests.
\nDefault: 1800 (30 minutes)
\nConstraints: 1 to 28,800
" } }, "DebugLogging": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.
" } }, "CreatedDate": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "The date and time when the proxy was first created.
" } }, "UpdatedDate": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "The date and time when the proxy was last updated.
" } } }, "traits": { "smithy.api#documentation": "The data structure representing a proxy managed by the RDS Proxy.
\nThis data type is used as a response element in the DescribeDBProxies action.
The specified proxy name must be unique for all proxies owned by your AWS account in the specified AWS Region.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#DBProxyEndpoint": { "type": "structure", "members": { "DBProxyEndpointName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name for the DB proxy endpoint. An identifier must begin with a letter and\n must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen\n or contain two consecutive hyphens.
" } }, "DBProxyEndpointArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the DB proxy endpoint.
" } }, "DBProxyName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The identifier for the DB proxy that is associated with this DB proxy endpoint.
" } }, "Status": { "target": "com.amazonaws.rds#DBProxyEndpointStatus", "traits": { "smithy.api#documentation": "The current status of this DB proxy endpoint. A status of available means the\n endpoint is ready to handle requests. Other values indicate that you must wait for\n the endpoint to be ready, or take some action to resolve an issue.
Provides the VPC ID of the DB proxy endpoint.
" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#StringList", "traits": { "smithy.api#documentation": "Provides a list of VPC security groups that the DB proxy endpoint belongs to.
" } }, "VpcSubnetIds": { "target": "com.amazonaws.rds#StringList", "traits": { "smithy.api#documentation": "The EC2 subnet IDs for the DB proxy endpoint.
" } }, "Endpoint": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the\n connection string for a database client application.
" } }, "CreatedDate": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "The date and time when the DB proxy endpoint was first created.
" } }, "TargetRole": { "target": "com.amazonaws.rds#DBProxyEndpointTargetRole", "traits": { "smithy.api#documentation": "A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
" } }, "IsDefault": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "A value that indicates whether this endpoint is the default endpoint for the associated DB proxy.\n Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the\n DB proxy can be either read/write or read-only.
" } } }, "traits": { "smithy.api#documentation": "The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one\n endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same\n DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the\n associated DB proxy.
\nThis data type is used as a response element in the DescribeDBProxyEndpoints operation.
The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#DBProxyEndpointList": { "type": "list", "member": { "target": "com.amazonaws.rds#DBProxyEndpoint" } }, "com.amazonaws.rds#DBProxyEndpointName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 63 }, "smithy.api#pattern": "[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*" } }, "com.amazonaws.rds#DBProxyEndpointNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The DB proxy endpoint doesn't exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.rds#DBProxyEndpointQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The DB proxy already has the maximum number of endpoints.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#DBProxyEndpointStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "available", "name": "AVAILABLE" }, { "value": "modifying", "name": "MODIFYING" }, { "value": "incompatible-network", "name": "INCOMPATIBLE_NETWORK" }, { "value": "insufficient-resource-limits", "name": "INSUFFICIENT_RESOURCE_LIMITS" }, { "value": "creating", "name": "CREATING" }, { "value": "deleting", "name": "DELETING" } ] } }, "com.amazonaws.rds#DBProxyEndpointTargetRole": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "READ_WRITE", "name": "READ_WRITE" }, { "value": "READ_ONLY", "name": "READ_ONLY" } ] } }, "com.amazonaws.rds#DBProxyList": { "type": "list", "member": { "target": "com.amazonaws.rds#DBProxy" } }, "com.amazonaws.rds#DBProxyName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 63 }, "smithy.api#pattern": "[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*" } }, "com.amazonaws.rds#DBProxyNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The specified proxy name doesn't correspond to a proxy owned by your AWS account in the specified AWS Region.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.rds#DBProxyQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "Your AWS account already has the maximum number of proxies in the specified AWS Region.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#DBProxyStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "available", "name": "AVAILABLE" }, { "value": "modifying", "name": "MODIFYING" }, { "value": "incompatible-network", "name": "INCOMPATIBLE_NETWORK" }, { "value": "insufficient-resource-limits", "name": "INSUFFICIENT_RESOURCE_LIMITS" }, { "value": "creating", "name": "CREATING" }, { "value": "deleting", "name": "DELETING" }, { "value": "suspended", "name": "SUSPENDED" }, { "value": "suspending", "name": "SUSPENDING" }, { "value": "reactivating", "name": "REACTIVATING" } ] } }, "com.amazonaws.rds#DBProxyTarget": { "type": "structure", "members": { "TargetArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.
" } }, "Endpoint": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The writer endpoint for the RDS DB instance or Aurora DB cluster.
" } }, "TrackedClusterId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.
" } }, "RdsResourceId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The identifier representing the target. It can be the instance identifier for an RDS DB instance,\n or the cluster identifier for an Aurora DB cluster.
" } }, "Port": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#documentation": "The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.
" } }, "Type": { "target": "com.amazonaws.rds#TargetType", "traits": { "smithy.api#documentation": "Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.
" } }, "Role": { "target": "com.amazonaws.rds#TargetRole", "traits": { "smithy.api#documentation": "A value that indicates whether the target of the proxy can be used for read/write or read-only operations.
" } }, "TargetHealth": { "target": "com.amazonaws.rds#TargetHealth", "traits": { "smithy.api#documentation": "Information about the connection health of the RDS Proxy target.
" } } }, "traits": { "smithy.api#documentation": "Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster\n that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.
\nThis data type is used as a response element in the DescribeDBProxyTargets action.
The proxy is already associated with the specified RDS DB instance or Aurora DB cluster.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#DBProxyTargetGroup": { "type": "structure", "members": { "DBProxyName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The identifier for the RDS proxy associated with this target group.
" } }, "TargetGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "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.
" } }, "TargetGroupArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) representing the target group.
" } }, "IsDefault": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Whether this target group is the first one used for connection requests by the associated proxy.\n Because each proxy is currently associated with a single target group, currently this setting\n is always true.
The current status of this target group. A status of available means the\n target group is correctly associated with a database. Other values indicate that you must wait for\n the target group to be ready, or take some action to resolve an issue.
The settings that determine the size and behavior of the connection pool for the target group.
" } }, "CreatedDate": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "The date and time when the target group was first created.
" } }, "UpdatedDate": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "The date and time when the target group was last updated.
" } } }, "traits": { "smithy.api#documentation": "Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group\n is associated with exactly one RDS DB instance or Aurora DB cluster.
\nThis data type is used as a response element in the DescribeDBProxyTargetGroups action.
The specified target group isn't available for a proxy owned by your AWS account in the specified AWS Region.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.rds#DBProxyTargetNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your AWS account in the specified AWS Region.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.rds#DBSecurityGroup": { "type": "structure", "members": { "OwnerId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Provides the AWS ID of the owner of a specific DB security group.
" } }, "DBSecurityGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the name of the DB security group.
" } }, "DBSecurityGroupDescription": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Provides the description of the DB security group.
" } }, "VpcId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Provides the VpcId of the DB security group.
" } }, "EC2SecurityGroups": { "target": "com.amazonaws.rds#EC2SecurityGroupList", "traits": { "smithy.api#documentation": "\n Contains a list of EC2SecurityGroup elements.\n
\n Contains a list of IPRange elements.\n
The Amazon Resource Name (ARN) for the DB security group.
" } } }, "traits": { "smithy.api#documentation": "Contains the details for an Amazon RDS DB security group.\n
\nThis data type is used as a response element \n in the DescribeDBSecurityGroups action.\n
\n A DB security group with the name specified in\n DBSecurityGroupName already exists.\n
The name of the DB security group.
" } }, "Status": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The status of the DB security group.
" } } }, "traits": { "smithy.api#documentation": "This data type is used as a response element in the following actions:
\n\n ModifyDBInstance\n
\n RebootDBInstance\n
\n RestoreDBInstanceFromDBSnapshot\n
\n RestoreDBInstanceToPointInTime\n
\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
\n A list of DBSecurityGroup instances.\n
\n Contains the result of a successful invocation of the DescribeDBSecurityGroups action.\n
\n DBSecurityGroupName doesn't refer to an existing DB security group.\n
A DB security group isn't allowed for this action.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#DBSecurityGroupQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The request would result in the user exceeding the allowed number of DB security\n groups.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#DBSecurityGroups": { "type": "list", "member": { "target": "com.amazonaws.rds#DBSecurityGroup", "traits": { "smithy.api#xmlName": "DBSecurityGroup" } } }, "com.amazonaws.rds#DBSnapshot": { "type": "structure", "members": { "DBSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the identifier for the DB snapshot.
" } }, "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
" } }, "SnapshotCreateTime": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "Specifies when the snapshot was taken in Coordinated Universal Time (UTC).
" } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the name of the database engine.
" } }, "AllocatedStorage": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#documentation": "Specifies the allocated storage size in gibibytes (GiB).
" } }, "Status": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the status of this DB snapshot.
" } }, "Port": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#documentation": "Specifies the port that the database engine was listening on at the time of the snapshot.
" } }, "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
" } }, "VpcId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Provides the VPC ID associated with the DB snapshot.
" } }, "InstanceCreateTime": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from\n which the snapshot was taken, was created.
" } }, "MasterUsername": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Provides the master username for the DB snapshot.
" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the version of the database engine.
" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "License model information for the restored DB instance.
" } }, "SnapshotType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Provides the type of the DB snapshot.
" } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Provides the option group name for the DB snapshot.
" } }, "PercentProgress": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#documentation": "The percentage of the estimated data that has been transferred.
" } }, "SourceRegion": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The AWS Region that the DB snapshot was created in or copied from.
" } }, "SourceDBSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case of cross-customer or cross-region copy.
" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the storage type associated with DB snapshot.
" } }, "TdeCredentialArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The ARN from the key store with which to associate the instance for TDE encryption.
" } }, "Encrypted": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the DB snapshot is encrypted.
" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n If Encrypted is true, the AWS KMS key identifier \n for the encrypted DB snapshot.\n
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
" } }, "DBSnapshotArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the DB snapshot.
" } }, "Timezone": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The time zone of the DB snapshot.\n In most cases, the Timezone element is empty.\n Timezone content appears only for\n snapshots taken from \n Microsoft SQL Server DB instances \n that were created with a time zone specified.\n
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
" } }, "ProcessorFeatures": { "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class\n of the DB instance when the DB snapshot was created.
" } }, "DbiResourceId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.
" } }, "TagList": { "target": "com.amazonaws.rds#TagList" } }, "traits": { "smithy.api#documentation": "Contains the details of an Amazon RDS DB snapshot.\n
\nThis data type is used as a response element \n in the DescribeDBSnapshots action.\n
\n DBSnapshotIdentifier is already used by an existing snapshot.\n
The name of the manual DB snapshot attribute.
\nThe attribute named restore refers to the list of AWS accounts that\n have permission to copy or restore the manual DB cluster snapshot. For more information, \n see the ModifyDBSnapshotAttribute\n API action.
The value or values for the manual DB snapshot attribute.
\nIf the AttributeName field is set to restore, then this element\n returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual\n DB snapshot. If a value of all is in the list, then the manual DB snapshot\n is public and available for any AWS account to copy or restore.
Contains the name and values of a manual DB snapshot attribute
\nManual DB snapshot attributes are used to authorize other AWS accounts\n to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute\n API.
The identifier of the manual DB snapshot that the attributes apply to.
" } }, "DBSnapshotAttributes": { "target": "com.amazonaws.rds#DBSnapshotAttributeList", "traits": { "smithy.api#documentation": "The list of attributes and values for the manual DB snapshot.
" } } }, "traits": { "smithy.api#documentation": "Contains the results of a successful call to the DescribeDBSnapshotAttributes\n API action.
Manual DB snapshot attributes are used to authorize other AWS accounts\n to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute\n API action.
\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
\n A list of DBSnapshot instances.\n
\n Contains the result of a successful invocation of the DescribeDBSnapshots action.\n
\n DBSnapshotIdentifier doesn't refer to an existing DB snapshot.\n
The name of the DB subnet group.
" } }, "DBSubnetGroupDescription": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Provides the description of the DB subnet group.
" } }, "VpcId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Provides the VpcId of the DB subnet group.
" } }, "SubnetGroupStatus": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Provides the status of the DB subnet group.
" } }, "Subnets": { "target": "com.amazonaws.rds#SubnetList", "traits": { "smithy.api#documentation": "\n Contains a list of Subnet elements.\n
The Amazon Resource Name (ARN) for the DB subnet group.
" } } }, "traits": { "smithy.api#documentation": "Contains the details of an Amazon RDS DB subnet group.\n
\nThis data type is used as a response element \n in the DescribeDBSubnetGroups action.\n
\n DBSubnetGroupName is already used by an existing DB subnet group.\n
Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#DBSubnetGroupMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
\n A list of DBSubnetGroup instances.\n
\n Contains the result of a successful invocation of the DescribeDBSubnetGroups action.\n
The DBSubnetGroup shouldn't be specified while creating read replicas that lie\n in the same region as the source instance.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#DBSubnetGroupNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "\n DBSubnetGroupName doesn't refer to an existing DB subnet group.\n
The request would result in the user exceeding the allowed number of DB subnet\n groups.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#DBSubnetGroups": { "type": "list", "member": { "target": "com.amazonaws.rds#DBSubnetGroup", "traits": { "smithy.api#xmlName": "DBSubnetGroup" } } }, "com.amazonaws.rds#DBSubnetQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The request would result in the user exceeding the allowed number of subnets in a\n DB subnet groups.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#DBUpgradeDependencyFailureFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The DB upgrade failed because a resource the DB depends on can't be\n modified.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#DeleteCustomAvailabilityZone": { "type": "operation", "input": { "target": "com.amazonaws.rds#DeleteCustomAvailabilityZoneMessage" }, "output": { "target": "com.amazonaws.rds#DeleteCustomAvailabilityZoneResult" }, "errors": [ { "target": "com.amazonaws.rds#CustomAvailabilityZoneNotFoundFault" }, { "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" } ], "traits": { "smithy.api#documentation": "Deletes a custom Availability Zone (AZ).
\nA custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.
\nFor more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n
" } }, "com.amazonaws.rds#DeleteCustomAvailabilityZoneMessage": { "type": "structure", "members": { "CustomAvailabilityZoneId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The custom AZ identifier.
", "smithy.api#required": {} } } } }, "com.amazonaws.rds#DeleteCustomAvailabilityZoneResult": { "type": "structure", "members": { "CustomAvailabilityZone": { "target": "com.amazonaws.rds#CustomAvailabilityZone" } } }, "com.amazonaws.rds#DeleteDBCluster": { "type": "operation", "input": { "target": "com.amazonaws.rds#DeleteDBClusterMessage" }, "output": { "target": "com.amazonaws.rds#DeleteDBClusterResult" }, "errors": [ { "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, { "target": "com.amazonaws.rds#DBClusterSnapshotAlreadyExistsFault" }, { "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" }, { "target": "com.amazonaws.rds#InvalidDBClusterStateFault" }, { "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "The DeleteDBCluster action deletes a previously provisioned DB cluster. \n When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. \n Manual DB cluster snapshots of the specified DB cluster are not deleted.
\n \nFor more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nDeletes a custom endpoint and removes it from an Amazon Aurora DB cluster.
\nThis action only applies to Aurora DB clusters.
\nThe identifier associated with the custom endpoint. This parameter is stored as a lowercase string.
", "smithy.api#required": {} } } } }, "com.amazonaws.rds#DeleteDBClusterMessage": { "type": "structure", "members": { "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.
\nConstraints:
\nMust match an existing DBClusterIdentifier.
\nA value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted.\n If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot \n is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. \n By default, this parameter is disabled.
\nYou must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.
\n The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot\n is disabled.\n
\n Specifying this parameter and also skipping the creation of a final DB cluster snapshot \n with the SkipFinalShapshot parameter results in an error.
Constraints:
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nDeletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
\nFor more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nThe name of the DB cluster parameter group.
\nConstraints:
\nMust be the name of an existing DB cluster parameter group.
\nYou can't delete a default DB cluster parameter group.
\nCan't be associated with any DB clusters.
\nDeletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
\nThe DB cluster snapshot must be in the available state to be\n deleted.
For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nThe identifier of the DB cluster snapshot to delete.
\nConstraints: Must be the name of an existing DB cluster snapshot in the available state.
The DeleteDBInstance action deletes a previously provisioned DB instance. \n When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. \n Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.
\n If you request a final DB snapshot \n the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance\n is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.\n
When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.
If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following\n conditions are true:
\nThe DB cluster is a read replica of another Amazon Aurora DB cluster.
\nThe DB instance is the only instance in the DB cluster.
\nTo delete a DB instance in this case, first call the\n PromoteReadReplicaDBCluster API action to promote the DB cluster so\n it's no longer a read replica. After the promotion completes, then call the\n DeleteDBInstance API action to delete the final instance in the DB\n cluster.
Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.
The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.
" } }, "DBInstanceAutomatedBackupsArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the automated backups to delete, for example,\n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
Parameter input for the DeleteDBInstanceAutomatedBackup operation.
The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.
\nConstraints:
\nMust match the name of an existing DB instance.
\nA value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted.\n If skip is specified, no DB snapshot is created. If skip isn't specified, a DB snapshot \n is created before the DB instance is deleted. By default, skip isn't specified, and the DB snapshot is created.
\nWhen a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when skip is specified.
\nSpecify skip when deleting a read replica.
\nThe FinalDBSnapshotIdentifier parameter must be specified if skip isn't specified.
\n\n The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot\n parameter is disabled.\n
Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error.
\nConstraints:
\nMust be 1 to 255 letters or numbers.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nCan't be specified when deleting a read replica.
\nA value that indicates whether to remove automated backups immediately after the DB\n instance is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB instance is deleted.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#DeleteDBInstanceResult": { "type": "structure", "members": { "DBInstance": { "target": "com.amazonaws.rds#DBInstance" } } }, "com.amazonaws.rds#DeleteDBParameterGroup": { "type": "operation", "input": { "target": "com.amazonaws.rds#DeleteDBParameterGroupMessage" }, "errors": [ { "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" } ], "traits": { "smithy.api#documentation": "Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.
" } }, "com.amazonaws.rds#DeleteDBParameterGroupMessage": { "type": "structure", "members": { "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the DB parameter group.
\nConstraints:
\nMust be the name of an existing DB parameter group
\nYou can't delete a default DB parameter group
\nCan't be associated with any DB instances
\nDeletes an existing DB proxy.
" } }, "com.amazonaws.rds#DeleteDBProxyEndpoint": { "type": "operation", "input": { "target": "com.amazonaws.rds#DeleteDBProxyEndpointRequest" }, "output": { "target": "com.amazonaws.rds#DeleteDBProxyEndpointResponse" }, "errors": [ { "target": "com.amazonaws.rds#DBProxyEndpointNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidDBProxyEndpointStateFault" } ], "traits": { "smithy.api#documentation": "Deletes a DBProxyEndpoint. Doing so removes the ability to access the DB proxy using the\n endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write\n or read-only operations, or using a different VPC than the DB proxy's default VPC.
The name of the DB proxy endpoint to delete.
", "smithy.api#required": {} } } } }, "com.amazonaws.rds#DeleteDBProxyEndpointResponse": { "type": "structure", "members": { "DBProxyEndpoint": { "target": "com.amazonaws.rds#DBProxyEndpoint", "traits": { "smithy.api#documentation": "The data structure representing the details of the DB proxy endpoint that you delete.
" } } } }, "com.amazonaws.rds#DeleteDBProxyRequest": { "type": "structure", "members": { "DBProxyName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the DB proxy to delete.
", "smithy.api#required": {} } } } }, "com.amazonaws.rds#DeleteDBProxyResponse": { "type": "structure", "members": { "DBProxy": { "target": "com.amazonaws.rds#DBProxy", "traits": { "smithy.api#documentation": "The data structure representing the details of the DB proxy that you delete.
" } } } }, "com.amazonaws.rds#DeleteDBSecurityGroup": { "type": "operation", "input": { "target": "com.amazonaws.rds#DeleteDBSecurityGroupMessage" }, "errors": [ { "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" } ], "traits": { "smithy.api#documentation": "Deletes a DB security group.
\nThe specified DB security group must not be associated with any DB instances.
\nThe name of the DB security group to delete.
\nYou can't delete the default DB security group.
\nConstraints:
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nMust not be \"Default\"
\nDeletes a DB snapshot. If the snapshot is being copied, the copy operation is\n terminated.
\nThe DB snapshot must be in the available state to be deleted.
The DB snapshot identifier.
\nConstraints: Must be the name of an existing DB snapshot in the available state.
Deletes a DB subnet group.
\nThe specified database subnet group must not be associated with any DB instances.
\nThe name of the database subnet group to delete.
\nYou can't delete the default subnet group.
\nConstraints:
\nConstraints: Must match the name of an existing DBSubnetGroup. Must not be default.
\nExample: mySubnetgroup\n
Deletes an RDS event notification subscription.
" } }, "com.amazonaws.rds#DeleteEventSubscriptionMessage": { "type": "structure", "members": { "SubscriptionName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the RDS event notification subscription you want to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#DeleteEventSubscriptionResult": { "type": "structure", "members": { "EventSubscription": { "target": "com.amazonaws.rds#EventSubscription" } } }, "com.amazonaws.rds#DeleteGlobalCluster": { "type": "operation", "input": { "target": "com.amazonaws.rds#DeleteGlobalClusterMessage" }, "output": { "target": "com.amazonaws.rds#DeleteGlobalClusterResult" }, "errors": [ { "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" } ], "traits": { "smithy.api#documentation": "\n Deletes a global database cluster. The primary and secondary clusters must already be detached or\n destroyed first.\n
\nThis action only applies to Aurora DB clusters.
\n\n The cluster identifier of the global database cluster being deleted.\n
", "smithy.api#required": {} } } } }, "com.amazonaws.rds#DeleteGlobalClusterResult": { "type": "structure", "members": { "GlobalCluster": { "target": "com.amazonaws.rds#GlobalCluster" } } }, "com.amazonaws.rds#DeleteInstallationMedia": { "type": "operation", "input": { "target": "com.amazonaws.rds#DeleteInstallationMediaMessage" }, "output": { "target": "com.amazonaws.rds#InstallationMedia" }, "errors": [ { "target": "com.amazonaws.rds#InstallationMediaNotFoundFault" } ], "traits": { "smithy.api#documentation": "Deletes the installation medium for a DB engine that requires an on-premises customer provided license,\n such as Microsoft SQL Server.
" } }, "com.amazonaws.rds#DeleteInstallationMediaMessage": { "type": "structure", "members": { "InstallationMediaId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The installation medium ID.
", "smithy.api#required": {} } } } }, "com.amazonaws.rds#DeleteOptionGroup": { "type": "operation", "input": { "target": "com.amazonaws.rds#DeleteOptionGroupMessage" }, "errors": [ { "target": "com.amazonaws.rds#InvalidOptionGroupStateFault" }, { "target": "com.amazonaws.rds#OptionGroupNotFoundFault" } ], "traits": { "smithy.api#documentation": "Deletes an existing option group.
" } }, "com.amazonaws.rds#DeleteOptionGroupMessage": { "type": "structure", "members": { "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the option group to be deleted.
\nYou can't delete default option groups.
\nRemove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.
The identifier of the DBProxy that is associated with the DBProxyTargetGroup.
The identifier of the DBProxyTargetGroup.
One or more DB instance identifiers.
" } }, "DBClusterIdentifiers": { "target": "com.amazonaws.rds#StringList", "traits": { "smithy.api#documentation": "One or more DB cluster identifiers.
" } } } }, "com.amazonaws.rds#DeregisterDBProxyTargetsResponse": { "type": "structure", "members": {} }, "com.amazonaws.rds#DescribeAccountAttributes": { "type": "operation", "input": { "target": "com.amazonaws.rds#DescribeAccountAttributesMessage" }, "output": { "target": "com.amazonaws.rds#AccountAttributesMessage" }, "traits": { "smithy.api#documentation": "Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
\nThis command doesn't take any parameters.
" } }, "com.amazonaws.rds#DescribeAccountAttributesMessage": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#DescribeCertificates": { "type": "operation", "input": { "target": "com.amazonaws.rds#DescribeCertificatesMessage" }, "output": { "target": "com.amazonaws.rds#CertificateMessage" }, "errors": [ { "target": "com.amazonaws.rds#CertificateNotFoundFault" } ], "traits": { "smithy.api#documentation": "Lists the set of CA certificates provided by Amazon RDS for this AWS account.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "Certificates", "pageSize": "MaxRecords" } } }, "com.amazonaws.rds#DescribeCertificatesMessage": { "type": "structure", "members": { "CertificateIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive.
\nConstraints:
\nMust match an existing CertificateIdentifier.
\nThis parameter isn't currently supported.
" } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous\n DescribeCertificates request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
Returns information about custom Availability Zones (AZs).
\nA custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.
\nFor more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "CustomAvailabilityZones", "pageSize": "MaxRecords" } } }, "com.amazonaws.rds#DescribeCustomAvailabilityZonesMessage": { "type": "structure", "members": { "CustomAvailabilityZoneId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The custom AZ identifier. If this parameter is specified, information from only the specific custom AZ is returned.
" } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { "smithy.api#documentation": "A filter that specifies one or more custom AZs to describe.
" } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "An optional pagination token provided by a previous\n DescribeCustomAvailabilityZones request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.
Returns information about backtracks for a DB cluster.
\nFor more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora MySQL DB clusters.
\nThe DB cluster identifier of the DB cluster to be described. This parameter is\n stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 alphanumeric characters or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: my-cluster1\n
If specified, this value is the backtrack identifier of the backtrack to be\n described.
\nConstraints:
\nMust contain a valid universally unique identifier (UUID). For more\n information about UUIDs, see A Universally Unique Identifier \n (UUID) URN Namespace.
\nExample: 123e4567-e89b-12d3-a456-426655440000\n
A filter that specifies one or more DB clusters to describe. Supported filters\n include the following:
\n\n db-cluster-backtrack-id - Accepts backtrack identifiers. The\n results list includes information about only the backtracks identified by these\n identifiers.
\n db-cluster-backtrack-status - Accepts any of the following backtrack status values:
\n applying\n
\n completed\n
\n failed\n
\n pending\n
The results list includes information about only the backtracks identified\n by these values.
\nThe maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": " An optional pagination token provided by a previous\n DescribeDBClusterBacktracks request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
Returns information about endpoints for an Amazon Aurora DB cluster.
\nThis action only applies to Aurora DB clusters.
\nThe DB cluster identifier of the DB cluster associated with the endpoint. This parameter is\n stored as a lowercase string.
" } }, "DBClusterEndpointIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
" } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { "smithy.api#documentation": "A set of name-value pairs that define which endpoints to include in the output.\n The filters are specified as name-value pairs, in the format\n Name=endpoint_type,Values=endpoint_type1,endpoint_type2,....\n Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status.\n Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom.\n Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any.\n Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, inactive, modifying.\n
The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": " An optional pagination token provided by a previous\n DescribeDBClusterEndpoints request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
\n Returns a list of DBClusterParameterGroup descriptions. If a \n DBClusterParameterGroupName parameter is specified,\n the list will contain only the description of the specified DB cluster parameter group.\n
For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nThe name of a specific DB cluster parameter group to return details for.
\nConstraints:
\nIf supplied, must match the name of an existing DBClusterParameterGroup.
\nThis parameter isn't currently supported.
" } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous\n DescribeDBClusterParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
Returns the detailed parameter list for a particular DB cluster parameter group.
\nFor more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nThe name of a specific DB cluster parameter group to return parameter details for.
\nConstraints:
\nIf supplied, must match the name of an existing DBClusterParameterGroup.
\n\n A value that indicates to return only parameters for a specific source. \n Parameter sources can be engine, service,\n or customer.\n
This parameter isn't currently supported.
" } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous\n DescribeDBClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
\nWhen sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes\n returns the restore attribute and a list of IDs for the AWS accounts that are \n authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB cluster snapshot is public and\n can be copied or restored by all AWS accounts.
To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the\n manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.
This action only applies to Aurora DB clusters.
\nThe identifier for the DB cluster snapshot to describe the attributes for.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#DescribeDBClusterSnapshotAttributesResult": { "type": "structure", "members": { "DBClusterSnapshotAttributesResult": { "target": "com.amazonaws.rds#DBClusterSnapshotAttributesResult" } } }, "com.amazonaws.rds#DescribeDBClusterSnapshots": { "type": "operation", "input": { "target": "com.amazonaws.rds#DescribeDBClusterSnapshotsMessage" }, "output": { "target": "com.amazonaws.rds#DBClusterSnapshotMessage" }, "errors": [ { "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" } ], "traits": { "smithy.api#documentation": "Returns information about DB cluster snapshots. This API action supports pagination.
\nFor more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nThe ID of the DB cluster to retrieve the list of DB cluster snapshots for. \n This parameter can't be used in conjunction with the\n DBClusterSnapshotIdentifier parameter.\n This parameter isn't case-sensitive.\n
Constraints:
\nIf supplied, must match the identifier of an existing DBCluster.
\nA specific DB cluster snapshot identifier to describe. \n This parameter can't be used in conjunction with the\n DBClusterIdentifier parameter. \n This value is stored as a lowercase string.\n
Constraints:
\nIf supplied, must match the identifier of an existing DBClusterSnapshot.
\nIf this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
The type of DB cluster snapshots to be returned. You can specify one of the following values:
\n\n automated - Return all DB cluster snapshots that have been automatically taken by \n Amazon RDS for my AWS account.
\n manual - Return all DB cluster snapshots that have been taken by my AWS account.
\n shared - Return all manual DB cluster snapshots that have been shared to my AWS account.
\n public - Return all DB cluster snapshots that have been marked as public.
If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are\n returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared\n parameter. You can include public DB cluster snapshots with these results by enabling the \n IncludePublic parameter.
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.
A filter that specifies one or more DB cluster snapshots to describe.
\nSupported filters:
\n\n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs).
\n db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.
\n snapshot-type - Accepts types of DB cluster snapshots.
\n engine - Accepts names of database engines.
The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "An optional pagination token provided by a previous\n DescribeDBClusterSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
A value that indicates whether to include shared manual DB cluster snapshots \n from other AWS accounts that this AWS account has been given \n permission to copy or restore. By default, these snapshots are not included.
\nYou can give an AWS account permission to restore a manual DB cluster snapshot from\n another AWS account by the ModifyDBClusterSnapshotAttribute API action.
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any AWS account. By default, the public snapshots are not included.
\nYou can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#DescribeDBClusters": { "type": "operation", "input": { "target": "com.amazonaws.rds#DescribeDBClustersMessage" }, "output": { "target": "com.amazonaws.rds#DBClusterMessage" }, "errors": [ { "target": "com.amazonaws.rds#DBClusterNotFoundFault" } ], "traits": { "smithy.api#documentation": "Returns information about provisioned Aurora DB clusters. This API supports pagination.
\nFor more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide. \n
\nThis operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
\nThe user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.
\nConstraints:
\nIf supplied, must match an existing DBClusterIdentifier.
\nA filter that specifies one or more DB clusters to describe.
\nSupported filters:
\n\n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list will only include information about\n the DB clusters identified by these ARNs.
The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "An optional pagination token provided by a previous\n DescribeDBClusters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
Optional Boolean parameter that specifies whether the output includes information about clusters\n shared from other AWS accounts.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#DescribeDBEngineVersions": { "type": "operation", "input": { "target": "com.amazonaws.rds#DescribeDBEngineVersionsMessage" }, "output": { "target": "com.amazonaws.rds#DBEngineVersionMessage" }, "traits": { "smithy.api#documentation": "Returns a list of the available DB engines.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "DBEngineVersions", "pageSize": "MaxRecords" } } }, "com.amazonaws.rds#DescribeDBEngineVersionsMessage": { "type": "structure", "members": { "Engine": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The database engine to return.
\nValid Values:\n
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible Aurora)
\n aurora-postgresql\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-se2\n
\n oracle-se1\n
\n oracle-se\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The database engine version to return.
\nExample: 5.1.49\n
The name of a specific DB parameter group family to return details for.
\nConstraints:
\nIf supplied, must match an existing DBParameterGroupFamily.
\nThis parameter isn't currently supported.
" } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "\n The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.
" } }, "ListSupportedCharacterSets": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to list the supported character sets for each engine version.
\nIf this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance, \n the response includes a list of supported character sets for each engine version.\n
A value that indicates whether to list the supported time zones for each engine version.
\nIf this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, \n the response includes a list of supported time zones for each engine version.\n
A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.
" } } } }, "com.amazonaws.rds#DescribeDBInstanceAutomatedBackups": { "type": "operation", "input": { "target": "com.amazonaws.rds#DescribeDBInstanceAutomatedBackupsMessage" }, "output": { "target": "com.amazonaws.rds#DBInstanceAutomatedBackupMessage" }, "errors": [ { "target": "com.amazonaws.rds#DBInstanceAutomatedBackupNotFoundFault" } ], "traits": { "smithy.api#documentation": "Displays backups for both current and deleted\n instances. For example, use this operation to\n find details about automated backups for previously deleted instances. Current instances\n with retention periods greater than zero (0) are returned for both the \n DescribeDBInstanceAutomatedBackups and\n DescribeDBInstances operations.
All parameters are optional.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "DBInstanceAutomatedBackups", "pageSize": "MaxRecords" } } }, "com.amazonaws.rds#DescribeDBInstanceAutomatedBackupsMessage": { "type": "structure", "members": { "DbiResourceId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The resource ID of the DB instance that is the source of \n\t\t the automated backup. This parameter isn't case-sensitive.
" } }, "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "(Optional) The user-supplied instance identifier. If this parameter is specified, it must\n match the identifier of an existing DB instance. It returns information from the\n specific DB instance' automated backup. This parameter isn't case-sensitive.
" } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { "smithy.api#documentation": "A filter that specifies which resources to return based on status.
\n\t\tSupported filters are the following:
\n\t\t\n\t\t\t\t\t status\n\t\t\t\t
\n active - automated backups for current instances
\n retained - automated backups for deleted instances and after backup replication is stopped
\n creating - automated backups that are waiting for the first automated snapshot to be available
\n\t\t db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). \n\t\t The results list includes only information about the DB instance automated backups identified by these ARNs.
\n\t\t dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). \n\t\t The results list includes only information about the DB instance resources identified by these ARNs.
Returns all resources by default. The status for each resource is specified in the response.
" } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the specified \n\t\t\tMaxRecords value, a pagination token called a marker is included in the response so that \n\t\t\tyou can retrieve the remaining results.
The pagination token provided in the previous request. If this parameter is specified the response \n\t\t\tincludes only records beyond the marker, up to MaxRecords.
The Amazon Resource Name (ARN) of the replicated automated backups, for example,\n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
Parameter input for DescribeDBInstanceAutomatedBackups.
" } }, "com.amazonaws.rds#DescribeDBInstances": { "type": "operation", "input": { "target": "com.amazonaws.rds#DescribeDBInstancesMessage" }, "output": { "target": "com.amazonaws.rds#DBInstanceMessage" }, "errors": [ { "target": "com.amazonaws.rds#DBInstanceNotFoundFault" } ], "traits": { "smithy.api#documentation": "Returns information about provisioned RDS instances. This API supports pagination.
\nThis operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
\nThe user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.
\nConstraints:
\nIf supplied, must match the identifier of an existing DBInstance.
\nA filter that specifies one or more DB instances to describe.
\nSupported filters:
\n\n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list will only include information about \n the DB instances associated with the DB clusters identified by these ARNs.
\n db-instance-id - Accepts DB instance identifiers and DB \n instance Amazon Resource Names (ARNs). The results list will only include information about\n the DB instances identified by these ARNs.
\n dbi-resource-id - Accepts DB instance resource identifiers. The results list will \n only include information about the DB instances identified by these DB instance resource identifiers.
\n domain - Accepts Active Directory directory IDs. The results list will only \n include information about the DB instances associated with these domains.
\n engine - Accepts engine names. The results list will only include information \n about the DB instances for these engines.
\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous\n DescribeDBInstances request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
Returns a list of DB log files for the DB instance.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "DescribeDBLogFiles", "pageSize": "MaxRecords" } } }, "com.amazonaws.rds#DescribeDBLogFilesDetails": { "type": "structure", "members": { "LogFileName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the log file for the specified DB instance.
" } }, "LastWritten": { "target": "com.amazonaws.rds#Long", "traits": { "smithy.api#documentation": "A POSIX timestamp when the last log entry was written.
" } }, "Size": { "target": "com.amazonaws.rds#Long", "traits": { "smithy.api#documentation": "The size, in bytes, of the log file for the specified DB instance.
" } } }, "traits": { "smithy.api#documentation": "This data type is used as a response element to DescribeDBLogFiles.
The customer-assigned name of the DB instance that contains the log files you want to list.
\nConstraints:
\nMust match the identifier of an existing DBInstance.
\nFilters the available log files for log file names that contain the specified string.
" } }, "FileLastWritten": { "target": "com.amazonaws.rds#Long", "traits": { "smithy.api#documentation": "Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.
" } }, "FileSize": { "target": "com.amazonaws.rds#Long", "traits": { "smithy.api#documentation": "Filters the available log files for files larger than the specified size.
" } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { "smithy.api#documentation": "This parameter isn't currently supported.
" } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#DescribeDBLogFilesResponse": { "type": "structure", "members": { "DescribeDBLogFiles": { "target": "com.amazonaws.rds#DescribeDBLogFilesList", "traits": { "smithy.api#documentation": "The DB log files returned.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "A pagination token that can be used in a later DescribeDBLogFiles request.
" } } }, "traits": { "smithy.api#documentation": "\n The response from a call to DescribeDBLogFiles.\n
\n Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified,\n the list will contain only the description of the specified DB parameter group.\n
The name of a specific DB parameter group to return details for.
\nConstraints:
\nIf supplied, must match the name of an existing DBClusterParameterGroup.
\nThis parameter isn't currently supported.
" } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous\n DescribeDBParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
Returns the detailed parameter list for a particular DB parameter group.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "Parameters", "pageSize": "MaxRecords" } } }, "com.amazonaws.rds#DescribeDBParametersMessage": { "type": "structure", "members": { "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of a specific DB parameter group to return details for.
\nConstraints:
\nIf supplied, must match the name of an existing DBParameterGroup.
\nThe parameter types to return.
\nDefault: All parameter types returned
\nValid Values: user | system | engine-default\n
This parameter isn't currently supported.
" } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous\n DescribeDBParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
Returns information about DB proxies.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "DBProxies", "pageSize": "MaxRecords" } } }, "com.amazonaws.rds#DescribeDBProxiesRequest": { "type": "structure", "members": { "DBProxyName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the DB proxy. If you omit this parameter,\n the output includes information about all DB proxies owned by\n your AWS account ID.
" } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { "smithy.api#documentation": "This parameter is not currently supported.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.\n
The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } } } }, "com.amazonaws.rds#DescribeDBProxiesResponse": { "type": "structure", "members": { "DBProxies": { "target": "com.amazonaws.rds#DBProxyList", "traits": { "smithy.api#documentation": "A return value representing an arbitrary number of DBProxy data structures.
\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.\n
Returns information about DB proxy endpoints.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "DBProxyEndpoints", "pageSize": "MaxRecords" } } }, "com.amazonaws.rds#DescribeDBProxyEndpointsRequest": { "type": "structure", "members": { "DBProxyName": { "target": "com.amazonaws.rds#DBProxyName", "traits": { "smithy.api#documentation": "The name of the DB proxy whose endpoints you want to describe. If you omit\n this parameter, the output includes information about all DB proxy endpoints\n associated with all your DB proxies.
" } }, "DBProxyEndpointName": { "target": "com.amazonaws.rds#DBProxyEndpointName", "traits": { "smithy.api#documentation": "The name of a DB proxy endpoint to describe. If you omit this parameter,\n the output includes information about all DB proxy endpoints associated with\n the specified proxy.
" } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { "smithy.api#documentation": "This parameter is not currently supported.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.\n
The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } } } }, "com.amazonaws.rds#DescribeDBProxyEndpointsResponse": { "type": "structure", "members": { "DBProxyEndpoints": { "target": "com.amazonaws.rds#DBProxyEndpointList", "traits": { "smithy.api#documentation": "The list of ProxyEndpoint objects returned by the API operation.
\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.\n
Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.
The identifier of the DBProxy associated with the target group.
The identifier of the DBProxyTargetGroup to describe.
This parameter is not currently supported.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.\n
\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } } } }, "com.amazonaws.rds#DescribeDBProxyTargetGroupsResponse": { "type": "structure", "members": { "TargetGroups": { "target": "com.amazonaws.rds#TargetGroupList", "traits": { "smithy.api#documentation": "An arbitrary number of DBProxyTargetGroup objects, containing details of the corresponding target groups.
\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.\n
Returns information about DBProxyTarget objects. This API supports pagination.
The identifier of the DBProxyTarget to describe.
The identifier of the DBProxyTargetGroup to describe.
This parameter is not currently supported.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.\n
\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } } } }, "com.amazonaws.rds#DescribeDBProxyTargetsResponse": { "type": "structure", "members": { "Targets": { "target": "com.amazonaws.rds#TargetList", "traits": { "smithy.api#documentation": "An arbitrary number of DBProxyTarget objects, containing details of the corresponding targets.
\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.\n
\n Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified,\n the list will contain only the descriptions of the specified DB security group.\n
The name of the DB security group to return details for.
" } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { "smithy.api#documentation": "This parameter isn't currently supported.
" } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous\n DescribeDBSecurityGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
Returns a list of DB snapshot attribute names and values for a manual DB snapshot.
\nWhen sharing snapshots with other AWS accounts, DescribeDBSnapshotAttributes\n returns the restore attribute and a list of IDs for the AWS accounts that are \n authorized to copy or restore the manual DB snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB snapshot is public and\n can be copied or restored by all AWS accounts.
To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the\n manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.
The identifier for the DB snapshot to describe the attributes for.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#DescribeDBSnapshotAttributesResult": { "type": "structure", "members": { "DBSnapshotAttributesResult": { "target": "com.amazonaws.rds#DBSnapshotAttributesResult" } } }, "com.amazonaws.rds#DescribeDBSnapshots": { "type": "operation", "input": { "target": "com.amazonaws.rds#DescribeDBSnapshotsMessage" }, "output": { "target": "com.amazonaws.rds#DBSnapshotMessage" }, "errors": [ { "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" } ], "traits": { "smithy.api#documentation": "Returns information about DB snapshots. This API action supports pagination.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "DBSnapshots", "pageSize": "MaxRecords" }, "smithy.waiters#waitable": { "DBSnapshotAvailable": { "acceptors": [ { "state": "success", "matcher": { "output": { "path": "DBSnapshots[].Status", "expected": "available", "comparator": "allStringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "DBSnapshots[].Status", "expected": "deleted", "comparator": "anyStringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "DBSnapshots[].Status", "expected": "deleting", "comparator": "anyStringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "DBSnapshots[].Status", "expected": "failed", "comparator": "anyStringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "DBSnapshots[].Status", "expected": "incompatible-restore", "comparator": "anyStringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "DBSnapshots[].Status", "expected": "incompatible-parameters", "comparator": "anyStringEquals" } } } ], "minDelay": 30 } } } }, "com.amazonaws.rds#DescribeDBSnapshotsMessage": { "type": "structure", "members": { "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The ID of the DB instance to retrieve the list of DB snapshots for. \n This parameter can't be used in conjunction with DBSnapshotIdentifier.\n This parameter isn't case-sensitive.\n
Constraints:
\nIf supplied, must match the identifier of an existing DBInstance.
\n\n A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier. \n This value is stored as a lowercase string.\n
Constraints:
\nIf supplied, must match the identifier of an existing DBSnapshot.
\nIf this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
The type of snapshots to be returned. You can specify one of the following values:
\n\n automated - Return all DB snapshots that have been automatically taken by \n Amazon RDS for my AWS account.
\n manual - Return all DB snapshots that have been taken by my AWS account.
\n shared - Return all manual DB snapshots that have been shared to my AWS account.
\n public - Return all DB snapshots that have been marked as public.
\n awsbackup - Return the DB snapshots managed by the AWS Backup service.
For information about AWS Backup, see the \n \n AWS Backup Developer Guide.\n \n
\nThe awsbackup type does not apply to Aurora.
If you don't specify a SnapshotType value, then both automated and manual snapshots are\n returned. Shared and public DB snapshots are not included in the returned results by default.\n You can include shared snapshots with these results by enabling the IncludeShared\n parameter. You can include public snapshots with these results by enabling the \n IncludePublic parameter.
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.
A filter that specifies one or more DB snapshots to describe.
\nSupported filters:
\n\n db-instance-id - Accepts DB instance identifiers and DB \n instance Amazon Resource Names (ARNs).
\n db-snapshot-id - Accepts DB snapshot identifiers.
\n dbi-resource-id - Accepts identifiers of source DB instances.
\n snapshot-type - Accepts types of DB snapshots.
\n engine - Accepts names of database engines.
\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous\n DescribeDBSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
A value that indicates whether to include shared manual DB cluster snapshots \n from other AWS accounts that this AWS account has been given \n permission to copy or restore. By default, these snapshots are not included.
\nYou can give an AWS account permission to restore a manual DB snapshot from\n another AWS account by using the ModifyDBSnapshotAttribute API action.
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any AWS account. By default, the public snapshots are not included.
\nYou can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
" } }, "DbiResourceId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "A specific DB resource ID to describe.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#DescribeDBSubnetGroups": { "type": "operation", "input": { "target": "com.amazonaws.rds#DescribeDBSubnetGroupsMessage" }, "output": { "target": "com.amazonaws.rds#DBSubnetGroupMessage" }, "errors": [ { "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" } ], "traits": { "smithy.api#documentation": "Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
\nFor an overview of CIDR ranges, go to the \n Wikipedia Tutorial.\n
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "DBSubnetGroups", "pageSize": "MaxRecords" } } }, "com.amazonaws.rds#DescribeDBSubnetGroupsMessage": { "type": "structure", "members": { "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the DB subnet group to return details for.
" } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { "smithy.api#documentation": "This parameter isn't currently supported.
" } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous DescribeDBSubnetGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
Returns the default engine and system parameter information for the cluster database engine.
\nFor more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
" } }, "com.amazonaws.rds#DescribeEngineDefaultClusterParametersMessage": { "type": "structure", "members": { "DBParameterGroupFamily": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the DB cluster parameter group family to return engine parameter information for.
", "smithy.api#required": {} } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { "smithy.api#documentation": "This parameter isn't currently supported.
" } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous\n DescribeEngineDefaultClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
Returns the default engine and system parameter information for the specified database engine.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "EngineDefaults.Marker", "items": "EngineDefaults.Parameters", "pageSize": "MaxRecords" } } }, "com.amazonaws.rds#DescribeEngineDefaultParametersMessage": { "type": "structure", "members": { "DBParameterGroupFamily": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the DB parameter group family.
", "smithy.api#required": {} } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { "smithy.api#documentation": "This parameter isn't currently supported.
" } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous\n DescribeEngineDefaultParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
Displays a list of categories for all event source types, or, if specified, for a specified source type.\n You can see a list of the event categories and source types \n in \n Events in the Amazon RDS User Guide.\n
" } }, "com.amazonaws.rds#DescribeEventCategoriesMessage": { "type": "structure", "members": { "SourceType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The type of source that is generating the events.
\nValid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot\n
This parameter isn't currently supported.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#DescribeEventSubscriptions": { "type": "operation", "input": { "target": "com.amazonaws.rds#DescribeEventSubscriptionsMessage" }, "output": { "target": "com.amazonaws.rds#EventSubscriptionsMessage" }, "errors": [ { "target": "com.amazonaws.rds#SubscriptionNotFoundFault" } ], "traits": { "smithy.api#documentation": "Lists all the subscription descriptions for a customer account. The description for a subscription includes \n SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
The name of the RDS event notification subscription you want to describe.
" } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { "smithy.api#documentation": "This parameter isn't currently supported.
" } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n
Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, and DB cluster snapshots for the past 14 days. \n Events specific to a particular DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, and DB cluster snapshots group can be \n obtained by providing the name as a parameter.
\nBy default, the past hour of events are returned.
\nThe identifier of the event source for which events are returned. If not specified, then all sources are included in the response.
\nConstraints:
\nIf SourceIdentifier is supplied, SourceType must also be provided.
If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
Can't end with a hyphen or contain two consecutive hyphens.
\nThe event source to retrieve events for. If no value is specified, all events are returned.
" } }, "StartTime": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "\n The beginning of the time interval to retrieve events for,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n
\nExample: 2009-07-08T18:00Z
" } }, "EndTime": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "\n The end of the time interval for which to retrieve events,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n
\nExample: 2009-07-08T18:00Z
" } }, "Duration": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The number of minutes to retrieve events for.
\nDefault: 60
" } }, "EventCategories": { "target": "com.amazonaws.rds#EventCategoriesList", "traits": { "smithy.api#documentation": "A list of event categories that trigger notifications for a event notification subscription.
" } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { "smithy.api#documentation": "This parameter isn't currently supported.
" } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous\n DescribeEvents request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
Returns information about a snapshot export to Amazon S3. This API operation supports\n pagination.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "ExportTasks", "pageSize": "MaxRecords" } } }, "com.amazonaws.rds#DescribeExportTasksMessage": { "type": "structure", "members": { "ExportTaskIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The identifier of the snapshot export task to be described.
" } }, "SourceArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
" } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { "smithy.api#documentation": "Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to\n include in the output. Filter names and values are case-sensitive.
\nSupported filters include the following:
\n\n export-task-identifier - An identifier for the snapshot export task.
\n s3-bucket - The Amazon S3 bucket the snapshot is exported to.
\n source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3
\n status - The status of the export task. Must be lowercase, for example, complete.
\n An optional pagination token provided by a previous DescribeExportTasks request.\n If you specify this parameter, the response includes only records beyond the marker,\n up to the value specified by the MaxRecords parameter.\n
\n The maximum number of records to include in the response. If more records exist than the \n specified value, a pagination token called a marker is included in the response. \n You can use the marker in a later DescribeExportTasks request \n to retrieve the remaining results.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } } } }, "com.amazonaws.rds#DescribeGlobalClusters": { "type": "operation", "input": { "target": "com.amazonaws.rds#DescribeGlobalClustersMessage" }, "output": { "target": "com.amazonaws.rds#GlobalClustersMessage" }, "errors": [ { "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" } ], "traits": { "smithy.api#documentation": "\n Returns information about Aurora global database clusters. This API supports pagination.\n
\n\n For more information on Amazon Aurora, see What Is Amazon Aurora? in the\n Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\n\n The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.\n
\nConstraints:
\nIf supplied, must match an existing DBClusterIdentifier.
\nA filter that specifies one or more global DB clusters to describe.
\nSupported filters:
\n\n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list will only include information about\n the DB clusters identified by these ARNs.
\n The maximum number of records to include in the response. If more records exist than the specified\n MaxRecords value, a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous DescribeGlobalClusters request. If\n this parameter is specified, the response includes only records beyond the marker, up to the value\n specified by MaxRecords.\n
Describes the available installation media for a DB engine that requires an \n on-premises customer provided license, such as Microsoft SQL Server.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "InstallationMedia", "pageSize": "MaxRecords" } } }, "com.amazonaws.rds#DescribeInstallationMediaMessage": { "type": "structure", "members": { "InstallationMediaId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The installation medium ID.
" } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { "smithy.api#documentation": "A filter that specifies one or more installation media to describe. Supported filters\n include the following:
\n\n custom-availability-zone-id - Accepts custom Availability Zone (AZ)\n identifiers. The results list includes information about only the custom AZs\n identified by these identifiers.
\n engine - Accepts database engines. The results list includes information about \n only the database engines identified by these identifiers.
For more information about the valid engines for installation media, see ImportInstallationMedia.
\nAn optional pagination token provided by a previous DescribeInstallationMedia request.\n If this parameter is specified, the response includes\n only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.
Describes all available options.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "OptionGroupOptions", "pageSize": "MaxRecords" } } }, "com.amazonaws.rds#DescribeOptionGroupOptionsMessage": { "type": "structure", "members": { "EngineName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "A required parameter. Options available for the given engine name are described.
\nValid Values:\n
\n\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-se2\n
\n oracle-se1\n
\n oracle-se\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
If specified, filters the results to include only options for the specified major engine version.
" } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { "smithy.api#documentation": "This parameter isn't currently supported.
" } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.
Describes the available option groups.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "OptionGroupsList", "pageSize": "MaxRecords" } } }, "com.amazonaws.rds#DescribeOptionGroupsMessage": { "type": "structure", "members": { "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.
" } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { "smithy.api#documentation": "This parameter isn't currently supported.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous DescribeOptionGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "EngineName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Filters the list of option groups to only include groups associated with a specific database engine.
\nValid Values:\n
\n\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-se2\n
\n oracle-se1\n
\n oracle-se\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#DescribeOrderableDBInstanceOptions": { "type": "operation", "input": { "target": "com.amazonaws.rds#DescribeOrderableDBInstanceOptionsMessage" }, "output": { "target": "com.amazonaws.rds#OrderableDBInstanceOptionsMessage" }, "traits": { "smithy.api#documentation": "Returns a list of orderable DB instance options for the specified engine.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "OrderableDBInstanceOptions", "pageSize": "MaxRecords" } } }, "com.amazonaws.rds#DescribeOrderableDBInstanceOptionsMessage": { "type": "structure", "members": { "Engine": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the engine to retrieve DB instance options for.
\nValid Values:\n
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible Aurora)
\n aurora-postgresql\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-se2\n
\n oracle-se1\n
\n oracle-se\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.
" } }, "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
" } }, "AvailabilityZoneGroup": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.
\nOmit this parameter to show the available offerings in the specified AWS Region.
" } }, "Vpc": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to show only VPC or non-VPC offerings.
" } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { "smithy.api#documentation": "This parameter isn't currently supported.
" } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "PendingMaintenanceActions", "pageSize": "MaxRecords" } } }, "com.amazonaws.rds#DescribePendingMaintenanceActionsMessage": { "type": "structure", "members": { "ResourceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The ARN of a resource to return pending maintenance actions for.
" } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { "smithy.api#documentation": "A filter that specifies one or more resources to return pending maintenance actions for.
\nSupported filters:
\n\n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list will only include pending maintenance \n actions for the DB clusters identified by these ARNs.
\n db-instance-id - Accepts DB instance identifiers and DB \n instance ARNs. The results list will only include pending maintenance \n actions for the DB instances identified by these ARNs.
\n An optional pagination token provided by a previous\n DescribePendingMaintenanceActions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to a number of records specified by MaxRecords.\n
\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#DescribeReservedDBInstances": { "type": "operation", "input": { "target": "com.amazonaws.rds#DescribeReservedDBInstancesMessage" }, "output": { "target": "com.amazonaws.rds#ReservedDBInstanceMessage" }, "errors": [ { "target": "com.amazonaws.rds#ReservedDBInstanceNotFoundFault" } ], "traits": { "smithy.api#documentation": "Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "ReservedDBInstances", "pageSize": "MaxRecords" } } }, "com.amazonaws.rds#DescribeReservedDBInstancesMessage": { "type": "structure", "members": { "ReservedDBInstanceId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.
" } }, "ReservedDBInstancesOfferingId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.
" } }, "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.
" } }, "Duration": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
\nValid Values: 1 | 3 | 31536000 | 94608000\n
The product description filter value. Specify this parameter to show only those reservations matching the specified product description.
" } }, "OfferingType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
\nValid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\" \n
A value that indicates whether to show only those reservations that support Multi-AZ.
" } }, "LeaseId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.
\nAWS Support might request the lease ID for an issue related to a reserved DB instance.
\nThis parameter isn't currently supported.
" } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "\n The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
Lists available reserved DB instance offerings.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "ReservedDBInstancesOfferings", "pageSize": "MaxRecords" } } }, "com.amazonaws.rds#DescribeReservedDBInstancesOfferingsMessage": { "type": "structure", "members": { "ReservedDBInstancesOfferingId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.
\nExample: 438012d3-4052-4cc7-b2e3-8d3372e0e706\n
The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
" } }, "Duration": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
\nValid Values: 1 | 3 | 31536000 | 94608000\n
Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.
\nThe results show offerings that partially match the filter value.
\nThe offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
\nValid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\" \n
A value that indicates whether to show only those reservations that support Multi-AZ.
" } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { "smithy.api#documentation": "This parameter isn't currently supported.
" } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "\n The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
Returns a list of the source AWS Regions where the current AWS Region can create a read replica, \n copy a DB snapshot from, or replicate automated backups from. This API action supports pagination.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "SourceRegions", "pageSize": "MaxRecords" } } }, "com.amazonaws.rds#DescribeSourceRegionsMessage": { "type": "structure", "members": { "RegionName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The source AWS Region name. For example, us-east-1.
Constraints:
\nMust specify a valid AWS Region name.
\nThe maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "An optional pagination token provided by a previous DescribeSourceRegions request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.
This parameter isn't currently supported.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#DescribeValidDBInstanceModifications": { "type": "operation", "input": { "target": "com.amazonaws.rds#DescribeValidDBInstanceModificationsMessage" }, "output": { "target": "com.amazonaws.rds#DescribeValidDBInstanceModificationsResult" }, "errors": [ { "target": "com.amazonaws.rds#DBInstanceNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" } ], "traits": { "smithy.api#documentation": "You can call DescribeValidDBInstanceModifications \n to learn what modifications you can make to your DB instance.\n You can use this information when you call \n ModifyDBInstance.\n
The customer identifier or the ARN of your DB instance.\n
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#DescribeValidDBInstanceModificationsResult": { "type": "structure", "members": { "ValidDBInstanceModificationsMessage": { "target": "com.amazonaws.rds#ValidDBInstanceModificationsMessage" } } }, "com.amazonaws.rds#DomainMembership": { "type": "structure", "members": { "Domain": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The identifier of the Active Directory Domain.
" } }, "Status": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
" } }, "FQDN": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The fully qualified domain name of the Active Directory Domain.
" } }, "IAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the IAM role to be used when making API calls to the Directory Service.
" } } }, "traits": { "smithy.api#documentation": "An Active Directory Domain membership record associated with the DB instance or cluster.
" } }, "com.amazonaws.rds#DomainMembershipList": { "type": "list", "member": { "target": "com.amazonaws.rds#DomainMembership", "traits": { "smithy.api#xmlName": "DomainMembership" } }, "traits": { "smithy.api#documentation": "List of Active Directory Domain membership records associated with a DB instance or cluster.
" } }, "com.amazonaws.rds#DomainNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "\n Domain doesn't refer to an existing Active Directory domain.\n
The minimum value in the range.
" } }, "To": { "target": "com.amazonaws.rds#Double", "traits": { "smithy.api#documentation": "The maximum value in the range.
" } } }, "traits": { "smithy.api#documentation": "A range of double values.
" } }, "com.amazonaws.rds#DoubleRangeList": { "type": "list", "member": { "target": "com.amazonaws.rds#DoubleRange", "traits": { "smithy.api#xmlName": "DoubleRange" } } }, "com.amazonaws.rds#DownloadDBLogFilePortion": { "type": "operation", "input": { "target": "com.amazonaws.rds#DownloadDBLogFilePortionMessage" }, "output": { "target": "com.amazonaws.rds#DownloadDBLogFilePortionDetails" }, "errors": [ { "target": "com.amazonaws.rds#DBInstanceNotFoundFault" }, { "target": "com.amazonaws.rds#DBLogFileNotFoundFault" } ], "traits": { "smithy.api#documentation": "Downloads all or a portion of the specified log file, up to 1 MB in size.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "pageSize": "NumberOfLines" } } }, "com.amazonaws.rds#DownloadDBLogFilePortionDetails": { "type": "structure", "members": { "LogFileData": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Entries from the specified log file.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "A pagination token that can be used in a later DownloadDBLogFilePortion request.
" } }, "AdditionalDataPending": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Boolean value that if true, indicates there is more data to be downloaded.
" } } }, "traits": { "smithy.api#documentation": "This data type is used as a response element to DownloadDBLogFilePortion.
The customer-assigned name of the DB instance that contains the log files you want to list.
\nConstraints:
\nMust match the identifier of an existing DBInstance.
\nThe name of the log file to be downloaded.
", "smithy.api#required": {} } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The pagination token provided in the previous request or \"0\". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.
" } }, "NumberOfLines": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#documentation": "The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.
\nIf the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning \n or the end of the log file, depending on the value of the Marker parameter.
\nIf neither Marker or NumberOfLines are specified, the entire log file is returned up to a \n maximum of 10000 lines, starting with the most recent log entries first.
\nIf \n NumberOfLines is specified and Marker isn't specified, then the most recent lines from the end \n of the log file are returned.
\nIf Marker is specified as \"0\", then the specified \n number of lines from the beginning of the log file are returned.
\nYou can \n download the log file in blocks of lines by specifying the size of the block using \n the NumberOfLines parameter, and by specifying a value of \"0\" for the Marker parameter in your \n first request. Include the Marker value returned in the response as the Marker value for the next \n request, continuing until the AdditionalDataPending response element returns false.
\nProvides the status of the EC2 security group. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".
" } }, "EC2SecurityGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the name of the EC2 security group.
" } }, "EC2SecurityGroupId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the id of the EC2 security group.
" } }, "EC2SecurityGroupOwnerId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n Specifies the AWS ID of the owner of the EC2 security group\n specified in the EC2SecurityGroupName field.\n
This data type is used as a response element in the following actions:
\n\n AuthorizeDBSecurityGroupIngress\n
\n DescribeDBSecurityGroups\n
\n RevokeDBSecurityGroupIngress\n
Specifies the DNS address of the DB instance.
" } }, "Port": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#documentation": "Specifies the port that the database engine is listening on.
" } }, "HostedZoneId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
" } } }, "traits": { "smithy.api#documentation": "This data type represents the information you need to connect to an Amazon RDS DB instance.\n This data type is used as a response element in the following actions:
\n\n CreateDBInstance\n
\n DescribeDBInstances\n
\n DeleteDBInstance\n
For the data structure that represents Amazon Aurora DB cluster endpoints,\n see DBClusterEndpoint.
Specifies the name of the DB parameter group family that the engine default parameters apply to.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous \n EngineDefaults request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n
Contains a list of engine default parameters.
" } } }, "traits": { "smithy.api#documentation": "\n Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.\n
Provides the identifier for the source of the event.
" } }, "SourceType": { "target": "com.amazonaws.rds#SourceType", "traits": { "smithy.api#documentation": "Specifies the source type for this event.
" } }, "Message": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Provides the text of this event.
" } }, "EventCategories": { "target": "com.amazonaws.rds#EventCategoriesList", "traits": { "smithy.api#documentation": "Specifies the category for the event.
" } }, "Date": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "Specifies the date and time of the event.
" } }, "SourceArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the event.
" } } }, "traits": { "smithy.api#documentation": "\n This data type is used as a response element in the DescribeEvents action.\n
The source type that the returned categories belong to
" } }, "EventCategories": { "target": "com.amazonaws.rds#EventCategoriesList", "traits": { "smithy.api#documentation": "The event categories for the specified source type
" } } }, "traits": { "smithy.api#documentation": "Contains the results of a successful invocation of the DescribeEventCategories operation.
A list of EventCategoriesMap data types.
" } } }, "traits": { "smithy.api#documentation": "Data returned from the DescribeEventCategories operation.
The AWS customer account associated with the RDS event notification subscription.
" } }, "CustSubscriptionId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The RDS event notification subscription Id.
" } }, "SnsTopicArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The topic ARN of the RDS event notification subscription.
" } }, "Status": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The status of the RDS event notification subscription.
\nConstraints:
\nCan be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
\nThe 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.
" } }, "SubscriptionCreationTime": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The time the RDS event notification subscription was created.
" } }, "SourceType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The source type for the RDS event notification subscription.
" } }, "SourceIdsList": { "target": "com.amazonaws.rds#SourceIdsList", "traits": { "smithy.api#documentation": "A list of source IDs for the RDS event notification subscription.
" } }, "EventCategoriesList": { "target": "com.amazonaws.rds#EventCategoriesList", "traits": { "smithy.api#documentation": "A list of event categories for the RDS event notification subscription.
" } }, "Enabled": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
" } }, "EventSubscriptionArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the event subscription.
" } } }, "traits": { "smithy.api#documentation": "Contains the results of a successful invocation of the DescribeEventSubscriptions action.
You have reached the maximum number of event subscriptions.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#EventSubscriptionsList": { "type": "list", "member": { "target": "com.amazonaws.rds#EventSubscription", "traits": { "smithy.api#xmlName": "EventSubscription" } } }, "com.amazonaws.rds#EventSubscriptionsMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
A list of EventSubscriptions data types.
" } } }, "traits": { "smithy.api#documentation": "Data returned by the DescribeEventSubscriptions action.
" } }, "com.amazonaws.rds#EventsMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous \n Events request.\n If this parameter is specified, the response includes\n only records beyond the marker, \n up to the value specified by MaxRecords .\n
\n A list of Event instances.\n
\n Contains the result of a successful invocation of the DescribeEvents action.\n
A unique identifier for the snapshot export task. This ID isn't an identifier for\n the Amazon S3 bucket where the snapshot is exported to.
" } }, "SourceArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
" } }, "ExportOnly": { "target": "com.amazonaws.rds#StringList", "traits": { "smithy.api#documentation": "The data exported from the snapshot. Valid values are the following:
\n\n database - Export all the data from a specified database.
\n database.table \n table-name - \n Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
\n database.schema \n schema-name - Export a database schema of the snapshot. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
\n database.schema.table \n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
The time that the snapshot was created.
" } }, "TaskStartTime": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "The time that the snapshot export task started.
" } }, "TaskEndTime": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "The time that the snapshot export task completed.
" } }, "S3Bucket": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon S3 bucket that the snapshot is exported to.
" } }, "S3Prefix": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
" } }, "IamRoleArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The key identifier of the AWS KMS customer master key (CMK) that is used to encrypt the snapshot when it's exported to\n Amazon S3. The AWS KMS CMK identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export\n must have encryption and decryption permissions to use this AWS KMS CMK.
" } }, "Status": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The progress status of the export task.
" } }, "PercentProgress": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#documentation": "The progress of the snapshot export task as a percentage.
" } }, "TotalExtractedDataInGB": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#documentation": "The total amount of data exported, in gigabytes.
" } }, "FailureCause": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The reason the export failed, if it failed.
" } }, "WarningMessage": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "A warning about the snapshot export task.
" } } }, "traits": { "smithy.api#documentation": "Contains the details of a snapshot export to Amazon S3.\n
\nThis data type is used as a response element in the DescribeExportTasks action.\n
You can't start an export task that's already running.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#ExportTaskNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The export task doesn't exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.rds#ExportTasksList": { "type": "list", "member": { "target": "com.amazonaws.rds#ExportTask", "traits": { "smithy.api#xmlName": "ExportTask" } } }, "com.amazonaws.rds#ExportTasksMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "A pagination token that can be used in a later DescribeExportTasks\n request. A marker is used for pagination to identify the location to begin output for\n the next response of DescribeExportTasks.
Information about an export of a snapshot to Amazon S3.
" } } } }, "com.amazonaws.rds#FailoverDBCluster": { "type": "operation", "input": { "target": "com.amazonaws.rds#FailoverDBClusterMessage" }, "output": { "target": "com.amazonaws.rds#FailoverDBClusterResult" }, "errors": [ { "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidDBClusterStateFault" }, { "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" } ], "traits": { "smithy.api#documentation": "Forces a failover for a DB cluster.
\nA failover for a DB cluster promotes one of the Aurora Replicas (read-only instances)\n in the DB cluster to be the primary instance (the cluster writer).
\nAmazon Aurora will automatically fail over to an Aurora Replica, if one exists,\n when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. \n Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing \n connections that use those endpoint addresses when the failover is complete.
\nFor more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nA DB cluster identifier to force a failover for. This parameter isn't case-sensitive.
\nConstraints:
\nMust match the identifier of an existing DBCluster.
\nThe name of the instance to promote to the primary instance.
\nYou must specify the instance identifier for an Aurora Replica in the DB cluster.\n For example, mydbcluster-replica1.
Initiates the failover process for an Aurora global database (GlobalCluster).
\nA failover for an Aurora global database promotes one of secondary read-only DB clusters to be\n the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words,\n the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected\n secondary DB cluster assumes full read/write capabilities for the Aurora global database.
\nFor more information about failing over an Amazon Aurora global database, see\n Managed planned failover for Amazon Aurora global\n databases in the Amazon Aurora User Guide.\n
\nThis action applies to GlobalCluster (Aurora global databases) only. Use this action only on\n healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to\n reconfigure your Aurora global database topology.\n
\nIdentifier of the Aurora global database (GlobalCluster)\n that should be failed over. The identifier is the unique key assigned by\n the user when the Aurora global database was created. In other words,\n it's the name of the Aurora global database that you want to fail over.
\nConstraints:
\nMust match the identifier of an existing\n GlobalCluster (Aurora global database).
\nIdentifier of the secondary Aurora DB cluster that you want to promote to primary for the Aurora\n global database (GlobalCluster.) Use the Amazon Resource Name (ARN) for the identifier so that\n Aurora can locate the cluster in its AWS Region. \n
", "smithy.api#required": {} } } } }, "com.amazonaws.rds#FailoverGlobalClusterResult": { "type": "structure", "members": { "GlobalCluster": { "target": "com.amazonaws.rds#GlobalCluster" } } }, "com.amazonaws.rds#FailoverState": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.rds#FailoverStatus", "traits": { "smithy.api#documentation": "The current status of the Aurora global database (GlobalCluster). Possible values are as follows:\n
\npending – A request to fail over the Aurora global database (GlobalCluster) has been received by the service. The\n GlobalCluster's primary DB cluster and the specified secondary DB cluster are being verified before the failover\n process can start.
failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such\n as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.
\ncancelling – The request to fail over the Aurora global database (GlobalCluster) was cancelled and the primary\n Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states. \n
\nThe Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this\n state.
" } }, "ToDbClusterArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated\n with this state.
" } } }, "traits": { "smithy.api#documentation": "Contains the state of scheduled or in-process failover operations on an\n Aurora global database (GlobalCluster). This Data type is empty unless a failover\n operation is scheduled or is currently underway on the Aurora global database.
" } }, "com.amazonaws.rds#FailoverStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "pending", "name": "PENDING" }, { "value": "failing-over", "name": "FAILING_OVER" }, { "value": "cancelling", "name": "CANCELLING" } ] } }, "com.amazonaws.rds#FeatureNameList": { "type": "list", "member": { "target": "com.amazonaws.rds#String" } }, "com.amazonaws.rds#Filter": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the filter. Filter names are case-sensitive.
", "smithy.api#required": {} } }, "Values": { "target": "com.amazonaws.rds#FilterValueList", "traits": { "smithy.api#documentation": "One or more filter values. Filter values are case-sensitive.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A filter name and value pair that is used to return a more specific list of results \n from a describe operation. Filters can be used to match a set of resources by specific \n criteria, such as IDs. The filters supported by a describe operation are documented \n with the describe operation.
\nCurrently, wildcards are not supported in filters.
\nThe following actions can be filtered:
\n\n DescribeDBClusterBacktracks\n
\n DescribeDBClusterEndpoints\n
\n DescribeDBClusters\n
\n DescribeDBInstances\n
\n DescribePendingMaintenanceActions\n
\n Contains a user-supplied global database cluster identifier. This identifier is the unique key that\n identifies a global database cluster.\n
" } }, "GlobalClusterResourceId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in\n AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the DB cluster is accessed.\n
" } }, "GlobalClusterArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the global database cluster.
" } }, "Status": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the current state of this global database cluster.
" } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n The Aurora database engine used by the global database cluster.\n
" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Indicates the database engine version.
" } }, "DatabaseName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n The default database name within the new global database cluster.\n
" } }, "StorageEncrypted": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "\n The storage encryption setting for the global database cluster.\n
" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "\n The deletion protection setting for the new global database cluster.\n
" } }, "GlobalClusterMembers": { "target": "com.amazonaws.rds#GlobalClusterMemberList", "traits": { "smithy.api#documentation": "\n The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to\n 1 item.\n
" } }, "FailoverState": { "target": "com.amazonaws.rds#FailoverState", "traits": { "smithy.api#documentation": "A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database.\n This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database (GlobalCluster).\n
" } } }, "traits": { "smithy.api#documentation": "A data type representing an Aurora global database.
" } }, "com.amazonaws.rds#GlobalClusterAlreadyExistsFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The GlobalClusterIdentifier already exists. Choose a new global database identifier (unique name) to create a new global database cluster.
\n The Amazon Resource Name (ARN) for each Aurora cluster.\n
" } }, "Readers": { "target": "com.amazonaws.rds#ReadersArnList", "traits": { "smithy.api#documentation": "\n The Amazon Resource Name (ARN) for each read-only secondary cluster\n associated with the Aurora global database.\n
" } }, "IsWriter": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "\n Specifies whether the Aurora cluster is the primary cluster\n (that is, has read-write capability) for the Aurora global\n database with which it is associated.\n
" } }, "GlobalWriteForwardingStatus": { "target": "com.amazonaws.rds#WriteForwardingStatus", "traits": { "smithy.api#documentation": "Specifies whether a secondary cluster in an Aurora global database has\n write forwarding enabled, not enabled, or is in the process of enabling it.
" } } }, "traits": { "smithy.api#documentation": "\n A data structure with information about any primary and\n secondary clusters associated with an Aurora global database.\n
" } }, "com.amazonaws.rds#GlobalClusterMemberList": { "type": "list", "member": { "target": "com.amazonaws.rds#GlobalClusterMember", "traits": { "smithy.api#xmlName": "GlobalClusterMember" } } }, "com.amazonaws.rds#GlobalClusterNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The GlobalClusterIdentifier doesn't refer to an existing global database cluster.
The number of global database clusters for this account is already at the maximum allowed.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#GlobalClustersMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous DescribeGlobalClusters request.\n If this parameter is specified, the response includes\n only records beyond the marker, up to the value specified by MaxRecords.\n
\n The list of global clusters returned by this request.\n
" } } } }, "com.amazonaws.rds#IAMAuthMode": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "DISABLED", "name": "DISABLED" }, { "value": "REQUIRED", "name": "REQUIRED" } ] } }, "com.amazonaws.rds#IPRange": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".
" } }, "CIDRIP": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the IP range.
" } } }, "traits": { "smithy.api#documentation": "\n This data type is used as a response element in the DescribeDBSecurityGroups action.\n
The IAM role requires additional permissions to export to an Amazon S3 bucket.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#IamRoleNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The IAM role is missing for exporting to an Amazon S3 bucket.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.rds#ImportInstallationMedia": { "type": "operation", "input": { "target": "com.amazonaws.rds#ImportInstallationMediaMessage" }, "output": { "target": "com.amazonaws.rds#InstallationMedia" }, "errors": [ { "target": "com.amazonaws.rds#CustomAvailabilityZoneNotFoundFault" }, { "target": "com.amazonaws.rds#InstallationMediaAlreadyExistsFault" } ], "traits": { "smithy.api#documentation": "Imports the installation media for a DB engine that requires an on-premises \n customer provided license, such as SQL Server.
" } }, "com.amazonaws.rds#ImportInstallationMediaMessage": { "type": "structure", "members": { "CustomAvailabilityZoneId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The identifier of the custom Availability Zone (AZ) to import the installation media to.
", "smithy.api#required": {} } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the database engine to be used for this instance.\n
\n \nThe list only includes supported DB engines that require an on-premises \n customer provided license.\n
\n \nValid Values:\n
\n\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The version number of the database engine to use.
\nFor a list of valid engine versions, call DescribeDBEngineVersions.
\nThe following are the database engines and links to information about the major and minor \n versions. The list only includes DB engines that require an on-premises \n customer provided license.
\n \n\n Microsoft SQL Server\n
\n \nSee \n Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide.\n
", "smithy.api#required": {} } }, "EngineInstallationMediaPath": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The path to the installation medium for the specified DB engine.
\nExample: SQLServerISO/en_sql_server_2016_enterprise_x64_dvd_8701793.iso\n
The path to the installation medium for the operating system associated with the specified DB engine.
\nExample: WindowsISO/en_windows_server_2016_x64_dvd_9327751.iso\n
The installation medium ID.
" } }, "CustomAvailabilityZoneId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The custom Availability Zone (AZ) that contains the installation media.
" } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The DB engine.
" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The engine version of the DB engine.
" } }, "EngineInstallationMediaPath": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The path to the installation medium for the DB engine.
" } }, "OSInstallationMediaPath": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The path to the installation medium for the operating system associated with the DB engine.
" } }, "Status": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The status of the installation medium.
" } }, "FailureCause": { "target": "com.amazonaws.rds#InstallationMediaFailureCause", "traits": { "smithy.api#documentation": "If an installation media failure occurred, the cause of the failure.
" } } }, "traits": { "smithy.api#documentation": "Contains the installation media for a DB engine that requires an on-premises \n customer provided license, such as Microsoft SQL Server.
" } }, "com.amazonaws.rds#InstallationMediaAlreadyExistsFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The specified installation medium has already been imported.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#InstallationMediaFailureCause": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The reason that an installation media import failed.
" } } }, "traits": { "smithy.api#documentation": "Contains the cause of an installation media failure. Installation media is used \n for a DB engine that requires an on-premises \n customer provided license, such as Microsoft SQL Server.
" } }, "com.amazonaws.rds#InstallationMediaList": { "type": "list", "member": { "target": "com.amazonaws.rds#InstallationMedia", "traits": { "smithy.api#xmlName": "InstallationMedia" } } }, "com.amazonaws.rds#InstallationMediaMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "An optional pagination token provided by a previous\n DescribeInstallationMedia request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.
The list of InstallationMedia objects for the AWS account.
" } } } }, "com.amazonaws.rds#InstallationMediaNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "\n InstallationMediaID doesn't refer to an existing installation medium.
The request would result in the user exceeding the allowed number of DB\n instances.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#InsufficientAvailableIPsInSubnetFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The requested operation can't be performed because there aren't enough available IP addresses \n in the proxy's subnets. Add more CIDR blocks to the VPC or remove IP address that aren't required \n from the subnets.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#InsufficientDBClusterCapacityFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The DB cluster doesn't have enough capacity for the current operation.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.rds#InsufficientDBInstanceCapacityFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The specified DB instance class isn't available in the specified Availability\n Zone.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#InsufficientStorageClusterCapacityFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "There is insufficient storage available for the current action. You might be able to\n resolve this error by updating your subnet group to use different Availability Zones\n that have more storage available.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#Integer": { "type": "integer" }, "com.amazonaws.rds#IntegerOptional": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.rds#InvalidDBClusterCapacityFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "\n Capacity isn't a valid Aurora Serverless DB cluster\n capacity. Valid capacity values are 2, 4, 8, 16, \n 32, 64, 128, and 256.
The requested operation can't be performed on the endpoint while the endpoint is in this state.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The supplied value isn't a valid DB cluster snapshot state.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#InvalidDBClusterStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The requested operation can't be performed while the cluster is in this state.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#InvalidDBInstanceAutomatedBackupStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The automated backup is in an invalid state. \n \t For example, this automated backup is associated with an active instance.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#InvalidDBInstanceStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The DB instance isn't in a valid state.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#InvalidDBParameterGroupStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The DB parameter group is in use or is in an invalid state. If you are attempting\n to delete the parameter group, you can't delete it when the parameter group is in\n this state.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#InvalidDBProxyEndpointStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "You can't perform this operation while the DB proxy endpoint is in a particular state.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#InvalidDBProxyStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The requested operation can't be performed while the proxy is in this state.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#InvalidDBSecurityGroupStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The state of the DB security group doesn't allow deletion.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#InvalidDBSnapshotStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The state of the DB snapshot doesn't allow deletion.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#InvalidDBSubnetGroupFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The DBSubnetGroup doesn't belong to the same VPC as that of an existing\n cross-region read replica of the same source instance.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#InvalidDBSubnetGroupStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The DB subnet group cannot be deleted because it's in use.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#InvalidDBSubnetStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "\n The DB subnet isn't in the available state.\n
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#InvalidEventSubscriptionStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "This error can occur if someone else is modifying a subscription. You should retry the action.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#InvalidExportOnlyFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The export is invalid for exporting to an Amazon S3 bucket.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#InvalidExportSourceStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#InvalidExportTaskStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "You can't cancel an export task that has completed.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#InvalidGlobalClusterStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The global cluster is in an invalid state and can't perform the requested operation.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#InvalidOptionGroupStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "\n The option group isn't in the available state.\n
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#InvalidRestoreFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "Cannot restore from VPC backup to non-VPC DB instance.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#InvalidS3BucketFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The specified Amazon S3 bucket name can't be found or Amazon RDS isn't\n authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#InvalidSubnet": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#InvalidVPCNetworkStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The DB subnet group doesn't cover all Availability Zones after it's\n created because of users' change.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#KMSKeyNotAccessibleFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "An error occurred accessing an AWS KMS key.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#KeyList": { "type": "list", "member": { "target": "com.amazonaws.rds#String" } }, "com.amazonaws.rds#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.rds#ListTagsForResourceMessage" }, "output": { "target": "com.amazonaws.rds#TagListMessage" }, "errors": [ { "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, { "target": "com.amazonaws.rds#DBInstanceNotFoundFault" }, { "target": "com.amazonaws.rds#DBProxyNotFoundFault" }, { "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" }, { "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" } ], "traits": { "smithy.api#documentation": "Lists all tags on an Amazon RDS resource.
\nFor an overview on tagging an Amazon RDS resource, \n see Tagging Amazon RDS Resources \n in the Amazon RDS User Guide.
" } }, "com.amazonaws.rds#ListTagsForResourceMessage": { "type": "structure", "members": { "ResourceName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
", "smithy.api#required": {} } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { "smithy.api#documentation": "This parameter isn't currently supported.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#LogTypeList": { "type": "list", "member": { "target": "com.amazonaws.rds#String" } }, "com.amazonaws.rds#Long": { "type": "long" }, "com.amazonaws.rds#LongOptional": { "type": "long", "traits": { "smithy.api#box": {} } }, "com.amazonaws.rds#MaxRecords": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 20, "max": 100 } } }, "com.amazonaws.rds#MinimumEngineVersionPerAllowedValue": { "type": "structure", "members": { "AllowedValue": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The allowed value for an option setting.
" } }, "MinimumEngineVersion": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The minimum DB engine version required for the allowed value.
" } } }, "traits": { "smithy.api#documentation": "The minimum DB engine version required for each corresponding allowed value for an option setting.
" } }, "com.amazonaws.rds#MinimumEngineVersionPerAllowedValueList": { "type": "list", "member": { "target": "com.amazonaws.rds#MinimumEngineVersionPerAllowedValue", "traits": { "smithy.api#xmlName": "MinimumEngineVersionPerAllowedValue" } } }, "com.amazonaws.rds#ModifyCertificates": { "type": "operation", "input": { "target": "com.amazonaws.rds#ModifyCertificatesMessage" }, "output": { "target": "com.amazonaws.rds#ModifyCertificatesResult" }, "errors": [ { "target": "com.amazonaws.rds#CertificateNotFoundFault" } ], "traits": { "smithy.api#documentation": "Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS)\n certificate for Amazon RDS for new DB instances temporarily, or remove the override.
\nBy using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB\n instances that is different from the default certificate provided by RDS. You can also\n use this operation to remove the override, so that new DB instances use the default\n certificate provided by RDS.
\nYou might need to override the default certificate in the following situations:
\nYou already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet \n the RDS default CA certificate for the specified AWS Region.
\nRDS has already moved to a new default CA certificate for the specified AWS\n Region, but you are still in the process of supporting the new CA certificate.\n In this case, you temporarily need additional time to finish your application\n changes.
\nFor more information about rotating your SSL/TLS certificate for RDS DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.
\nFor more information about rotating your SSL/TLS certificate for Aurora DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
" } }, "com.amazonaws.rds#ModifyCertificatesMessage": { "type": "structure", "members": { "CertificateIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The new default certificate identifier to override the current one with.
\nTo determine the valid values, use the describe-certificates AWS CLI\n command or the DescribeCertificates API operation.
A value that indicates whether to remove the override for the default certificate. \n If the override is removed, the default certificate is the system\n default.
" } } } }, "com.amazonaws.rds#ModifyCertificatesResult": { "type": "structure", "members": { "Certificate": { "target": "com.amazonaws.rds#Certificate" } } }, "com.amazonaws.rds#ModifyCurrentDBClusterCapacity": { "type": "operation", "input": { "target": "com.amazonaws.rds#ModifyCurrentDBClusterCapacityMessage" }, "output": { "target": "com.amazonaws.rds#DBClusterCapacityInfo" }, "errors": [ { "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidDBClusterCapacityFault" }, { "target": "com.amazonaws.rds#InvalidDBClusterStateFault" } ], "traits": { "smithy.api#documentation": "Set the capacity of an Aurora Serverless DB cluster to a specific value.
\nAurora Serverless scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale \n fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity \n to set the capacity explicitly.
After this call sets the DB cluster capacity, Aurora Serverless can automatically scale\n the DB cluster based on the cooldown period for scaling up and the cooldown period\n for scaling down.
\nFor more information about Aurora Serverless, see Using Amazon Aurora Serverless in the \n Amazon Aurora User Guide.
\nIf you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that \n prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling points, \n see \n Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
\nThe DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
\nConstraints:
\nMust match the identifier of an existing DB cluster.
\nThe DB cluster capacity.
\nWhen you change the capacity of a paused Aurora Serverless DB cluster, it automatically resumes.
\nConstraints:
\nFor 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 amount of time, in seconds, that Aurora Serverless tries to find a scaling point\n to perform seamless scaling before enforcing the timeout action. The default is\n 300.
\nValue must be from 10 through 600.
\nThe action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.
\n ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.
\n RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.
Modify a setting for an Amazon Aurora DB cluster. \n You can change one\n or more database configuration parameters by specifying these parameters and the new values in the\n request. For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nModifies the properties of an endpoint in an Amazon Aurora DB cluster.
\nThis action only applies to Aurora DB clusters.
\nThe identifier of the endpoint to modify. This parameter is stored as a lowercase string.
", "smithy.api#required": {} } }, "EndpointType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The type of the endpoint. One of: READER, WRITER, ANY.
List of DB instance identifiers that are part of the custom endpoint group.
" } }, "ExcludedMembers": { "target": "com.amazonaws.rds#StringList", "traits": { "smithy.api#documentation": "List of DB instance identifiers that aren't part of the custom endpoint group.\n All other eligible instances are reachable through the custom endpoint.\n Only relevant if the list of static members is empty.
" } } } }, "com.amazonaws.rds#ModifyDBClusterMessage": { "type": "structure", "members": { "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
\nConstraints: This identifier must match the identifier of an existing DB\n cluster.
", "smithy.api#required": {} } }, "NewDBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens
\nThe first character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-cluster2\n
A value that indicates whether the modifications in this request and\n any pending modifications are asynchronously applied\n as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the DB cluster. \n If this parameter is disabled, changes to the\n DB cluster are applied during the next maintenance window.
The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, \n MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately \n parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, \n and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are\n applied immediately, regardless of the value of the ApplyImmediately parameter.
By default, this parameter is disabled.
" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The number of days for which automated backups are retained. You must specify a minimum value of 1.
\nDefault: 1
\nConstraints:
\nMust be a value from 1 to 35
\nThe name of the DB cluster parameter group to use for the DB cluster.
" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { "smithy.api#documentation": "A list of VPC security groups that the DB cluster will belong to.
" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The port number on which the DB cluster accepts connections.
\nConstraints: Value must be 1150-65535\n
Default: The same port as the original DB cluster.
" } }, "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The new password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
\nConstraints: Must contain from 8 to 41 characters.
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "A value that indicates that the DB cluster should be associated with the specified option group. \n Changing this parameter doesn't result in an outage except in the following case, and the change \n is applied during the next maintenance window\n unless the ApplyImmediately is enabled for this request. If the parameter change results in an option group that \n enables OEM, this change can cause a brief (sub-second) period during which new connections \n are rejected but existing connections are not interrupted.\n
Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
" } }, "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n
The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.\n
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nThe weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
\nFormat: ddd:hh24:mi-ddd:hh24:mi\n
The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.\n
\nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
\nConstraints: Minimum 30-minute window.
" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n
" } }, "BacktrackWindow": { "target": "com.amazonaws.rds#LongOptional", "traits": { "smithy.api#documentation": "The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.
\nCurrently, Backtrack is only supported for Aurora MySQL DB clusters.
\nDefault: 0
\nConstraints:
\nIf specified, this value must be set to a number from 0 to 259,200 (72 hours).
\nThe configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The version number of the database engine to which you want to upgrade. \n Changing this parameter results in an outage. The change is applied during\n the next maintenance window unless ApplyImmediately is enabled.
To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for aurora-postgresql, use the following command:
\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n
A value that indicates whether major version upgrades are allowed.
\nConstraints: You must allow major version upgrades when specifying a value for the\n EngineVersion parameter that is a different major version than the DB\n cluster's current version.
The name of the DB parameter group to apply to all instances of the DB cluster.
\nWhen you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB\n cluster isn't rebooted automatically. Also, parameter changes aren't\n applied during the next maintenance window but instead are applied immediately.
Default: The existing name setting
\nConstraints:
\nThe DB parameter group must be in the same DB parameter group family as this DB cluster.
\nThe DBInstanceParameterGroupName parameter is only valid in combination with \n the AllowMajorVersionUpgrade parameter.
The Active Directory directory ID to move the DB cluster to. \n Specify none to remove the cluster from its current domain.\n The domain must be created prior to this operation.\n
For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.\n
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
" } }, "ScalingConfiguration": { "target": "com.amazonaws.rds#ScalingConfiguration", "traits": { "smithy.api#documentation": "The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.
A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled.\n
" } }, "EnableHttpEndpoint": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint \n is disabled.
\nWhen enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless DB cluster. You can also query your database\n from inside the RDS console with the query editor.
\nFor more information, see Using the Data API for Aurora Serverless in the \n Amazon Aurora User Guide.
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.
" } }, "EnableGlobalWriteForwarding": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an\n Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.
\nYou can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is\n demoted by the FailoverGlobalCluster API operation, but it does nothing until then.\n
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#ModifyDBClusterParameterGroup": { "type": "operation", "input": { "target": "com.amazonaws.rds#ModifyDBClusterParameterGroupMessage" }, "output": { "target": "com.amazonaws.rds#DBClusterParameterGroupNameMessage" }, "errors": [ { "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" } ], "traits": { "smithy.api#documentation": "\n Modifies the parameters of a DB cluster parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, \n and ApplyMethod. A maximum of 20\n parameters can be modified in a single request.\n
For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nChanges to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.
\nAfter you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters action to verify \n that your DB cluster parameter group has been created or modified.
If the modified DB cluster parameter group is used by an Aurora Serverless cluster, Aurora\n applies the update immediately. The cluster restart might interrupt your workload. In that case,\n your application must reopen any connections and retry any transactions that were active\n when the parameter changes took effect.
\nThis action only applies to Aurora DB clusters.
\nThe name of the DB cluster parameter group to modify.
", "smithy.api#required": {} } }, "Parameters": { "target": "com.amazonaws.rds#ParametersList", "traits": { "smithy.api#documentation": "A list of parameters in the DB cluster parameter group to modify.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#ModifyDBClusterResult": { "type": "structure", "members": { "DBCluster": { "target": "com.amazonaws.rds#DBCluster" } } }, "com.amazonaws.rds#ModifyDBClusterSnapshotAttribute": { "type": "operation", "input": { "target": "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeMessage" }, "output": { "target": "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeResult" }, "errors": [ { "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" }, { "target": "com.amazonaws.rds#SharedSnapshotQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
\nTo share a manual DB cluster snapshot with other AWS accounts, specify\n restore as the AttributeName and use the\n ValuesToAdd parameter to add a list of IDs of the AWS accounts that are\n authorized to restore the manual DB cluster snapshot. Use the value all to\n make the manual DB cluster snapshot public, which means that it can be copied or\n restored by all AWS accounts.
Don't add the all value for any manual DB cluster snapshots\n that contain private information that you don't want available to all AWS\n accounts.
If a manual DB cluster snapshot is encrypted, it can be shared, but only by\n specifying a list of authorized AWS account IDs for the ValuesToAdd\n parameter. You can't use all as a value for that parameter in this\n case.
To view which AWS accounts have access to copy or restore a manual DB cluster\n snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API action. The accounts are\n returned as values for the restore attribute.
This action only applies to Aurora DB clusters.
\nThe identifier for the DB cluster snapshot to modify the attributes for.
", "smithy.api#required": {} } }, "AttributeName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the DB cluster snapshot attribute to modify.
\nTo manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, \n set this value to restore.
To view the list of attributes available to modify, use the\n DescribeDBClusterSnapshotAttributes API action.
\nA list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.
To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account\n IDs, or all to make the manual DB cluster snapshot restorable by \n any AWS account. Do not add the all value for any\n manual DB cluster snapshots that contain private information that you don't want available\n to all AWS accounts.
A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.
To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include\n one or more AWS account\n identifiers, or all to remove authorization for any AWS account to copy or\n restore the DB cluster snapshot. If you specify all, an AWS account whose account ID is\n explicitly added to the restore attribute\n can still copy or restore a manual DB cluster snapshot.
Modifies settings for a DB instance. \n You can change one or more database configuration parameters by specifying these parameters and the new values in the request.\n To learn what modifications you can make to your DB instance,\n call DescribeValidDBInstanceModifications\n before you call ModifyDBInstance.\n
The DB instance identifier. This value is stored as a lowercase string.
\nConstraints:
\nMust match the identifier of an existing DBInstance.
\nThe new amount of storage (in gibibytes) to allocate for the DB instance.\n
\n \nFor MariaDB, MySQL, Oracle, and PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.\n
\n \nFor the valid values for allocated storage for each engine,\n see CreateDBInstance.\n
The new compute and memory capacity of the DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all AWS Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n
If you modify the DB instance class, an outage occurs during the change.\n The change is applied during the next maintenance window,\n unless ApplyImmediately is enabled for this request.\n
Default: Uses existing setting
" } }, "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The new DB subnet group for the DB instance.\n You can use this parameter to move your DB instance to a different VPC.\n \n If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC.\n For more information, see \n Working with a DB instance in a VPC \n in the Amazon RDS User Guide. \n
\nChanging the subnet group causes an outage during the change. \n The change is applied during the next maintenance window,\n unless you enable ApplyImmediately.\n
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
\nExample: mySubnetGroup\n
A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.
\nConstraints:
\nIf supplied, must match existing DBSecurityGroups.
\nA list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
\n\n Amazon Aurora\n
\nNot applicable. The associated list of EC2 VPC security groups is managed by\n the DB cluster. For more information, see ModifyDBCluster.
Constraints:
\nIf supplied, must match existing VpcSecurityGroupIds.
\nA value that indicates whether the modifications in this request and\n any pending modifications are asynchronously applied\n as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is \n disabled.\n
\n If this parameter is disabled, changes to the\n DB instance are applied during the next maintenance window. Some parameter changes can cause an outage\n and are applied on the next call to RebootDBInstance, or the next failure reboot. \n Review the table of parameters in Modifying a DB Instance \n in the Amazon RDS User Guide. to see the impact of enabling\n or disabling ApplyImmediately for each modified parameter and to determine when the changes are applied.\n
The new password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".
\n\n Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.\n
\n Amazon Aurora\n
\nNot applicable. The password for the master user is managed by the DB cluster. For\n more information, see ModifyDBCluster.\n
Default: Uses existing setting
\n\n\n MariaDB\n
\nConstraints: Must contain from 8 to 41 characters.
\n \n\n Microsoft SQL Server\n
\nConstraints: Must contain from 8 to 128 characters.
\n \n\n MySQL\n
\nConstraints: Must contain from 8 to 41 characters.
\n \n\n Oracle\n
\nConstraints: Must contain from 8 to 30 characters.
\n \n\n PostgreSQL\n
\nConstraints: Must contain from 8 to 128 characters.
\n\nAmazon RDS API actions never return the password, \n so this action provides a way to regain access to a primary instance user if the password is lost. \n This includes restoring privileges that might have been accidentally revoked.\n
\nThe name of the DB parameter group to apply to the DB instance. Changing this\n setting doesn't result in an outage. The parameter group name itself is changed\n immediately, but the actual parameter changes are not applied until you reboot the\n instance without failover. In this case, the DB instance isn't rebooted automatically and the\n parameter changes isn't applied during the next maintenance window.
\nDefault: Uses existing setting
\nConstraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
\nEnabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
\nThese changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled\n for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously\n applied as soon as possible.
\n Amazon Aurora\n
\nNot applicable. The retention period for automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
\nConstraints:
\nMust be a value from 0 to 35
\nCan be specified for a MySQL read replica only if the source is running MySQL 5.6 or\n later
\nCan be specified for a PostgreSQL read replica only if the source is running PostgreSQL\n 9.3.5
\nCan't be set to 0 if the DB instance is a source to read replicas
\n\n The daily time range during which automated backups are created\n if automated backups are enabled,\n as determined by the BackupRetentionPeriod parameter. \n Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region. For more information, see Backup window in the Amazon RDS User Guide.\n
\n Amazon Aurora\n
\nNot applicable. The daily time range for creating automated backups is managed by\n the DB cluster. For more information, see ModifyDBCluster.
Constraints:
\nMust be in the format hh24:mi-hh24:mi
\nMust be in Universal Time Coordinated (UTC)
\nMust not conflict with the preferred maintenance window
\nMust be at least 30 minutes
\nThe weekly time range (in UTC) during which system maintenance can occur, which\n might result in an outage. Changing this parameter doesn't result in an outage, except\n in the following situation, and the change is asynchronously applied as soon as\n possible. If there are pending actions that cause a reboot, and the maintenance window\n is changed to include the current time, then changing this parameter will cause a reboot\n of the DB instance. If moving this window to the current time, there must be at least 30\n minutes between the current time and end of the window to ensure pending changes are\n applied.
\nFor more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.\n
\nDefault: Uses existing setting
\nFormat: ddd:hh24:mi-ddd:hh24:mi
\nValid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
\nConstraints: Must be at least 30 minutes
" } }, "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether the DB instance is a Multi-AZ deployment. \n Changing this parameter doesn't result in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is \n enabled for this request.\n
\n The version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.\n
For major version upgrades, if a nondefault DB parameter group is currently in use, a\n new DB parameter group in the DB parameter group family for the new engine version must\n be specified. The new DB parameter group can be the default for that DB parameter group\n family.
\nIf you specify only a major version, Amazon RDS will update the DB instance to the \n default minor version if the current minor version is lower.\n For information about valid engine versions, see CreateDBInstance, \n or call DescribeDBEngineVersions.
A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
\nConstraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "\n A value that indicates whether minor version upgrades are applied automatically\n to the DB instance during the maintenance window. \n Changing this parameter doesn't result in an outage except in the following case \n and the change is asynchronously applied as soon as possible.\n An outage results if this parameter is enabled during the maintenance window, \n and a newer minor version is available, and RDS has enabled auto patching for that engine version.\n
" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The license model for the DB instance.
\nValid values: license-included | bring-your-own-license | \n general-public-license\n
The new Provisioned IOPS (I/O operations per second) value for the RDS instance. \n
\nChanging this setting doesn't result in an outage and\n the change is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.\n If you are migrating from Provisioned IOPS to standard storage, set this value to 0. \n The DB instance will require a reboot for the change in storage type to take effect.\n
If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.
\nConstraints: For MariaDB, MySQL, Oracle, and PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. \n
\nDefault: Uses existing setting
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n A value that indicates the DB instance should be associated with the specified option group. \n Changing this parameter doesn't result in an outage except in the following case and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled \n for this request. If the parameter change results in an option group that \n enables OEM, this change can cause a brief (sub-second) period during which new connections \n are rejected but existing connections are not interrupted.\n
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
" } }, "NewDBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n The new DB instance identifier for the DB instance when renaming a DB\n instance. When you change the DB instance identifier, an instance \n reboot occurs immediately if you enable ApplyImmediately, or will occur \n during the next maintenance window if you disable Apply Immediately. This value is stored \n as a lowercase string. \n
Constraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: mydbinstance\n
Specifies the storage type to be associated with the DB instance.\n
\nIf you specify Provisioned IOPS (io1), \n you must also include a value for the Iops parameter.\n
If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.
\n\n Valid values: standard | gp2 | io1\n
Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
The ARN from the key store with which to associate the instance for TDE encryption.
" } }, "TdeCredentialPassword": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The password for the given ARN from the key store in order to access the device.
" } }, "CACertificateIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Indicates the certificate that needs to be associated with the instance.
" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Active Directory directory ID to move the DB instance to. \n Specify none to remove the instance from its current domain.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
\n\n Amazon Aurora\n
\nNot applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see ModifyDBCluster.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
\nIf MonitoringRoleArn is specified, then you must also set MonitoringInterval\n to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60\n
The port number on which the database accepts connections.
\nThe value of the DBPortNumber parameter must not match any of the port values specified for options in the option\n group for the DB instance.
Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately\n parameter.
\n MySQL\n
\n\n Default: 3306\n
Valid values: 1150-65535\n
\n MariaDB\n
\n\n Default: 3306\n
Valid values: 1150-65535\n
\n PostgreSQL\n
\n\n Default: 5432\n
Valid values: 1150-65535\n
Type: Integer
\n\n Oracle\n
\n\n Default: 1521\n
Valid values: 1150-65535\n
\n SQL Server\n
\n\n Default: 1433\n
Valid values: 1150-65535 except 1234, 1434,\n 3260, 3343, 3389, 47001, and\n 49152-49156.
\n Amazon Aurora\n
\n\n Default: 3306\n
Valid values: 1150-65535\n
A value that indicates whether the DB instance is publicly accessible.\n
\nWhen the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\n\n PubliclyAccessible only applies to DB instances in a VPC. \n The DB instance must be part of a public subnet and \n PubliclyAccessible must be enabled for it to be publicly accessible.\n
Changes to the PubliclyAccessible parameter are applied immediately regardless\n of the value of the ApplyImmediately parameter.
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
The name of the IAM role to use when making API calls to the Directory Service.
" } }, "PromotionTier": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.\n
\nDefault: 1
\nValid Values: 0 - 15
" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nThis setting doesn't apply to Amazon Aurora. Mapping AWS IAM accounts to database accounts is managed by the DB\n cluster.
\n \nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" } }, "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to enable Performance Insights for the DB instance.
\nFor more information, see \n Using Amazon Performance Insights in the Amazon Relational Database Service\n User Guide.\n
" } }, "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The AWS KMS key identifier for encryption of Performance Insights data.
\nThe AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default CMK. There is a default CMK for your AWS account. \n Your AWS account has a different default CMK for each AWS Region.
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
" } }, "CloudwatchLogsExportConfiguration": { "target": "com.amazonaws.rds#CloudwatchLogsExportConfiguration", "traits": { "smithy.api#documentation": "The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.
\nA change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance \n immediately. Therefore, the ApplyImmediately parameter has no effect.
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
" } }, "UseDefaultProcessorFeatures": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.
" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled. For more information, see \n \n Deleting a DB Instance.\n
" } }, "MaxAllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
\nFor more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.
" } }, "CertificateRotationRestart": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether the DB instance is restarted when you rotate your \n SSL/TLS certificate.
\nBy default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate \n is not updated until the DB instance is restarted.
\nSet this parameter only if you are not using SSL/TLS to connect to the DB instance.
\nIf you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your \n DB engine to rotate your SSL/TLS certificate:
\nFor more information about rotating your SSL/TLS certificate for RDS DB engines, see \n \n Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.\n
\nFor more information about rotating your SSL/TLS certificate for Aurora DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.\n
\nA value that sets the open mode of a replica database to either mounted or read-only.
\nCurrently, this parameter is only supported for Oracle DB instances.
\nMounted DB replicas are included in Oracle Enterprise Edition. The main use case for \n mounted replicas is cross-Region disaster recovery. The primary database doesn't use \n Active Data Guard to transmit information to the mounted replica. Because it doesn't \n accept user connections, a mounted replica can't serve a read-only workload. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.
" } }, "EnableCustomerOwnedIp": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the AWS Outposts User Guide.
" } }, "AwsBackupRecoveryPointArn": { "target": "com.amazonaws.rds#AwsBackupRecoveryPointArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recovery point in AWS Backup.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#ModifyDBInstanceResult": { "type": "structure", "members": { "DBInstance": { "target": "com.amazonaws.rds#DBInstance" } } }, "com.amazonaws.rds#ModifyDBParameterGroup": { "type": "operation", "input": { "target": "com.amazonaws.rds#ModifyDBParameterGroupMessage" }, "output": { "target": "com.amazonaws.rds#DBParameterGroupNameMessage" }, "errors": [ { "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" } ], "traits": { "smithy.api#documentation": "\n Modifies the parameters of a DB parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, and \n ApplyMethod. A maximum of 20\n parameters can be modified in a single request.\n
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.
\nAfter you modify a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the modify action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.
The name of the DB parameter group.
\nConstraints:
\nIf supplied, must match the name of an existing DBParameterGroup.
An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.
\nValid Values (for the application method): immediate | pending-reboot\n
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.
\nChanges the settings for an existing DB proxy.
" } }, "com.amazonaws.rds#ModifyDBProxyEndpoint": { "type": "operation", "input": { "target": "com.amazonaws.rds#ModifyDBProxyEndpointRequest" }, "output": { "target": "com.amazonaws.rds#ModifyDBProxyEndpointResponse" }, "errors": [ { "target": "com.amazonaws.rds#DBProxyEndpointAlreadyExistsFault" }, { "target": "com.amazonaws.rds#DBProxyEndpointNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidDBProxyEndpointStateFault" }, { "target": "com.amazonaws.rds#InvalidDBProxyStateFault" } ], "traits": { "smithy.api#documentation": "Changes the settings for an existing DB proxy endpoint.
" } }, "com.amazonaws.rds#ModifyDBProxyEndpointRequest": { "type": "structure", "members": { "DBProxyEndpointName": { "target": "com.amazonaws.rds#DBProxyEndpointName", "traits": { "smithy.api#documentation": "The name of the DB proxy sociated with the DB proxy endpoint that you want to modify.
", "smithy.api#required": {} } }, "NewDBProxyEndpointName": { "target": "com.amazonaws.rds#DBProxyEndpointName", "traits": { "smithy.api#documentation": "The new identifier for the DBProxyEndpoint. An identifier must\n begin with a letter and must contain only ASCII letters, digits, and hyphens; it\n can't end with a hyphen or contain two consecutive hyphens.
The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint\n uses a different VPC than the original proxy, you also specify a different\n set of security group IDs than for the original proxy.
" } } } }, "com.amazonaws.rds#ModifyDBProxyEndpointResponse": { "type": "structure", "members": { "DBProxyEndpoint": { "target": "com.amazonaws.rds#DBProxyEndpoint", "traits": { "smithy.api#documentation": "The DBProxyEndpoint object representing the new settings for the DB proxy endpoint.
The identifier for the DBProxy to modify.
The new identifier for the DBProxy. 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.
The new authentication settings for the DBProxy.
Whether Transport Layer Security (TLS) encryption is required for connections to the proxy.\n By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn't\n use TLS.
" } }, "IdleClientTimeout": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this\n value higher or lower than the connection timeout limit for the associated database.
" } }, "DebugLogging": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.
" } }, "RoleArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
" } }, "SecurityGroups": { "target": "com.amazonaws.rds#StringList", "traits": { "smithy.api#documentation": "The new list of security groups for the DBProxy.
The DBProxy object representing the new settings for the proxy.
Modifies the properties of a DBProxyTargetGroup.
The name of the new target group to assign to the proxy.
", "smithy.api#required": {} } }, "DBProxyName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the new proxy to which to assign the target group.
", "smithy.api#required": {} } }, "ConnectionPoolConfig": { "target": "com.amazonaws.rds#ConnectionPoolConfiguration", "traits": { "smithy.api#documentation": "The settings that determine the size and behavior of the connection pool for the target group.
" } }, "NewName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The new name for the modified DBProxyTarget. 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.
The settings of the modified DBProxyTarget.
Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted\n or unencrypted, but not shared or public.\n \n
\n \nAmazon RDS supports upgrading DB snapshots for MySQL, Oracle, and PostgreSQL.\n
" } }, "com.amazonaws.rds#ModifyDBSnapshotAttribute": { "type": "operation", "input": { "target": "com.amazonaws.rds#ModifyDBSnapshotAttributeMessage" }, "output": { "target": "com.amazonaws.rds#ModifyDBSnapshotAttributeResult" }, "errors": [ { "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" }, { "target": "com.amazonaws.rds#SharedSnapshotQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.
\nTo share a manual DB snapshot with other AWS accounts, specify restore\n as the AttributeName and use the ValuesToAdd parameter to add\n a list of IDs of the AWS accounts that are authorized to restore the manual DB snapshot.\n Uses the value all to make the manual DB snapshot public, which means it\n can be copied or restored by all AWS accounts.
Don't add the all value for any manual DB snapshots that\n contain private information that you don't want available to all AWS\n accounts.
If the manual DB snapshot is encrypted, it can be shared, but only by specifying a\n list of authorized AWS account IDs for the ValuesToAdd parameter. You\n can't use all as a value for that parameter in this case.
To view which AWS accounts have access to copy or restore a manual DB snapshot, or\n whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action. The accounts are returned as\n values for the restore attribute.
The identifier for the DB snapshot to modify the attributes for.
", "smithy.api#required": {} } }, "AttributeName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the DB snapshot attribute to modify.
\nTo manage authorization for other AWS accounts to copy or restore a manual DB snapshot, \n set this value to restore.
To view the list of attributes available to modify, use the\n DescribeDBSnapshotAttributes API action.
\nA list of DB snapshot attributes to add to the attribute specified by AttributeName.
To authorize other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account\n IDs, or all to make the manual DB snapshot restorable by \n any AWS account. Do not add the all value for any\n manual DB snapshots that contain private information that you don't want available\n to all AWS accounts.
A list of DB snapshot attributes to remove from the attribute specified by AttributeName.
To remove authorization for other AWS accounts to copy or restore a manual snapshot, set this list to include \n one or more AWS account\n identifiers, or all to remove authorization for any AWS account to copy or\n restore the DB snapshot. If you specify all, an AWS account whose\n account ID is explicitly added to the restore attribute\n can still copy or restore the manual DB snapshot.
The identifier of the DB snapshot to modify.
", "smithy.api#required": {} } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The engine version to upgrade the DB snapshot to.\n
\n \nThe following are the database engines and engine versions that are available when you upgrade a DB snapshot.\n
\n\n\n MySQL\n
\n \n\n 5.5.46 (supported for 5.1 DB snapshots)
\n Oracle\n
\n \n\n 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)
\n 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)
\n 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)
\n PostgreSQL\n
\nFor the list of engine versions that are available for upgrading a DB snapshot, see \n \n Upgrading the PostgreSQL DB Engine for Amazon RDS.\n
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The option group to identify with the upgraded DB snapshot.\n
\n \nYou can specify this parameter when you upgrade an Oracle DB snapshot.\n The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance.\n For more information, see \n Option group considerations in the Amazon RDS User Guide.\n
" } } } }, "com.amazonaws.rds#ModifyDBSnapshotResult": { "type": "structure", "members": { "DBSnapshot": { "target": "com.amazonaws.rds#DBSnapshot" } } }, "com.amazonaws.rds#ModifyDBSubnetGroup": { "type": "operation", "input": { "target": "com.amazonaws.rds#ModifyDBSubnetGroupMessage" }, "output": { "target": "com.amazonaws.rds#ModifyDBSubnetGroupResult" }, "errors": [ { "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" }, { "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" }, { "target": "com.amazonaws.rds#DBSubnetQuotaExceededFault" }, { "target": "com.amazonaws.rds#InvalidSubnet" }, { "target": "com.amazonaws.rds#SubnetAlreadyInUse" } ], "traits": { "smithy.api#documentation": "Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.
" } }, "com.amazonaws.rds#ModifyDBSubnetGroupMessage": { "type": "structure", "members": { "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name for the DB subnet group. This value is stored as a lowercase string.\n You can't modify the default subnet group.\n
\nConstraints: Must match the name of an existing DBSubnetGroup. Must not be default.
\nExample: mySubnetgroup\n
The description for the DB subnet group.
" } }, "SubnetIds": { "target": "com.amazonaws.rds#SubnetIdentifierList", "traits": { "smithy.api#documentation": "The EC2 subnet IDs for the DB subnet group.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#ModifyDBSubnetGroupResult": { "type": "structure", "members": { "DBSubnetGroup": { "target": "com.amazonaws.rds#DBSubnetGroup" } } }, "com.amazonaws.rds#ModifyEventSubscription": { "type": "operation", "input": { "target": "com.amazonaws.rds#ModifyEventSubscriptionMessage" }, "output": { "target": "com.amazonaws.rds#ModifyEventSubscriptionResult" }, "errors": [ { "target": "com.amazonaws.rds#EventSubscriptionQuotaExceededFault" }, { "target": "com.amazonaws.rds#SNSInvalidTopicFault" }, { "target": "com.amazonaws.rds#SNSNoAuthorizationFault" }, { "target": "com.amazonaws.rds#SNSTopicArnNotFoundFault" }, { "target": "com.amazonaws.rds#SubscriptionCategoryNotFoundFault" }, { "target": "com.amazonaws.rds#SubscriptionNotFoundFault" } ], "traits": { "smithy.api#documentation": "Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change \n source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given source type (SourceType) \n in Events in the Amazon RDS User Guide \n or by using the DescribeEventCategories operation.
The name of the RDS event notification subscription.
", "smithy.api#required": {} } }, "SnsTopicArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
" } }, "SourceType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. If this value isn't specified, all events are returned.
\nValid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot \n
\n A list of event categories for a source type (SourceType) that you want to subscribe to. \n You can see a list of the categories for a given source type \n in Events in the Amazon RDS User Guide \n or by using the DescribeEventCategories operation.\n
\n A value that indicates whether to activate the subscription.\n
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#ModifyEventSubscriptionResult": { "type": "structure", "members": { "EventSubscription": { "target": "com.amazonaws.rds#EventSubscription" } } }, "com.amazonaws.rds#ModifyGlobalCluster": { "type": "operation", "input": { "target": "com.amazonaws.rds#ModifyGlobalClusterMessage" }, "output": { "target": "com.amazonaws.rds#ModifyGlobalClusterResult" }, "errors": [ { "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidDBClusterStateFault" }, { "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" }, { "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" } ], "traits": { "smithy.api#documentation": "\n Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration\n parameters by specifying these parameters and the new values in the request. For more information on\n Amazon Aurora, see What Is Amazon Aurora? in the\n Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\n\n The DB cluster identifier for the global cluster being modified. This parameter isn't case-sensitive.\n
\nConstraints:
\nMust match the identifier of an existing global database cluster.
\n\n The new cluster identifier for the global database cluster when modifying a global database cluster.\n This value is stored as a lowercase string.\n
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens
\nThe first character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-cluster2\n
\n Indicates if the global database cluster has deletion protection enabled. The global database cluster\n can't be deleted when deletion protection is enabled.\n
" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The version number of the database engine to which you want to upgrade. \n Changing this parameter results in an outage. The change is applied during\n the next maintenance window unless ApplyImmediately is enabled.
To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n
To list all of the available engine versions for aurora-postgresql, use the following command:
\n aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n
A value that indicates whether major version upgrades are allowed.
\nConstraints: You must allow major version upgrades when specifying a value for the\n EngineVersion parameter that is a different major version than the DB\n cluster's current version.
If you upgrade the major version of a global database, the cluster and DB instance parameter\n groups are set to the default parameter groups for the new version. Apply any custom parameter\n groups after completing the upgrade.
" } } } }, "com.amazonaws.rds#ModifyGlobalClusterResult": { "type": "structure", "members": { "GlobalCluster": { "target": "com.amazonaws.rds#GlobalCluster" } } }, "com.amazonaws.rds#ModifyOptionGroup": { "type": "operation", "input": { "target": "com.amazonaws.rds#ModifyOptionGroupMessage" }, "output": { "target": "com.amazonaws.rds#ModifyOptionGroupResult" }, "errors": [ { "target": "com.amazonaws.rds#InvalidOptionGroupStateFault" }, { "target": "com.amazonaws.rds#OptionGroupNotFoundFault" } ], "traits": { "smithy.api#documentation": "Modifies an existing option group.
" } }, "com.amazonaws.rds#ModifyOptionGroupMessage": { "type": "structure", "members": { "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the option group to be modified.
\nPermanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
", "smithy.api#required": {} } }, "OptionsToInclude": { "target": "com.amazonaws.rds#OptionConfigurationList", "traits": { "smithy.api#documentation": "Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.
" } }, "OptionsToRemove": { "target": "com.amazonaws.rds#OptionNamesList", "traits": { "smithy.api#documentation": "Options in this list are removed from the option group.
" } }, "ApplyImmediately": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#ModifyOptionGroupResult": { "type": "structure", "members": { "OptionGroup": { "target": "com.amazonaws.rds#OptionGroup" } } }, "com.amazonaws.rds#Option": { "type": "structure", "members": { "OptionName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the option.
" } }, "OptionDescription": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The description of the option.
" } }, "Persistent": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Indicate if this option is persistent.
" } }, "Permanent": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Indicate if this option is permanent.
" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "If required, the port configured for this option to use.
" } }, "OptionVersion": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The version of the option.
" } }, "OptionSettings": { "target": "com.amazonaws.rds#OptionSettingConfigurationList", "traits": { "smithy.api#documentation": "The option settings for this option.
" } }, "DBSecurityGroupMemberships": { "target": "com.amazonaws.rds#DBSecurityGroupMembershipList", "traits": { "smithy.api#documentation": "If the option requires access to a port, then this DB security group allows access to the port.
" } }, "VpcSecurityGroupMemberships": { "target": "com.amazonaws.rds#VpcSecurityGroupMembershipList", "traits": { "smithy.api#documentation": "If the option requires access to a port, then this VPC security group allows access to the port.
" } } }, "traits": { "smithy.api#documentation": "Option details.
" } }, "com.amazonaws.rds#OptionConfiguration": { "type": "structure", "members": { "OptionName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The configuration of options to include in a group.
", "smithy.api#required": {} } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The optional port for the option.
" } }, "OptionVersion": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The version for the option.
" } }, "DBSecurityGroupMemberships": { "target": "com.amazonaws.rds#DBSecurityGroupNameList", "traits": { "smithy.api#documentation": "A list of DBSecurityGroupMembership name strings used for this option.
" } }, "VpcSecurityGroupMemberships": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { "smithy.api#documentation": "A list of VpcSecurityGroupMembership name strings used for this option.
" } }, "OptionSettings": { "target": "com.amazonaws.rds#OptionSettingsList", "traits": { "smithy.api#documentation": "The option settings to include in an option group.
" } } }, "traits": { "smithy.api#documentation": "A list of all available options
" } }, "com.amazonaws.rds#OptionConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.rds#OptionConfiguration", "traits": { "smithy.api#xmlName": "OptionConfiguration" } } }, "com.amazonaws.rds#OptionGroup": { "type": "structure", "members": { "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the name of the option group.
" } }, "OptionGroupDescription": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Provides a description of the option group.
" } }, "EngineName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Indicates the name of the engine that this option group can be applied to.
" } }, "MajorEngineVersion": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Indicates the major engine version associated with this option group.
" } }, "Options": { "target": "com.amazonaws.rds#OptionsList", "traits": { "smithy.api#documentation": "Indicates what options are available in the option group.
" } }, "AllowsVpcAndNonVpcInstanceMemberships": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Indicates whether this option group can be applied to both VPC \n and non-VPC instances. The value true indicates the option group \n can be applied to both VPC and non-VPC instances.\n
If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank.\n If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, \n then this option group can be applied to both VPC and non-VPC instances.\n If this field contains a value, then this option group can only be \n applied to instances that are in the VPC indicated by this field.\n
The Amazon Resource Name (ARN) for the option group.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#OptionGroupAlreadyExistsFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The option group you are trying to create already exists.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#OptionGroupMembership": { "type": "structure", "members": { "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the option group that the instance belongs to.
" } }, "Status": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The status of the DB instance's option group membership. Valid values are: \n in-sync, \n pending-apply, \n pending-removal, \n pending-maintenance-apply, \n pending-maintenance-removal, \n applying, \n removing, \n and failed.\n
Provides information on the option groups the DB instance is a member of.
" } }, "com.amazonaws.rds#OptionGroupMembershipList": { "type": "list", "member": { "target": "com.amazonaws.rds#OptionGroupMembership", "traits": { "smithy.api#xmlName": "OptionGroupMembership" } } }, "com.amazonaws.rds#OptionGroupNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The specified option group could not be found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.rds#OptionGroupOption": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the option.
" } }, "Description": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The description of the option.
" } }, "EngineName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the engine that this option can be applied to.
" } }, "MajorEngineVersion": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Indicates the major engine version that the option is available for.
" } }, "MinimumRequiredMinorEngineVersion": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The minimum required engine version for the option to be applied.
" } }, "PortRequired": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the option requires a port.
" } }, "DefaultPort": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "If the option requires a port, specifies the default port for the option.
" } }, "OptionsDependedOn": { "target": "com.amazonaws.rds#OptionsDependedOn", "traits": { "smithy.api#documentation": "The options that are prerequisites for this option.
" } }, "OptionsConflictsWith": { "target": "com.amazonaws.rds#OptionsConflictsWith", "traits": { "smithy.api#documentation": "The options that conflict with this option.
" } }, "Persistent": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "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.
" } }, "Permanent": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "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.
" } }, "RequiresAutoMinorEngineVersionUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "If true, you must enable the Auto Minor Version Upgrade setting for your DB instance \n before you can use this option.\n You can enable Auto Minor Version Upgrade when you first create your DB instance,\n or by modifying your DB instance later.\n
" } }, "VpcOnly": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "If true, you can only use this option with a DB instance that is in a VPC.\n
" } }, "SupportsOptionVersionDowngrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "If true, you can change the option to an earlier version of the option. \n This only applies to options that have different versions available.\n
" } }, "OptionGroupOptionSettings": { "target": "com.amazonaws.rds#OptionGroupOptionSettingsList", "traits": { "smithy.api#documentation": "The option settings that are available (and the default value) for each option in an option group.
" } }, "OptionGroupOptionVersions": { "target": "com.amazonaws.rds#OptionGroupOptionVersionsList", "traits": { "smithy.api#documentation": "The versions that are available for the option.
" } } }, "traits": { "smithy.api#documentation": "Available option.
" } }, "com.amazonaws.rds#OptionGroupOptionSetting": { "type": "structure", "members": { "SettingName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the option group option.
" } }, "SettingDescription": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The description of the option group option.
" } }, "DefaultValue": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The default value for the option group option.
" } }, "ApplyType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The DB engine specific parameter type for the option group option.
" } }, "AllowedValues": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Indicates the acceptable values for the option group option.
" } }, "IsModifiable": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Boolean value where true indicates that this option group option can be changed from the default value.
" } }, "IsRequired": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Boolean value where true indicates that a value must be specified for this option setting of the option group option.
" } }, "MinimumEngineVersionPerAllowedValue": { "target": "com.amazonaws.rds#MinimumEngineVersionPerAllowedValueList", "traits": { "smithy.api#documentation": "The minimum DB engine version required for the corresponding allowed value for this option setting.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.rds#OptionGroupOptionSettingsList": { "type": "list", "member": { "target": "com.amazonaws.rds#OptionGroupOptionSetting", "traits": { "smithy.api#xmlName": "OptionGroupOptionSetting" } } }, "com.amazonaws.rds#OptionGroupOptionVersionsList": { "type": "list", "member": { "target": "com.amazonaws.rds#OptionVersion", "traits": { "smithy.api#xmlName": "OptionVersion" } } }, "com.amazonaws.rds#OptionGroupOptionsList": { "type": "list", "member": { "target": "com.amazonaws.rds#OptionGroupOption", "traits": { "smithy.api#xmlName": "OptionGroupOption" } }, "traits": { "smithy.api#documentation": "List of available option group options.
" } }, "com.amazonaws.rds#OptionGroupOptionsMessage": { "type": "structure", "members": { "OptionGroupOptions": { "target": "com.amazonaws.rds#OptionGroupOptionsList" }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.
The quota of 20 option groups was exceeded for this AWS account.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#OptionGroups": { "type": "structure", "members": { "OptionGroupsList": { "target": "com.amazonaws.rds#OptionGroupsList", "traits": { "smithy.api#documentation": "List of option groups.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
List of option groups.
" } }, "com.amazonaws.rds#OptionGroupsList": { "type": "list", "member": { "target": "com.amazonaws.rds#OptionGroup", "traits": { "smithy.api#xmlName": "OptionGroup" } } }, "com.amazonaws.rds#OptionNamesList": { "type": "list", "member": { "target": "com.amazonaws.rds#String" } }, "com.amazonaws.rds#OptionSetting": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the option that has settings that you can set.
" } }, "Value": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The current value of the option setting.
" } }, "DefaultValue": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The default value of the option setting.
" } }, "Description": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The description of the option setting.
" } }, "ApplyType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The DB engine specific parameter type.
" } }, "DataType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The data type of the option setting.
" } }, "AllowedValues": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The allowed values of the option setting.
" } }, "IsModifiable": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "A Boolean value that, when true, indicates the option setting can be modified from the default.
" } }, "IsCollection": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Indicates if the option setting is part of a collection.
" } } }, "traits": { "smithy.api#documentation": "Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.
" } }, "com.amazonaws.rds#OptionSettingConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.rds#OptionSetting", "traits": { "smithy.api#xmlName": "OptionSetting" } } }, "com.amazonaws.rds#OptionSettingsList": { "type": "list", "member": { "target": "com.amazonaws.rds#OptionSetting", "traits": { "smithy.api#xmlName": "OptionSetting" } } }, "com.amazonaws.rds#OptionVersion": { "type": "structure", "members": { "Version": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The version of the option.
" } }, "IsDefault": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "True if the version is the default version of the option, and otherwise false.
" } } }, "traits": { "smithy.api#documentation": "The version for an option. Option group option versions are returned by \n the DescribeOptionGroupOptions action.
The engine type of a DB instance.
" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The engine version of a DB instance.
" } }, "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The DB instance class for a DB instance.
" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The license model for a DB instance.
" } }, "AvailabilityZoneGroup": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Availability Zone group for a DB instance.
" } }, "AvailabilityZones": { "target": "com.amazonaws.rds#AvailabilityZoneList", "traits": { "smithy.api#documentation": "A list of Availability Zones for a DB instance.
" } }, "MultiAZCapable": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Indicates whether a DB instance is Multi-AZ capable.
" } }, "ReadReplicaCapable": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Indicates whether a DB instance can have a read replica.
" } }, "Vpc": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Indicates whether a DB instance is in a VPC.
" } }, "SupportsStorageEncryption": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Indicates whether a DB instance supports encrypted storage.
" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Indicates the storage type for a DB instance.
" } }, "SupportsIops": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Indicates whether a DB instance supports provisioned IOPS.
" } }, "SupportsEnhancedMonitoring": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.
" } }, "SupportsIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Indicates whether a DB instance supports IAM database authentication.
" } }, "SupportsPerformanceInsights": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "True if a DB instance supports Performance Insights, otherwise false.
" } }, "MinStorageSize": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "Minimum storage size for a DB instance.
" } }, "MaxStorageSize": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "Maximum storage size for a DB instance.
" } }, "MinIopsPerDbInstance": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "Minimum total provisioned IOPS for a DB instance.
" } }, "MaxIopsPerDbInstance": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "Maximum total provisioned IOPS for a DB instance.
" } }, "MinIopsPerGib": { "target": "com.amazonaws.rds#DoubleOptional", "traits": { "smithy.api#documentation": "Minimum provisioned IOPS per GiB for a DB instance.
" } }, "MaxIopsPerGib": { "target": "com.amazonaws.rds#DoubleOptional", "traits": { "smithy.api#documentation": "Maximum provisioned IOPS per GiB for a DB instance.
" } }, "AvailableProcessorFeatures": { "target": "com.amazonaws.rds#AvailableProcessorFeatureList", "traits": { "smithy.api#documentation": "A list of the available processor features for the DB instance class of a DB instance.
" } }, "SupportedEngineModes": { "target": "com.amazonaws.rds#EngineModeList", "traits": { "smithy.api#documentation": "A list of the supported DB engine modes.
" } }, "SupportsStorageAutoscaling": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.
" } }, "SupportsKerberosAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "Whether a DB instance supports Kerberos Authentication.
" } }, "OutpostCapable": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Whether a DB instance supports RDS on Outposts.
\nFor more information about RDS on Outposts, see Amazon RDS on AWS Outposts \n in the Amazon RDS User Guide.\n
" } }, "SupportsGlobalDatabases": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.
" } } }, "traits": { "smithy.api#documentation": "Contains a list of available options for a DB instance.
\n\n This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.\n
An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.
\n An optional pagination token provided by a previous \n OrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n
\n Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action. \n
The Amazon Resource Name (ARN) of the Outpost.
" } } }, "traits": { "smithy.api#documentation": "A data type that represents an Outpost.
\nFor more information about RDS on Outposts, see Amazon RDS on AWS Outposts \n in the Amazon RDS User Guide.\n
" } }, "com.amazonaws.rds#Parameter": { "type": "structure", "members": { "ParameterName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the name of the parameter.
" } }, "ParameterValue": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the value of the parameter.
" } }, "Description": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Provides a description of the parameter.
" } }, "Source": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Indicates the source of the parameter value.
" } }, "ApplyType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the engine specific parameters type.
" } }, "DataType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the valid data type for the parameter.
" } }, "AllowedValues": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the valid range of values for the parameter.
" } }, "IsModifiable": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "\n Indicates whether (true) or not (false) the parameter can be modified.\n Some parameters have security or operational implications\n that prevent them from being changed.\n
The earliest engine version to which the parameter can apply.
" } }, "ApplyMethod": { "target": "com.amazonaws.rds#ApplyMethod", "traits": { "smithy.api#documentation": "Indicates when to apply parameter updates.
" } }, "SupportedEngineModes": { "target": "com.amazonaws.rds#EngineModeList", "traits": { "smithy.api#documentation": "The valid DB engine modes.
" } } }, "traits": { "smithy.api#documentation": "\n This data type is used as a request parameter in the\n ModifyDBParameterGroup and ResetDBParameterGroup actions.\n
This data type is used as a response element in the \n DescribeEngineDefaultParameters and DescribeDBParameters actions.
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
" } }, "LogTypesToDisable": { "target": "com.amazonaws.rds#LogTypeList", "traits": { "smithy.api#documentation": "Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.rds#PendingMaintenanceAction": { "type": "structure", "members": { "Action": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The type of pending maintenance action that is available for the resource. \n Valid actions are system-update, db-upgrade, hardware-maintenance, \n and ca-certificate-rotation.
The date of the maintenance window when the action is applied.\n The maintenance action is applied to the resource during\n its first maintenance window after this date.
" } }, "ForcedApplyDate": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "The date when the maintenance action is automatically applied.
\nOn this date, the maintenance action is applied to the resource as soon as possible, \n regardless of the maintenance window for the resource. There might be a delay of \n one or more days from this date before the maintenance action is applied.
" } }, "OptInStatus": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Indicates the type of opt-in request that has been received for the resource.
" } }, "CurrentApplyDate": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "The effective date when the pending maintenance action is applied \n to the resource. This date takes into account opt-in requests received from\n the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate,\n and the ForcedApplyDate. This value is blank if an \n opt-in request has not been received and nothing has been specified as\n AutoAppliedAfterDate or ForcedApplyDate.
A description providing more detail about the maintenance action.
" } } }, "traits": { "smithy.api#documentation": "Provides information about a pending maintenance action for a resource.
" } }, "com.amazonaws.rds#PendingMaintenanceActionDetails": { "type": "list", "member": { "target": "com.amazonaws.rds#PendingMaintenanceAction", "traits": { "smithy.api#xmlName": "PendingMaintenanceAction" } } }, "com.amazonaws.rds#PendingMaintenanceActions": { "type": "list", "member": { "target": "com.amazonaws.rds#ResourcePendingMaintenanceActions", "traits": { "smithy.api#xmlName": "ResourcePendingMaintenanceActions" } } }, "com.amazonaws.rds#PendingMaintenanceActionsMessage": { "type": "structure", "members": { "PendingMaintenanceActions": { "target": "com.amazonaws.rds#PendingMaintenanceActions", "traits": { "smithy.api#documentation": "A list of the pending maintenance actions for the resource.
" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous\n DescribePendingMaintenanceActions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to a number of records specified by MaxRecords.\n
Data returned from the DescribePendingMaintenanceActions action.
" } }, "com.amazonaws.rds#PendingModifiedValues": { "type": "structure", "members": { "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the compute and memory capacity class for the DB instance.
" } }, "AllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The allocated storage size for the DB instance specified in gibibytes .
" } }, "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The master credentials for the DB instance.
" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The port for the DB instance.
" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The number of days for which automated backups are retained.
" } }, "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The database engine version.
" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The license model for the DB instance.
\nValid values: license-included | bring-your-own-license | \n general-public-license\n
The Provisioned IOPS value for the DB instance.
" } }, "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The database identifier for the DB instance.
" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The storage type of the DB instance.
" } }, "CACertificateIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The identifier of the CA certificate for the DB instance.
" } }, "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The DB subnet group for the DB instance.
" } }, "PendingCloudwatchLogsExports": { "target": "com.amazonaws.rds#PendingCloudwatchLogsExports" }, "ProcessorFeatures": { "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class\n of the DB instance.
" } }, "IAMDatabaseAuthenticationEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "Whether mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
" } } }, "traits": { "smithy.api#documentation": "\n This data type is used as a response element in the ModifyDBInstance operation and \n contains changes that will be applied during the next maintenance window.\n
\n SourceDBInstanceIdentifier\n refers to a DB instance with\n BackupRetentionPeriod equal to 0.\n
The name of the processor feature. Valid names are coreCount and threadsPerCore.
The value of a processor feature name.
" } } }, "traits": { "smithy.api#documentation": "Contains the processor features of a DB instance class.
\nTo specify the number of CPU cores, use the coreCount feature name \n for the Name parameter. To specify the number of threads per core, use the\n threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you\n call one of the following actions:
\n\n CreateDBInstance\n
\n ModifyDBInstance\n
\n RestoreDBInstanceFromDBSnapshot\n
\n RestoreDBInstanceFromS3\n
\n RestoreDBInstanceToPointInTime\n
You can view the valid processor values for a particular instance class by calling the\n DescribeOrderableDBInstanceOptions action and specifying the\n instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
\n\n DescribeDBInstances\n
\n DescribeDBSnapshots\n
\n DescribeValidDBInstanceModifications\n
If you call DescribeDBInstances, ProcessorFeature returns\n non-null values only if the following conditions are met:
You are accessing an Oracle DB instance.
\nYour Oracle DB instance class supports configuring the number of CPU cores and threads per core.
\nThe current number CPU cores and threads is set to a non-default value.
\nFor more information, see Configuring the\n Processor of the DB Instance Class in the Amazon RDS User Guide.\n \n
" } }, "com.amazonaws.rds#ProcessorFeatureList": { "type": "list", "member": { "target": "com.amazonaws.rds#ProcessorFeature", "traits": { "smithy.api#xmlName": "ProcessorFeature" } } }, "com.amazonaws.rds#PromoteReadReplica": { "type": "operation", "input": { "target": "com.amazonaws.rds#PromoteReadReplicaMessage" }, "output": { "target": "com.amazonaws.rds#PromoteReadReplicaResult" }, "errors": [ { "target": "com.amazonaws.rds#DBInstanceNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" } ], "traits": { "smithy.api#documentation": "Promotes a read replica DB instance to a standalone DB instance.
\nBackup duration is a function of the amount of changes to the database since the previous\n backup. If you plan to promote a read replica to a standalone instance, we\n recommend that you enable backups and complete at least one backup prior to\n promotion. In addition, a read replica cannot be promoted to a standalone\n instance when it is in the backing-up status. If you have\n enabled backups on your read replica, configure the automated backup window\n so that daily backups do not interfere with read replica\n promotion.
This command doesn't apply to Aurora MySQL and Aurora PostgreSQL.
\nPromotes a read replica DB cluster to a standalone DB cluster.
\nThis action only applies to Aurora DB clusters.
\nThe identifier of the DB cluster read replica to promote. This parameter isn't\n case-sensitive.
\nConstraints:
\nMust match the identifier of an existing DB cluster read replica.
\nExample: my-cluster-replica1\n
The DB instance identifier. This value is stored as a lowercase string.
\nConstraints:
\nMust match the identifier of an existing read replica DB instance.
\nExample: mydbinstance\n
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
\nDefault: 1
\nConstraints:
\nMust be a value from 0 to 35.
\nCan't be set to 0 if the DB instance is a source to read replicas.
\n\n The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n
\n The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region. \n To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.\n
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nProvisioned IOPS not available in the specified Availability Zone.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#PurchaseReservedDBInstancesOffering": { "type": "operation", "input": { "target": "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingMessage" }, "output": { "target": "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingResult" }, "errors": [ { "target": "com.amazonaws.rds#ReservedDBInstanceAlreadyExistsFault" }, { "target": "com.amazonaws.rds#ReservedDBInstanceQuotaExceededFault" }, { "target": "com.amazonaws.rds#ReservedDBInstancesOfferingNotFoundFault" } ], "traits": { "smithy.api#documentation": "Purchases a reserved DB instance offering.
" } }, "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingMessage": { "type": "structure", "members": { "ReservedDBInstancesOfferingId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The ID of the Reserved DB instance offering to purchase.
\nExample: 438012d3-4052-4cc7-b2e3-8d3372e0e706
", "smithy.api#required": {} } }, "ReservedDBInstanceId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Customer-specified identifier to track this reservation.
\nExample: myreservationID
" } }, "DBInstanceCount": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The number of instances to reserve.
\nDefault: 1\n
The minimum value in the range.
" } }, "To": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#documentation": "The maximum value in the range.
" } }, "Step": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The step value for the range.\n For example, if you have a range of 5,000 to 10,000,\n with a step value of 1,000,\n the valid values start at 5,000 and step up by 1,000.\n Even though 7,500 is within the range,\n it isn't a valid value for the range.\n The valid values are 5,000, 6,000, 7,000, 8,000...\n
" } } }, "traits": { "smithy.api#documentation": "A range of integer values.
" } }, "com.amazonaws.rds#RangeList": { "type": "list", "member": { "target": "com.amazonaws.rds#Range", "traits": { "smithy.api#xmlName": "Range" } } }, "com.amazonaws.rds#ReadReplicaDBClusterIdentifierList": { "type": "list", "member": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#xmlName": "ReadReplicaDBClusterIdentifier" } } }, "com.amazonaws.rds#ReadReplicaDBInstanceIdentifierList": { "type": "list", "member": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#xmlName": "ReadReplicaDBInstanceIdentifier" } } }, "com.amazonaws.rds#ReadReplicaIdentifierList": { "type": "list", "member": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#xmlName": "ReadReplicaIdentifier" } } }, "com.amazonaws.rds#ReadersArnList": { "type": "list", "member": { "target": "com.amazonaws.rds#String" } }, "com.amazonaws.rds#RebootDBInstance": { "type": "operation", "input": { "target": "com.amazonaws.rds#RebootDBInstanceMessage" }, "output": { "target": "com.amazonaws.rds#RebootDBInstanceResult" }, "errors": [ { "target": "com.amazonaws.rds#DBInstanceNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" } ], "traits": { "smithy.api#documentation": "You might need to reboot your DB instance, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB parameter group associated with the DB instance, \n you must reboot the instance for the changes to take effect.\n
\n\nRebooting a DB instance restarts the database engine service. \n Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.\n
\n \nFor more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.\n
" } }, "com.amazonaws.rds#RebootDBInstanceMessage": { "type": "structure", "members": { "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The DB instance identifier. This parameter is stored as a lowercase string.
\nConstraints:
\nMust match the identifier of an existing DBInstance.
\n\n A value that indicates whether the reboot is conducted through a Multi-AZ failover.\n
\nConstraint: You can't enable force failover if the instance isn't configured for Multi-AZ.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#RebootDBInstanceResult": { "type": "structure", "members": { "DBInstance": { "target": "com.amazonaws.rds#DBInstance" } } }, "com.amazonaws.rds#RecurringCharge": { "type": "structure", "members": { "RecurringChargeAmount": { "target": "com.amazonaws.rds#Double", "traits": { "smithy.api#documentation": "The amount of the recurring charge.
" } }, "RecurringChargeFrequency": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The frequency of the recurring charge.
" } } }, "traits": { "smithy.api#documentation": "\n This data type is used as a response element in the \n DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.\n
Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.
The identifier of the DBProxy that is associated with the DBProxyTargetGroup.
The identifier of the DBProxyTargetGroup.
One or more DB instance identifiers.
" } }, "DBClusterIdentifiers": { "target": "com.amazonaws.rds#StringList", "traits": { "smithy.api#documentation": "One or more DB cluster identifiers.
" } } } }, "com.amazonaws.rds#RegisterDBProxyTargetsResponse": { "type": "structure", "members": { "DBProxyTargets": { "target": "com.amazonaws.rds#TargetList", "traits": { "smithy.api#documentation": "One or more DBProxyTarget objects that are created when you register targets with a target group.
\n Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a\n standalone cluster with read-write capability instead of being read-only and receiving data from a\n primary cluster in a different region.\n
\nThis action only applies to Aurora DB clusters.
\n\n The cluster identifier to detach from the Aurora global database cluster.\n
" } }, "DbClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.\n
" } } } }, "com.amazonaws.rds#RemoveFromGlobalClusterResult": { "type": "structure", "members": { "GlobalCluster": { "target": "com.amazonaws.rds#GlobalCluster" } } }, "com.amazonaws.rds#RemoveRoleFromDBCluster": { "type": "operation", "input": { "target": "com.amazonaws.rds#RemoveRoleFromDBClusterMessage" }, "errors": [ { "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, { "target": "com.amazonaws.rds#DBClusterRoleNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidDBClusterStateFault" } ], "traits": { "smithy.api#documentation": "Disassociates an AWS Identity and Access Management (IAM) role from an Amazon Aurora DB cluster.\n For more information, see Authorizing Amazon Aurora MySQL \n to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide.
\nThis action only applies to Aurora DB clusters.
\nThe name of the DB cluster to disassociate the IAM role from.
", "smithy.api#required": {} } }, "RoleArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example\n arn:aws:iam::123456789012:role/AuroraAccessRole.
The name of the feature for the DB cluster that the IAM role is to be disassociated from.\n For the list of supported feature names, see DBEngineVersion.
" } } } }, "com.amazonaws.rds#RemoveRoleFromDBInstance": { "type": "operation", "input": { "target": "com.amazonaws.rds#RemoveRoleFromDBInstanceMessage" }, "errors": [ { "target": "com.amazonaws.rds#DBInstanceNotFoundFault" }, { "target": "com.amazonaws.rds#DBInstanceRoleNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" } ], "traits": { "smithy.api#documentation": "Disassociates an AWS Identity and Access Management (IAM) role from a DB instance.
" } }, "com.amazonaws.rds#RemoveRoleFromDBInstanceMessage": { "type": "structure", "members": { "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the DB instance to disassociate the IAM role from.
", "smithy.api#required": {} } }, "RoleArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance,\n for example, arn:aws:iam::123456789012:role/AccessRole.
The name of the feature for the DB instance that the IAM role is to be disassociated from.\n For the list of supported feature names, see DBEngineVersion.\n
Removes a source identifier from an existing RDS event notification subscription.
" } }, "com.amazonaws.rds#RemoveSourceIdentifierFromSubscriptionMessage": { "type": "structure", "members": { "SubscriptionName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the RDS event notification subscription you want to remove a source identifier from.
", "smithy.api#required": {} } }, "SourceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n The source identifier to be removed from the subscription, such as the DB instance identifier \n for a DB instance or the name of a security group.\n
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#RemoveSourceIdentifierFromSubscriptionResult": { "type": "structure", "members": { "EventSubscription": { "target": "com.amazonaws.rds#EventSubscription" } } }, "com.amazonaws.rds#RemoveTagsFromResource": { "type": "operation", "input": { "target": "com.amazonaws.rds#RemoveTagsFromResourceMessage" }, "errors": [ { "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, { "target": "com.amazonaws.rds#DBInstanceNotFoundFault" }, { "target": "com.amazonaws.rds#DBProxyNotFoundFault" }, { "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" }, { "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" } ], "traits": { "smithy.api#documentation": "Removes metadata tags from an Amazon RDS resource.
\nFor an overview on tagging an Amazon RDS resource, \n see Tagging Amazon RDS Resources \n in the Amazon RDS User Guide.\n
" } }, "com.amazonaws.rds#RemoveTagsFromResourceMessage": { "type": "structure", "members": { "ResourceName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.\n
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.rds#KeyList", "traits": { "smithy.api#documentation": "The tag key (name) of the tag to be removed.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#ReplicaMode": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "open-read-only", "name": "OPEN_READ_ONLY" }, { "value": "mounted", "name": "MOUNTED" } ] } }, "com.amazonaws.rds#ReservedDBInstance": { "type": "structure", "members": { "ReservedDBInstanceId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The unique identifier for the reservation.
" } }, "ReservedDBInstancesOfferingId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The offering identifier.
" } }, "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The DB instance class for the reserved DB instance.
" } }, "StartTime": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "The time the reservation started.
" } }, "Duration": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#documentation": "The duration of the reservation in seconds.
" } }, "FixedPrice": { "target": "com.amazonaws.rds#Double", "traits": { "smithy.api#documentation": "The fixed price charged for this reserved DB instance.
" } }, "UsagePrice": { "target": "com.amazonaws.rds#Double", "traits": { "smithy.api#documentation": "The hourly price charged for this reserved DB instance.
" } }, "CurrencyCode": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The currency code for the reserved DB instance.
" } }, "DBInstanceCount": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#documentation": "The number of reserved DB instances.
" } }, "ProductDescription": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The description of the reserved DB instance.
" } }, "OfferingType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The offering type of this reserved DB instance.
" } }, "MultiAZ": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Indicates if the reservation applies to Multi-AZ deployments.
" } }, "State": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The state of the reserved DB instance.
" } }, "RecurringCharges": { "target": "com.amazonaws.rds#RecurringChargeList", "traits": { "smithy.api#documentation": "The recurring price charged to run this reserved DB instance.
" } }, "ReservedDBInstanceArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the reserved DB instance.
" } }, "LeaseId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The unique identifier for the lease associated with the reserved DB instance.
\nAWS Support might request the lease ID for an issue related to a reserved DB instance.
\n\n This data type is used as a response element in the \n DescribeReservedDBInstances and \n PurchaseReservedDBInstancesOffering actions.\n
User already has a reservation with the given identifier.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.rds#ReservedDBInstanceList": { "type": "list", "member": { "target": "com.amazonaws.rds#ReservedDBInstance", "traits": { "smithy.api#xmlName": "ReservedDBInstance" } } }, "com.amazonaws.rds#ReservedDBInstanceMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
A list of reserved DB instances.
" } } }, "traits": { "smithy.api#documentation": "\n Contains the result of a successful invocation of the DescribeReservedDBInstances action.\n
The specified reserved DB Instance not found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.rds#ReservedDBInstanceQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "Request would exceed the user's DB Instance quota.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#ReservedDBInstancesOffering": { "type": "structure", "members": { "ReservedDBInstancesOfferingId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The offering identifier.
" } }, "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The DB instance class for the reserved DB instance.
" } }, "Duration": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#documentation": "The duration of the offering in seconds.
" } }, "FixedPrice": { "target": "com.amazonaws.rds#Double", "traits": { "smithy.api#documentation": "The fixed price charged for this offering.
" } }, "UsagePrice": { "target": "com.amazonaws.rds#Double", "traits": { "smithy.api#documentation": "The hourly price charged for this offering.
" } }, "CurrencyCode": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The currency code for the reserved DB instance offering.
" } }, "ProductDescription": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The database engine used by the offering.
" } }, "OfferingType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The offering type.
" } }, "MultiAZ": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Indicates if the offering applies to Multi-AZ deployments.
" } }, "RecurringCharges": { "target": "com.amazonaws.rds#RecurringChargeList", "traits": { "smithy.api#documentation": "The recurring price charged to run this reserved DB instance.
" } } }, "traits": { "smithy.api#documentation": "\n This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.\n
\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
A list of reserved DB instance offerings.
" } } }, "traits": { "smithy.api#documentation": "\n Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action. \n
Specified offering does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.rds#ResetDBClusterParameterGroup": { "type": "operation", "input": { "target": "com.amazonaws.rds#ResetDBClusterParameterGroupMessage" }, "output": { "target": "com.amazonaws.rds#DBClusterParameterGroupNameMessage" }, "errors": [ { "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" } ], "traits": { "smithy.api#documentation": "\n Modifies the parameters of a DB cluster parameter group to the default value. To\n reset specific parameters submit a list of the following: ParameterName \n and ApplyMethod. To reset the\n entire DB cluster parameter group, specify the DBClusterParameterGroupName \n and ResetAllParameters parameters.\n
\n When resetting the entire group, dynamic parameters are updated immediately and static parameters\n are set to pending-reboot to take effect on the next DB instance restart \n or RebootDBInstance request. You must call RebootDBInstance for every\n DB instance in your DB cluster that you want the updated static parameter to apply to.
For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nThe name of the DB cluster parameter group to reset.
", "smithy.api#required": {} } }, "ResetAllParameters": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "A value that indicates whether to reset all parameters in the DB cluster parameter group \n to their default values. You can't use this parameter if there \n is a list of parameter names specified for the Parameters parameter.
A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this\n parameter if the ResetAllParameters parameter is enabled.
Modifies the parameters of a DB parameter group to the engine/system default value.\n To reset specific parameters, provide a list of the following:\n ParameterName and ApplyMethod. To reset the entire DB\n parameter group, specify the DBParameterGroup name and\n ResetAllParameters parameters. When resetting the entire group, dynamic\n parameters are updated immediately and static parameters are set to\n pending-reboot to take effect on the next DB instance restart or\n RebootDBInstance request.
The name of the DB parameter group.
\nConstraints:
\nMust match the name of an existing DBParameterGroup.
\n A value that indicates whether to reset all parameters in the DB parameter group to default values. \n By default, all parameters in the DB parameter group are reset to default values.\n
" } }, "Parameters": { "target": "com.amazonaws.rds#ParametersList", "traits": { "smithy.api#documentation": "To reset the entire DB parameter group, specify the DBParameterGroup\n name and ResetAllParameters parameters. To reset specific parameters,\n provide a list of the following: ParameterName and\n ApplyMethod. A maximum of 20 parameters can be modified in a single\n request.
\n MySQL\n
\nValid Values (for Apply method): immediate | pending-reboot\n
You can use the immediate value with dynamic parameters only. You can use \n the pending-reboot value for both dynamic and static parameters, and changes \n are applied when DB instance reboots.
\n MariaDB\n
\nValid Values (for Apply method): immediate | pending-reboot\n
You can use the immediate value with dynamic parameters only. You can use \n the pending-reboot value for both dynamic and static parameters, and changes \n are applied when DB instance reboots.
\n Oracle\n
\nValid Values (for Apply method): pending-reboot\n
The specified resource ID was not found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.rds#ResourcePendingMaintenanceActions": { "type": "structure", "members": { "ResourceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The ARN of the resource that has pending maintenance actions.
" } }, "PendingMaintenanceActionDetails": { "target": "com.amazonaws.rds#PendingMaintenanceActionDetails", "traits": { "smithy.api#documentation": "A list that provides details about the pending maintenance actions for the resource.
" } } }, "traits": { "smithy.api#documentation": "Describes the pending maintenance actions for a resource.
" } }, "com.amazonaws.rds#RestoreDBClusterFromS3": { "type": "operation", "input": { "target": "com.amazonaws.rds#RestoreDBClusterFromS3Message" }, "output": { "target": "com.amazonaws.rds#RestoreDBClusterFromS3Result" }, "errors": [ { "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" }, { "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, { "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" }, { "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" }, { "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" }, { "target": "com.amazonaws.rds#DomainNotFoundFault" }, { "target": "com.amazonaws.rds#InsufficientStorageClusterCapacityFault" }, { "target": "com.amazonaws.rds#InvalidDBClusterStateFault" }, { "target": "com.amazonaws.rds#InvalidDBSubnetGroupStateFault" }, { "target": "com.amazonaws.rds#InvalidS3BucketFault" }, { "target": "com.amazonaws.rds#InvalidSubnet" }, { "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" }, { "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" }, { "target": "com.amazonaws.rds#StorageQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.\n Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be\n created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the\n Amazon Aurora User Guide.
\nThis action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromS3 action has completed and the DB\n cluster is available.
For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters. The source DB engine must be\n MySQL.
\nA list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.
\nDefault: 1
\nConstraints:
\nMust be a value from 1 to 35
\nA value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
" } }, "DatabaseName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The database name for the restored DB cluster.
" } }, "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: my-cluster1\n
The name of the DB cluster parameter group to associate\n with the restored DB cluster. If this argument is omitted, default.aurora5.6 is used.\n
Constraints:
\nIf supplied, must match the name of an existing DBClusterParameterGroup.
\nA list of EC2 VPC security groups to associate with the restored DB cluster.
" } }, "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "A DB subnet group to associate with the restored DB cluster.
\nConstraints: If supplied, must match the name of an existing DBSubnetGroup.\n
\nExample: mySubnetgroup\n
The name of the database engine to be used for this DB cluster.
\nValid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql \n
The version number of the database engine to use.
\nTo list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for aurora-postgresql, use the following command:
\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n
\n Aurora MySQL\n
\nExample: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5\n
\n Aurora PostgreSQL\n
\nExample: 9.6.3, 10.7\n
The port number on which the instances in the restored DB cluster accept connections.
\n\n Default: 3306\n
The name of the master user for the restored DB cluster.
\nConstraints:
\nMust be 1 to 16 letters or numbers.
\nFirst character must be a letter.
\nCan't be a reserved word for the chosen database engine.
\nThe password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
\nConstraints: Must contain from 8 to 41 characters.
", "smithy.api#required": {} } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "A value that indicates that the restored DB cluster should be associated with the specified option group.
\nPermanent options can't be removed from an option group. An option group can't be removed from a \n DB cluster once it is associated with a DB cluster.
" } }, "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.\n
The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.\n
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nThe weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
\nFormat: ddd:hh24:mi-ddd:hh24:mi\n
The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.\n
\nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
\nConstraints: Minimum 30-minute window.
" } }, "Tags": { "target": "com.amazonaws.rds#TagList" }, "StorageEncrypted": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether the restored DB cluster is encrypted.
" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The AWS KMS key identifier for an encrypted DB cluster.
\nThe AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).\n To use a CMK in a different AWS account, specify the key ARN or alias ARN.
\nIf the StorageEncrypted parameter is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS will use your default CMK. There is a \n default CMK for your AWS account. Your AWS account has a different\n default CMK for each AWS Region.
A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n
" } }, "SourceEngine": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The identifier for the database engine that was backed up to create the files stored in the\n Amazon S3 bucket.\n
\nValid values: mysql\n
The version of the database that the backup files were created from.
\nMySQL versions 5.5, 5.6, and 5.7 are supported.\n
\nExample: 5.6.40, 5.7.28\n
The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
", "smithy.api#required": {} } }, "S3Prefix": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster.\n If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is\n created by using all of the files in the Amazon S3 bucket.
" } }, "S3IngestionRoleArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes\n Amazon RDS to access the Amazon S3 bucket on your behalf.
", "smithy.api#required": {} } }, "BacktrackWindow": { "target": "com.amazonaws.rds#LongOptional", "traits": { "smithy.api#documentation": "The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.
\nCurrently, Backtrack is only supported for Aurora MySQL DB clusters.
\nDefault: 0
\nConstraints:
\nIf specified, this value must be set to a number from 0 to 259,200 (72 hours).
\nThe list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled.\n
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.\n
\n\n For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.\n
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
" } } } }, "com.amazonaws.rds#RestoreDBClusterFromS3Result": { "type": "structure", "members": { "DBCluster": { "target": "com.amazonaws.rds#DBCluster" } } }, "com.amazonaws.rds#RestoreDBClusterFromSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.rds#RestoreDBClusterFromSnapshotMessage" }, "output": { "target": "com.amazonaws.rds#RestoreDBClusterFromSnapshotResult" }, "errors": [ { "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" }, { "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" }, { "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" }, { "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" }, { "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" }, { "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" }, { "target": "com.amazonaws.rds#DomainNotFoundFault" }, { "target": "com.amazonaws.rds#InsufficientDBClusterCapacityFault" }, { "target": "com.amazonaws.rds#InsufficientStorageClusterCapacityFault" }, { "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" }, { "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" }, { "target": "com.amazonaws.rds#InvalidRestoreFault" }, { "target": "com.amazonaws.rds#InvalidSubnet" }, { "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" }, { "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" }, { "target": "com.amazonaws.rds#OptionGroupNotFoundFault" }, { "target": "com.amazonaws.rds#StorageQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "Creates a new DB cluster from a DB snapshot or DB cluster snapshot. This action\n only applies to Aurora DB clusters.
\nThe target DB cluster is created from the source snapshot with a default\n configuration. If you don't specify a security group, the new DB cluster is\n associated with the default security group.
\nThis action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromSnapshot action has completed and the DB\n cluster is available.
For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nProvides the list of Availability Zones (AZs) where instances in the restored DB\n cluster can be created.
" } }, "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.\n This parameter isn't case-sensitive.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-snapshot-id\n
The identifier for the DB snapshot or DB cluster snapshot to restore from.
\nYou can use either the name or the Amazon Resource Name (ARN) to specify a DB\n cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
\nConstraints:
\nMust match the identifier of an existing Snapshot.
\nThe database engine to use for the new DB cluster.
\nDefault: The same as source
\nConstraint: Must be compatible with the engine of the source
", "smithy.api#required": {} } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The version of the database engine to use for the new DB cluster.
\nTo list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for aurora-postgresql, use the following command:
\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n
If you aren't using the default engine version, then you must specify the engine version.
\n\n Aurora MySQL\n
\nExample: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5\n
\n Aurora PostgreSQL\n
\nExample: 9.6.3, 10.7\n
The port number on which the new DB cluster accepts connections.
\nConstraints: This value must be 1150-65535\n
Default: The same port as the original DB cluster.
" } }, "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the DB subnet group to use for the new DB cluster.
\nConstraints: If supplied, must match the name of an existing DB subnet group.
\nExample: mySubnetgroup\n
The database name for the restored DB cluster.
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the option group to use for the restored DB cluster.
" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { "smithy.api#documentation": "A list of VPC security groups that the new DB cluster will belong to.
" } }, "Tags": { "target": "com.amazonaws.rds#TagList", "traits": { "smithy.api#documentation": "The tags to be assigned to the restored DB cluster.
" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB\n snapshot or DB cluster snapshot.
\nThe AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).\n To use a CMK in a different AWS account, specify the key ARN or alias ARN.
\nWhen you don't specify a value for the KmsKeyId parameter, then the\n following occurs:
If the DB snapshot or DB cluster snapshot in\n SnapshotIdentifier is encrypted, then the restored DB cluster\n is encrypted using the AWS KMS CMK that was used to encrypt the DB snapshot or DB\n cluster snapshot.
If the DB snapshot or DB cluster snapshot in \n SnapshotIdentifier isn't encrypted, then the restored DB cluster\n isn't encrypted.
A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n
" } }, "BacktrackWindow": { "target": "com.amazonaws.rds#LongOptional", "traits": { "smithy.api#documentation": "The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.
\nCurrently, Backtrack is only supported for Aurora MySQL DB clusters.
\nDefault: 0
\nConstraints:
\nIf specified, this value must be set to a number from 0 to 259,200 (72 hours).
\nThe list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.\n The values in the list depend on the DB engine being used. For more information, see\n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon\n Aurora User Guide.
" } }, "EngineMode": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The DB engine mode of the DB cluster, either provisioned, serverless,\n parallelquery, global, or multimaster.
For more information, see \n CreateDBCluster.
" } }, "ScalingConfiguration": { "target": "com.amazonaws.rds#ScalingConfiguration", "traits": { "smithy.api#documentation": "For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
The name of the DB cluster parameter group to associate with this DB cluster. If this\n argument is omitted, the default DB cluster parameter group for the specified engine is\n used.
\nConstraints:
\nIf supplied, must match the name of an existing default DB cluster parameter group.
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nA value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled.\n
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.\n
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#RestoreDBClusterFromSnapshotResult": { "type": "structure", "members": { "DBCluster": { "target": "com.amazonaws.rds#DBCluster" } } }, "com.amazonaws.rds#RestoreDBClusterToPointInTime": { "type": "operation", "input": { "target": "com.amazonaws.rds#RestoreDBClusterToPointInTimeMessage" }, "output": { "target": "com.amazonaws.rds#RestoreDBClusterToPointInTimeResult" }, "errors": [ { "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" }, { "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, { "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" }, { "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" }, { "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" }, { "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" }, { "target": "com.amazonaws.rds#DomainNotFoundFault" }, { "target": "com.amazonaws.rds#InsufficientDBClusterCapacityFault" }, { "target": "com.amazonaws.rds#InsufficientStorageClusterCapacityFault" }, { "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" }, { "target": "com.amazonaws.rds#InvalidDBClusterStateFault" }, { "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" }, { "target": "com.amazonaws.rds#InvalidRestoreFault" }, { "target": "com.amazonaws.rds#InvalidSubnet" }, { "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" }, { "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" }, { "target": "com.amazonaws.rds#OptionGroupNotFoundFault" }, { "target": "com.amazonaws.rds#StorageQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "Restores a DB cluster to an arbitrary point in time. Users can restore to any point\n in time before LatestRestorableTime for up to\n BackupRetentionPeriod days. The target DB cluster is created from the\n source DB cluster with the same configuration as the original DB cluster, except that\n the new DB cluster is created with the default DB security group.
This action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterToPointInTime action has completed and the DB\n cluster is available.
For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nThe name of the new DB cluster to be created.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nThe type of restore to be performed. You can specify one of the following values:
\n\n full-copy - The new DB cluster is restored as a full copy of the\n source DB cluster.
\n copy-on-write - The new DB cluster is restored as a clone of the\n source DB cluster.
Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.
If you don't specify a RestoreType value, then the new DB cluster is\n restored as a full copy of the source DB cluster.
The identifier of the source DB cluster from which to restore.
\nConstraints:
\nMust match the identifier of an existing DBCluster.
\nThe date and time to restore the DB cluster to.
\nValid Values: Value must be a time in Universal Coordinated Time (UTC) format
\nConstraints:
\nMust be before the latest restorable time for the DB instance
\nMust be specified if UseLatestRestorableTime parameter isn't provided
Can't be specified if the UseLatestRestorableTime parameter is enabled
Can't be specified if the RestoreType parameter is copy-on-write\n
Example: 2015-03-07T23:45:00Z\n
A value that indicates whether to restore the DB cluster to the latest \n restorable backup time. By default, the DB cluster isn't restored to the latest \n restorable backup time.\n
\nConstraints: Can't be specified if RestoreToTime parameter is provided.
The port number on which the new DB cluster accepts connections.
\nConstraints: A value from 1150-65535.\n
Default: The default port for the engine.
" } }, "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The DB subnet group name to use for the new DB cluster.
\nConstraints: If supplied, must match the name of an existing DBSubnetGroup.
\nExample: mySubnetgroup\n
The name of the option group for the new DB cluster.
" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { "smithy.api#documentation": "A list of VPC security groups that the new DB cluster belongs to.
" } }, "Tags": { "target": "com.amazonaws.rds#TagList" }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
\nThe AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).\n To use a CMK in a different AWS account, specify the key ARN or alias ARN.
\nYou can restore to a new DB cluster and encrypt the new DB cluster with a AWS KMS CMK that is different than the\n AWS KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the AWS KMS CMK\n identified by the KmsKeyId parameter.
If you don't specify a value for the KmsKeyId parameter, then the following occurs:
If the DB cluster is encrypted, then the restored DB cluster is encrypted using the AWS KMS CMK that was used to encrypt the source DB cluster.
\nIf the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.
\nIf DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request\n is rejected.
A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n
" } }, "BacktrackWindow": { "target": "com.amazonaws.rds#LongOptional", "traits": { "smithy.api#documentation": "The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.
\nCurrently, Backtrack is only supported for Aurora MySQL DB clusters.
\nDefault: 0
\nConstraints:
\nIf specified, this value must be set to a number from 0 to 259,200 (72 hours).
\nThe list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
" } }, "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the DB cluster parameter group to associate with this DB cluster. \n If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
\nConstraints:
\nIf supplied, must match the name of an existing DB cluster parameter group.
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nA value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled.\n
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.\n
\n\n For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.\n
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#RestoreDBClusterToPointInTimeResult": { "type": "structure", "members": { "DBCluster": { "target": "com.amazonaws.rds#DBCluster" } } }, "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshotMessage" }, "output": { "target": "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshotResult" }, "errors": [ { "target": "com.amazonaws.rds#AuthorizationNotFoundFault" }, { "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" }, { "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" }, { "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" }, { "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" }, { "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" }, { "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" }, { "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" }, { "target": "com.amazonaws.rds#DomainNotFoundFault" }, { "target": "com.amazonaws.rds#InstanceQuotaExceededFault" }, { "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" }, { "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" }, { "target": "com.amazonaws.rds#InvalidRestoreFault" }, { "target": "com.amazonaws.rds#InvalidSubnet" }, { "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" }, { "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" }, { "target": "com.amazonaws.rds#OptionGroupNotFoundFault" }, { "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" }, { "target": "com.amazonaws.rds#StorageQuotaExceededFault" }, { "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" } ], "traits": { "smithy.api#documentation": "Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most\n of the source's original configuration, including the default security group and DB parameter group. By default, the new DB\n instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group\n associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.
\nIf you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance\n before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you\n have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as\n the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original\n DB instance with the DB instance created from the snapshot.
\nIf you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\n must be the ARN of the shared DB snapshot.
This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.
Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.
\nConstraints:
\nMust contain from 1 to 63 numbers, letters, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-snapshot-id\n
The identifier for the DB snapshot to restore from.
\nConstraints:
\nMust match the identifier of an existing DBSnapshot.
\nIf you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\n must be the ARN of the shared DB snapshot.
The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all AWS Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n
Default: The same DBInstanceClass as the original DB instance.
" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The port number on which the database accepts connections.
\nDefault: The same port as the original DB instance
\nConstraints: Value must be 1150-65535\n
The Availability Zone (AZ) where the DB instance will be created.
\nDefault: A random, system-chosen Availability Zone.
\nConstraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Example: us-east-1a\n
The DB subnet group name to use for the new instance.
\nConstraints: If supplied, must match the name of an existing DBSubnetGroup.
\nExample: mySubnetgroup\n
A value that indicates whether the DB instance is a Multi-AZ deployment.
\nConstraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "License model information for the restored DB instance.
\nDefault: Same as source.
\n\n Valid values: license-included | bring-your-own-license | general-public-license\n
The database name for the restored DB instance.
\nThis parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.
\nThe database engine to use for the new instance.
\nDefault: The same as source
\nConstraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
\n\nValid Values:
\n \n\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-se2\n
\n oracle-se1\n
\n oracle-se\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. \n If this parameter isn't specified, the IOPS value is taken from the backup. \n If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. \n The conversion takes additional time, though your DB instance is available for connections before the conversion starts.\n
\nThe provisioned IOPS value must follow the requirements for your database engine.\n For more information, see \n Amazon RDS Provisioned IOPS Storage to Improve Performance \n in the Amazon RDS User Guide.\n
\nConstraints: Must be an integer greater than 1000.
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the option group to be used for the restored DB instance.
\n \nPermanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
" } }, "Tags": { "target": "com.amazonaws.rds#TagList" }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the storage type to be associated with the DB instance.
\n\n Valid values: standard | gp2 | io1\n
\n If you specify io1, you must also include a value for the\n Iops parameter.\n
\n Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
The ARN from the key store with which to associate the instance for TDE encryption.
" } }, "TdeCredentialPassword": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The password for the given ARN from the key store in order to access the device.
" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { "smithy.api#documentation": "\n A list of EC2 VPC security groups to associate with this DB instance.\n
\n\n Default: The default EC2 VPC security group for the DB subnet group's VPC.\n
" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specify the Active Directory directory ID to restore the DB instance in.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { "smithy.api#documentation": "The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
" } }, "ProcessorFeatures": { "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
" } }, "UseDefaultProcessorFeatures": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.
" } }, "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the DB parameter group to associate with this DB instance.
\nIf you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.
Constraints:
\nIf supplied, must match the name of an existing DBParameterGroup.
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nA value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled. For more information, see \n \n Deleting a DB Instance.\n
" } }, "EnableCustomerOwnedIp": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the AWS Outposts User Guide.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshotResult": { "type": "structure", "members": { "DBInstance": { "target": "com.amazonaws.rds#DBInstance" } } }, "com.amazonaws.rds#RestoreDBInstanceFromS3": { "type": "operation", "input": { "target": "com.amazonaws.rds#RestoreDBInstanceFromS3Message" }, "output": { "target": "com.amazonaws.rds#RestoreDBInstanceFromS3Result" }, "errors": [ { "target": "com.amazonaws.rds#AuthorizationNotFoundFault" }, { "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" }, { "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" }, { "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" }, { "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" }, { "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" }, { "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" }, { "target": "com.amazonaws.rds#InstanceQuotaExceededFault" }, { "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" }, { "target": "com.amazonaws.rds#InvalidS3BucketFault" }, { "target": "com.amazonaws.rds#InvalidSubnet" }, { "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" }, { "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" }, { "target": "com.amazonaws.rds#OptionGroupNotFoundFault" }, { "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" }, { "target": "com.amazonaws.rds#StorageQuotaExceededFault" }, { "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" } ], "traits": { "smithy.api#documentation": "Amazon Relational Database Service (Amazon RDS) \n supports importing MySQL databases by using backup files. \n You can create a backup of your on-premises database, \n store it on Amazon Simple Storage Service (Amazon S3), \n and then restore the backup file onto a new Amazon RDS DB instance running MySQL.\n For more information, see Importing Data into an Amazon RDS MySQL DB Instance \n in the Amazon RDS User Guide. \n
" } }, "com.amazonaws.rds#RestoreDBInstanceFromS3Message": { "type": "structure", "members": { "DBName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the database to create when the DB instance is created.\n Follow the naming rules specified in CreateDBInstance.\n
The DB instance identifier. This parameter is stored as a lowercase string.\n
\n\nConstraints:
\n\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: mydbinstance\n
The amount of storage (in gigabytes) to allocate initially for the DB instance.\n Follow the allocation rules specified in CreateDBInstance.\n
Be sure to allocate enough memory for your new DB instance\n so that the restore operation can succeed.\n You can also allocate additional memory for future growth. \n
\nThe compute and memory capacity of the DB instance, \n for example, db.m4.large.\n Not all DB instance classes are available in all AWS Regions, \n or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.\n
Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.\n
", "smithy.api#required": {} } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the database engine to be used for this instance.\n
\n \nValid Values: mysql\n
The name for the master user.\n
\n \nConstraints:\n
\nMust be 1 to 16 letters or numbers.
\nFirst character must be a letter.
\nCan't be a reserved word for the chosen database engine.
\nThe password for the master user. \n The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".\n
\n \nConstraints: Must contain from 8 to 41 characters.
" } }, "DBSecurityGroups": { "target": "com.amazonaws.rds#DBSecurityGroupNameList", "traits": { "smithy.api#documentation": "A list of DB security groups to associate with this DB instance.
\nDefault: The default DB security group for the database engine.
" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { "smithy.api#documentation": "A list of VPC security groups to associate with this DB instance.\n
" } }, "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Availability Zone that the DB instance is created in. \n For information about AWS Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.\n
\nDefault: A random, system-chosen Availability Zone in the endpoint's AWS Region.\n
\n\n Example: us-east-1d\n
Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same AWS Region as the current endpoint.\n
A DB subnet group to associate with this DB instance.
" } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The time range each week during which system maintenance can occur, \n in Universal Coordinated Time (UTC). \n For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.\n
\n\nConstraints:
\nMust be in the format ddd:hh24:mi-ddd:hh24:mi.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
\nMust be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred backup window.
\nMust be at least 30 minutes.
\nThe name of the DB parameter group to associate with this DB instance.
\nIf you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.
The number of days for which automated backups are retained. \n Setting this parameter to a positive number enables backups.\n For more information, see CreateDBInstance.\n
The time range each day \n during which automated backups are created \n if automated backups are enabled. \n For more information, see Backup window in the Amazon RDS User Guide.\n
\n \nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nThe port number on which the database accepts connections.\n
\nType: Integer\n
\nValid Values: 1150-65535\n
Default: 3306\n
A value that indicates whether the DB instance is a Multi-AZ deployment. \n If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.\n
The version number of the database engine to use.\n Choose the latest minor version of your database engine. \n For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.\n
A value that indicates whether minor engine upgrades are applied automatically \n to the DB instance during the maintenance window. By default, minor engine upgrades \n are not applied automatically.\n
" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The license model for this DB instance.\n Use general-public-license.\n
The amount of Provisioned IOPS (input/output operations per second) \n to allocate initially for the DB instance.\n For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance \n in the Amazon RDS User Guide.\n
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the option group to associate with this DB instance. \n If this argument is omitted, the default option group for the specified engine is used.\n
" } }, "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" } }, "Tags": { "target": "com.amazonaws.rds#TagList", "traits": { "smithy.api#documentation": "A list of tags to associate with this DB instance.\n For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. \n
" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the storage type to be associated with the DB instance.\n
\nValid values: standard | gp2 | io1\n
If you specify io1, \n you must also include a value for the Iops parameter.\n
Default: io1 \n if the Iops parameter is specified; \n otherwise gp2\n
A value that indicates whether the new DB instance is encrypted or not.\n
" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The AWS KMS key identifier for an encrypted DB instance.\n
\nThe AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).\n To use a CMK in a different AWS account, specify the key ARN or alias ARN.
\nIf the StorageEncrypted parameter is enabled, \n and you do not specify a value for the KmsKeyId parameter, \n then Amazon RDS will use your default CMK. \n There is a default CMK for your AWS account. \n Your AWS account has a different default CMK for each AWS Region.\n
A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. \n
" } }, "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The interval, in seconds, \n between points when Enhanced Monitoring metrics are collected for the DB instance. \n To disable collecting Enhanced Monitoring metrics, specify 0.\n
\n\nIf MonitoringRoleArn is specified, \n then you must also set MonitoringInterval to a value other than 0.\n
Valid Values: 0, 1, 5, 10, 15, 30, 60\n
\nDefault: 0\n
The ARN for the IAM role that permits RDS \n to send enhanced monitoring metrics to Amazon CloudWatch Logs. \n For example, arn:aws:iam:123456789012:role/emaccess. \n For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.\n
If MonitoringInterval is set to a value other than 0, \n then you must supply a MonitoringRoleArn value.\n
A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" } }, "SourceEngine": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the engine of your source database.\n
\n \nValid Values: mysql\n
The version of the database that the backup files were created from.
\nMySQL versions 5.6 and 5.7 are supported.\n
\nExample: 5.6.40\n
The name of your Amazon S3 bucket \n that contains your database backup file. \n
", "smithy.api#required": {} } }, "S3Prefix": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The prefix of your Amazon S3 bucket.\n
" } }, "S3IngestionRoleArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket. \n
", "smithy.api#required": {} } }, "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to enable Performance Insights for the DB instance.\n
\nFor more information, see \n Using Amazon Performance Insights in the Amazon Relational Database Service\n User Guide.\n
" } }, "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The AWS KMS key identifier for encryption of Performance Insights data.
\nThe AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default CMK. There is a default CMK for your AWS account. \n Your AWS account has a different default CMK for each AWS Region.
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
" } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { "smithy.api#documentation": "The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
" } }, "ProcessorFeatures": { "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
" } }, "UseDefaultProcessorFeatures": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.
" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled. For more information, see \n \n Deleting a DB Instance.\n
" } }, "MaxAllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
\nFor more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.
" } } } }, "com.amazonaws.rds#RestoreDBInstanceFromS3Result": { "type": "structure", "members": { "DBInstance": { "target": "com.amazonaws.rds#DBInstance" } } }, "com.amazonaws.rds#RestoreDBInstanceToPointInTime": { "type": "operation", "input": { "target": "com.amazonaws.rds#RestoreDBInstanceToPointInTimeMessage" }, "output": { "target": "com.amazonaws.rds#RestoreDBInstanceToPointInTimeResult" }, "errors": [ { "target": "com.amazonaws.rds#AuthorizationNotFoundFault" }, { "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" }, { "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" }, { "target": "com.amazonaws.rds#DBInstanceAutomatedBackupNotFoundFault" }, { "target": "com.amazonaws.rds#DBInstanceNotFoundFault" }, { "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" }, { "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" }, { "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" }, { "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" }, { "target": "com.amazonaws.rds#DomainNotFoundFault" }, { "target": "com.amazonaws.rds#InstanceQuotaExceededFault" }, { "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" }, { "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" }, { "target": "com.amazonaws.rds#InvalidRestoreFault" }, { "target": "com.amazonaws.rds#InvalidSubnet" }, { "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" }, { "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" }, { "target": "com.amazonaws.rds#OptionGroupNotFoundFault" }, { "target": "com.amazonaws.rds#PointInTimeRestoreNotEnabledFault" }, { "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" }, { "target": "com.amazonaws.rds#StorageQuotaExceededFault" }, { "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" } ], "traits": { "smithy.api#documentation": "Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.
\n\tThe target database is created with most of the original configuration, but in a\n system-selected Availability Zone, with the default security group, the default subnet\n group, and the default DB parameter group. By default, the new DB instance is created as\n a single-AZ deployment except when the instance is a SQL Server instance that has an\n option group that is associated with mirroring; in this case, the instance becomes a\n mirrored deployment and not a single-AZ deployment.
\nThis command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.
The identifier of the source DB instance from which to restore.
\nConstraints:
\nMust match the identifier of an existing DB instance.
\nThe name of the new DB instance to be created.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nThe date and time to restore from.
\nValid Values: Value must be a time in Universal Coordinated Time (UTC) format
\nConstraints:
\nMust be before the latest restorable time for the DB instance
\nCan't be specified if the UseLatestRestorableTime parameter is enabled
Example: 2009-09-07T23:45:00Z\n
\n A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance \n isn't restored from the latest backup time.\n
\nConstraints: Can't be specified if the RestoreTime parameter is provided.
The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all AWS Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n
Default: The same DBInstanceClass as the original DB instance.
" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The port number on which the database accepts connections.
\nConstraints: Value must be 1150-65535\n
Default: The same port as the original DB instance.
" } }, "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Availability Zone (AZ) where the DB instance will be created.
\nDefault: A random, system-chosen Availability Zone.
\nConstraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Example: us-east-1a\n
The DB subnet group name to use for the new instance.
\nConstraints: If supplied, must match the name of an existing DBSubnetGroup.
\nExample: mySubnetgroup\n
A value that indicates whether the DB instance is a Multi-AZ deployment.
\nConstraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "License model information for the restored DB instance.
\nDefault: Same as source.
\n\n Valid values: license-included | bring-your-own-license | general-public-license\n
The database name for the restored DB instance.
\nThis parameter isn't used for the MySQL or MariaDB engines.
\nThe database engine to use for the new instance.
\nDefault: The same as source
\nConstraint: Must be compatible with the engine of the source
\n\nValid Values:
\n \n\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-se2\n
\n oracle-se1\n
\n oracle-se\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
\nConstraints: Must be an integer greater than 1000.
\n\n SQL Server\n
\nSetting the IOPS value for the SQL Server database engine isn't supported.
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the option group to be used for the restored DB instance.
\n \nPermanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
" } }, "Tags": { "target": "com.amazonaws.rds#TagList" }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specifies the storage type to be associated with the DB instance.
\n\n Valid values: standard | gp2 | io1\n
\n If you specify io1, you must also include a value for the\n Iops parameter.\n
\n Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
The ARN from the key store with which to associate the instance for TDE encryption.
" } }, "TdeCredentialPassword": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The password for the given ARN from the key store in order to access the device.
" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { "smithy.api#documentation": "\n A list of EC2 VPC security groups to associate with this DB instance.\n
\n\n Default: The default EC2 VPC security group for the DB subnet group's VPC.\n
" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specify the Active Directory directory ID to restore the DB instance in.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { "smithy.api#documentation": "The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
" } }, "ProcessorFeatures": { "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
" } }, "UseDefaultProcessorFeatures": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether the DB instance class of the DB instance uses its default processor features.
" } }, "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the DB parameter group to associate with this DB instance.
\nIf you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.
Constraints:
\nIf supplied, must match the name of an existing DBParameterGroup.
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nA value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled. For more information, see \n \n Deleting a DB Instance.\n
" } }, "SourceDbiResourceId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The resource ID of the source DB instance from which to restore.
" } }, "MaxAllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
\nFor more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.
" } }, "SourceDBInstanceAutomatedBackupsArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, \n arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the AWS Outposts User Guide.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#RestoreDBInstanceToPointInTimeResult": { "type": "structure", "members": { "DBInstance": { "target": "com.amazonaws.rds#DBInstance" } } }, "com.amazonaws.rds#RestoreWindow": { "type": "structure", "members": { "EarliestTime": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "The earliest time you can restore an instance to.
" } }, "LatestTime": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "The latest time you can restore an instance to.
" } } }, "traits": { "smithy.api#documentation": "Earliest and latest time an instance can be restored to:
" } }, "com.amazonaws.rds#RevokeDBSecurityGroupIngress": { "type": "operation", "input": { "target": "com.amazonaws.rds#RevokeDBSecurityGroupIngressMessage" }, "output": { "target": "com.amazonaws.rds#RevokeDBSecurityGroupIngressResult" }, "errors": [ { "target": "com.amazonaws.rds#AuthorizationNotFoundFault" }, { "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" } ], "traits": { "smithy.api#documentation": "Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).
" } }, "com.amazonaws.rds#RevokeDBSecurityGroupIngressMessage": { "type": "structure", "members": { "DBSecurityGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the DB security group to revoke ingress from.
", "smithy.api#required": {} } }, "CIDRIP": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n The IP range to revoke access from. \n Must be a valid CIDR range. If CIDRIP is specified, \n EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId\n can't be provided.\n
\n The name of the EC2 security group to revoke access from.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.\n
\n The id of the EC2 security group to revoke access from.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.\n
\n The AWS account number of the owner of the EC2 security group\n specified in the EC2SecurityGroupName parameter.\n The AWS access key ID isn't an acceptable value.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.\n
SNS has responded that there is a problem with the SND topic specified.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#SNSNoAuthorizationFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "You do not have permission to publish to the SNS topic ARN.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#SNSTopicArnNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The SNS topic ARN does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.rds#ScalingConfiguration": { "type": "structure", "members": { "MinCapacity": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "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.
" } }, "MaxCapacity": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "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.
" } }, "AutoPause": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. \n 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. \n In this case, the DB cluster is restored when there is a request to connect to it.
\nThe time, in seconds, before an Aurora DB cluster in serverless mode is paused.
Specify a value between 300 and 86,400 seconds.
" } }, "TimeoutAction": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.
\n ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.
\n RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.
If you specify ForceApplyCapacityChange, connections that \n prevent Aurora Serverless from finding a scaling point might be dropped.
For more information, see \n Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.
" } } }, "traits": { "smithy.api#documentation": "Contains the scaling configuration of an Aurora Serverless DB cluster.
\nFor more information, see Using Amazon Aurora Serverless in the \n Amazon Aurora User Guide.
" } }, "com.amazonaws.rds#ScalingConfigurationInfo": { "type": "structure", "members": { "MinCapacity": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The maximum capacity for the Aurora DB cluster in serverless DB engine\n mode.
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
A value that indicates whether automatic pause is allowed for the Aurora DB cluster\n in serverless DB engine mode.
When the value is set to false for an Aurora Serverless DB cluster, the DB cluster automatically resumes.
" } }, "SecondsUntilAutoPause": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "The remaining amount of time, in seconds, before the Aurora DB cluster in\n serverless mode is paused. A DB cluster can be paused only when\n it's idle (it has no connections).
The timeout action of a call to ModifyCurrentDBClusterCapacity, either \n ForceApplyCapacityChange or RollbackCapacityChange.
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless in the \n Amazon Aurora User Guide.
" } }, "com.amazonaws.rds#SharedSnapshotQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#SnapshotQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The request would result in the user exceeding the allowed number of DB\n snapshots.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#SourceIdsList": { "type": "list", "member": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#xmlName": "SourceId" } } }, "com.amazonaws.rds#SourceNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The requested source could not be found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.rds#SourceRegion": { "type": "structure", "members": { "RegionName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the source AWS Region.
" } }, "Endpoint": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The endpoint for the source AWS Region endpoint.
" } }, "Status": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The status of the source AWS Region.
" } }, "SupportsDBInstanceAutomatedBackupsReplication": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Whether the source AWS Region supports replicating automated backups to the current AWS Region.
" } } }, "traits": { "smithy.api#documentation": "Contains an AWS Region name as the result of a successful call to the DescribeSourceRegions action.
\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
A list of SourceRegion instances that contains each source AWS Region that the\n current AWS Region can get a read replica or a DB snapshot from.
" } } }, "traits": { "smithy.api#documentation": "Contains the result of a successful invocation of the DescribeSourceRegions action.
Starts a database activity stream to monitor activity on the database.\n For more information, see Database Activity Streams\n in the Amazon Aurora User Guide.
" } }, "com.amazonaws.rds#StartActivityStreamRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the DB cluster,\n for example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.
Specifies the mode of the database activity stream.\n Database events such as a change or access generate an activity stream event.\n The database session can handle these events either synchronously or asynchronously.\n
", "smithy.api#required": {} } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The AWS KMS key identifier for encrypting messages in the database activity stream.\n The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
", "smithy.api#required": {} } }, "ApplyImmediately": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "Specifies whether or not the database activity stream is to start as soon as possible, \n regardless of the maintenance window for the database.
" } } } }, "com.amazonaws.rds#StartActivityStreamResponse": { "type": "structure", "members": { "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The AWS KMS key identifier for encryption of messages in the database activity stream.
" } }, "KinesisStreamName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the Amazon Kinesis data stream to be used for the database activity stream.
" } }, "Status": { "target": "com.amazonaws.rds#ActivityStreamStatus", "traits": { "smithy.api#documentation": "The status of the database activity stream.
" } }, "Mode": { "target": "com.amazonaws.rds#ActivityStreamMode", "traits": { "smithy.api#documentation": "The mode of the database activity stream.
" } }, "ApplyImmediately": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Indicates whether or not the database activity stream will start as soon as possible, \n regardless of the maintenance window for the database.
" } } } }, "com.amazonaws.rds#StartDBCluster": { "type": "operation", "input": { "target": "com.amazonaws.rds#StartDBClusterMessage" }, "output": { "target": "com.amazonaws.rds#StartDBClusterResult" }, "errors": [ { "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidDBClusterStateFault" }, { "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" } ], "traits": { "smithy.api#documentation": "Starts an Amazon Aurora DB cluster that was stopped using the AWS console, the stop-db-cluster\n AWS CLI command, or the StopDBCluster action.
\n \nFor more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nThe DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as\n a lowercase string.
", "smithy.api#required": {} } } } }, "com.amazonaws.rds#StartDBClusterResult": { "type": "structure", "members": { "DBCluster": { "target": "com.amazonaws.rds#DBCluster" } } }, "com.amazonaws.rds#StartDBInstance": { "type": "operation", "input": { "target": "com.amazonaws.rds#StartDBInstanceMessage" }, "output": { "target": "com.amazonaws.rds#StartDBInstanceResult" }, "errors": [ { "target": "com.amazonaws.rds#AuthorizationNotFoundFault" }, { "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, { "target": "com.amazonaws.rds#DBInstanceNotFoundFault" }, { "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" }, { "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" }, { "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" }, { "target": "com.amazonaws.rds#InvalidDBClusterStateFault" }, { "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" }, { "target": "com.amazonaws.rds#InvalidSubnet" }, { "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" }, { "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" } ], "traits": { "smithy.api#documentation": "\n Starts an Amazon RDS DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the StopDBInstance action.\n
\n \nFor more information, see \n \n Starting an Amazon RDS DB instance That Was Previously Stopped in the \n Amazon RDS User Guide.\n
\n \n\n This command doesn't apply to Aurora MySQL and Aurora PostgreSQL.\n For Aurora DB clusters, use StartDBCluster instead.\n
Enables replication of automated backups to a different AWS Region.
\nFor more information, see \n Replicating Automated Backups to Another AWS Region in the Amazon RDS User Guide.\n
" } }, "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationMessage": { "type": "structure", "members": { "SourceDBInstanceArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source DB instance for the replicated automated backups, for example, \n arn:aws:rds:us-west-2:123456789012:db:mydatabase.
The retention period for the replicated automated backups.
" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The AWS KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the\n Amazon Resource Name (ARN) for the KMS encryption key in the destination AWS Region, for example, \n arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.
A URL that contains a Signature Version 4 signed request for the StartDBInstanceAutomatedBackupsReplication action to be \n called in the AWS Region of the source DB instance. The presigned URL must be a valid request for the\n StartDBInstanceAutomatedBackupsReplication API action that can be executed in the AWS Region that contains\n the source DB instance.
" } } } }, "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationResult": { "type": "structure", "members": { "DBInstanceAutomatedBackup": { "target": "com.amazonaws.rds#DBInstanceAutomatedBackup" } } }, "com.amazonaws.rds#StartDBInstanceMessage": { "type": "structure", "members": { "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n The user-supplied instance identifier. \n
", "smithy.api#required": {} } } } }, "com.amazonaws.rds#StartDBInstanceResult": { "type": "structure", "members": { "DBInstance": { "target": "com.amazonaws.rds#DBInstance" } } }, "com.amazonaws.rds#StartExportTask": { "type": "operation", "input": { "target": "com.amazonaws.rds#StartExportTaskMessage" }, "output": { "target": "com.amazonaws.rds#ExportTask" }, "errors": [ { "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" }, { "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" }, { "target": "com.amazonaws.rds#ExportTaskAlreadyExistsFault" }, { "target": "com.amazonaws.rds#IamRoleMissingPermissionsFault" }, { "target": "com.amazonaws.rds#IamRoleNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidExportOnlyFault" }, { "target": "com.amazonaws.rds#InvalidExportSourceStateFault" }, { "target": "com.amazonaws.rds#InvalidS3BucketFault" }, { "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" } ], "traits": { "smithy.api#documentation": "Starts an export of a snapshot to Amazon S3. \n The provided IAM role must have access to the S3 bucket. \n
" } }, "com.amazonaws.rds#StartExportTaskMessage": { "type": "structure", "members": { "ExportTaskIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "A unique identifier for the snapshot export task. This ID isn't an identifier for\n the Amazon S3 bucket where the snapshot is to be exported to.
", "smithy.api#required": {} } }, "SourceArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3.
", "smithy.api#required": {} } }, "S3BucketName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the Amazon S3 bucket to export the snapshot to.
", "smithy.api#required": {} } }, "IamRoleArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the IAM role to use for writing to the Amazon S3 bucket \n when exporting a snapshot.
", "smithy.api#required": {} } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The ID of the AWS KMS customer master key (CMK) to use to encrypt the snapshot exported to Amazon S3. The AWS KMS \n key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). \n The caller of this operation must be authorized to \n execute the following operations. These can be set in the AWS KMS key policy:
\nGrantOperation.Encrypt
\nGrantOperation.Decrypt
\nGrantOperation.GenerateDataKey
\nGrantOperation.GenerateDataKeyWithoutPlaintext
\nGrantOperation.ReEncryptFrom
\nGrantOperation.ReEncryptTo
\nGrantOperation.CreateGrant
\nGrantOperation.DescribeKey
\nGrantOperation.RetireGrant
\nThe Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
" } }, "ExportOnly": { "target": "com.amazonaws.rds#StringList", "traits": { "smithy.api#documentation": "The data to be exported from the snapshot. \n If this parameter is not provided, all the snapshot data is exported.\n Valid values are the following:
\n\n database - Export all the data from a specified database.
\n database.table \n table-name - \n Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
\n database.schema \n schema-name - Export a database schema of the snapshot. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
\n database.schema.table \n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
Stops a database activity stream that was started using the AWS console, \n the start-activity-stream AWS CLI command, or the StartActivityStream action.
For more information, see \n Database Activity Streams\n in the Amazon Aurora User Guide.
" } }, "com.amazonaws.rds#StopActivityStreamRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the DB cluster for the database activity stream.\n For example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.\n
Specifies whether or not the database activity stream is to stop as soon as possible, \n regardless of the maintenance window for the database.
" } } } }, "com.amazonaws.rds#StopActivityStreamResponse": { "type": "structure", "members": { "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The AWS KMS key identifier used for encrypting messages in the database activity stream.
\nThe AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
" } }, "KinesisStreamName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the Amazon Kinesis data stream used for the database activity stream.
" } }, "Status": { "target": "com.amazonaws.rds#ActivityStreamStatus", "traits": { "smithy.api#documentation": "The status of the database activity stream.
" } } } }, "com.amazonaws.rds#StopDBCluster": { "type": "operation", "input": { "target": "com.amazonaws.rds#StopDBClusterMessage" }, "output": { "target": "com.amazonaws.rds#StopDBClusterResult" }, "errors": [ { "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, { "target": "com.amazonaws.rds#InvalidDBClusterStateFault" }, { "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" } ], "traits": { "smithy.api#documentation": "\n Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's\n metadata, including its endpoints and DB parameter groups. Aurora also\n retains the transaction logs so you can do a point-in-time restore if necessary.\n
\n \nFor more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nThe DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as\n a lowercase string.
", "smithy.api#required": {} } } } }, "com.amazonaws.rds#StopDBClusterResult": { "type": "structure", "members": { "DBCluster": { "target": "com.amazonaws.rds#DBCluster" } } }, "com.amazonaws.rds#StopDBInstance": { "type": "operation", "input": { "target": "com.amazonaws.rds#StopDBInstanceMessage" }, "output": { "target": "com.amazonaws.rds#StopDBInstanceResult" }, "errors": [ { "target": "com.amazonaws.rds#DBInstanceNotFoundFault" }, { "target": "com.amazonaws.rds#DBSnapshotAlreadyExistsFault" }, { "target": "com.amazonaws.rds#InvalidDBClusterStateFault" }, { "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" }, { "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "\n Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, \n DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if \n necessary.\n
\n \nFor more information, see \n \n Stopping an Amazon RDS DB Instance Temporarily in the \n Amazon RDS User Guide.\n
\n \n\n This command doesn't apply to Aurora MySQL and Aurora PostgreSQL.\n For Aurora clusters, use StopDBCluster instead.\n
Stops automated backup replication for a DB instance.
\nFor more information, see \n Replicating Automated Backups to Another AWS Region in the Amazon RDS User Guide.\n
" } }, "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationMessage": { "type": "structure", "members": { "SourceDBInstanceArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source DB instance for which to stop replicating automated backups, for example, \n arn:aws:rds:us-west-2:123456789012:db:mydatabase.
\n The user-supplied instance identifier.\n
", "smithy.api#required": {} } }, "DBSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "\n The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.\n
" } } } }, "com.amazonaws.rds#StopDBInstanceResult": { "type": "structure", "members": { "DBInstance": { "target": "com.amazonaws.rds#DBInstance" } } }, "com.amazonaws.rds#StorageQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The request would result in the user exceeding the allowed amount of storage\n available across all DB instances.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#StorageTypeNotSupportedFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "Storage of the StorageType specified can't be associated\n with the DB instance.
The identifier of the subnet.
" } }, "SubnetAvailabilityZone": { "target": "com.amazonaws.rds#AvailabilityZone" }, "SubnetOutpost": { "target": "com.amazonaws.rds#Outpost", "traits": { "smithy.api#documentation": "If the subnet is associated with an Outpost, this value specifies the Outpost.
\nFor more information about RDS on Outposts, see Amazon RDS on AWS Outposts \n in the Amazon RDS User Guide.\n
" } }, "SubnetStatus": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The status of the subnet.
" } } }, "traits": { "smithy.api#documentation": "\n This data type is used as a response element for the DescribeDBSubnetGroups operation.\n
The DB subnet is already in use in the Availability Zone.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#SubnetIdentifierList": { "type": "list", "member": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#xmlName": "SubnetIdentifier" } } }, "com.amazonaws.rds#SubnetList": { "type": "list", "member": { "target": "com.amazonaws.rds#Subnet", "traits": { "smithy.api#xmlName": "Subnet" } } }, "com.amazonaws.rds#SubscriptionAlreadyExistFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The supplied subscription name already exists.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rds#SubscriptionCategoryNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The supplied category does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.rds#SubscriptionNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.rds#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The subscription name does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.rds#SupportedCharacterSetsList": { "type": "list", "member": { "target": "com.amazonaws.rds#CharacterSet", "traits": { "smithy.api#xmlName": "CharacterSet" } } }, "com.amazonaws.rds#SupportedTimezonesList": { "type": "list", "member": { "target": "com.amazonaws.rds#Timezone", "traits": { "smithy.api#xmlName": "Timezone" } } }, "com.amazonaws.rds#TStamp": { "type": "timestamp" }, "com.amazonaws.rds#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "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, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").
" } }, "Value": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "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, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").
" } } }, "traits": { "smithy.api#documentation": "Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
" } }, "com.amazonaws.rds#TagList": { "type": "list", "member": { "target": "com.amazonaws.rds#Tag", "traits": { "smithy.api#xmlName": "Tag" } }, "traits": { "smithy.api#documentation": "A list of tags.\n For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. \n
" } }, "com.amazonaws.rds#TagListMessage": { "type": "structure", "members": { "TagList": { "target": "com.amazonaws.rds#TagList", "traits": { "smithy.api#documentation": "List of tags returned by the ListTagsForResource operation.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.rds#TargetGroupList": { "type": "list", "member": { "target": "com.amazonaws.rds#DBProxyTargetGroup" } }, "com.amazonaws.rds#TargetHealth": { "type": "structure", "members": { "State": { "target": "com.amazonaws.rds#TargetState", "traits": { "smithy.api#documentation": "The current state of the connection health lifecycle for the RDS Proxy target.\n The following is a typical lifecycle example for the states of an RDS Proxy target:\n
\n\n registering > unavailable > available > unavailable > available\n
The reason for the current health State of the RDS Proxy target.
A description of the health of the RDS Proxy target. \n If the State is AVAILABLE, a description is not included.
Information about the connection health of an RDS Proxy target.
" } }, "com.amazonaws.rds#TargetHealthReason": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "UNREACHABLE", "name": "UNREACHABLE" }, { "value": "CONNECTION_FAILED", "name": "CONNECTION_FAILED" }, { "value": "AUTH_FAILURE", "name": "AUTH_FAILURE" }, { "value": "PENDING_PROXY_CAPACITY", "name": "PENDING_PROXY_CAPACITY" }, { "value": "INVALID_REPLICATION_STATE", "name": "INVALID_REPLICATION_STATE" } ] } }, "com.amazonaws.rds#TargetList": { "type": "list", "member": { "target": "com.amazonaws.rds#DBProxyTarget" } }, "com.amazonaws.rds#TargetRole": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "READ_WRITE", "name": "READ_WRITE" }, { "value": "READ_ONLY", "name": "READ_ONLY" }, { "value": "UNKNOWN", "name": "UNKNOWN" } ] } }, "com.amazonaws.rds#TargetState": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "REGISTERING", "name": "registering" }, { "value": "AVAILABLE", "name": "available" }, { "value": "UNAVAILABLE", "name": "unavailable" } ] } }, "com.amazonaws.rds#TargetType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "RDS_INSTANCE", "name": "RDS_INSTANCE" }, { "value": "RDS_SERVERLESS_ENDPOINT", "name": "RDS_SERVERLESS_ENDPOINT" }, { "value": "TRACKED_CLUSTER", "name": "TRACKED_CLUSTER" } ] } }, "com.amazonaws.rds#Timezone": { "type": "structure", "members": { "TimezoneName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the time zone.
" } } }, "traits": { "smithy.api#documentation": "A time zone associated with a \n DBInstance \n or a DBSnapshot.\n This data type is an element in the response to \n the DescribeDBInstances, \n the DescribeDBSnapshots,\n and the DescribeDBEngineVersions\n actions.\n
The name of the upgrade target database engine.
" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The version number of the upgrade target database engine.
" } }, "Description": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The version of the database engine that a DB instance can be upgraded to.
" } }, "AutoUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.
A value that indicates whether upgrading to the target version requires upgrading the major version of the database engine.
" } }, "SupportedEngineModes": { "target": "com.amazonaws.rds#EngineModeList", "traits": { "smithy.api#documentation": "A list of the supported DB engine modes for the target engine version.
" } }, "SupportsParallelQuery": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether you can use Aurora parallel query with the target engine version.
" } }, "SupportsGlobalDatabases": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "A value that indicates whether you can use Aurora global databases with the target engine version.
" } } }, "traits": { "smithy.api#documentation": "The version of the database engine that a DB instance can be upgraded to.
" } }, "com.amazonaws.rds#UserAuthConfig": { "type": "structure", "members": { "Description": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "A user-specified description about the authentication used by a proxy to log in as a specific database user.
" } }, "UserName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the database user to which the proxy connects.
" } }, "AuthScheme": { "target": "com.amazonaws.rds#AuthScheme", "traits": { "smithy.api#documentation": "The type of authentication that the proxy uses for connections from the proxy to the underlying database.
" } }, "SecretArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate\n to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
" } }, "IAMAuth": { "target": "com.amazonaws.rds#IAMAuthMode", "traits": { "smithy.api#documentation": "Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
" } } }, "traits": { "smithy.api#documentation": "Specifies the details of authentication used by a proxy to log in as a specific database user.
" } }, "com.amazonaws.rds#UserAuthConfigInfo": { "type": "structure", "members": { "Description": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "A user-specified description about the authentication used by a proxy to log in as a specific database user.
" } }, "UserName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the database user to which the proxy connects.
" } }, "AuthScheme": { "target": "com.amazonaws.rds#AuthScheme", "traits": { "smithy.api#documentation": "The type of authentication that the proxy uses for connections from the proxy to the underlying database.
" } }, "SecretArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate\n to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
" } }, "IAMAuth": { "target": "com.amazonaws.rds#IAMAuthMode", "traits": { "smithy.api#documentation": "Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
" } } }, "traits": { "smithy.api#documentation": "Returns the details of authentication used by a proxy to log in as a specific database user.
" } }, "com.amazonaws.rds#UserAuthConfigInfoList": { "type": "list", "member": { "target": "com.amazonaws.rds#UserAuthConfigInfo" } }, "com.amazonaws.rds#UserAuthConfigList": { "type": "list", "member": { "target": "com.amazonaws.rds#UserAuthConfig" } }, "com.amazonaws.rds#ValidDBInstanceModificationsMessage": { "type": "structure", "members": { "Storage": { "target": "com.amazonaws.rds#ValidStorageOptionsList", "traits": { "smithy.api#documentation": "Valid storage options for your DB instance.\n
" } }, "ValidProcessorFeatures": { "target": "com.amazonaws.rds#AvailableProcessorFeatureList", "traits": { "smithy.api#documentation": "Valid processor features for your DB instance.\n
" } } }, "traits": { "smithy.api#documentation": "Information about valid modifications that you can make to your DB instance.\n Contains the result of a successful call to the \n DescribeValidDBInstanceModifications action.\n You can use this information when you call\n ModifyDBInstance.\n
The valid storage types for your DB instance.\n For example, gp2, io1.\n
" } }, "StorageSize": { "target": "com.amazonaws.rds#RangeList", "traits": { "smithy.api#documentation": "The valid range of storage in gibibytes.\n For example, 100 to 16384. \n
" } }, "ProvisionedIops": { "target": "com.amazonaws.rds#RangeList", "traits": { "smithy.api#documentation": "The valid range of provisioned IOPS.\n For example, 1000-20000.\n
" } }, "IopsToStorageRatio": { "target": "com.amazonaws.rds#DoubleRangeList", "traits": { "smithy.api#documentation": "The valid range of Provisioned IOPS to gibibytes of storage multiplier.\n For example, 3-10,\n which means that provisioned IOPS can be between 3 and 10 times storage.\n
" } }, "SupportsStorageAutoscaling": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "Whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.
" } } }, "traits": { "smithy.api#documentation": "Information about valid modifications that you can make to your DB instance.\n Contains the result of a successful call to the \n DescribeValidDBInstanceModifications action.\n
The name of the VPC security group.
" } }, "Status": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The status of the VPC security group.
" } } }, "traits": { "smithy.api#documentation": "This data type is used as a response element for queries on VPC security group membership.
" } }, "com.amazonaws.rds#VpcSecurityGroupMembershipList": { "type": "list", "member": { "target": "com.amazonaws.rds#VpcSecurityGroupMembership", "traits": { "smithy.api#xmlName": "VpcSecurityGroupMembership" } } }, "com.amazonaws.rds#VpnDetails": { "type": "structure", "members": { "VpnId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The ID of the VPN.
" } }, "VpnTunnelOriginatorIP": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.
" } }, "VpnGatewayIp": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The IP address of network traffic from AWS to your on-premises data center.
" } }, "VpnPSK": { "target": "com.amazonaws.rds#StringSensitive", "traits": { "smithy.api#documentation": "The preshared key (PSK) for the VPN.
" } }, "VpnName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The name of the VPN.
" } }, "VpnState": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "The state of the VPN.
" } } }, "traits": { "smithy.api#documentation": "Information about the virtual private network (VPN) between the VMware vSphere cluster and the AWS website.
\nFor more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n
" } }, "com.amazonaws.rds#WriteForwardingStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "enabled", "name": "ENABLED" }, { "value": "disabled", "name": "DISABLED" }, { "value": "enabling", "name": "ENABLING" }, { "value": "disabling", "name": "DISABLING" }, { "value": "unknown", "name": "UNKNOWN" } ] } } } }