From dce784598e359f01a29258260ffb0a231e4c8e27 Mon Sep 17 00:00:00 2001 From: Jonathan Eskew Date: Thu, 30 Jul 2015 13:09:04 -0700 Subject: [PATCH] Update models for next release --- src/data/opsworks/2013-02-18/api-2.json | 121 +- src/data/opsworks/2013-02-18/docs-2.json | 92 +- src/data/opsworks/2013-02-18/waiters-2.json | 17 + src/data/rds/2014-10-31/api-2.json | 1803 +++++++++++++++++-- src/data/rds/2014-10-31/docs-2.json | 627 ++++++- 5 files changed, 2428 insertions(+), 232 deletions(-) diff --git a/src/data/opsworks/2013-02-18/api-2.json b/src/data/opsworks/2013-02-18/api-2.json index 2d4e5b7d17..124830319c 100644 --- a/src/data/opsworks/2013-02-18/api-2.json +++ b/src/data/opsworks/2013-02-18/api-2.json @@ -297,6 +297,24 @@ } ] }, + "DeregisterEcsCluster":{ + "name":"DeregisterEcsCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterEcsClusterRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "exception":true + } + ] + }, "DeregisterElasticIp":{ "name":"DeregisterElasticIp", "http":{ @@ -445,6 +463,25 @@ } ] }, + "DescribeEcsClusters":{ + "name":"DescribeEcsClusters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEcsClustersRequest"}, + "output":{"shape":"DescribeEcsClustersResult"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "exception":true + } + ] + }, "DescribeElasticIps":{ "name":"DescribeElasticIps", "http":{ @@ -826,6 +863,25 @@ } ] }, + "RegisterEcsCluster":{ + "name":"RegisterEcsCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterEcsClusterRequest"}, + "output":{"shape":"RegisterEcsClusterResult"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "exception":true + } + ] + }, "RegisterElasticIp":{ "name":"RegisterElasticIp", "http":{ @@ -1263,12 +1319,14 @@ "enum":[ "DocumentRoot", "RailsEnv", - "AutoBundleOnDeploy" + "AutoBundleOnDeploy", + "AwsFlowRubySettings" ] }, "AppType":{ "type":"string", "enum":[ + "aws-flow-ruby", "java", "rails", "php", @@ -1522,6 +1580,7 @@ "Shortname":{"shape":"String"}, "Attributes":{"shape":"LayerAttributes"}, "CustomInstanceProfileArn":{"shape":"String"}, + "CustomJson":{"shape":"String"}, "CustomSecurityGroupIds":{"shape":"Strings"}, "Packages":{"shape":"Strings"}, "VolumeConfigurations":{"shape":"VolumeConfigurations"}, @@ -1698,6 +1757,13 @@ "type":"list", "member":{"shape":"Deployment"} }, + "DeregisterEcsClusterRequest":{ + "type":"structure", + "required":["EcsClusterArn"], + "members":{ + "EcsClusterArn":{"shape":"String"} + } + }, "DeregisterElasticIpRequest":{ "type":"structure", "required":["ElasticIp"], @@ -1780,6 +1846,22 @@ "Deployments":{"shape":"Deployments"} } }, + "DescribeEcsClustersRequest":{ + "type":"structure", + "members":{ + "EcsClusterArns":{"shape":"Strings"}, + "StackId":{"shape":"String"}, + "NextToken":{"shape":"String"}, + "MaxResults":{"shape":"Integer"} + } + }, + "DescribeEcsClustersResult":{ + "type":"structure", + "members":{ + "EcsClusters":{"shape":"EcsClusters"}, + "NextToken":{"shape":"String"} + } + }, "DescribeElasticIpsRequest":{ "type":"structure", "members":{ @@ -2019,6 +2101,19 @@ "DeleteOnTermination":{"shape":"Boolean"} } }, + "EcsCluster":{ + "type":"structure", + "members":{ + "EcsClusterArn":{"shape":"String"}, + "EcsClusterName":{"shape":"String"}, + "StackId":{"shape":"String"}, + "RegisteredAt":{"shape":"DateTime"} + } + }, + "EcsClusters":{ + "type":"list", + "member":{"shape":"EcsCluster"} + }, "ElasticIp":{ "type":"structure", "members":{ @@ -2108,6 +2203,8 @@ "CreatedAt":{"shape":"DateTime"}, "EbsOptimized":{"shape":"Boolean"}, "Ec2InstanceId":{"shape":"String"}, + "EcsClusterArn":{"shape":"String"}, + "EcsContainerInstanceArn":{"shape":"String"}, "ElasticIp":{"shape":"String"}, "Hostname":{"shape":"String"}, "InfrastructureClass":{"shape":"String"}, @@ -2187,6 +2284,7 @@ "Shortname":{"shape":"String"}, "Attributes":{"shape":"LayerAttributes"}, "CustomInstanceProfileArn":{"shape":"String"}, + "CustomJson":{"shape":"String"}, "CustomSecurityGroupIds":{"shape":"Strings"}, "DefaultSecurityGroupNames":{"shape":"Strings"}, "Packages":{"shape":"Strings"}, @@ -2210,6 +2308,7 @@ "LayerAttributesKeys":{ "type":"string", "enum":[ + "EcsClusterArn", "EnableHaproxyStats", "HaproxyStatsUrl", "HaproxyStatsUser", @@ -2239,6 +2338,8 @@ "LayerType":{ "type":"string", "enum":[ + "aws-flow-ruby", + "ecs-cluster", "java-app", "lb", "web", @@ -2356,6 +2457,23 @@ "Shutdown":{"shape":"Strings"} } }, + "RegisterEcsClusterRequest":{ + "type":"structure", + "required":[ + "EcsClusterArn", + "StackId" + ], + "members":{ + "EcsClusterArn":{"shape":"String"}, + "StackId":{"shape":"String"} + } + }, + "RegisterEcsClusterResult":{ + "type":"structure", + "members":{ + "EcsClusterArn":{"shape":"String"} + } + }, "RegisterElasticIpRequest":{ "type":"structure", "required":[ @@ -2716,6 +2834,7 @@ "Shortname":{"shape":"String"}, "Attributes":{"shape":"LayerAttributes"}, "CustomInstanceProfileArn":{"shape":"String"}, + "CustomJson":{"shape":"String"}, "CustomSecurityGroupIds":{"shape":"Strings"}, "Packages":{"shape":"Strings"}, "VolumeConfigurations":{"shape":"VolumeConfigurations"}, diff --git a/src/data/opsworks/2013-02-18/docs-2.json b/src/data/opsworks/2013-02-18/docs-2.json index 427b9734c1..d38f446b32 100644 --- a/src/data/opsworks/2013-02-18/docs-2.json +++ b/src/data/opsworks/2013-02-18/docs-2.json @@ -1,7 +1,7 @@ { "version": "2.0", "operations": { - "AssignInstance": "

Assign a registered instance to a layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

", + "AssignInstance": "

Assign a registered instance to a layer.

Required Permissions: To use this action, an AWS Identity and Access Management (IAM) user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

", "AssignVolume": "

Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be registered with the stack by calling RegisterVolume. After you register the volume, you must call UpdateVolume to specify a mount point before calling AssignVolume. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

", "AssociateElasticIp": "

Associates one of the stack's registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling RegisterElasticIp. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

", "AttachElasticLoadBalancer": "

Attaches an Elastic Load Balancing load balancer to a specified layer. For more information, see Elastic Load Balancing.

You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see Elastic Load Balancing Developer Guide.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

", @@ -17,6 +17,7 @@ "DeleteLayer": "

Deletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see How to Delete a Layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

", "DeleteStack": "

Deletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see Shut Down a Stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

", "DeleteUserProfile": "

Deletes a user profile.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

", + "DeregisterEcsCluster": "

Deregisters a specified Amazon ECS cluster from a stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see .

", "DeregisterElasticIp": "

Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

", "DeregisterInstance": "

Deregister a registered Amazon EC2 or on-premises instance. This action removes the instance from the stack and returns it to your control. This action can not be used with instances that were created with AWS OpsWorks.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

", "DeregisterRdsDbInstance": "

Deregisters an Amazon RDS instance.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

", @@ -25,6 +26,7 @@ "DescribeApps": "

Requests a description of a specified set of apps.

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

", "DescribeCommands": "

Describes the results of specified commands.

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

", "DescribeDeployments": "

Requests a description of a specified set of deployments.

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

", + "DescribeEcsClusters": "

Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the MaxResults and NextToken parameters to paginate the response. However, AWS OpsWorks currently supports only one cluster per layer, so the result set has a maximum of one element.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information on user permissions, see Managing User Permissions.

", "DescribeElasticIps": "

Describes Elastic IP addresses.

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

", "DescribeElasticLoadBalancers": "

Describes a stack's Elastic Load Balancing instances.

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

", "DescribeInstances": "

Requests a description of a set of instances.

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

", @@ -46,6 +48,7 @@ "GetHostnameSuggestion": "

Gets a generated host name for the specified layer, based on the current host name theme.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

", "GrantAccess": "This action can be used only with Windows stacks.

Grants RDP access to a Windows instance for a specified time period.

", "RebootInstance": "

Reboots a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

", + "RegisterEcsCluster": "

Registers a specified Amazon ECS cluster with a stack. You can register only one cluster with a stack. A cluster can be registered with only one stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

", "RegisterElasticIp": "

Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling DeregisterElasticIp. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

", "RegisterInstance": "

Registers instances with a specified stack that were created outside of AWS OpsWorks.

We do not recommend using this action to register instances. The complete registration operation has two primary steps, installing the AWS OpsWorks agent on the instance and registering the instance with the stack. RegisterInstance handles only the second step. You should instead use the AWS CLI register command, which performs the entire registration operation. For more information, see Registering an Instance with an AWS OpsWorks Stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

", "RegisterRdsDbInstance": "

Registers an Amazon RDS instance with a stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

", @@ -69,7 +72,7 @@ "UpdateUserProfile": "

Updates a specified user profile.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

", "UpdateVolume": "

Updates an Amazon EBS volume's name or mount point. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, - "service": "AWS OpsWorks

Welcome to the AWS OpsWorks API Reference. This guide provides descriptions, syntax, and usage examples about AWS OpsWorks actions and data types, including common parameters and error codes.

AWS OpsWorks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the AWS OpsWorks details page.

SDKs and CLI

The most common way to use the AWS OpsWorks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:

Endpoints

AWS OpsWorks supports only one endpoint, opsworks.us-east-1.amazonaws.com (HTTPS), so you must connect to that endpoint. You can then use the API to direct AWS OpsWorks to create stacks in any AWS Region.

Chef Versions

When you call CreateStack, CloneStack, or UpdateStack we recommend you use the ConfigurationManager parameter to specify the Chef version, 0.9, 11.4, or 11.10. The default value is currently 11.10. For more information, see Chef Versions.

You can still specify Chef 0.9 for your stack, but new features are not available for Chef 0.9 stacks, and support is scheduled to end on July 24, 2014. We do not recommend using Chef 0.9 for new stacks, and we recommend migrating your existing Chef 0.9 stacks to Chef 11.10 as soon as possible.", + "service": "AWS OpsWorks

Welcome to the AWS OpsWorks API Reference. This guide provides descriptions, syntax, and usage examples about AWS OpsWorks actions and data types, including common parameters and error codes.

AWS OpsWorks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the AWS OpsWorks details page.

SDKs and CLI

The most common way to use the AWS OpsWorks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:

Endpoints

AWS OpsWorks supports only one endpoint, opsworks.us-east-1.amazonaws.com (HTTPS), so you must connect to that endpoint. You can then use the API to direct AWS OpsWorks to create stacks in any AWS Region.

Chef Versions

When you call CreateStack, CloneStack, or UpdateStack we recommend you use the ConfigurationManager parameter to specify the Chef version. The recommended value for Linux stacks, which is also the default value, is currently 11.10. Windows stacks use Chef 12.2. For more information, see Chef Versions.

You can also specify Chef 11.4 or Chef 0.9 for your Linux stack. However, Chef 0.9 has been deprecated. We do not recommend using Chef 0.9 for new stacks, and we recommend migrating your existing Chef 0.9 stacks to Chef 11.10 as soon as possible.", "shapes": { "AgentVersion": { "base": "

Describes an agent version.

", @@ -181,7 +184,7 @@ "App$EnableSsl": "

Whether to enable SSL for the app.

", "ChefConfiguration$ManageBerkshelf": "

Whether to enable Berkshelf.

", "CloneStackRequest$UseCustomCookbooks": "

Whether to use custom cookbooks.

", - "CloneStackRequest$UseOpsworksSecurityGroups": "

Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.

AWS OpsWorks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:

For more information, see Create a New Stack.

", + "CloneStackRequest$UseOpsworksSecurityGroups": "

Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.

AWS OpsWorks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:

For more information, see Create a New Stack.

", "CloneStackRequest$ClonePermissions": "

Whether to clone the source stack's permissions.

", "CreateAppRequest$EnableSsl": "

Whether to enable SSL for the app.

", "CreateInstanceRequest$InstallUpdatesOnBoot": "

Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true to ensure that your instances have the latest security updates.

", @@ -189,7 +192,7 @@ "CreateLayerRequest$EnableAutoHealing": "

Whether to disable auto healing for the layer.

", "CreateLayerRequest$AutoAssignElasticIps": "

Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.

", "CreateLayerRequest$AutoAssignPublicIps": "

For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.

", - "CreateLayerRequest$InstallUpdatesOnBoot": "

Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

", + "CreateLayerRequest$InstallUpdatesOnBoot": "

Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

To ensure that your instances have the latest security updates, we strongly recommend using the default value of true.

", "CreateLayerRequest$UseEbsOptimizedInstances": "

Whether to use Amazon EBS-optimized instances.

", "CreateStackRequest$UseCustomCookbooks": "

Whether the stack uses custom cookbooks.

", "CreateStackRequest$UseOpsworksSecurityGroups": "

Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.

AWS OpsWorks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:

For more information, see Create a New Stack.

", @@ -354,6 +357,7 @@ "Command$CompletedAt": "

Date when the command completed.

", "Deployment$CreatedAt": "

Date when the deployment was created.

", "Deployment$CompletedAt": "

Date when the deployment completed.

", + "EcsCluster$RegisteredAt": "

The time and date that the cluster was registered with the stack.

", "Instance$CreatedAt": "

The time that the instance was created.

", "Layer$CreatedAt": "

Date when the layer was created.

", "RaidArray$CreatedAt": "

When the RAID array was created.

", @@ -417,6 +421,11 @@ "DescribeDeploymentsResult$Deployments": "

An array of Deployment objects that describe the deployments.

" } }, + "DeregisterEcsClusterRequest": { + "base": null, + "refs": { + } + }, "DeregisterElasticIpRequest": { "base": null, "refs": { @@ -477,6 +486,16 @@ "refs": { } }, + "DescribeEcsClustersRequest": { + "base": null, + "refs": { + } + }, + "DescribeEcsClustersResult": { + "base": "

Contains the response to a DescribeEcsClusters request.

", + "refs": { + } + }, "DescribeElasticIpsRequest": { "base": null, "refs": { @@ -656,6 +675,18 @@ "BlockDeviceMapping$Ebs": "

An EBSBlockDevice that defines how to configure an Amazon EBS volume when the instance is launched.

" } }, + "EcsCluster": { + "base": "

Describes a registered Amazon ECS cluster.

", + "refs": { + "EcsClusters$member": null + } + }, + "EcsClusters": { + "base": null, + "refs": { + "DescribeEcsClustersResult$EcsClusters": "

A list of EcsCluster objects containing the cluster descriptions.

" + } + }, "ElasticIp": { "base": "

Describes an Elastic IP address.

", "refs": { @@ -750,6 +781,7 @@ "AutoScalingThresholds$InstanceCount": "

The number of instances to add or remove when the load exceeds a threshold.

", "Command$ExitCode": "

The command exit code.

", "Deployment$Duration": "

The deployment duration.

", + "DescribeEcsClustersRequest$MaxResults": "

To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

", "EbsBlockDevice$Iops": "

The number of I/O operations per second (IOPS) that the volume supports. For more information, see EbsBlockDevice.

", "EbsBlockDevice$VolumeSize": "

The volume size, in GiB. For more information, see EbsBlockDevice.

", "InstancesCount$Assigning": "

The number of instances in the Assigning state.

", @@ -796,8 +828,8 @@ "LayerAttributes": { "base": null, "refs": { - "CreateLayerRequest$Attributes": "

One or more user-defined key/value pairs to be added to the stack attributes.

", - "Layer$Attributes": "

The layer attributes.

For the HaproxyStatsPassword, MysqlRootPassword, and GangliaPassword attributes, AWS OpsWorks returns *****FILTERED***** instead of the actual value", + "CreateLayerRequest$Attributes": "

One or more user-defined key-value pairs to be added to the stack attributes.

To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN.

", + "Layer$Attributes": "

The layer attributes.

For the HaproxyStatsPassword, MysqlRootPassword, and GangliaPassword attributes, AWS OpsWorks returns *****FILTERED***** instead of the actual value

For an ECS Cluster layer, AWS OpsWorks the EcsClusterArn attribute is set to the cluster's ARN.

", "UpdateLayerRequest$Attributes": "

One or more user-defined key/value pairs to be added to the stack attributes.

" } }, @@ -823,7 +855,7 @@ "LifecycleEventConfiguration": { "base": "

Specifies the lifecycle event configuration

", "refs": { - "CreateLayerRequest$LifecycleEventConfiguration": "

A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.

", + "CreateLayerRequest$LifecycleEventConfiguration": "

A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.

", "Layer$LifecycleEventConfiguration": "

A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.

", "UpdateLayerRequest$LifecycleEventConfiguration": "

" } @@ -903,6 +935,16 @@ "UpdateLayerRequest$CustomRecipes": "

A LayerCustomRecipes object that specifies the layer's custom recipes.

" } }, + "RegisterEcsClusterRequest": { + "base": null, + "refs": { + } + }, + "RegisterEcsClusterResult": { + "base": "

Contains the response to a RegisterEcsCluster request.

", + "refs": { + } + }, "RegisterElasticIpRequest": { "base": null, "refs": { @@ -1116,8 +1158,8 @@ "CloneStackRequest$Region": "

The cloned stack AWS region, such as \"us-east-1\". For more information about AWS regions, see Regions and Endpoints.

", "CloneStackRequest$VpcId": "

The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All instances are launched into this VPC, and you cannot change the ID later.

If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.

If you specify a nondefault VPC ID, note the following:

For more information on how to use AWS OpsWorks with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2 Classic, see Supported Platforms.

", "CloneStackRequest$ServiceRoleArn": "

The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. If you create a stack by using the AWS OpsWorks console, it creates the role for you. You can obtain an existing stack's IAM ARN programmatically by calling DescribePermissions. For more information about IAM ARNs, see Using Identifiers.

You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly.

", - "CloneStackRequest$DefaultInstanceProfileArn": "

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

", - "CloneStackRequest$DefaultOs": "

The stack's operating system, which must be set to one of the following.

The default option is the parent stack's operating system. For more information on the supported operating systems, see AWS OpsWorks Operating Systems.

You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux.", + "CloneStackRequest$DefaultInstanceProfileArn": "

The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

", + "CloneStackRequest$DefaultOs": "

The stack's operating system, which must be set to one of the following.

The default option is the parent stack's operating system. For more information on the supported operating systems, see AWS OpsWorks Operating Systems.

You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux.", "CloneStackRequest$HostnameTheme": "

The stack's host name theme, with spaces are replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

", "CloneStackRequest$DefaultAvailabilityZone": "

The cloned stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description.

", "CloneStackRequest$DefaultSubnetId": "

The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.

", @@ -1144,7 +1186,7 @@ "CreateInstanceRequest$StackId": "

The stack ID.

", "CreateInstanceRequest$InstanceType": "

The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

", "CreateInstanceRequest$Hostname": "

The instance host name.

", - "CreateInstanceRequest$Os": "

The instance's operating system, which must be set to one of the following.

For more information on the supported operating systems, see AWS OpsWorks Operating Systems.

The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. For more information on the supported operating systems, see Operating SystemsFor more information on how to use custom AMIs with AWS OpsWorks, see Using Custom AMIs.

", + "CreateInstanceRequest$Os": "

The instance's operating system, which must be set to one of the following.

For more information on the supported operating systems, see AWS OpsWorks Operating Systems.

The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. For more information on the supported operating systems, see Operating SystemsFor more information on how to use custom AMIs with AWS OpsWorks, see Using Custom AMIs.

", "CreateInstanceRequest$AmiId": "

A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs.

If you specify a custom AMI, you must set Os to Custom.", "CreateInstanceRequest$SshKeyName": "

The instance's Amazon EC2 key-pair name.

", "CreateInstanceRequest$AvailabilityZone": "

The instance Availability Zone. For more information, see Regions and Endpoints.

", @@ -1154,15 +1196,16 @@ "CreateInstanceResult$InstanceId": "

The instance ID.

", "CreateLayerRequest$StackId": "

The layer stack ID.

", "CreateLayerRequest$Name": "

The layer name, which is used by the console.

", - "CreateLayerRequest$Shortname": "

For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.

The built-in layers' short names are defined by AWS OpsWorks. For more information, see the Layer Reference

", - "CreateLayerRequest$CustomInstanceProfileArn": "

The ARN of an IAM profile that to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

", + "CreateLayerRequest$Shortname": "

For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.

The built-in layers' short names are defined by AWS OpsWorks. For more information, see the Layer Reference.

", + "CreateLayerRequest$CustomInstanceProfileArn": "

The ARN of an IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

", + "CreateLayerRequest$CustomJson": "

A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON.

", "CreateLayerResult$LayerId": "

The layer ID.

", "CreateStackRequest$Name": "

The stack name.

", "CreateStackRequest$Region": "

The stack's AWS region, such as \"us-east-1\". For more information about Amazon regions, see Regions and Endpoints.

", "CreateStackRequest$VpcId": "

The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later.

If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.

If you specify a nondefault VPC ID, note the following:

For more information on how to use AWS OpsWorks with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2-Classic, see Supported Platforms.

", "CreateStackRequest$ServiceRoleArn": "

The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers.

", "CreateStackRequest$DefaultInstanceProfileArn": "

The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

", - "CreateStackRequest$DefaultOs": "

The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following.

The default option is the current Amazon Linux version. For more information on the supported operating systems, see AWS OpsWorks Operating Systems.

", + "CreateStackRequest$DefaultOs": "

The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following.

The default option is the current Amazon Linux version. For more information on the supported operating systems, see AWS OpsWorks Operating Systems.

", "CreateStackRequest$HostnameTheme": "

The stack's host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

", "CreateStackRequest$DefaultAvailabilityZone": "

The stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description.

", "CreateStackRequest$DefaultSubnetId": "

The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.

", @@ -1190,6 +1233,7 @@ "Deployment$Status": "

The deployment status:

", "Deployment$CustomJson": "

A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. The string should be in the following format and must escape characters such as '\"':

\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

", "DeploymentCommandArgs$key": null, + "DeregisterEcsClusterRequest$EcsClusterArn": "

The cluster's ARN.

", "DeregisterElasticIpRequest$ElasticIp": "

The Elastic IP address.

", "DeregisterInstanceRequest$InstanceId": "

The instance ID.

", "DeregisterRdsDbInstanceRequest$RdsDbInstanceArn": "

The Amazon RDS instance's ARN.

", @@ -1200,6 +1244,9 @@ "DescribeCommandsRequest$InstanceId": "

The instance ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified instance.

", "DescribeDeploymentsRequest$StackId": "

The stack ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified stack.

", "DescribeDeploymentsRequest$AppId": "

The app ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified app.

", + "DescribeEcsClustersRequest$StackId": "

A stack ID. DescribeEcsClusters returns a description of the cluster that is registered with the stack.

", + "DescribeEcsClustersRequest$NextToken": "

If the previous paginated request did not return all of the remaining results, the response object'sNextToken parameter value is set to a token. To retrieve the next set of results, call DescribeEcsClusters again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

", + "DescribeEcsClustersResult$NextToken": "

If a paginated request does not return all of the remaining results, this parameter is set to a token that you can assign to the request object's NextToken parameter to retrieve the next set of results. If the previous paginated request returned all of the remaining results, this parameter is set to null.

", "DescribeElasticIpsRequest$InstanceId": "

The instance ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses associated with the specified instance.

", "DescribeElasticIpsRequest$StackId": "

A stack ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses that are registered with the specified stack.

", "DescribeElasticLoadBalancersRequest$StackId": "

A stack ID. The action describes the stack's Elastic Load Balancing instances.

", @@ -1223,6 +1270,9 @@ "DetachElasticLoadBalancerRequest$LayerId": "

The ID of the layer that the Elastic Load Balancing instance is attached to.

", "DisassociateElasticIpRequest$ElasticIp": "

The Elastic IP address.

", "EbsBlockDevice$SnapshotId": "

The snapshot ID.

", + "EcsCluster$EcsClusterArn": "

The cluster's ARN.

", + "EcsCluster$EcsClusterName": "

The cluster name.

", + "EcsCluster$StackId": "

The stack ID.

", "ElasticIp$Ip": "

The IP address.

", "ElasticIp$Name": "

The name.

", "ElasticIp$Domain": "

The domain.

", @@ -1244,6 +1294,8 @@ "Instance$AmiId": "

A custom AMI ID to be used to create the instance. For more information, see Instances

", "Instance$AvailabilityZone": "

The instance Availability Zone. For more information, see Regions and Endpoints.

", "Instance$Ec2InstanceId": "

The ID of the associated Amazon EC2 instance.

", + "Instance$EcsClusterArn": "

For container instances, the Amazon ECS cluster's ARN.

", + "Instance$EcsContainerInstanceArn": "

For container instances, the instance's ARN.

", "Instance$ElasticIp": "

The instance Elastic IP address .

", "Instance$Hostname": "

The instance host name.

", "Instance$InfrastructureClass": "

For registered instances, the infrastructure class: ec2 or on-premises.

", @@ -1273,6 +1325,7 @@ "Layer$Name": "

The layer name.

", "Layer$Shortname": "

The layer short name.

", "Layer$CustomInstanceProfileArn": "

The ARN of the default IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

", + "Layer$CustomJson": "

A JSON formatted string containing the layer's custom stack configuration and deployment attributes.

", "LayerAttributes$value": null, "LoadBasedAutoScalingConfiguration$LayerId": "

The layer ID.

", "Parameters$key": null, @@ -1297,6 +1350,9 @@ "RdsDbInstance$Engine": "

The instance's database engine.

", "RdsDbInstance$StackId": "

The ID of the stack that the instance is registered with.

", "RebootInstanceRequest$InstanceId": "

The instance ID.

", + "RegisterEcsClusterRequest$EcsClusterArn": "

The cluster's ARN.

", + "RegisterEcsClusterRequest$StackId": "

The stack ID.

", + "RegisterEcsClusterResult$EcsClusterArn": "

The cluster's ARN.

", "RegisterElasticIpRequest$ElasticIp": "

The Elastic IP address.

", "RegisterElasticIpRequest$StackId": "

The stack ID.

", "RegisterElasticIpResult$ElasticIp": "

The Elastic IP address.

", @@ -1379,7 +1435,7 @@ "UpdateInstanceRequest$InstanceId": "

The instance ID.

", "UpdateInstanceRequest$InstanceType": "

The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

", "UpdateInstanceRequest$Hostname": "

The instance host name.

", - "UpdateInstanceRequest$Os": "

The instance's operating system, which must be set to one of the following.

For more information on the supported operating systems, see AWS OpsWorks Operating Systems.

The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the AmiId parameter to specify the custom AMI that you want to use. For more information on the supported operating systems, see Operating Systems. For more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs.

You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux.", + "UpdateInstanceRequest$Os": "

The instance's operating system, which must be set to one of the following.

For more information on the supported operating systems, see AWS OpsWorks Operating Systems.

The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the AmiId parameter to specify the custom AMI that you want to use. For more information on the supported operating systems, see Operating Systems. For more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs.

You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux.", "UpdateInstanceRequest$AmiId": "

A custom AMI ID to be used to create the instance. The AMI must be based on one of the supported operating systems. For more information, see Instances

If you specify a custom AMI, you must set Os to Custom.", "UpdateInstanceRequest$SshKeyName": "

The instance's Amazon EC2 key name.

", "UpdateInstanceRequest$AgentVersion": "

The default AWS OpsWorks agent version. You have the following options:

The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions.

", @@ -1387,15 +1443,16 @@ "UpdateLayerRequest$Name": "

The layer name, which is used by the console.

", "UpdateLayerRequest$Shortname": "

For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorksand by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\\A[a-z0-9\\-\\_\\.]+\\Z/.

The built-in layers' short names are defined by AWS OpsWorks. For more information, see the Layer Reference

", "UpdateLayerRequest$CustomInstanceProfileArn": "

The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

", + "UpdateLayerRequest$CustomJson": "

A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON.

", "UpdateMyUserProfileRequest$SshPublicKey": "

The user's SSH public key.

", "UpdateRdsDbInstanceRequest$RdsDbInstanceArn": "

The Amazon RDS instance's ARN.

", "UpdateRdsDbInstanceRequest$DbUser": "

The master user name.

", "UpdateRdsDbInstanceRequest$DbPassword": "

The database password.

", "UpdateStackRequest$StackId": "

The stack ID.

", "UpdateStackRequest$Name": "

The stack's new name.

", - "UpdateStackRequest$ServiceRoleArn": "

The stack IAM role, which allows AWS OpsWorks to work with AWS resources on your behalf. You must set this parameter to the ARN for an existing IAM role. For more information about IAM ARNs, see Using Identifiers.

There is no default value. You must set this parameter to a valid service role ARN or the action will fail. You can specify the stack's current service role ARN, if you prefer, but you must do so explicitly.

", + "UpdateStackRequest$ServiceRoleArn": "

Do not use this parameter. You cannot update a stack's service role.

", "UpdateStackRequest$DefaultInstanceProfileArn": "

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

", - "UpdateStackRequest$DefaultOs": "

The stack's operating system, which must be set to one of the following:

The default option is the stack's current operating system. For more information on the supported operating systems, see AWS OpsWorks Operating Systems.

", + "UpdateStackRequest$DefaultOs": "

The stack's operating system, which must be set to one of the following:

The default option is the stack's current operating system. For more information on the supported operating systems, see AWS OpsWorks Operating Systems.

", "UpdateStackRequest$HostnameTheme": "

The stack's new host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

", "UpdateStackRequest$DefaultAvailabilityZone": "

The stack's default Availability Zone, which must be in the stack's region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see CreateStack.

", "UpdateStackRequest$DefaultSubnetId": "

The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.

", @@ -1439,12 +1496,13 @@ "CreateDeploymentRequest$InstanceIds": "

The instance IDs for the deployment targets.

", "CreateInstanceRequest$LayerIds": "

An array that contains the instance's layer IDs.

", "CreateLayerRequest$CustomSecurityGroupIds": "

An array containing the layer custom security group IDs.

", - "CreateLayerRequest$Packages": "

An array of Package objects that describe the layer packages.

", + "CreateLayerRequest$Packages": "

An array of Package objects that describes the layer packages.

", "Deployment$InstanceIds": "

The IDs of the target instances.

", "DeploymentCommandArgs$value": null, "DescribeAppsRequest$AppIds": "

An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app.

", "DescribeCommandsRequest$CommandIds": "

An array of command IDs. If you include this parameter, DescribeCommands returns a description of the specified commands. Otherwise, it returns a description of every command.

", "DescribeDeploymentsRequest$DeploymentIds": "

An array of deployment IDs to be described. If you include this parameter, DescribeDeployments returns a description of the specified deployments. Otherwise, it returns a description of every deployment.

", + "DescribeEcsClustersRequest$EcsClusterArns": "

A list of ARNs, one for each cluster to be described.

", "DescribeElasticIpsRequest$Ips": "

An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.

", "DescribeElasticLoadBalancersRequest$LayerIds": "

A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers.

", "DescribeInstancesRequest$InstanceIds": "

An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance.

", diff --git a/src/data/opsworks/2013-02-18/waiters-2.json b/src/data/opsworks/2013-02-18/waiters-2.json index 2b5bb44de6..5092bad620 100644 --- a/src/data/opsworks/2013-02-18/waiters-2.json +++ b/src/data/opsworks/2013-02-18/waiters-2.json @@ -1,6 +1,23 @@ { "version": 2, "waiters": { + "AppExists": { + "delay": 1, + "operation": "DescribeApps", + "maxAttempts": 40, + "acceptors": [ + { + "expected": 200, + "matcher": "status", + "state": "success" + }, + { + "matcher": "status", + "expected": 400, + "state": "failure" + } + ] + }, "InstanceOnline": { "delay": 15, "operation": "DescribeInstances", diff --git a/src/data/rds/2014-10-31/api-2.json b/src/data/rds/2014-10-31/api-2.json index 707293e925..4ce847edc9 100644 --- a/src/data/rds/2014-10-31/api-2.json +++ b/src/data/rds/2014-10-31/api-2.json @@ -146,6 +146,48 @@ } ] }, + "CopyDBClusterSnapshot":{ + "name":"CopyDBClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyDBClusterSnapshotMessage"}, + "output":{ + "shape":"CopyDBClusterSnapshotResult", + "wrapper":true, + "resultWrapper":"CopyDBClusterSnapshotResult" + }, + "errors":[ + { + "shape":"DBClusterSnapshotAlreadyExistsFault", + "error":{ + "code":"DBClusterSnapshotAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"DBClusterSnapshotNotFoundFault", + "error":{ + "code":"DBClusterSnapshotNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidDBClusterStateFault", + "error":{ + "code":"InvalidDBClusterStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + } + ] + }, "CopyDBParameterGroup":{ "name":"CopyDBParameterGroup", "http":{ @@ -281,6 +323,195 @@ } ] }, + "CreateDBCluster":{ + "name":"CreateDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBClusterMessage"}, + "output":{ + "shape":"CreateDBClusterResult", + "wrapper":true, + "resultWrapper":"CreateDBClusterResult" + }, + "errors":[ + { + "shape":"DBClusterAlreadyExistsFault", + "error":{ + "code":"DBClusterAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InsufficientStorageClusterCapacityFault", + "error":{ + "code":"InsufficientStorageClusterCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"DBClusterQuotaExceededFault", + "error":{ + "code":"DBClusterQuotaExceededFault", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + { + "shape":"StorageQuotaExceededFault", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidDBClusterStateFault", + "error":{ + "code":"InvalidDBClusterStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidDBSubnetGroupStateFault", + "error":{ + "code":"InvalidDBSubnetGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"DBClusterParameterGroupNotFoundFault", + "error":{ + "code":"DBClusterParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + } + ] + }, + "CreateDBClusterParameterGroup":{ + "name":"CreateDBClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBClusterParameterGroupMessage"}, + "output":{ + "shape":"CreateDBClusterParameterGroupResult", + "wrapper":true, + "resultWrapper":"CreateDBClusterParameterGroupResult" + }, + "errors":[ + { + "shape":"DBParameterGroupQuotaExceededFault", + "error":{ + "code":"DBParameterGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"DBParameterGroupAlreadyExistsFault", + "error":{ + "code":"DBParameterGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + } + ] + }, + "CreateDBClusterSnapshot":{ + "name":"CreateDBClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBClusterSnapshotMessage"}, + "output":{ + "shape":"CreateDBClusterSnapshotResult", + "wrapper":true, + "resultWrapper":"CreateDBClusterSnapshotResult" + }, + "errors":[ + { + "shape":"DBClusterSnapshotAlreadyExistsFault", + "error":{ + "code":"DBClusterSnapshotAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidDBClusterStateFault", + "error":{ + "code":"InvalidDBClusterStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"DBClusterNotFoundFault", + "error":{ + "code":"DBClusterNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + { + "shape":"SnapshotQuotaExceededFault", + "error":{ + "code":"SnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + } + ] + }, "CreateDBInstance":{ "name":"CreateDBInstance", "http":{ @@ -366,6 +597,15 @@ }, "exception":true }, + { + "shape":"InvalidDBClusterStateFault", + "error":{ + "code":"InvalidDBClusterStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, { "shape":"InvalidSubnet", "error":{ @@ -402,6 +642,15 @@ }, "exception":true }, + { + "shape":"DBClusterNotFoundFault", + "error":{ + "code":"DBClusterNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, { "shape":"StorageTypeNotSupportedFault", "error":{ @@ -905,50 +1154,32 @@ } ] }, - "DeleteDBInstance":{ - "name":"DeleteDBInstance", + "DeleteDBCluster":{ + "name":"DeleteDBCluster", "http":{ "method":"POST", "requestUri":"/" }, - "input":{"shape":"DeleteDBInstanceMessage"}, + "input":{"shape":"DeleteDBClusterMessage"}, "output":{ - "shape":"DeleteDBInstanceResult", + "shape":"DeleteDBClusterResult", "wrapper":true, - "resultWrapper":"DeleteDBInstanceResult" + "resultWrapper":"DeleteDBClusterResult" }, "errors":[ { - "shape":"DBInstanceNotFoundFault", + "shape":"DBClusterNotFoundFault", "error":{ - "code":"DBInstanceNotFound", + "code":"DBClusterNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true }, { - "shape":"InvalidDBInstanceStateFault", - "error":{ - "code":"InvalidDBInstanceState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - { - "shape":"DBSnapshotAlreadyExistsFault", - "error":{ - "code":"DBSnapshotAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - { - "shape":"SnapshotQuotaExceededFault", + "shape":"InvalidDBClusterStateFault", "error":{ - "code":"SnapshotQuotaExceeded", + "code":"InvalidDBClusterStateFault", "httpStatusCode":400, "senderFault":true }, @@ -956,13 +1187,13 @@ } ] }, - "DeleteDBParameterGroup":{ - "name":"DeleteDBParameterGroup", + "DeleteDBClusterParameterGroup":{ + "name":"DeleteDBClusterParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, - "input":{"shape":"DeleteDBParameterGroupMessage"}, + "input":{"shape":"DeleteDBClusterParameterGroupMessage"}, "errors":[ { "shape":"InvalidDBParameterGroupStateFault", @@ -984,27 +1215,32 @@ } ] }, - "DeleteDBSecurityGroup":{ - "name":"DeleteDBSecurityGroup", + "DeleteDBClusterSnapshot":{ + "name":"DeleteDBClusterSnapshot", "http":{ "method":"POST", "requestUri":"/" }, - "input":{"shape":"DeleteDBSecurityGroupMessage"}, + "input":{"shape":"DeleteDBClusterSnapshotMessage"}, + "output":{ + "shape":"DeleteDBClusterSnapshotResult", + "wrapper":true, + "resultWrapper":"DeleteDBClusterSnapshotResult" + }, "errors":[ { - "shape":"InvalidDBSecurityGroupStateFault", + "shape":"InvalidDBClusterSnapshotStateFault", "error":{ - "code":"InvalidDBSecurityGroupState", + "code":"InvalidDBClusterSnapshotStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, { - "shape":"DBSecurityGroupNotFoundFault", + "shape":"DBClusterSnapshotNotFoundFault", "error":{ - "code":"DBSecurityGroupNotFound", + "code":"DBClusterSnapshotNotFoundFault", "httpStatusCode":404, "senderFault":true }, @@ -1012,24 +1248,131 @@ } ] }, - "DeleteDBSnapshot":{ - "name":"DeleteDBSnapshot", + "DeleteDBInstance":{ + "name":"DeleteDBInstance", "http":{ "method":"POST", "requestUri":"/" }, - "input":{"shape":"DeleteDBSnapshotMessage"}, + "input":{"shape":"DeleteDBInstanceMessage"}, "output":{ - "shape":"DeleteDBSnapshotResult", + "shape":"DeleteDBInstanceResult", "wrapper":true, - "resultWrapper":"DeleteDBSnapshotResult" + "resultWrapper":"DeleteDBInstanceResult" }, "errors":[ { - "shape":"InvalidDBSnapshotStateFault", + "shape":"DBInstanceNotFoundFault", "error":{ - "code":"InvalidDBSnapshotState", - "httpStatusCode":400, + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"DBSnapshotAlreadyExistsFault", + "error":{ + "code":"DBSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"SnapshotQuotaExceededFault", + "error":{ + "code":"SnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + } + ] + }, + "DeleteDBParameterGroup":{ + "name":"DeleteDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBParameterGroupMessage"}, + "errors":[ + { + "shape":"InvalidDBParameterGroupStateFault", + "error":{ + "code":"InvalidDBParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + } + ] + }, + "DeleteDBSecurityGroup":{ + "name":"DeleteDBSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBSecurityGroupMessage"}, + "errors":[ + { + "shape":"InvalidDBSecurityGroupStateFault", + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + } + ] + }, + "DeleteDBSnapshot":{ + "name":"DeleteDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBSnapshotMessage"}, + "output":{ + "shape":"DeleteDBSnapshotResult", + "wrapper":true, + "resultWrapper":"DeleteDBSnapshotResult" + }, + "errors":[ + { + "shape":"InvalidDBSnapshotStateFault", + "error":{ + "code":"InvalidDBSnapshotState", + "httpStatusCode":400, "senderFault":true }, "exception":true @@ -1171,7 +1514,99 @@ "shape":"CertificateNotFoundFault", "error":{ "code":"CertificateNotFound", - "httpStatusCode":400, + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + } + ] + }, + "DescribeDBClusterParameterGroups":{ + "name":"DescribeDBClusterParameterGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBClusterParameterGroupsMessage"}, + "output":{ + "shape":"DBClusterParameterGroupsMessage", + "resultWrapper":"DescribeDBClusterParameterGroupsResult" + }, + "errors":[ + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + } + ] + }, + "DescribeDBClusterParameters":{ + "name":"DescribeDBClusterParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBClusterParametersMessage"}, + "output":{ + "shape":"DBClusterParameterGroupDetails", + "resultWrapper":"DescribeDBClusterParametersResult" + }, + "errors":[ + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + } + ] + }, + "DescribeDBClusterSnapshots":{ + "name":"DescribeDBClusterSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBClusterSnapshotsMessage"}, + "output":{ + "shape":"DBClusterSnapshotMessage", + "resultWrapper":"DescribeDBClusterSnapshotsResult" + }, + "errors":[ + { + "shape":"DBClusterSnapshotNotFoundFault", + "error":{ + "code":"DBClusterSnapshotNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + } + ] + }, + "DescribeDBClusters":{ + "name":"DescribeDBClusters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBClustersMessage"}, + "output":{ + "shape":"DBClusterMessage", + "resultWrapper":"DescribeDBClustersResult" + }, + "errors":[ + { + "shape":"DBClusterNotFoundFault", + "error":{ + "code":"DBClusterNotFoundFault", + "httpStatusCode":404, "senderFault":true }, "exception":true @@ -1351,6 +1786,19 @@ } ] }, + "DescribeEngineDefaultClusterParameters":{ + "name":"DescribeEngineDefaultClusterParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEngineDefaultClusterParametersMessage"}, + "output":{ + "shape":"DescribeEngineDefaultClusterParametersResult", + "wrapper":true, + "resultWrapper":"DescribeEngineDefaultClusterParametersResult" + } + }, "DescribeEngineDefaultParameters":{ "name":"DescribeEngineDefaultParameters", "http":{ @@ -1547,6 +1995,48 @@ "senderFault":true }, "exception":true + }, + { + "shape":"DBLogFileNotFoundFault", + "error":{ + "code":"DBLogFileNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + } + ] + }, + "FailoverDBCluster":{ + "name":"FailoverDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"FailoverDBClusterMessage"}, + "output":{ + "shape":"FailoverDBClusterResult", + "wrapper":true, + "resultWrapper":"FailoverDBClusterResult" + }, + "errors":[ + { + "shape":"DBClusterNotFoundFault", + "error":{ + "code":"DBClusterNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidDBClusterStateFault", + "error":{ + "code":"InvalidDBClusterStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true } ] }, @@ -1582,87 +2072,224 @@ } ] }, - "ModifyDBInstance":{ - "name":"ModifyDBInstance", + "ModifyDBCluster":{ + "name":"ModifyDBCluster", "http":{ "method":"POST", "requestUri":"/" }, - "input":{"shape":"ModifyDBInstanceMessage"}, + "input":{"shape":"ModifyDBClusterMessage"}, "output":{ - "shape":"ModifyDBInstanceResult", + "shape":"ModifyDBClusterResult", "wrapper":true, - "resultWrapper":"ModifyDBInstanceResult" + "resultWrapper":"ModifyDBClusterResult" }, "errors":[ { - "shape":"InvalidDBInstanceStateFault", + "shape":"DBClusterNotFoundFault", "error":{ - "code":"InvalidDBInstanceState", - "httpStatusCode":400, + "code":"DBClusterNotFoundFault", + "httpStatusCode":404, "senderFault":true }, "exception":true }, { - "shape":"InvalidDBSecurityGroupStateFault", + "shape":"InvalidDBClusterStateFault", "error":{ - "code":"InvalidDBSecurityGroupState", + "code":"InvalidDBClusterStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, { - "shape":"DBInstanceAlreadyExistsFault", + "shape":"StorageQuotaExceededFault", "error":{ - "code":"DBInstanceAlreadyExists", + "code":"StorageQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, { - "shape":"DBInstanceNotFoundFault", + "shape":"DBSubnetGroupNotFoundFault", "error":{ - "code":"DBInstanceNotFound", + "code":"DBSubnetGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true }, { - "shape":"DBSecurityGroupNotFoundFault", + "shape":"InvalidVPCNetworkStateFault", "error":{ - "code":"DBSecurityGroupNotFound", - "httpStatusCode":404, + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, "senderFault":true }, "exception":true }, { - "shape":"DBParameterGroupNotFoundFault", + "shape":"InvalidDBSubnetGroupStateFault", "error":{ - "code":"DBParameterGroupNotFound", - "httpStatusCode":404, + "code":"InvalidDBSubnetGroupStateFault", + "httpStatusCode":400, "senderFault":true }, "exception":true }, { - "shape":"InsufficientDBInstanceCapacityFault", + "shape":"InvalidSubnet", "error":{ - "code":"InsufficientDBInstanceCapacity", + "code":"InvalidSubnet", "httpStatusCode":400, "senderFault":true }, "exception":true }, { - "shape":"StorageQuotaExceededFault", + "shape":"DBClusterParameterGroupNotFoundFault", "error":{ - "code":"StorageQuotaExceeded", - "httpStatusCode":400, + "code":"DBClusterParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidDBSecurityGroupStateFault", + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + } + ] + }, + "ModifyDBClusterParameterGroup":{ + "name":"ModifyDBClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBClusterParameterGroupMessage"}, + "output":{ + "shape":"DBClusterParameterGroupNameMessage", + "resultWrapper":"ModifyDBClusterParameterGroupResult" + }, + "errors":[ + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidDBParameterGroupStateFault", + "error":{ + "code":"InvalidDBParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + } + ] + }, + "ModifyDBInstance":{ + "name":"ModifyDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBInstanceMessage"}, + "output":{ + "shape":"ModifyDBInstanceResult", + "wrapper":true, + "resultWrapper":"ModifyDBInstanceResult" + }, + "errors":[ + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidDBSecurityGroupStateFault", + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"DBInstanceAlreadyExistsFault", + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InsufficientDBInstanceCapacityFault", + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"StorageQuotaExceededFault", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, "senderFault":true }, "exception":true @@ -1725,7 +2352,7 @@ "shape":"CertificateNotFoundFault", "error":{ "code":"CertificateNotFound", - "httpStatusCode":400, + "httpStatusCode":404, "senderFault":true }, "exception":true @@ -2085,41 +2712,382 @@ "exception":true }, { - "shape":"DBSnapshotNotFoundFault", + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + } + ] + }, + "ResetDBClusterParameterGroup":{ + "name":"ResetDBClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetDBClusterParameterGroupMessage"}, + "output":{ + "shape":"DBClusterParameterGroupNameMessage", + "resultWrapper":"ResetDBClusterParameterGroupResult" + }, + "errors":[ + { + "shape":"InvalidDBParameterGroupStateFault", + "error":{ + "code":"InvalidDBParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + } + ] + }, + "ResetDBParameterGroup":{ + "name":"ResetDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetDBParameterGroupMessage"}, + "output":{ + "shape":"DBParameterGroupNameMessage", + "resultWrapper":"ResetDBParameterGroupResult" + }, + "errors":[ + { + "shape":"InvalidDBParameterGroupStateFault", + "error":{ + "code":"InvalidDBParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + } + ] + }, + "RestoreDBClusterFromSnapshot":{ + "name":"RestoreDBClusterFromSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreDBClusterFromSnapshotMessage"}, + "output":{ + "shape":"RestoreDBClusterFromSnapshotResult", + "wrapper":true, + "resultWrapper":"RestoreDBClusterFromSnapshotResult" + }, + "errors":[ + { + "shape":"DBClusterAlreadyExistsFault", + "error":{ + "code":"DBClusterAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"DBClusterQuotaExceededFault", + "error":{ + "code":"DBClusterQuotaExceededFault", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + { + "shape":"StorageQuotaExceededFault", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + { + "shape":"DBClusterSnapshotNotFoundFault", + "error":{ + "code":"DBClusterSnapshotNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InsufficientDBClusterCapacityFault", + "error":{ + "code":"InsufficientDBClusterCapacityFault", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InsufficientStorageClusterCapacityFault", + "error":{ + "code":"InsufficientStorageClusterCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidDBSnapshotStateFault", + "error":{ + "code":"InvalidDBSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidDBClusterSnapshotStateFault", + "error":{ + "code":"InvalidDBClusterSnapshotStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"StorageQuotaExceededFault", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidRestoreFault", + "error":{ + "code":"InvalidRestoreFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + } + ] + }, + "RestoreDBClusterToPointInTime":{ + "name":"RestoreDBClusterToPointInTime", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreDBClusterToPointInTimeMessage"}, + "output":{ + "shape":"RestoreDBClusterToPointInTimeResult", + "wrapper":true, + "resultWrapper":"RestoreDBClusterToPointInTimeResult" + }, + "errors":[ + { + "shape":"DBClusterAlreadyExistsFault", + "error":{ + "code":"DBClusterAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"DBClusterQuotaExceededFault", + "error":{ + "code":"DBClusterQuotaExceededFault", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + { + "shape":"StorageQuotaExceededFault", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + { + "shape":"DBClusterNotFoundFault", + "error":{ + "code":"DBClusterNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + { + "shape":"DBClusterSnapshotNotFoundFault", + "error":{ + "code":"DBClusterSnapshotNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InsufficientDBClusterCapacityFault", + "error":{ + "code":"InsufficientDBClusterCapacityFault", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidDBSnapshotStateFault", + "error":{ + "code":"InvalidDBSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidDBClusterSnapshotStateFault", + "error":{ + "code":"InvalidDBClusterSnapshotStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"StorageQuotaExceededFault", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidRestoreFault", + "error":{ + "code":"InvalidRestoreFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"DBSubnetGroupNotFoundFault", "error":{ - "code":"DBSnapshotNotFound", + "code":"DBSubnetGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true - } - ] - }, - "ResetDBParameterGroup":{ - "name":"ResetDBParameterGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ResetDBParameterGroupMessage"}, - "output":{ - "shape":"DBParameterGroupNameMessage", - "resultWrapper":"ResetDBParameterGroupResult" - }, - "errors":[ + }, { - "shape":"InvalidDBParameterGroupStateFault", + "shape":"InvalidSubnet", "error":{ - "code":"InvalidDBParameterGroupState", + "code":"InvalidSubnet", "httpStatusCode":400, "senderFault":true }, "exception":true }, { - "shape":"DBParameterGroupNotFoundFault", + "shape":"OptionGroupNotFoundFault", "error":{ - "code":"DBParameterGroupNotFound", + "code":"OptionGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, @@ -2283,6 +3251,15 @@ "senderFault":true }, "exception":true + }, + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true } ] }, @@ -2451,6 +3428,15 @@ "senderFault":true }, "exception":true + }, + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true } ] }, @@ -2620,6 +3606,13 @@ "locationName":"AvailabilityZone" } }, + "AvailabilityZones":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"AvailabilityZone" + } + }, "Boolean":{"type":"boolean"}, "BooleanOptional":{"type":"boolean"}, "Certificate":{ @@ -2653,7 +3646,7 @@ }, "error":{ "code":"CertificateNotFound", - "httpStatusCode":400, + "httpStatusCode":404, "senderFault":true }, "exception":true @@ -2665,6 +3658,18 @@ "CharacterSetDescription":{"shape":"String"} } }, + "CopyDBClusterSnapshotMessage":{ + "type":"structure", + "required":[ + "SourceDBClusterSnapshotIdentifier", + "TargetDBClusterSnapshotIdentifier" + ], + "members":{ + "SourceDBClusterSnapshotIdentifier":{"shape":"String"}, + "TargetDBClusterSnapshotIdentifier":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, "CopyDBParameterGroupMessage":{ "type":"structure", "required":[ @@ -2705,15 +3710,60 @@ "Tags":{"shape":"TagList"} } }, + "CreateDBClusterMessage":{ + "type":"structure", + "members":{ + "AvailabilityZones":{"shape":"AvailabilityZones"}, + "BackupRetentionPeriod":{"shape":"IntegerOptional"}, + "CharacterSetName":{"shape":"String"}, + "DatabaseName":{"shape":"String"}, + "DBClusterIdentifier":{"shape":"String"}, + "DBClusterParameterGroupName":{"shape":"String"}, + "VpcSecurityGroupIds":{"shape":"VpcSecurityGroupIdList"}, + "DBSubnetGroupName":{"shape":"String"}, + "Engine":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "MasterUsername":{"shape":"String"}, + "MasterUserPassword":{"shape":"String"}, + "OptionGroupName":{"shape":"String"}, + "PreferredBackupWindow":{"shape":"String"}, + "PreferredMaintenanceWindow":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateDBClusterParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBClusterParameterGroupName", + "DBParameterGroupFamily", + "Description" + ], + "members":{ + "DBClusterParameterGroupName":{"shape":"String"}, + "DBParameterGroupFamily":{"shape":"String"}, + "Description":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateDBClusterSnapshotMessage":{ + "type":"structure", + "required":[ + "DBClusterSnapshotIdentifier", + "DBClusterIdentifier" + ], + "members":{ + "DBClusterSnapshotIdentifier":{"shape":"String"}, + "DBClusterIdentifier":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, "CreateDBInstanceMessage":{ "type":"structure", "required":[ "DBInstanceIdentifier", - "AllocatedStorage", "DBInstanceClass", - "Engine", - "MasterUsername", - "MasterUserPassword" + "Engine" ], "members":{ "DBName":{"shape":"String"}, @@ -2741,6 +3791,7 @@ "CharacterSetName":{"shape":"String"}, "PubliclyAccessible":{"shape":"BooleanOptional"}, "Tags":{"shape":"TagList"}, + "DBClusterIdentifier":{"shape":"String"}, "StorageType":{"shape":"String"}, "TdeCredentialArn":{"shape":"String"}, "TdeCredentialPassword":{"shape":"String"}, @@ -2807,51 +3858,260 @@ "Tags":{"shape":"TagList"} } }, - "CreateDBSubnetGroupMessage":{ + "CreateDBSubnetGroupMessage":{ + "type":"structure", + "required":[ + "DBSubnetGroupName", + "DBSubnetGroupDescription", + "SubnetIds" + ], + "members":{ + "DBSubnetGroupName":{"shape":"String"}, + "DBSubnetGroupDescription":{"shape":"String"}, + "SubnetIds":{"shape":"SubnetIdentifierList"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateEventSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SnsTopicArn" + ], + "members":{ + "SubscriptionName":{"shape":"String"}, + "SnsTopicArn":{"shape":"String"}, + "SourceType":{"shape":"String"}, + "EventCategories":{"shape":"EventCategoriesList"}, + "SourceIds":{"shape":"SourceIdsList"}, + "Enabled":{"shape":"BooleanOptional"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateOptionGroupMessage":{ + "type":"structure", + "required":[ + "OptionGroupName", + "EngineName", + "MajorEngineVersion", + "OptionGroupDescription" + ], + "members":{ + "OptionGroupName":{"shape":"String"}, + "EngineName":{"shape":"String"}, + "MajorEngineVersion":{"shape":"String"}, + "OptionGroupDescription":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "DBCluster":{ + "type":"structure", + "members":{ + "AllocatedStorage":{"shape":"IntegerOptional"}, + "AvailabilityZones":{"shape":"AvailabilityZones"}, + "BackupRetentionPeriod":{"shape":"IntegerOptional"}, + "CharacterSetName":{"shape":"String"}, + "DatabaseName":{"shape":"String"}, + "DBClusterIdentifier":{"shape":"String"}, + "DBClusterParameterGroup":{"shape":"String"}, + "DBSubnetGroup":{"shape":"String"}, + "Status":{"shape":"String"}, + "PercentProgress":{"shape":"String"}, + "EarliestRestorableTime":{"shape":"TStamp"}, + "Endpoint":{"shape":"String"}, + "Engine":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "LatestRestorableTime":{"shape":"TStamp"}, + "Port":{"shape":"IntegerOptional"}, + "MasterUsername":{"shape":"String"}, + "DBClusterOptionGroupMemberships":{"shape":"DBClusterOptionGroupMemberships"}, + "PreferredBackupWindow":{"shape":"String"}, + "PreferredMaintenanceWindow":{"shape":"String"}, + "DBClusterMembers":{"shape":"DBClusterMemberList"}, + "VpcSecurityGroups":{"shape":"VpcSecurityGroupMembershipList"} + }, + "wrapper":true + }, + "DBClusterAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBClusterAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBClusterList":{ + "type":"list", + "member":{ + "shape":"DBCluster", + "locationName":"DBCluster" + } + }, + "DBClusterMember":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "IsClusterWriter":{"shape":"Boolean"}, + "DBClusterParameterGroupStatus":{"shape":"String"} + }, + "wrapper":true + }, + "DBClusterMemberList":{ + "type":"list", + "member":{ + "shape":"DBClusterMember", + "locationName":"DBClusterMember" + } + }, + "DBClusterMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBClusters":{"shape":"DBClusterList"} + } + }, + "DBClusterNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBClusterNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBClusterOptionGroupMemberships":{ + "type":"list", + "member":{ + "shape":"DBClusterOptionGroupStatus", + "locationName":"DBClusterOptionGroup" + } + }, + "DBClusterOptionGroupStatus":{ + "type":"structure", + "members":{ + "DBClusterOptionGroupName":{"shape":"String"}, + "Status":{"shape":"String"} + } + }, + "DBClusterParameterGroup":{ + "type":"structure", + "members":{ + "DBClusterParameterGroupName":{"shape":"String"}, + "DBParameterGroupFamily":{"shape":"String"}, + "Description":{"shape":"String"} + }, + "wrapper":true + }, + "DBClusterParameterGroupDetails":{ + "type":"structure", + "members":{ + "Parameters":{"shape":"ParametersList"}, + "Marker":{"shape":"String"} + } + }, + "DBClusterParameterGroupList":{ + "type":"list", + "member":{ + "shape":"DBClusterParameterGroup", + "locationName":"DBClusterParameterGroup" + } + }, + "DBClusterParameterGroupNameMessage":{ + "type":"structure", + "members":{ + "DBClusterParameterGroupName":{"shape":"String"} + } + }, + "DBClusterParameterGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBClusterParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBClusterParameterGroupsMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBClusterParameterGroups":{"shape":"DBClusterParameterGroupList"} + } + }, + "DBClusterQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBClusterQuotaExceededFault", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "DBClusterSnapshot":{ + "type":"structure", + "members":{ + "AvailabilityZones":{"shape":"AvailabilityZones"}, + "DBClusterSnapshotIdentifier":{"shape":"String"}, + "DBClusterIdentifier":{"shape":"String"}, + "SnapshotCreateTime":{"shape":"TStamp"}, + "Engine":{"shape":"String"}, + "AllocatedStorage":{"shape":"Integer"}, + "Status":{"shape":"String"}, + "Port":{"shape":"Integer"}, + "VpcId":{"shape":"String"}, + "ClusterCreateTime":{"shape":"TStamp"}, + "MasterUsername":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "LicenseModel":{"shape":"String"}, + "SnapshotType":{"shape":"String"}, + "PercentProgress":{"shape":"Integer"} + }, + "wrapper":true + }, + "DBClusterSnapshotAlreadyExistsFault":{ "type":"structure", - "required":[ - "DBSubnetGroupName", - "DBSubnetGroupDescription", - "SubnetIds" - ], "members":{ - "DBSubnetGroupName":{"shape":"String"}, - "DBSubnetGroupDescription":{"shape":"String"}, - "SubnetIds":{"shape":"SubnetIdentifierList"}, - "Tags":{"shape":"TagList"} + }, + "error":{ + "code":"DBClusterSnapshotAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBClusterSnapshotList":{ + "type":"list", + "member":{ + "shape":"DBClusterSnapshot", + "locationName":"DBClusterSnapshot" } }, - "CreateEventSubscriptionMessage":{ + "DBClusterSnapshotMessage":{ "type":"structure", - "required":[ - "SubscriptionName", - "SnsTopicArn" - ], "members":{ - "SubscriptionName":{"shape":"String"}, - "SnsTopicArn":{"shape":"String"}, - "SourceType":{"shape":"String"}, - "EventCategories":{"shape":"EventCategoriesList"}, - "SourceIds":{"shape":"SourceIdsList"}, - "Enabled":{"shape":"BooleanOptional"}, - "Tags":{"shape":"TagList"} + "Marker":{"shape":"String"}, + "DBClusterSnapshots":{"shape":"DBClusterSnapshotList"} } }, - "CreateOptionGroupMessage":{ + "DBClusterSnapshotNotFoundFault":{ "type":"structure", - "required":[ - "OptionGroupName", - "EngineName", - "MajorEngineVersion", - "OptionGroupDescription" - ], "members":{ - "OptionGroupName":{"shape":"String"}, - "EngineName":{"shape":"String"}, - "MajorEngineVersion":{"shape":"String"}, - "OptionGroupDescription":{"shape":"String"}, - "Tags":{"shape":"TagList"} - } + }, + "error":{ + "code":"DBClusterSnapshotNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true }, "DBEngineVersion":{ "type":"structure", @@ -2915,6 +4175,8 @@ "StatusInfos":{"shape":"DBInstanceStatusInfoList"}, "StorageType":{"shape":"String"}, "TdeCredentialArn":{"shape":"String"}, + "DbInstancePort":{"shape":"Integer"}, + "DBClusterIdentifier":{"shape":"String"}, "StorageEncrypted":{"shape":"Boolean"}, "KmsKeyId":{"shape":"String"}, "DbiResourceId":{"shape":"String"}, @@ -2974,6 +4236,17 @@ "locationName":"DBInstanceStatusInfo" } }, + "DBLogFileNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBLogFileNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, "DBParameterGroup":{ "type":"structure", "members":{ @@ -3169,6 +4442,7 @@ "OptionGroupName":{"shape":"String"}, "PercentProgress":{"shape":"Integer"}, "SourceRegion":{"shape":"String"}, + "SourceDBSnapshotIdentifier":{"shape":"String"}, "StorageType":{"shape":"String"}, "TdeCredentialArn":{"shape":"String"}, "Encrypted":{"shape":"Boolean"}, @@ -3314,6 +4588,28 @@ }, "exception":true }, + "DeleteDBClusterMessage":{ + "type":"structure", + "members":{ + "DBClusterIdentifier":{"shape":"String"}, + "SkipFinalSnapshot":{"shape":"Boolean"}, + "FinalDBSnapshotIdentifier":{"shape":"String"} + } + }, + "DeleteDBClusterParameterGroupMessage":{ + "type":"structure", + "required":["DBClusterParameterGroupName"], + "members":{ + "DBClusterParameterGroupName":{"shape":"String"} + } + }, + "DeleteDBClusterSnapshotMessage":{ + "type":"structure", + "required":["DBClusterSnapshotIdentifier"], + "members":{ + "DBClusterSnapshotIdentifier":{"shape":"String"} + } + }, "DeleteDBInstanceMessage":{ "type":"structure", "required":["DBInstanceIdentifier"], @@ -3379,6 +4675,46 @@ "Marker":{"shape":"String"} } }, + "DescribeDBClusterParameterGroupsMessage":{ + "type":"structure", + "members":{ + "DBClusterParameterGroupName":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBClusterParametersMessage":{ + "type":"structure", + "required":["DBClusterParameterGroupName"], + "members":{ + "DBClusterParameterGroupName":{"shape":"String"}, + "Source":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBClusterSnapshotsMessage":{ + "type":"structure", + "members":{ + "DBClusterIdentifier":{"shape":"String"}, + "DBClusterSnapshotIdentifier":{"shape":"String"}, + "SnapshotType":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBClustersMessage":{ + "type":"structure", + "members":{ + "DBClusterIdentifier":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, "DescribeDBEngineVersionsMessage":{ "type":"structure", "members":{ @@ -3485,6 +4821,16 @@ "Marker":{"shape":"String"} } }, + "DescribeEngineDefaultClusterParametersMessage":{ + "type":"structure", + "required":["DBParameterGroupFamily"], + "members":{ + "DBParameterGroupFamily":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, "DescribeEngineDefaultParametersMessage":{ "type":"structure", "required":["DBParameterGroupFamily"], @@ -3745,6 +5091,12 @@ "Events":{"shape":"EventList"} } }, + "FailoverDBClusterMessage":{ + "type":"structure", + "members":{ + "DBClusterIdentifier":{"shape":"String"} + } + }, "Filter":{ "type":"structure", "required":[ @@ -3795,6 +5147,17 @@ }, "exception":true }, + "InsufficientDBClusterCapacityFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InsufficientDBClusterCapacityFault", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, "InsufficientDBInstanceCapacityFault":{ "type":"structure", "members":{ @@ -3806,8 +5169,41 @@ }, "exception":true }, + "InsufficientStorageClusterCapacityFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InsufficientStorageClusterCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, "Integer":{"type":"integer"}, "IntegerOptional":{"type":"integer"}, + "InvalidDBClusterSnapshotStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBClusterSnapshotStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBClusterStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBClusterStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, "InvalidDBInstanceStateFault":{ "type":"structure", "members":{ @@ -3964,6 +5360,33 @@ } }, "Long":{"type":"long"}, + "ModifyDBClusterMessage":{ + "type":"structure", + "members":{ + "DBClusterIdentifier":{"shape":"String"}, + "NewDBClusterIdentifier":{"shape":"String"}, + "ApplyImmediately":{"shape":"Boolean"}, + "BackupRetentionPeriod":{"shape":"IntegerOptional"}, + "DBClusterParameterGroupName":{"shape":"String"}, + "VpcSecurityGroupIds":{"shape":"VpcSecurityGroupIdList"}, + "Port":{"shape":"IntegerOptional"}, + "MasterUserPassword":{"shape":"String"}, + "OptionGroupName":{"shape":"String"}, + "PreferredBackupWindow":{"shape":"String"}, + "PreferredMaintenanceWindow":{"shape":"String"} + } + }, + "ModifyDBClusterParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBClusterParameterGroupName", + "Parameters" + ], + "members":{ + "DBClusterParameterGroupName":{"shape":"String"}, + "Parameters":{"shape":"ParametersList"} + } + }, "ModifyDBInstanceMessage":{ "type":"structure", "required":["DBInstanceIdentifier"], @@ -4537,6 +5960,15 @@ }, "exception":true }, + "ResetDBClusterParameterGroupMessage":{ + "type":"structure", + "required":["DBClusterParameterGroupName"], + "members":{ + "DBClusterParameterGroupName":{"shape":"String"}, + "ResetAllParameters":{"shape":"Boolean"}, + "Parameters":{"shape":"ParametersList"} + } + }, "ResetDBParameterGroupMessage":{ "type":"structure", "required":["DBParameterGroupName"], @@ -4565,6 +5997,45 @@ }, "wrapper":true }, + "RestoreDBClusterFromSnapshotMessage":{ + "type":"structure", + "required":[ + "DBClusterIdentifier", + "SnapshotIdentifier", + "Engine" + ], + "members":{ + "AvailabilityZones":{"shape":"AvailabilityZones"}, + "DBClusterIdentifier":{"shape":"String"}, + "SnapshotIdentifier":{"shape":"String"}, + "Engine":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "DBSubnetGroupName":{"shape":"String"}, + "DatabaseName":{"shape":"String"}, + "OptionGroupName":{"shape":"String"}, + "VpcSecurityGroupIds":{"shape":"VpcSecurityGroupIdList"}, + "Tags":{"shape":"TagList"} + } + }, + "RestoreDBClusterToPointInTimeMessage":{ + "type":"structure", + "required":[ + "DBClusterIdentifier", + "SourceDBClusterIdentifier" + ], + "members":{ + "DBClusterIdentifier":{"shape":"String"}, + "SourceDBClusterIdentifier":{"shape":"String"}, + "RestoreToTime":{"shape":"TStamp"}, + "UseLatestRestorableTime":{"shape":"Boolean"}, + "Port":{"shape":"IntegerOptional"}, + "DBSubnetGroupName":{"shape":"String"}, + "OptionGroupName":{"shape":"String"}, + "VpcSecurityGroupIds":{"shape":"VpcSecurityGroupIdList"}, + "Tags":{"shape":"TagList"} + } + }, "RestoreDBInstanceFromDBSnapshotMessage":{ "type":"structure", "required":[ @@ -4859,6 +6330,12 @@ "DBSecurityGroup":{"shape":"DBSecurityGroup"} } }, + "CopyDBClusterSnapshotResult":{ + "type":"structure", + "members":{ + "DBClusterSnapshot":{"shape":"DBClusterSnapshot"} + } + }, "CopyDBParameterGroupResult":{ "type":"structure", "members":{ @@ -4877,6 +6354,24 @@ "OptionGroup":{"shape":"OptionGroup"} } }, + "CreateDBClusterResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "CreateDBClusterParameterGroupResult":{ + "type":"structure", + "members":{ + "DBClusterParameterGroup":{"shape":"DBClusterParameterGroup"} + } + }, + "CreateDBClusterSnapshotResult":{ + "type":"structure", + "members":{ + "DBClusterSnapshot":{"shape":"DBClusterSnapshot"} + } + }, "CreateDBInstanceResult":{ "type":"structure", "members":{ @@ -4925,6 +6420,18 @@ "OptionGroup":{"shape":"OptionGroup"} } }, + "DeleteDBClusterResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "DeleteDBClusterSnapshotResult":{ + "type":"structure", + "members":{ + "DBClusterSnapshot":{"shape":"DBClusterSnapshot"} + } + }, "DeleteDBInstanceResult":{ "type":"structure", "members":{ @@ -4943,12 +6450,30 @@ "EventSubscription":{"shape":"EventSubscription"} } }, + "DescribeEngineDefaultClusterParametersResult":{ + "type":"structure", + "members":{ + "EngineDefaults":{"shape":"EngineDefaults"} + } + }, "DescribeEngineDefaultParametersResult":{ "type":"structure", "members":{ "EngineDefaults":{"shape":"EngineDefaults"} } }, + "FailoverDBClusterResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "ModifyDBClusterResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, "ModifyDBInstanceResult":{ "type":"structure", "members":{ @@ -4997,6 +6522,18 @@ "EventSubscription":{"shape":"EventSubscription"} } }, + "RestoreDBClusterFromSnapshotResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "RestoreDBClusterToPointInTimeResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, "RestoreDBInstanceFromDBSnapshotResult":{ "type":"structure", "members":{ diff --git a/src/data/rds/2014-10-31/docs-2.json b/src/data/rds/2014-10-31/docs-2.json index 81e3b08e27..27c4c8493e 100644 --- a/src/data/rds/2014-10-31/docs-2.json +++ b/src/data/rds/2014-10-31/docs-2.json @@ -2,21 +2,28 @@ "version": "2.0", "operations": { "AddSourceIdentifierToSubscription": "

Adds a source identifier to an existing RDS event notification subscription.

", - "AddTagsToResource": "

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 Condition statement in IAM policy for Amazon RDS.

For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.

", - "ApplyPendingMaintenanceAction": "

Applies a pending maintenance action to a resource (for example, a DB instance).

", - "AuthorizeDBSecurityGroupIngress": "

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

You cannot authorize ingress from an EC2 security group in one Region to an Amazon RDS DB instance in another. You cannot authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

", + "AddTagsToResource": "

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.

For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.

", + "ApplyPendingMaintenanceAction": "

Applies a pending maintenance action to a resource (for example, to a DB instance).

", + "AuthorizeDBSecurityGroupIngress": "

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

You cannot authorize ingress from an EC2 security group in one region to an Amazon RDS DB instance in another. You cannot authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

", + "CopyDBClusterSnapshot": "

Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

", "CopyDBParameterGroup": "

Copies the specified DB parameter group.

", "CopyDBSnapshot": "

Copies the specified DBSnapshot. The source DBSnapshot must be in the \"available\" state.

", "CopyOptionGroup": "

Copies the specified option group.

", + "CreateDBCluster": "

Creates a new Amazon Aurora DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

", + "CreateDBClusterParameterGroup": "

Creates a new DB cluster parameter group.

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

", + "CreateDBClusterSnapshot": "

Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

", "CreateDBInstance": "

Creates a new DB instance.

", - "CreateDBInstanceReadReplica": "

Creates a DB instance that acts as a Read Replica of a source DB instance.

All Read Replica DB instances are created as Single-AZ deployments with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified below.

The source DB instance must have backup retention enabled.

", + "CreateDBInstanceReadReplica": "

Creates a DB instance for a DB instance running MySQL or PostgreSQL that acts as a Read Replica of a source DB instance.

All Read Replica DB instances are created as Single-AZ deployments with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified below.

The source DB instance must have backup retention enabled.

", "CreateDBParameterGroup": "

Creates a new DB parameter group.

A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

", "CreateDBSecurityGroup": "

Creates a new DB security group. DB security groups control access to a DB instance.

", "CreateDBSnapshot": "

Creates a DBSnapshot. The source DBInstance must be in \"available\" state.

", "CreateDBSubnetGroup": "

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.

", "CreateEventSubscription": "

Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account.

", "CreateOptionGroup": "

Creates a new option group. You can create up to 20 option groups.

", - "DeleteDBInstance": "

The DeleteDBInstance action deletes a previously provisioned DB instance. A successful response from the web service indicates the request was received correctly. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted are not deleted.

If a final DB snapshot is requested the status of the RDS instance will be \"deleting\" until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action cannot be canceled or reverted once submitted.

", + "DeleteDBCluster": "

The DeleteDBCluster action deletes a previously provisioned DB cluster. A successful response from the web service indicates the request was received correctly. When you delete a DB cluster, all automated backups for that DB cluster are deleted and cannot be recovered. Manual DB cluster snapshots of the DB cluster to be deleted are not deleted.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

", + "DeleteDBClusterParameterGroup": "

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted cannot be associated with any DB clusters.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

", + "DeleteDBClusterSnapshot": "

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

The DB cluster snapshot must be in the available state to be deleted.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

", + "DeleteDBInstance": "

The DeleteDBInstance action deletes a previously provisioned DB instance. A successful response from the web service indicates the request was received correctly. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted are not deleted.

If a final DB snapshot is requested the status of the RDS instance will be \"deleting\" until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action cannot be canceled or reverted once submitted.

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

", "DeleteDBParameterGroup": "

Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances.

", "DeleteDBSecurityGroup": "

Deletes a DB security group.

The specified DB security group must not be associated with any DB instances.", "DeleteDBSnapshot": "

Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.

The DBSnapshot must be in the available state to be deleted.", @@ -25,6 +32,10 @@ "DeleteOptionGroup": "

Deletes an existing option group.

", "DescribeAccountAttributes": "

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.

This command does not take any parameters.

", "DescribeCertificates": "

Lists the set of CA certificates provided by Amazon RDS for this AWS account.

", + "DescribeDBClusterParameterGroups": "

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

", + "DescribeDBClusterParameters": "

Returns the detailed parameter list for a particular DB cluster parameter group.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

", + "DescribeDBClusterSnapshots": "

Returns information about DB cluster snapshots. This API supports pagination.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

", + "DescribeDBClusters": "

Returns information about provisioned Aurora DB clusters. This API supports pagination.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

", "DescribeDBEngineVersions": "

Returns a list of the available DB engines.

", "DescribeDBInstances": "

Returns information about provisioned RDS instances. This API supports pagination.

", "DescribeDBLogFiles": "

Returns a list of DB log files for the DB instance.

", @@ -33,8 +44,9 @@ "DescribeDBSecurityGroups": "

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.

", "DescribeDBSnapshots": "

Returns information about DB snapshots. This API supports pagination.

", "DescribeDBSubnetGroups": "

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

", + "DescribeEngineDefaultClusterParameters": "

Returns the default engine and system parameter information for the cluster database engine.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

", "DescribeEngineDefaultParameters": "

Returns the default engine and system parameter information for the specified database engine.

", - "DescribeEventCategories": "

Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.

", + "DescribeEventCategories": "

Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.

", "DescribeEventSubscriptions": "

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify a SubscriptionName, lists the description for that subscription.

", "DescribeEvents": "

Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

", "DescribeOptionGroupOptions": "

Describes all available options.

", @@ -43,8 +55,11 @@ "DescribePendingMaintenanceActions": "

Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

", "DescribeReservedDBInstances": "

Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

", "DescribeReservedDBInstancesOfferings": "

Lists available reserved DB instance offerings.

", - "DownloadDBLogFilePortion": "

Downloads all or a portion of the specified log file.

", + "DownloadDBLogFilePortion": "

Downloads all or a portion of the specified log file, up to 1 MB in size.

", + "FailoverDBCluster": "

Forces a failover for a DB cluster.

A failover for a DB cluster promotes one of the read-only instances in the DB cluster to the master DB instance (the cluster writer) and deletes the current primary instance.

Amazon Aurora will automatically fail over to a read-only instance, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a DB instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

", "ListTagsForResource": "

Lists all tags on an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.

", + "ModifyDBCluster": "

Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

", + "ModifyDBClusterParameterGroup": "

Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

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

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

", "ModifyDBInstance": "

Modify settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

", "ModifyDBParameterGroup": "

Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

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.

After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

", "ModifyDBSubnetGroup": "

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.

", @@ -55,12 +70,15 @@ "RebootDBInstance": "

Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed.

If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs.

The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions.

", "RemoveSourceIdentifierFromSubscription": "

Removes a source identifier from an existing RDS event notification subscription.

", "RemoveTagsFromResource": "

Removes metadata tags from an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.

", + "ResetDBClusterParameterGroup": "

Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

", "ResetDBParameterGroup": "

Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

", - "RestoreDBInstanceFromDBSnapshot": "

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the same configuration as the original source database, except that the new RDS instance is created with the default security group.

If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot.

", - "RestoreDBInstanceToPointInTime": "

Restores a DB instance to an arbitrary point-in-time. Users can restore to any point in time before the LatestRestorableTime for up to BackupRetentionPeriod days. The target database is created from the source database with the same configuration as the original database except that the DB instance is created with the default DB security group.

", + "RestoreDBClusterFromSnapshot": "

Creates a new DB cluster from a DB cluster snapshot. The target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

", + "RestoreDBClusterToPointInTime": "

Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

", + "RestoreDBInstanceFromDBSnapshot": "

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration, but in a system chosen availability zone with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment.

If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot.

", + "RestoreDBInstanceToPointInTime": "

Restores a DB instance to an arbitrary point-in-time. Users can restore to any point in time before the LatestRestorableTime for up to BackupRetentionPeriod days. The target database is created with the most of original configuration, but in a system chosen availability zone with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.

", "RevokeDBSecurityGroupIngress": "

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

" }, - "service": "Amazon Relational Database Service

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.

Amazon RDS gives you access to the capabilities of a MySQL, PostgreSQL, Microsoft SQL Server, Oracle, or Aurora database server. This means the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your database instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.

This is an interface reference for Amazon RDS. It contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces may require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. For a summary of the Amazon RDS interfaces, go to Available RDS Interfaces.

", + "service": "Amazon Relational Database Service

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.

Amazon RDS gives you access to the capabilities of a MySQL, PostgreSQL, Microsoft SQL Server, Oracle, or Aurora database server. This means the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your database instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.

This is an interface reference for Amazon RDS. It contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. For a summary of the Amazon RDS interfaces, go to Available RDS Interfaces.

", "shapes": { "AccountAttributesMessage": { "base": "

Data returned by the DescribeAccountAttributes action.

", @@ -130,22 +148,34 @@ "AvailabilityZoneList": { "base": null, "refs": { - "OrderableDBInstanceOption$AvailabilityZones": "

A list of availability zones for the orderable DB instance.

" + "OrderableDBInstanceOption$AvailabilityZones": "

A list of Availability Zones for the orderable DB instance.

" + } + }, + "AvailabilityZones": { + "base": null, + "refs": { + "CreateDBClusterMessage$AvailabilityZones": "

A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones.

", + "DBCluster$AvailabilityZones": "

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

", + "DBClusterSnapshot$AvailabilityZones": "

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

", + "RestoreDBClusterFromSnapshotMessage$AvailabilityZones": "

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

" } }, "Boolean": { "base": null, "refs": { + "DBClusterMember$IsClusterWriter": "

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

", "DBInstance$MultiAZ": "

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

", "DBInstance$AutoMinorVersionUpgrade": "

Indicates that minor version patches are applied automatically.

", "DBInstance$PubliclyAccessible": "

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

", "DBInstance$StorageEncrypted": "

Specifies whether the DB instance is encrypted.

", "DBInstanceStatusInfo$Normal": "

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

", "DBSnapshot$Encrypted": "

Specifies whether the DB snapshot is encrypted.

", - "DeleteDBInstanceMessage$SkipFinalSnapshot": "

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

Specify true when deleting a Read Replica.

The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.

Default: false

", + "DeleteDBClusterMessage$SkipFinalSnapshot": "

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

You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is false.

Default: false

", + "DeleteDBInstanceMessage$SkipFinalSnapshot": "

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

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

Specify true when deleting a Read Replica.

The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.

Default: false

", "DescribeDBEngineVersionsMessage$DefaultOnly": "

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

", "DownloadDBLogFilePortionDetails$AdditionalDataPending": "

Boolean value that if true, indicates there is more data to be downloaded.

", "EventSubscription$Enabled": "

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

", + "ModifyDBClusterMessage$ApplyImmediately": "

A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster.

If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window.

Default: false

", "ModifyDBInstanceMessage$ApplyImmediately": "

Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.

If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and will be applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately Parameter to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes will be applied.

Default: false

", "ModifyDBInstanceMessage$AllowMajorVersionUpgrade": "

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

Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

", "ModifyOptionGroupMessage$ApplyImmediately": "

Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the option group.

", @@ -166,14 +196,16 @@ "Parameter$IsModifiable": "

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

", "ReservedDBInstance$MultiAZ": "

Indicates if the reservation applies to Multi-AZ deployments.

", "ReservedDBInstancesOffering$MultiAZ": "

Indicates if the offering applies to Multi-AZ deployments.

", + "ResetDBClusterParameterGroupMessage$ResetAllParameters": "

A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise. You cannot use this parameter if there is a list of parameter names specified for the Parameters parameter.

", "ResetDBParameterGroupMessage$ResetAllParameters": "

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

Default: true

", + "RestoreDBClusterToPointInTimeMessage$UseLatestRestorableTime": "

A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if RestoreToTime parameter is provided.

", "RestoreDBInstanceToPointInTimeMessage$UseLatestRestorableTime": "

Specifies whether (true) or not (false) the DB instance is restored from the latest backup time.

Default: false

Constraints: Cannot be specified if RestoreTime parameter is provided.

" } }, "BooleanOptional": { "base": null, "refs": { - "CreateDBInstanceMessage$MultiAZ": "

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

", + "CreateDBInstanceMessage$MultiAZ": "

Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true. Do not set this value if you want a Multi-AZ deployment for a SQL Server DB instance. Multi-AZ for SQL Server is set using the Mirroring option in an option group.

", "CreateDBInstanceMessage$AutoMinorVersionUpgrade": "

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

Default: true

", "CreateDBInstanceMessage$PubliclyAccessible": "

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

", "CreateDBInstanceMessage$StorageEncrypted": "

Specifies whether the DB instance is encrypted.

Default: false

", @@ -184,7 +216,7 @@ "DescribeOrderableDBInstanceOptionsMessage$Vpc": "

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

", "DescribeReservedDBInstancesMessage$MultiAZ": "

The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.

", "DescribeReservedDBInstancesOfferingsMessage$MultiAZ": "

The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.

", - "ModifyDBInstanceMessage$MultiAZ": "

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

Constraints: Cannot be specified if the DB instance is a Read Replica.

", + "ModifyDBInstanceMessage$MultiAZ": "

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

Constraints: Cannot be specified if the DB instance is a Read Replica. This parameter cannot be used with SQL Server DB instances. Multi-AZ for SQL Server DB instances is set using the Mirroring option in an option group associated with the DB instance.

", "ModifyDBInstanceMessage$AutoMinorVersionUpgrade": "

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

", "ModifyEventSubscriptionMessage$Enabled": "

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

", "PendingModifiedValues$MultiAZ": "

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

", @@ -226,6 +258,11 @@ "SupportedCharacterSetsList$member": null } }, + "CopyDBClusterSnapshotMessage": { + "base": "

", + "refs": { + } + }, "CopyDBParameterGroupMessage": { "base": "

", "refs": { @@ -241,6 +278,21 @@ "refs": { } }, + "CreateDBClusterMessage": { + "base": "

", + "refs": { + } + }, + "CreateDBClusterParameterGroupMessage": { + "base": "

", + "refs": { + } + }, + "CreateDBClusterSnapshotMessage": { + "base": "

", + "refs": { + } + }, "CreateDBInstanceMessage": { "base": "

", "refs": { @@ -281,6 +333,131 @@ "refs": { } }, + "DBCluster": { + "base": "

Contains the result of a successful invocation of the following actions:

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

", + "refs": { + "DBClusterList$member": null, + "CreateDBClusterResult$DBCluster": null, + "DeleteDBClusterResult$DBCluster": null, + "FailoverDBClusterResult$DBCluster": null, + "ModifyDBClusterResult$DBCluster": null, + "RestoreDBClusterFromSnapshotResult$DBCluster": null, + "RestoreDBClusterToPointInTimeResult$DBCluster": null + } + }, + "DBClusterAlreadyExistsFault": { + "base": "

User already has a DB cluster with the given identifier.

", + "refs": { + } + }, + "DBClusterList": { + "base": null, + "refs": { + "DBClusterMessage$DBClusters": "

Contains a list of DB clusters for the user.

" + } + }, + "DBClusterMember": { + "base": "

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

", + "refs": { + "DBClusterMemberList$member": null + } + }, + "DBClusterMemberList": { + "base": null, + "refs": { + "DBCluster$DBClusterMembers": "

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

" + } + }, + "DBClusterMessage": { + "base": "

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

", + "refs": { + } + }, + "DBClusterNotFoundFault": { + "base": "

DBClusterIdentifier does not refer to an existing DB cluster.

", + "refs": { + } + }, + "DBClusterOptionGroupMemberships": { + "base": null, + "refs": { + "DBCluster$DBClusterOptionGroupMemberships": "

Provides the list of option group memberships for this DB cluster.

" + } + }, + "DBClusterOptionGroupStatus": { + "base": "

Contains status information for a DB cluster option group.

", + "refs": { + "DBClusterOptionGroupMemberships$member": null + } + }, + "DBClusterParameterGroup": { + "base": "

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

This data type is used as a request parameter in the DeleteDBClusterParameterGroup action, and as a response element in the DescribeDBClusterParameterGroups action.

", + "refs": { + "DBClusterParameterGroupList$member": null, + "CreateDBClusterParameterGroupResult$DBClusterParameterGroup": null + } + }, + "DBClusterParameterGroupDetails": { + "base": "

Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.

", + "refs": { + } + }, + "DBClusterParameterGroupList": { + "base": null, + "refs": { + "DBClusterParameterGroupsMessage$DBClusterParameterGroups": "

A list of DB cluster parameter groups.

" + } + }, + "DBClusterParameterGroupNameMessage": { + "base": "

", + "refs": { + } + }, + "DBClusterParameterGroupNotFoundFault": { + "base": "

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

", + "refs": { + } + }, + "DBClusterParameterGroupsMessage": { + "base": "

", + "refs": { + } + }, + "DBClusterQuotaExceededFault": { + "base": "

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

", + "refs": { + } + }, + "DBClusterSnapshot": { + "base": "

Contains the result of a successful invocation of the following actions:

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

", + "refs": { + "DBClusterSnapshotList$member": null, + "CopyDBClusterSnapshotResult$DBClusterSnapshot": null, + "CreateDBClusterSnapshotResult$DBClusterSnapshot": null, + "DeleteDBClusterSnapshotResult$DBClusterSnapshot": null + } + }, + "DBClusterSnapshotAlreadyExistsFault": { + "base": "

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

", + "refs": { + } + }, + "DBClusterSnapshotList": { + "base": null, + "refs": { + "DBClusterSnapshotMessage$DBClusterSnapshots": "

Provides a list of DB cluster snapshots for the user.

" + } + }, + "DBClusterSnapshotMessage": { + "base": "

Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.

", + "refs": { + } + }, + "DBClusterSnapshotNotFoundFault": { + "base": "

DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.

", + "refs": { + } + }, "DBEngineVersion": { "base": "

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

", "refs": { @@ -345,6 +522,11 @@ "DBInstance$StatusInfos": "

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

" } }, + "DBLogFileNotFoundFault": { + "base": "

LogFileName does not refer to an existing DB log file.

", + "refs": { + } + }, "DBParameterGroup": { "base": "

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

This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.

", "refs": { @@ -547,6 +729,21 @@ "refs": { } }, + "DeleteDBClusterMessage": { + "base": "

", + "refs": { + } + }, + "DeleteDBClusterParameterGroupMessage": { + "base": "

", + "refs": { + } + }, + "DeleteDBClusterSnapshotMessage": { + "base": "

", + "refs": { + } + }, "DeleteDBInstanceMessage": { "base": "

", "refs": { @@ -592,6 +789,26 @@ "refs": { } }, + "DescribeDBClusterParameterGroupsMessage": { + "base": "

", + "refs": { + } + }, + "DescribeDBClusterParametersMessage": { + "base": "

", + "refs": { + } + }, + "DescribeDBClusterSnapshotsMessage": { + "base": "

", + "refs": { + } + }, + "DescribeDBClustersMessage": { + "base": "

", + "refs": { + } + }, "DescribeDBEngineVersionsMessage": { "base": null, "refs": { @@ -649,6 +866,11 @@ "refs": { } }, + "DescribeEngineDefaultClusterParametersMessage": { + "base": "

", + "refs": { + } + }, "DescribeEngineDefaultParametersMessage": { "base": "

", "refs": { @@ -740,6 +962,7 @@ "EngineDefaults": { "base": "

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

", "refs": { + "DescribeEngineDefaultClusterParametersResult$EngineDefaults": null, "DescribeEngineDefaultParametersResult$EngineDefaults": null } }, @@ -815,6 +1038,11 @@ "refs": { } }, + "FailoverDBClusterMessage": { + "base": "

", + "refs": { + } + }, "Filter": { "base": null, "refs": { @@ -825,6 +1053,10 @@ "base": null, "refs": { "DescribeCertificatesMessage$Filters": "

This parameter is not currently supported.

", + "DescribeDBClusterParameterGroupsMessage$Filters": "

This parameter is not currently supported.

", + "DescribeDBClusterParametersMessage$Filters": "

This parameter is not currently supported.

", + "DescribeDBClusterSnapshotsMessage$Filters": "

This parameter is not currently supported.

", + "DescribeDBClustersMessage$Filters": "

This parameter is not currently supported.

", "DescribeDBEngineVersionsMessage$Filters": "

Not currently supported.

", "DescribeDBInstancesMessage$Filters": "

This parameter is not currently supported.

", "DescribeDBLogFilesMessage$Filters": "

This parameter is not currently supported.

", @@ -833,6 +1065,7 @@ "DescribeDBSecurityGroupsMessage$Filters": "

This parameter is not currently supported.

", "DescribeDBSnapshotsMessage$Filters": "

This parameter is not currently supported.

", "DescribeDBSubnetGroupsMessage$Filters": "

This parameter is not currently supported.

", + "DescribeEngineDefaultClusterParametersMessage$Filters": "

This parameter is not currently supported.

", "DescribeEngineDefaultParametersMessage$Filters": "

Not currently supported.

", "DescribeEventCategoriesMessage$Filters": "

This parameter is not currently supported.

", "DescribeEventSubscriptionsMessage$Filters": "

This parameter is not currently supported.

", @@ -869,20 +1102,34 @@ "refs": { } }, + "InsufficientDBClusterCapacityFault": { + "base": "

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

", + "refs": { + } + }, "InsufficientDBInstanceCapacityFault": { "base": "

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

", "refs": { } }, + "InsufficientStorageClusterCapacityFault": { + "base": "

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

", + "refs": { + } + }, "Integer": { "base": null, "refs": { + "DBClusterSnapshot$AllocatedStorage": "

Specifies the allocated storage size in gigabytes (GB).

", + "DBClusterSnapshot$Port": "

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

", + "DBClusterSnapshot$PercentProgress": "

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

", "DBInstance$AllocatedStorage": "

Specifies the allocated storage size specified in gigabytes.

", "DBInstance$BackupRetentionPeriod": "

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

", + "DBInstance$DbInstancePort": "

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.

", "DBSnapshot$AllocatedStorage": "

Specifies the allocated storage size in gigabytes (GB).

", "DBSnapshot$Port": "

Specifies the port that the database engine was listening on at the time of the snapshot.

", "DBSnapshot$PercentProgress": "

The percentage of the estimated data that has been transferred.

", - "DownloadDBLogFilePortionMessage$NumberOfLines": "

The number of lines to download.

If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.

", + "DownloadDBLogFilePortionMessage$NumberOfLines": "

The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file will be truncated at 1 MB in size.

If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.

", "Endpoint$Port": "

Specifies the port that the database engine is listening on.

", "ReservedDBInstance$Duration": "

The duration of the reservation in seconds.

", "ReservedDBInstance$DBInstanceCount": "

The number of reserved DB instances.

", @@ -892,36 +1139,48 @@ "IntegerOptional": { "base": null, "refs": { - "CreateDBInstanceMessage$AllocatedStorage": "

The amount of storage (in gigabytes) to be initially allocated for the database instance.

Type: Integer

MySQL

Constraints: Must be an integer from 5 to 3072.

PostgreSQL

Constraints: Must be an integer from 5 to 3072.

Oracle

Constraints: Must be an integer from 10 to 3072.

SQL Server

Constraints: Must be an integer from 200 to 1024 (Standard Edition and Enterprise Edition) or from 20 to 1024 (Express Edition and Web Edition)

", + "CreateDBClusterMessage$BackupRetentionPeriod": "

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.

Default: 1

Constraints:

", + "CreateDBClusterMessage$Port": "

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

Default: 3306

", + "CreateDBInstanceMessage$AllocatedStorage": "

The amount of storage (in gigabytes) to be initially allocated for the database instance.

Type: Integer

MySQL

Constraints: Must be an integer from 5 to 6144.

PostgreSQL

Constraints: Must be an integer from 5 to 6144.

Oracle

Constraints: Must be an integer from 10 to 6144.

SQL Server

Constraints: Must be an integer from 200 to 4096 (Standard Edition and Enterprise Edition) or from 20 to 4096 (Express Edition and Web Edition)

", "CreateDBInstanceMessage$BackupRetentionPeriod": "

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.

Default: 1

Constraints:

", "CreateDBInstanceMessage$Port": "

The port number on which the database accepts connections.

MySQL

Default: 3306

Valid Values: 1150-65535

Type: Integer

PostgreSQL

Default: 5432

Valid Values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid Values: 1150-65535

SQL Server

Default: 1433

Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.

", "CreateDBInstanceMessage$Iops": "

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

Constraints: To use PIOPS, this value must be an integer greater than 1000.

", "CreateDBInstanceReadReplicaMessage$Port": "

The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

", "CreateDBInstanceReadReplicaMessage$Iops": "

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

", + "DBCluster$AllocatedStorage": "

Specifies the allocated storage size in gigabytes (GB).

", + "DBCluster$BackupRetentionPeriod": "

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

", + "DBCluster$Port": "

Specifies the port that the database engine is listening on.

", "DBInstance$Iops": "

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

", "DBSnapshot$Iops": "

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

", - "DescribeCertificatesMessage$MaxRecords": "

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

Default: 100

Constraints: Minimum 20, maximum 100

", - "DescribeDBEngineVersionsMessage$MaxRecords": "

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

Default: 100

Constraints: minimum 20, maximum 100

", - "DescribeDBInstancesMessage$MaxRecords": "

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

Default: 100

Constraints: minimum 20, maximum 100

", + "DescribeCertificatesMessage$MaxRecords": "

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

Default: 100

Constraints: Minimum 20, maximum 100.

", + "DescribeDBClusterParameterGroupsMessage$MaxRecords": "

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

Default: 100

Constraints: Minimum 20, maximum 100.

", + "DescribeDBClusterParametersMessage$MaxRecords": "

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

Default: 100

Constraints: Minimum 20, maximum 100.

", + "DescribeDBClusterSnapshotsMessage$MaxRecords": "

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

Default: 100

Constraints: Minimum 20, maximum 100.

", + "DescribeDBClustersMessage$MaxRecords": "

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

Default: 100

Constraints: Minimum 20, maximum 100.

", + "DescribeDBEngineVersionsMessage$MaxRecords": "

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

Default: 100

Constraints: Minimum 20, maximum 100.

", + "DescribeDBInstancesMessage$MaxRecords": "

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

Default: 100

Constraints: Minimum 20, maximum 100.

", "DescribeDBLogFilesMessage$MaxRecords": "

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

", - "DescribeDBParameterGroupsMessage$MaxRecords": "

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

Default: 100

Constraints: minimum 20, maximum 100

", - "DescribeDBParametersMessage$MaxRecords": "

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

Default: 100

Constraints: minimum 20, maximum 100

", - "DescribeDBSecurityGroupsMessage$MaxRecords": "

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

Default: 100

Constraints: minimum 20, maximum 100

", - "DescribeDBSnapshotsMessage$MaxRecords": "

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

Default: 100

Constraints: minimum 20, maximum 100

", - "DescribeDBSubnetGroupsMessage$MaxRecords": "

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

Default: 100

Constraints: minimum 20, maximum 100

", - "DescribeEngineDefaultParametersMessage$MaxRecords": "

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

Default: 100

Constraints: minimum 20, maximum 100

", - "DescribeEventSubscriptionsMessage$MaxRecords": "

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

Default: 100

Constraints: minimum 20, maximum 100

", + "DescribeDBParameterGroupsMessage$MaxRecords": "

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

Default: 100

Constraints: Minimum 20, maximum 100.

", + "DescribeDBParametersMessage$MaxRecords": "

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

Default: 100

Constraints: Minimum 20, maximum 100.

", + "DescribeDBSecurityGroupsMessage$MaxRecords": "

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

Default: 100

Constraints: Minimum 20, maximum 100.

", + "DescribeDBSnapshotsMessage$MaxRecords": "

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

Default: 100

Constraints: Minimum 20, maximum 100.

", + "DescribeDBSubnetGroupsMessage$MaxRecords": "

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

Default: 100

Constraints: Minimum 20, maximum 100.

", + "DescribeEngineDefaultClusterParametersMessage$MaxRecords": "

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

Default: 100

Constraints: Minimum 20, maximum 100.

", + "DescribeEngineDefaultParametersMessage$MaxRecords": "

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

Default: 100

Constraints: Minimum 20, maximum 100.

", + "DescribeEventSubscriptionsMessage$MaxRecords": "

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

Default: 100

Constraints: Minimum 20, maximum 100.

", "DescribeEventsMessage$Duration": "

The number of minutes to retrieve events for.

Default: 60

", - "DescribeEventsMessage$MaxRecords": "

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

Default: 100

Constraints: minimum 20, maximum 100

", - "DescribeOptionGroupOptionsMessage$MaxRecords": "

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

Default: 100

Constraints: minimum 20, maximum 100

", - "DescribeOptionGroupsMessage$MaxRecords": "

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

Default: 100

Constraints: minimum 20, maximum 100

", - "DescribeOrderableDBInstanceOptionsMessage$MaxRecords": "

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

Default: 100

Constraints: minimum 20, maximum 100

", - "DescribePendingMaintenanceActionsMessage$MaxRecords": "

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

Default: 100

Constraints: minimum 20, maximum 100

", - "DescribeReservedDBInstancesMessage$MaxRecords": "

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

Default: 100

Constraints: minimum 20, maximum 100

", - "DescribeReservedDBInstancesOfferingsMessage$MaxRecords": "

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

Default: 100

Constraints: minimum 20, maximum 100

", - "ModifyDBInstanceMessage$AllocatedStorage": "

The new storage capacity of the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless ApplyImmediately is set to true for this request.

MySQL

Default: Uses existing setting

Valid Values: 5-3072

Constraints: Value supplied must be at least 10% greater than the current value. 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.

Type: Integer

PostgreSQL

Default: Uses existing setting

Valid Values: 5-3072

Constraints: Value supplied must be at least 10% greater than the current value. 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.

Type: Integer

Oracle

Default: Uses existing setting

Valid Values: 10-3072

Constraints: Value supplied must be at least 10% greater than the current value. 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.

SQL Server

Cannot be modified.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but may experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.

", + "DescribeEventsMessage$MaxRecords": "

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

Default: 100

Constraints: Minimum 20, maximum 100.

", + "DescribeOptionGroupOptionsMessage$MaxRecords": "

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

Default: 100

Constraints: Minimum 20, maximum 100.

", + "DescribeOptionGroupsMessage$MaxRecords": "

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

Default: 100

Constraints: Minimum 20, maximum 100.

", + "DescribeOrderableDBInstanceOptionsMessage$MaxRecords": "

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

Default: 100

Constraints: Minimum 20, maximum 100.

", + "DescribePendingMaintenanceActionsMessage$MaxRecords": "

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

Default: 100

Constraints: Minimum 20, maximum 100.

", + "DescribeReservedDBInstancesMessage$MaxRecords": "

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

Default: 100

Constraints: Minimum 20, maximum 100.

", + "DescribeReservedDBInstancesOfferingsMessage$MaxRecords": "

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

Default: 100

Constraints: Minimum 20, maximum 100.

", + "ModifyDBClusterMessage$BackupRetentionPeriod": "

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.

Default: 1

Constraints:

", + "ModifyDBClusterMessage$Port": "

The port number on which the DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

", + "ModifyDBInstanceMessage$AllocatedStorage": "

The new storage capacity of the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless ApplyImmediately is set to true for this request.

MySQL

Default: Uses existing setting

Valid Values: 5-6144

Constraints: Value supplied must be at least 10% greater than the current value. 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.

Type: Integer

PostgreSQL

Default: Uses existing setting

Valid Values: 5-6144

Constraints: Value supplied must be at least 10% greater than the current value. 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.

Type: Integer

Oracle

Default: Uses existing setting

Valid Values: 10-6144

Constraints: Value supplied must be at least 10% greater than the current value. 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.

SQL Server

Cannot be modified.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.

", "ModifyDBInstanceMessage$BackupRetentionPeriod": "

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.

Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

Default: Uses existing setting

Constraints:

", - "ModifyDBInstanceMessage$Iops": "

The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

Default: Uses existing setting

Constraints: Value supplied must be at least 10% greater than the current value. 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. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.

SQL Server

Setting the IOPS value for the SQL Server database engine is not supported.

Type: Integer

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but may experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.

", + "ModifyDBInstanceMessage$Iops": "

The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

Default: Uses existing setting

Constraints: Value supplied must be at least 10% greater than the current value. 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. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.

SQL Server

Setting the IOPS value for the SQL Server database engine is not supported.

Type: Integer

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.

", "Option$Port": "

If required, the port configured for this option to use.

", "OptionConfiguration$Port": "

The optional port for the option.

", "OptionGroupOption$DefaultPort": "

If the option requires a port, specifies the default port for the option.

", @@ -931,12 +1190,24 @@ "PendingModifiedValues$Iops": "

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

", "PromoteReadReplicaMessage$BackupRetentionPeriod": "

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.

Default: 1

Constraints:

", "PurchaseReservedDBInstancesOfferingMessage$DBInstanceCount": "

The number of instances to reserve.

Default: 1

", + "RestoreDBClusterFromSnapshotMessage$Port": "

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

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

", + "RestoreDBClusterToPointInTimeMessage$Port": "

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

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

", "RestoreDBInstanceFromDBSnapshotMessage$Port": "

The port number on which the database accepts connections.

Default: The same port as the original DB instance

Constraints: Value must be 1150-65535

", "RestoreDBInstanceFromDBSnapshotMessage$Iops": "

Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts.

Constraints: Must be an integer greater than 1000.

SQL Server

Setting the IOPS value for the SQL Server database engine is not supported.

", "RestoreDBInstanceToPointInTimeMessage$Port": "

The port number on which the database accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB instance.

", "RestoreDBInstanceToPointInTimeMessage$Iops": "

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

Constraints: Must be an integer greater than 1000.

SQL Server

Setting the IOPS value for the SQL Server database engine is not supported.

" } }, + "InvalidDBClusterSnapshotStateFault": { + "base": "

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

", + "refs": { + } + }, + "InvalidDBClusterStateFault": { + "base": "

The supplied value is not a valid DB cluster state.

", + "refs": { + } + }, "InvalidDBInstanceStateFault": { "base": "

The specified DB instance is not in the available state.

", "refs": { @@ -1020,10 +1291,20 @@ "AccountQuota$Max": "

The maximum allowed value for the quota.

", "DescribeDBLogFilesDetails$LastWritten": "

A POSIX timestamp when the last log entry was written.

", "DescribeDBLogFilesDetails$Size": "

The size, in bytes, of the log file for the specified DB instance.

", - "DescribeDBLogFilesMessage$FileLastWritten": "

Filters the available log files for files written since the specified date, in POSIX timestamp format.

", + "DescribeDBLogFilesMessage$FileLastWritten": "

Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

", "DescribeDBLogFilesMessage$FileSize": "

Filters the available log files for files larger than the specified size.

" } }, + "ModifyDBClusterMessage": { + "base": "

", + "refs": { + } + }, + "ModifyDBClusterParameterGroupMessage": { + "base": "

", + "refs": { + } + }, "ModifyDBInstanceMessage": { "base": "

", "refs": { @@ -1206,10 +1487,13 @@ "ParametersList": { "base": null, "refs": { + "DBClusterParameterGroupDetails$Parameters": "

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

", "DBParameterGroupDetails$Parameters": "

A list of Parameter values.

", "EngineDefaults$Parameters": "

Contains a list of engine default parameters.

", - "ModifyDBParameterGroupMessage$Parameters": "

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

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

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

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

MySQL

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

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

Oracle

Valid Values (for Apply method): pending-reboot

" + "ModifyDBClusterParameterGroupMessage$Parameters": "

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

", + "ModifyDBParameterGroupMessage$Parameters": "

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

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

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

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

", + "ResetDBParameterGroupMessage$Parameters": "

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

MySQL

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

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

Oracle

Valid Values (for Apply method): pending-reboot

" } }, "PendingMaintenanceAction": { @@ -1350,6 +1634,11 @@ "refs": { } }, + "ResetDBClusterParameterGroupMessage": { + "base": "

", + "refs": { + } + }, "ResetDBParameterGroupMessage": { "base": "

", "refs": { @@ -1367,6 +1656,16 @@ "ApplyPendingMaintenanceActionResult$ResourcePendingMaintenanceActions": null } }, + "RestoreDBClusterFromSnapshotMessage": { + "base": "

", + "refs": { + } + }, + "RestoreDBClusterToPointInTimeMessage": { + "base": "

", + "refs": { + } + }, "RestoreDBInstanceFromDBSnapshotMessage": { "base": "

", "refs": { @@ -1438,30 +1737,50 @@ "AddSourceIdentifierToSubscriptionMessage$SubscriptionName": "

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

", "AddSourceIdentifierToSubscriptionMessage$SourceIdentifier": "

The identifier of the event source to be added. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.

Constraints:

", "AddTagsToResourceMessage$ResourceName": "

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

", - "ApplyPendingMaintenanceActionMessage$ResourceIdentifier": "

The ARN of the resource that the pending maintenance action applies to.

", + "ApplyPendingMaintenanceActionMessage$ResourceIdentifier": "

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

", "ApplyPendingMaintenanceActionMessage$ApplyAction": "

The pending maintenance action to apply to this resource.

", "ApplyPendingMaintenanceActionMessage$OptInType": "

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

Valid values:

", "AuthorizeDBSecurityGroupIngressMessage$DBSecurityGroupName": "

The name of the DB security group to add authorization to.

", "AuthorizeDBSecurityGroupIngressMessage$CIDRIP": "

The IP range to authorize.

", - "AuthorizeDBSecurityGroupIngressMessage$EC2SecurityGroupName": "

Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

", - "AuthorizeDBSecurityGroupIngressMessage$EC2SecurityGroupId": "

Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

", - "AuthorizeDBSecurityGroupIngressMessage$EC2SecurityGroupOwnerId": "

AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

", + "AuthorizeDBSecurityGroupIngressMessage$EC2SecurityGroupName": "

Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

", + "AuthorizeDBSecurityGroupIngressMessage$EC2SecurityGroupId": "

Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

", + "AuthorizeDBSecurityGroupIngressMessage$EC2SecurityGroupOwnerId": "

AWS account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

", "AvailabilityZone$Name": "

The name of the availability zone.

", + "AvailabilityZones$member": null, "Certificate$CertificateIdentifier": "

The unique key that identifies a certificate.

", "Certificate$CertificateType": "

The type of the certificate.

", "Certificate$Thumbprint": "

The thumbprint of the certificate.

", "CertificateMessage$Marker": "

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

", "CharacterSet$CharacterSetName": "

The name of the character set.

", "CharacterSet$CharacterSetDescription": "

The description of the character set.

", - "CopyDBParameterGroupMessage$SourceDBParameterGroupIdentifier": "

The identifier or ARN for the source DB parameter group.

Constraints:

", + "CopyDBClusterSnapshotMessage$SourceDBClusterSnapshotIdentifier": "

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

Constraints:

Example: my-cluster-snapshot1

", + "CopyDBClusterSnapshotMessage$TargetDBClusterSnapshotIdentifier": "

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

Constraints:

Example: my-cluster-snapshot2

", + "CopyDBParameterGroupMessage$SourceDBParameterGroupIdentifier": "

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

Constraints:

", "CopyDBParameterGroupMessage$TargetDBParameterGroupIdentifier": "

The identifier for the copied DB parameter group.

Constraints:

Example: my-db-parameter-group

", "CopyDBParameterGroupMessage$TargetDBParameterGroupDescription": "

A description for the copied DB parameter group.

", "CopyDBSnapshotMessage$SourceDBSnapshotIdentifier": "

The identifier for the source DB snapshot.

Constraints:

Example: rds:mydb-2012-04-02-00-01

Example: arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805

", "CopyDBSnapshotMessage$TargetDBSnapshotIdentifier": "

The identifier for the copied snapshot.

Constraints:

Example: my-db-snapshot

", - "CopyOptionGroupMessage$SourceOptionGroupIdentifier": "

The identifier or ARN for the source option group.

Constraints:

", + "CopyOptionGroupMessage$SourceOptionGroupIdentifier": "

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

Constraints:

", "CopyOptionGroupMessage$TargetOptionGroupIdentifier": "

The identifier for the copied option group.

Constraints:

Example: my-option-group

", "CopyOptionGroupMessage$TargetOptionGroupDescription": "

The description for the copied option group.

", - "CreateDBInstanceMessage$DBName": "

The meaning of this parameter differs according to the database engine you use.

Type: String

MySQL

The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.

Constraints:

PostgreSQL

The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.

Constraints:

Oracle

The Oracle System ID (SID) of the created DB instance.

Default: ORCL

Constraints:

SQL Server

Not applicable. Must be null.

", + "CreateDBClusterMessage$CharacterSetName": "

A value that indicates that the DB cluster should be associated with the specified CharacterSet.

", + "CreateDBClusterMessage$DatabaseName": "

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

", + "CreateDBClusterMessage$DBClusterIdentifier": "

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

Constraints:

Example: my-cluster1

", + "CreateDBClusterMessage$DBClusterParameterGroupName": "

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, default.aurora5.6 for the specified engine will be used.

Constraints:

", + "CreateDBClusterMessage$DBSubnetGroupName": "

A DB subnet group to associate with this DB cluster.

", + "CreateDBClusterMessage$Engine": "

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

Valid Values: MySQL

", + "CreateDBClusterMessage$EngineVersion": "

The version number of the database engine to use.

Aurora

Example: 5.6.0

", + "CreateDBClusterMessage$MasterUsername": "

The name of the master user for the client DB cluster.

Constraints:

", + "CreateDBClusterMessage$MasterUserPassword": "

The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

Constraints: Must contain from 8 to 41 characters.

", + "CreateDBClusterMessage$OptionGroupName": "

A value that indicates that the DB cluster should be associated with the specified option group.

Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.

", + "CreateDBClusterMessage$PreferredBackupWindow": "

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

Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

", + "CreateDBClusterMessage$PreferredMaintenanceWindow": "

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

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

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

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

Constraints: Minimum 30-minute window.

", + "CreateDBClusterParameterGroupMessage$DBClusterParameterGroupName": "

The name of the DB cluster parameter group.

Constraints:

This value is stored as a lowercase string.", + "CreateDBClusterParameterGroupMessage$DBParameterGroupFamily": "

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

", + "CreateDBClusterParameterGroupMessage$Description": "

The description for the DB cluster parameter group.

", + "CreateDBClusterSnapshotMessage$DBClusterSnapshotIdentifier": "

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

Constraints:

Example: my-cluster1-snapshot1

", + "CreateDBClusterSnapshotMessage$DBClusterIdentifier": "

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

Constraints:

Example: my-cluster1

", + "CreateDBInstanceMessage$DBName": "

The meaning of this parameter differs according to the database engine you use.

Type: String

MySQL

The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.

Constraints:

PostgreSQL

The name of the database to create when the DB instance is created. If this parameter is not specified, the default \"postgres\" database is created in the DB instance.

Constraints:

Oracle

The Oracle System ID (SID) of the created DB instance.

Default: ORCL

Constraints:

SQL Server

Not applicable. Must be null.

", "CreateDBInstanceMessage$DBInstanceIdentifier": "

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

Constraints:

Example: mydbinstance

", "CreateDBInstanceMessage$DBInstanceClass": "

The compute and memory capacity of the DB instance.

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium

", "CreateDBInstanceMessage$Engine": "

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

Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres

Not every database engine is available for every AWS region.

", @@ -1469,28 +1788,29 @@ "CreateDBInstanceMessage$MasterUserPassword": "

The password for the master database user. Can be any printable ASCII character except \"/\", \"\"\", or \"@\".

Type: String

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

SQL Server

Constraints: Must contain from 8 to 128 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

", "CreateDBInstanceMessage$AvailabilityZone": "

The EC2 Availability Zone that the database instance will be created in. For information on regions and Availability Zones, see Regions and Availability Zones.

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

Example: us-east-1d

Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint.

", "CreateDBInstanceMessage$DBSubnetGroupName": "

A DB subnet group to associate with this DB instance.

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

", - "CreateDBInstanceMessage$PreferredMaintenanceWindow": "

The weekly time range (in UTC) during which system maintenance can occur. For more information, see DB Instance Maintenance.

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

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

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

Constraints: Minimum 30-minute window.

", + "CreateDBInstanceMessage$PreferredMaintenanceWindow": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see DB Instance Maintenance.

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

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

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

Constraints: Minimum 30-minute window.

", "CreateDBInstanceMessage$DBParameterGroupName": "

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

Constraints:

", - "CreateDBInstanceMessage$PreferredBackupWindow": "

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see DB Instance Backups.

Default: A 30-minute window selected at random from an 8-hour block of time per region. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.

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

", - "CreateDBInstanceMessage$EngineVersion": "

The version number of the database engine to use.

The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS region.

MySQL

MySQL

MySQL

MySQL

Oracle Database Enterprise Edition (oracle-ee)

Oracle Database Enterprise Edition (oracle-ee)

Oracle Database Standard Edition (oracle-se)

Oracle Database Standard Edition (oracle-se)

Oracle Database Standard Edition One (oracle-se1)

Oracle Database Standard Edition One (oracle-se1)

PostgreSQL

PostgreSQL

Microsoft SQL Server Enterprise Edition (sqlserver-ee)

Microsoft SQL Server Enterprise Edition (sqlserver-ee)

Microsoft SQL Server Express Edition (sqlserver-ex)

Microsoft SQL Server Express Edition (sqlserver-ex)

Microsoft SQL Server Standard Edition (sqlserver-se)

Microsoft SQL Server Standard Edition (sqlserver-se)

Microsoft SQL Server Web Edition (sqlserver-web)

Microsoft SQL Server Web Edition (sqlserver-web)

", + "CreateDBInstanceMessage$PreferredBackupWindow": "

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see DB Instance Backups.

Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

", + "CreateDBInstanceMessage$EngineVersion": "

The version number of the database engine to use.

The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS region.

MySQL

MySQL

MySQL

MySQL

Oracle Database Enterprise Edition (oracle-ee)

Oracle Database Enterprise Edition (oracle-ee)

Oracle Database Enterprise Edition (oracle-ee)

Oracle Database Standard Edition (oracle-se)

Oracle Database Standard Edition (oracle-se)

Oracle Database Standard Edition (oracle-se)

Oracle Database Standard Edition One (oracle-se1)

Oracle Database Standard Edition One (oracle-se1)

Oracle Database Standard Edition One (oracle-se1)

PostgreSQL

PostgreSQL

PostgreSQL

Microsoft SQL Server Enterprise Edition (sqlserver-ee)

Microsoft SQL Server Enterprise Edition (sqlserver-ee)

Microsoft SQL Server Express Edition (sqlserver-ex)

Microsoft SQL Server Express Edition (sqlserver-ex)

Microsoft SQL Server Standard Edition (sqlserver-se)

Microsoft SQL Server Standard Edition (sqlserver-se)

Microsoft SQL Server Web Edition (sqlserver-web)

Microsoft SQL Server Web Edition (sqlserver-web)

", "CreateDBInstanceMessage$LicenseModel": "

License model information for this DB instance.

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

", "CreateDBInstanceMessage$OptionGroupName": "

Indicates that the DB instance should be associated with the specified option group.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

", "CreateDBInstanceMessage$CharacterSetName": "

For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.

", + "CreateDBInstanceMessage$DBClusterIdentifier": "

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

For information on creating a DB cluster, see CreateDBCluster.

Type: String

", "CreateDBInstanceMessage$StorageType": "

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

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified; otherwise standard

", "CreateDBInstanceMessage$TdeCredentialArn": "

The ARN from the Key Store with which to associate the instance for TDE encryption.

", "CreateDBInstanceMessage$TdeCredentialPassword": "

The password for the given ARN from the Key Store in order to access the device.

", "CreateDBInstanceMessage$KmsKeyId": "

The KMS key identifier for an encrypted DB instance.

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

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

", - "CreateDBInstanceReadReplicaMessage$DBInstanceIdentifier": "

The DB instance identifier of the Read Replica. This is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.

", + "CreateDBInstanceReadReplicaMessage$DBInstanceIdentifier": "

The DB instance identifier of the Read Replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.

", "CreateDBInstanceReadReplicaMessage$SourceDBInstanceIdentifier": "

The identifier of the DB instance that will act as the source for the Read Replica. Each DB instance can have up to five Read Replicas.

Constraints:

", "CreateDBInstanceReadReplicaMessage$DBInstanceClass": "

The compute and memory capacity of the Read Replica.

Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium

Default: Inherits from the source DB instance.

", "CreateDBInstanceReadReplicaMessage$AvailabilityZone": "

The Amazon EC2 Availability Zone that the Read Replica will be created in.

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

Example: us-east-1d

", "CreateDBInstanceReadReplicaMessage$OptionGroupName": "

The option group the DB instance will be associated with. If omitted, the default option group for the engine specified will be used.

", "CreateDBInstanceReadReplicaMessage$DBSubnetGroupName": "

Specifies a DB subnet group for the DB instance. The new DB instance will be created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC.

Constraints:

", "CreateDBInstanceReadReplicaMessage$StorageType": "

Specifies the storage type to be associated with the Read Replica.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified; otherwise standard

", - "CreateDBParameterGroupMessage$DBParameterGroupName": "

The name of the DB parameter group.

Constraints:

This value is stored as a lower-case string.", + "CreateDBParameterGroupMessage$DBParameterGroupName": "

The name of the DB parameter group.

Constraints:

This value is stored as a lowercase string.", "CreateDBParameterGroupMessage$DBParameterGroupFamily": "

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

", "CreateDBParameterGroupMessage$Description": "

The description for the DB parameter group.

", - "CreateDBSecurityGroupMessage$DBSecurityGroupName": "

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

Constraints:

Example: mysecuritygroup

", + "CreateDBSecurityGroupMessage$DBSecurityGroupName": "

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

Constraints:

Example: mysecuritygroup

", "CreateDBSecurityGroupMessage$DBSecurityGroupDescription": "

The description for the DB security group.

", "CreateDBSnapshotMessage$DBSnapshotIdentifier": "

The identifier for the DB snapshot.

Constraints:

Example: my-snapshot-id

", "CreateDBSnapshotMessage$DBInstanceIdentifier": "

The DB instance identifier. This is the unique key that identifies a DB instance.

Constraints:

", @@ -1503,13 +1823,47 @@ "CreateOptionGroupMessage$EngineName": "

Specifies the name of the engine that this option group should be associated with.

", "CreateOptionGroupMessage$MajorEngineVersion": "

Specifies the major version of the engine that this option group should be associated with.

", "CreateOptionGroupMessage$OptionGroupDescription": "

The description of the option group.

", + "DBCluster$CharacterSetName": "

If present, specifies the name of the character set that this cluster is associated with.

", + "DBCluster$DatabaseName": "

Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

", + "DBCluster$DBClusterIdentifier": "

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

", + "DBCluster$DBClusterParameterGroup": "

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

", + "DBCluster$DBSubnetGroup": "

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

", + "DBCluster$Status": "

Specifies the current state of this DB cluster.

", + "DBCluster$PercentProgress": "

Specifies the progress of the operation as a percentage.

", + "DBCluster$Endpoint": "

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

", + "DBCluster$Engine": "

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

", + "DBCluster$EngineVersion": "

Indicates the database engine version.

", + "DBCluster$MasterUsername": "

Contains the master username for the DB cluster.

", + "DBCluster$PreferredBackupWindow": "

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

", + "DBCluster$PreferredMaintenanceWindow": "

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

", + "DBClusterMember$DBInstanceIdentifier": "

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

", + "DBClusterMember$DBClusterParameterGroupStatus": "

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

", + "DBClusterMessage$Marker": "

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

", + "DBClusterOptionGroupStatus$DBClusterOptionGroupName": "

Specifies the name of the DB cluster option group.

", + "DBClusterOptionGroupStatus$Status": "

Specifies the status of the DB cluster option group.

", + "DBClusterParameterGroup$DBClusterParameterGroupName": "

Provides the name of the DB cluster parameter group.

", + "DBClusterParameterGroup$DBParameterGroupFamily": "

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

", + "DBClusterParameterGroup$Description": "

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

", + "DBClusterParameterGroupDetails$Marker": "

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

", + "DBClusterParameterGroupNameMessage$DBClusterParameterGroupName": "

The name of the DB cluster parameter group.

Constraints:

This value is stored as a lowercase string.", + "DBClusterParameterGroupsMessage$Marker": "

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

", + "DBClusterSnapshot$DBClusterSnapshotIdentifier": "

Specifies the identifier for the DB cluster snapshot.

", + "DBClusterSnapshot$DBClusterIdentifier": "

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

", + "DBClusterSnapshot$Engine": "

Specifies the name of the database engine.

", + "DBClusterSnapshot$Status": "

Specifies the status of this DB cluster snapshot.

", + "DBClusterSnapshot$VpcId": "

Provides the VPC ID associated with the DB cluster snapshot.

", + "DBClusterSnapshot$MasterUsername": "

Provides the master username for the DB cluster snapshot.

", + "DBClusterSnapshot$EngineVersion": "

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

", + "DBClusterSnapshot$LicenseModel": "

Provides the license model information for this DB cluster snapshot.

", + "DBClusterSnapshot$SnapshotType": "

Provides the type of the DB cluster snapshot.

", + "DBClusterSnapshotMessage$Marker": "

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

", "DBEngineVersion$Engine": "

The name of the database engine.

", "DBEngineVersion$EngineVersion": "

The version number of the database engine.

", "DBEngineVersion$DBParameterGroupFamily": "

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

", "DBEngineVersion$DBEngineDescription": "

The description of the database engine.

", "DBEngineVersion$DBEngineVersionDescription": "

The description of the database engine version.

", "DBEngineVersionMessage$Marker": "

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

", - "DBInstance$DBInstanceIdentifier": "

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

", + "DBInstance$DBInstanceIdentifier": "

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

", "DBInstance$DBInstanceClass": "

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

", "DBInstance$Engine": "

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

", "DBInstance$DBInstanceStatus": "

Specifies the current state of this database.

", @@ -1517,7 +1871,7 @@ "DBInstance$DBName": "

The meaning of this parameter differs according to the database engine you use. For example, this value returns either MySQL or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for MySQL and PostgreSQL.

MySQL, SQL Server, PostgreSQL

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

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

", "DBInstance$PreferredBackupWindow": "

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

", "DBInstance$AvailabilityZone": "

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

", - "DBInstance$PreferredMaintenanceWindow": "

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

", + "DBInstance$PreferredMaintenanceWindow": "

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

", "DBInstance$EngineVersion": "

Indicates the database engine version.

", "DBInstance$ReadReplicaSourceDBInstanceIdentifier": "

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

", "DBInstance$LicenseModel": "

License model information for this DB instance.

", @@ -1525,6 +1879,7 @@ "DBInstance$SecondaryAvailabilityZone": "

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

", "DBInstance$StorageType": "

Specifies the storage type associated with DB instance.

", "DBInstance$TdeCredentialArn": "

The ARN from the Key Store with which the instance is associated for TDE encryption.

", + "DBInstance$DBClusterIdentifier": "

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

", "DBInstance$KmsKeyId": "

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

", "DBInstance$DbiResourceId": "

If StorageEncrypted is true, the region-unique, immutable identifier for the encrypted DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.

", "DBInstance$CACertificateIdentifier": "

The identifier of the CA certificate for this DB instance.

", @@ -1536,7 +1891,7 @@ "DBParameterGroup$DBParameterGroupFamily": "

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

", "DBParameterGroup$Description": "

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

", "DBParameterGroupDetails$Marker": "

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

", - "DBParameterGroupNameMessage$DBParameterGroupName": "

The name of the DB parameter group.

", + "DBParameterGroupNameMessage$DBParameterGroupName": "

Provides the name of the DB parameter group.

", "DBParameterGroupStatus$DBParameterGroupName": "

The name of the DP parameter group.

", "DBParameterGroupStatus$ParameterApplyStatus": "

The status of parameter updates.

", "DBParameterGroupsMessage$Marker": "

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

", @@ -1553,13 +1908,14 @@ "DBSnapshot$Engine": "

Specifies the name of the database engine.

", "DBSnapshot$Status": "

Specifies the status of this DB snapshot.

", "DBSnapshot$AvailabilityZone": "

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

", - "DBSnapshot$VpcId": "

Provides the Vpc Id associated with the DB snapshot.

", + "DBSnapshot$VpcId": "

Provides the VPC ID associated with the DB snapshot.

", "DBSnapshot$MasterUsername": "

Provides the master username for the DB snapshot.

", "DBSnapshot$EngineVersion": "

Specifies the version of the database engine.

", "DBSnapshot$LicenseModel": "

License model information for the restored DB instance.

", "DBSnapshot$SnapshotType": "

Provides the type of the DB snapshot.

", "DBSnapshot$OptionGroupName": "

Provides the option group name for the DB snapshot.

", "DBSnapshot$SourceRegion": "

The region that the DB snapshot was created in or copied from.

", + "DBSnapshot$SourceDBSnapshotIdentifier": "

The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.

", "DBSnapshot$StorageType": "

Specifies the storage type associated with DB Snapshot.

", "DBSnapshot$TdeCredentialArn": "

The ARN from the Key Store with which to associate the instance for TDE encryption.

", "DBSnapshot$KmsKeyId": "

If Encrypted is true, the KMS key identifier for the encrypted DB snapshot.

", @@ -1569,22 +1925,37 @@ "DBSubnetGroup$VpcId": "

Provides the VpcId of the DB subnet group.

", "DBSubnetGroup$SubnetGroupStatus": "

Provides the status of the DB subnet group.

", "DBSubnetGroupMessage$Marker": "

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

", - "DeleteDBInstanceMessage$DBInstanceIdentifier": "

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

Constraints:

", + "DeleteDBClusterMessage$DBClusterIdentifier": "

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

Constraints:

", + "DeleteDBClusterMessage$FinalDBSnapshotIdentifier": "

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

", + "DeleteDBClusterParameterGroupMessage$DBClusterParameterGroupName": "

The name of the DB cluster parameter group.

Constraints:

", + "DeleteDBClusterSnapshotMessage$DBClusterSnapshotIdentifier": "

The identifier of the DB cluster snapshot to delete.

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

", + "DeleteDBInstanceMessage$DBInstanceIdentifier": "

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

Constraints:

", "DeleteDBInstanceMessage$FinalDBSnapshotIdentifier": "

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

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

", "DeleteDBParameterGroupMessage$DBParameterGroupName": "

The name of the DB parameter group.

Constraints:

", - "DeleteDBSecurityGroupMessage$DBSecurityGroupName": "

The name of the DB security group to delete.

You cannot delete the default DB security group.

Constraints:

", + "DeleteDBSecurityGroupMessage$DBSecurityGroupName": "

The name of the DB security group to delete.

You cannot delete the default DB security group.

Constraints:

", "DeleteDBSnapshotMessage$DBSnapshotIdentifier": "

The DBSnapshot identifier.

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

", "DeleteDBSubnetGroupMessage$DBSubnetGroupName": "

The name of the database subnet group to delete.

You cannot delete the default subnet group.

Constraints:

", "DeleteEventSubscriptionMessage$SubscriptionName": "

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

", "DeleteOptionGroupMessage$OptionGroupName": "

The name of the option group to be deleted.

You cannot delete default option groups.", "DescribeCertificatesMessage$CertificateIdentifier": "

The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive.

Constraints:

", "DescribeCertificatesMessage$Marker": "

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

", + "DescribeDBClusterParameterGroupsMessage$DBClusterParameterGroupName": "

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

Constraints:

", + "DescribeDBClusterParameterGroupsMessage$Marker": "

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

", + "DescribeDBClusterParametersMessage$DBClusterParameterGroupName": "

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

Constraints:

", + "DescribeDBClusterParametersMessage$Source": "

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

", + "DescribeDBClusterParametersMessage$Marker": "

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

", + "DescribeDBClusterSnapshotsMessage$DBClusterIdentifier": "

A DB cluster identifier to retrieve the list of DB cluster snapshots for. This parameter cannot be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive.

Constraints:

", + "DescribeDBClusterSnapshotsMessage$DBClusterSnapshotIdentifier": "

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

Constraints:

", + "DescribeDBClusterSnapshotsMessage$SnapshotType": "

The type of DB cluster snapshots that will be returned. Values can be automated or manual. If this parameter is not specified, the returned results will include all snapshot types.

", + "DescribeDBClusterSnapshotsMessage$Marker": "

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

", + "DescribeDBClustersMessage$DBClusterIdentifier": "

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

Constraints:

", + "DescribeDBClustersMessage$Marker": "

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

", "DescribeDBEngineVersionsMessage$Engine": "

The database engine to return.

", "DescribeDBEngineVersionsMessage$EngineVersion": "

The database engine version to return.

Example: 5.1.49

", "DescribeDBEngineVersionsMessage$DBParameterGroupFamily": "

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

Constraints:

", "DescribeDBEngineVersionsMessage$Marker": "

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

", - "DescribeDBInstancesMessage$DBInstanceIdentifier": "

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

Constraints:

", - "DescribeDBInstancesMessage$Marker": "

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

", + "DescribeDBInstancesMessage$DBInstanceIdentifier": "

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

Constraints:

", + "DescribeDBInstancesMessage$Marker": "

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

", "DescribeDBLogFilesDetails$LogFileName": "

The name of the log file for the specified DB instance.

", "DescribeDBLogFilesMessage$DBInstanceIdentifier": "

The customer-assigned name of the DB instance that contains the log files you want to list.

Constraints:

", "DescribeDBLogFilesMessage$FilenameContains": "

Filters the available log files for log file names that contain the specified string.

", @@ -1596,13 +1967,15 @@ "DescribeDBParametersMessage$Source": "

The parameter types to return.

Default: All parameter types returned

Valid Values: user | system | engine-default

", "DescribeDBParametersMessage$Marker": "

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

", "DescribeDBSecurityGroupsMessage$DBSecurityGroupName": "

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

", - "DescribeDBSecurityGroupsMessage$Marker": "

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

", - "DescribeDBSnapshotsMessage$DBInstanceIdentifier": "

A DB instance identifier to retrieve the list of DB snapshots for. Cannot be used in conjunction with DBSnapshotIdentifier. This parameter is not case sensitive.

Constraints:

", - "DescribeDBSnapshotsMessage$DBSnapshotIdentifier": "

A specific DB snapshot identifier to describe. Cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

Constraints:

", + "DescribeDBSecurityGroupsMessage$Marker": "

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

", + "DescribeDBSnapshotsMessage$DBInstanceIdentifier": "

A DB instance identifier to retrieve the list of DB snapshots for. This parameter cannot be used in conjunction with DBSnapshotIdentifier. This parameter is not case-sensitive.

Constraints:

", + "DescribeDBSnapshotsMessage$DBSnapshotIdentifier": "

A specific DB snapshot identifier to describe. This parameter cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

Constraints:

", "DescribeDBSnapshotsMessage$SnapshotType": "

The type of snapshots that will be returned. Values can be \"automated\" or \"manual.\" If not specified, the returned results will include all snapshots types.

", "DescribeDBSnapshotsMessage$Marker": "

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

", "DescribeDBSubnetGroupsMessage$DBSubnetGroupName": "

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

", "DescribeDBSubnetGroupsMessage$Marker": "

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

", + "DescribeEngineDefaultClusterParametersMessage$DBParameterGroupFamily": "

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

", + "DescribeEngineDefaultClusterParametersMessage$Marker": "

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

", "DescribeEngineDefaultParametersMessage$DBParameterGroupFamily": "

The name of the DB parameter group family.

", "DescribeEngineDefaultParametersMessage$Marker": "

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

", "DescribeEventCategoriesMessage$SourceType": "

The type of source that will be generating the events.

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

", @@ -1610,7 +1983,7 @@ "DescribeEventSubscriptionsMessage$Marker": "

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

", "DescribeEventsMessage$SourceIdentifier": "

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

Constraints:

", "DescribeEventsMessage$Marker": "

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

", - "DescribeOptionGroupOptionsMessage$EngineName": "

A required parameter. Options available for the given Engine name will be described.

", + "DescribeOptionGroupOptionsMessage$EngineName": "

A required parameter. Options available for the given engine name will be described.

", "DescribeOptionGroupOptionsMessage$MajorEngineVersion": "

If specified, filters the results to include only options for the specified major engine version.

", "DescribeOptionGroupOptionsMessage$Marker": "

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

", "DescribeOptionGroupsMessage$OptionGroupName": "

The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.

", @@ -1629,13 +2002,13 @@ "DescribeReservedDBInstancesMessage$DBInstanceClass": "

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

", "DescribeReservedDBInstancesMessage$Duration": "

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

", "DescribeReservedDBInstancesMessage$ProductDescription": "

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

", - "DescribeReservedDBInstancesMessage$OfferingType": "

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"

", + "DescribeReservedDBInstancesMessage$OfferingType": "

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\"

", "DescribeReservedDBInstancesMessage$Marker": "

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

", "DescribeReservedDBInstancesOfferingsMessage$ReservedDBInstancesOfferingId": "

The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

", "DescribeReservedDBInstancesOfferingsMessage$DBInstanceClass": "

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

", "DescribeReservedDBInstancesOfferingsMessage$Duration": "

Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

", "DescribeReservedDBInstancesOfferingsMessage$ProductDescription": "

Product description filter value. Specify this parameter to show only the available offerings matching the specified product description.

", - "DescribeReservedDBInstancesOfferingsMessage$OfferingType": "

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"

", + "DescribeReservedDBInstancesOfferingsMessage$OfferingType": "

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\"

", "DescribeReservedDBInstancesOfferingsMessage$Marker": "

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

", "DownloadDBLogFilePortionDetails$LogFileData": "

Entries from the specified log file.

", "DownloadDBLogFilePortionDetails$Marker": "

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

", @@ -1647,7 +2020,7 @@ "EC2SecurityGroup$EC2SecurityGroupId": "

Specifies the id of the EC2 security group.

", "EC2SecurityGroup$EC2SecurityGroupOwnerId": "

Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

", "Endpoint$Address": "

Specifies the DNS address of the DB instance.

", - "EngineDefaults$DBParameterGroupFamily": "

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

", + "EngineDefaults$DBParameterGroupFamily": "

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

", "EngineDefaults$Marker": "

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

", "Event$SourceIdentifier": "

Provides the identifier for the source of the event.

", "Event$Message": "

Provides the text of this event.

", @@ -1661,25 +2034,34 @@ "EventSubscription$SourceType": "

The source type for the RDS event notification subscription.

", "EventSubscriptionsMessage$Marker": "

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

", "EventsMessage$Marker": "

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

", + "FailoverDBClusterMessage$DBClusterIdentifier": "

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

Constraints:

", "Filter$Name": "

This parameter is not currently supported.

", "FilterValueList$member": null, "IPRange$Status": "

Specifies the status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

", "IPRange$CIDRIP": "

Specifies the IP range.

", "KeyList$member": null, "ListTagsForResourceMessage$ResourceName": "

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

", + "ModifyDBClusterMessage$DBClusterIdentifier": "

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

Constraints:

", + "ModifyDBClusterMessage$NewDBClusterIdentifier": "

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

Constraints:

Example: my-cluster2

", + "ModifyDBClusterMessage$DBClusterParameterGroupName": "

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

", + "ModifyDBClusterMessage$MasterUserPassword": "

The new password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

Constraints: Must contain from 8 to 41 characters.

", + "ModifyDBClusterMessage$OptionGroupName": "

A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.

", + "ModifyDBClusterMessage$PreferredBackupWindow": "

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

Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

", + "ModifyDBClusterMessage$PreferredMaintenanceWindow": "

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

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

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

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

Constraints: Minimum 30-minute window.

", + "ModifyDBClusterParameterGroupMessage$DBClusterParameterGroupName": "

The name of the DB cluster parameter group to modify.

", "ModifyDBInstanceMessage$DBInstanceIdentifier": "

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

Constraints:

", "ModifyDBInstanceMessage$DBInstanceClass": "

The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.

Passing a value for this setting causes an outage during the change and is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

Default: Uses existing setting

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium

", - "ModifyDBInstanceMessage$MasterUserPassword": "

The new password for the DB instance master user. Can be any printable ASCII character except \"/\", \"\"\", or \"@\".

Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Default: Uses existing setting

Constraints: Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).

Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that may have been accidentally revoked. ", + "ModifyDBInstanceMessage$MasterUserPassword": "

The new password for the DB instance master user. Can be any printable ASCII character except \"/\", \"\"\", or \"@\".

Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Default: Uses existing setting

Constraints: Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).

Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked. ", "ModifyDBInstanceMessage$DBParameterGroupName": "

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

Default: Uses existing setting

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

", - "ModifyDBInstanceMessage$PreferredBackupWindow": "

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

", - "ModifyDBInstanceMessage$PreferredMaintenanceWindow": "

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

Default: Uses existing setting

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

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

", + "ModifyDBInstanceMessage$PreferredBackupWindow": "

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

", + "ModifyDBInstanceMessage$PreferredMaintenanceWindow": "

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

Default: Uses existing setting

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

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

", "ModifyDBInstanceMessage$EngineVersion": "

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

For major version upgrades, if a non-default DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

For a list of valid engine versions, see CreateDBInstance.

", "ModifyDBInstanceMessage$OptionGroupName": "

Indicates that the DB instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

", "ModifyDBInstanceMessage$NewDBInstanceIdentifier": "

The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value is stored as a lowercase string.

Constraints:

", "ModifyDBInstanceMessage$StorageType": "

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

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified; otherwise standard

", "ModifyDBInstanceMessage$TdeCredentialArn": "

The ARN from the Key Store with which to associate the instance for TDE encryption.

", "ModifyDBInstanceMessage$TdeCredentialPassword": "

The password for the given ARN from the Key Store in order to access the device.

", - "ModifyDBInstanceMessage$CACertificateIdentifier": "

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

", + "ModifyDBInstanceMessage$CACertificateIdentifier": "

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

", "ModifyDBParameterGroupMessage$DBParameterGroupName": "

The name of the DB parameter group.

Constraints:

", "ModifyDBSubnetGroupMessage$DBSubnetGroupName": "

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

Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".

Example: mySubnetgroup

", "ModifyDBSubnetGroupMessage$DBSubnetGroupDescription": "

The description for the DB subnet group.

", @@ -1692,7 +2074,7 @@ "OptionConfiguration$OptionName": "

The configuration of options to include in a group.

", "OptionGroup$OptionGroupName": "

Specifies the name of the option group.

", "OptionGroup$OptionGroupDescription": "

Provides a description of the option group.

", - "OptionGroup$EngineName": "

Engine name that this option group can be applied to.

", + "OptionGroup$EngineName": "

Indicates the name of the engine that this option group can be applied to.

", "OptionGroup$MajorEngineVersion": "

Indicates the major engine version associated with this option group.

", "OptionGroup$VpcId": "

If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.

", "OptionGroupMembership$OptionGroupName": "

The name of the option group that the instance belongs to.

", @@ -1720,9 +2102,9 @@ "OptionsDependedOn$member": null, "OrderableDBInstanceOption$Engine": "

The engine type of the orderable DB instance.

", "OrderableDBInstanceOption$EngineVersion": "

The engine version of the orderable DB instance.

", - "OrderableDBInstanceOption$DBInstanceClass": "

The DB instance Class for the orderable DB instance

", + "OrderableDBInstanceOption$DBInstanceClass": "

The DB instance class for the orderable DB instance.

", "OrderableDBInstanceOption$LicenseModel": "

The license model for the orderable DB instance.

", - "OrderableDBInstanceOption$StorageType": "

The storage type for this orderable DB instance.

", + "OrderableDBInstanceOption$StorageType": "

Indicates the storage type for this orderable DB instance.

", "OrderableDBInstanceOptionsMessage$Marker": "

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

", "Parameter$ParameterName": "

Specifies the name of the parameter.

", "Parameter$ParameterValue": "

Specifies the value of the parameter.

", @@ -1743,7 +2125,7 @@ "PendingModifiedValues$StorageType": "

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

", "PendingModifiedValues$CACertificateIdentifier": "

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

", "PromoteReadReplicaMessage$DBInstanceIdentifier": "

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

Constraints:

Example: mydbinstance

", - "PromoteReadReplicaMessage$PreferredBackupWindow": "

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

Default: A 30-minute window selected at random from an 8-hour block of time per region. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.

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

", + "PromoteReadReplicaMessage$PreferredBackupWindow": "

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

Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

", "PurchaseReservedDBInstancesOfferingMessage$ReservedDBInstancesOfferingId": "

The ID of the Reserved DB instance offering to purchase.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

", "PurchaseReservedDBInstancesOfferingMessage$ReservedDBInstanceId": "

Customer-specified identifier to track this reservation.

Example: myreservationID

", "ReadReplicaDBInstanceIdentifierList$member": null, @@ -1766,9 +2148,21 @@ "ReservedDBInstancesOffering$ProductDescription": "

The database engine used by the offering.

", "ReservedDBInstancesOffering$OfferingType": "

The offering type.

", "ReservedDBInstancesOfferingMessage$Marker": "

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

", + "ResetDBClusterParameterGroupMessage$DBClusterParameterGroupName": "

The name of the DB cluster parameter group to reset.

", "ResetDBParameterGroupMessage$DBParameterGroupName": "

The name of the DB parameter group.

Constraints:

", "ResourcePendingMaintenanceActions$ResourceIdentifier": "

The ARN of the resource that has pending maintenance actions.

", - "RestoreDBInstanceFromDBSnapshotMessage$DBInstanceIdentifier": "

Name of the DB instance to create from the DB snapshot. This parameter isn't case sensitive.

Constraints:

Example: my-snapshot-id

", + "RestoreDBClusterFromSnapshotMessage$DBClusterIdentifier": "

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

Constraints:

Example: my-snapshot-id

", + "RestoreDBClusterFromSnapshotMessage$SnapshotIdentifier": "

The identifier for the DB cluster snapshot to restore from.

Constraints:

", + "RestoreDBClusterFromSnapshotMessage$Engine": "

The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source

", + "RestoreDBClusterFromSnapshotMessage$EngineVersion": "

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

", + "RestoreDBClusterFromSnapshotMessage$DBSubnetGroupName": "

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

", + "RestoreDBClusterFromSnapshotMessage$DatabaseName": "

The database name for the restored DB cluster.

", + "RestoreDBClusterFromSnapshotMessage$OptionGroupName": "

The name of the option group to use for the restored DB cluster.

", + "RestoreDBClusterToPointInTimeMessage$DBClusterIdentifier": "

The name of the new DB cluster to be created.

Constraints:

", + "RestoreDBClusterToPointInTimeMessage$SourceDBClusterIdentifier": "

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

Constraints:

", + "RestoreDBClusterToPointInTimeMessage$DBSubnetGroupName": "

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

", + "RestoreDBClusterToPointInTimeMessage$OptionGroupName": "

The name of the option group for the new DB cluster.

", + "RestoreDBInstanceFromDBSnapshotMessage$DBInstanceIdentifier": "

Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.

Constraints:

Example: my-snapshot-id

", "RestoreDBInstanceFromDBSnapshotMessage$DBSnapshotIdentifier": "

The identifier for the DB snapshot to restore from.

Constraints:

", "RestoreDBInstanceFromDBSnapshotMessage$DBInstanceClass": "

The compute and memory capacity of the Amazon RDS DB instance.

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium

", "RestoreDBInstanceFromDBSnapshotMessage$AvailabilityZone": "

The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Example: us-east-1a

", @@ -1801,8 +2195,8 @@ "Subnet$SubnetIdentifier": "

Specifies the identifier of the subnet.

", "Subnet$SubnetStatus": "

Specifies the status of the subnet.

", "SubnetIdentifierList$member": null, - "Tag$Key": "

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". The string may only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

", - "Tag$Value": "

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". The string may only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

", + "Tag$Key": "

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot 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}_.:/=+\\\\-]*)$\").

", + "Tag$Value": "

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot 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}_.:/=+\\\\-]*)$\").

", "VpcSecurityGroupIdList$member": null, "VpcSecurityGroupMembership$VpcSecurityGroupId": "

The name of the VPC security group.

", "VpcSecurityGroupMembership$Status": "

The status of the VPC security group.

" @@ -1858,10 +2252,14 @@ "refs": { "Certificate$ValidFrom": "

The starting date from which the certificate is valid.

", "Certificate$ValidTill": "

The final date that the certificate continues to be valid.

", + "DBCluster$EarliestRestorableTime": "

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

", + "DBCluster$LatestRestorableTime": "

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

", + "DBClusterSnapshot$SnapshotCreateTime": "

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

", + "DBClusterSnapshot$ClusterCreateTime": "

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

", "DBInstance$InstanceCreateTime": "

Provides the date and time the DB instance was created.

", "DBInstance$LatestRestorableTime": "

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

", - "DBSnapshot$SnapshotCreateTime": "

Provides the time (UTC) when the snapshot was taken.

", - "DBSnapshot$InstanceCreateTime": "

Specifies the time (UTC) when the snapshot was taken.

", + "DBSnapshot$SnapshotCreateTime": "

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

", + "DBSnapshot$InstanceCreateTime": "

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

", "DescribeEventsMessage$StartTime": "

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

Example: 2009-07-08T18:00Z

", "DescribeEventsMessage$EndTime": "

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

Example: 2009-07-08T18:00Z

", "Event$Date": "

Specifies the date and time of the event.

", @@ -1869,7 +2267,8 @@ "PendingMaintenanceAction$ForcedApplyDate": "

The date when the maintenance action will be automatically applied. The maintenance action will be applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.

", "PendingMaintenanceAction$CurrentApplyDate": "

The effective date when the pending maintenance action will be applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.

", "ReservedDBInstance$StartTime": "

The time the reservation started.

", - "RestoreDBInstanceToPointInTimeMessage$RestoreTime": "

The date and time to restore from.

Valid Values: Value must be a UTC time

Constraints:

Example: 2009-09-07T23:45:00Z

" + "RestoreDBClusterToPointInTimeMessage$RestoreToTime": "

The date and time to restore the DB cluster to.

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

Constraints:

Example: 2015-03-07T23:45:00Z

", + "RestoreDBInstanceToPointInTimeMessage$RestoreTime": "

The date and time to restore from.

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

Constraints:

Example: 2009-09-07T23:45:00Z

" } }, "Tag": { @@ -1882,9 +2281,13 @@ "base": "

A list of tags.

", "refs": { "AddTagsToResourceMessage$Tags": "

The tags to be assigned to the Amazon RDS resource.

", + "CopyDBClusterSnapshotMessage$Tags": null, "CopyDBParameterGroupMessage$Tags": null, "CopyDBSnapshotMessage$Tags": null, "CopyOptionGroupMessage$Tags": null, + "CreateDBClusterMessage$Tags": null, + "CreateDBClusterParameterGroupMessage$Tags": null, + "CreateDBClusterSnapshotMessage$Tags": "

The tags to be assigned to the DB cluster snapshot.

", "CreateDBInstanceMessage$Tags": null, "CreateDBInstanceReadReplicaMessage$Tags": null, "CreateDBParameterGroupMessage$Tags": null, @@ -1894,6 +2297,8 @@ "CreateEventSubscriptionMessage$Tags": null, "CreateOptionGroupMessage$Tags": null, "PurchaseReservedDBInstancesOfferingMessage$Tags": null, + "RestoreDBClusterFromSnapshotMessage$Tags": "

The tags to be assigned to the restored DB cluster.

", + "RestoreDBClusterToPointInTimeMessage$Tags": null, "RestoreDBInstanceFromDBSnapshotMessage$Tags": null, "RestoreDBInstanceToPointInTimeMessage$Tags": null, "TagListMessage$TagList": "

List of tags returned by the ListTagsForResource operation.

" @@ -1907,9 +2312,13 @@ "VpcSecurityGroupIdList": { "base": null, "refs": { + "CreateDBClusterMessage$VpcSecurityGroupIds": "

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

", "CreateDBInstanceMessage$VpcSecurityGroupIds": "

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

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

", + "ModifyDBClusterMessage$VpcSecurityGroupIds": "

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

", "ModifyDBInstanceMessage$VpcSecurityGroupIds": "

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

Constraints:

", - "OptionConfiguration$VpcSecurityGroupMemberships": "

A list of VpcSecurityGroupMemebrship name strings used for this option.

" + "OptionConfiguration$VpcSecurityGroupMemberships": "

A list of VpcSecurityGroupMemebrship name strings used for this option.

", + "RestoreDBClusterFromSnapshotMessage$VpcSecurityGroupIds": "

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

", + "RestoreDBClusterToPointInTimeMessage$VpcSecurityGroupIds": "

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

" } }, "VpcSecurityGroupMembership": { @@ -1921,6 +2330,7 @@ "VpcSecurityGroupMembershipList": { "base": null, "refs": { + "DBCluster$VpcSecurityGroups": "

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

", "DBInstance$VpcSecurityGroups": "

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

", "Option$VpcSecurityGroupMemberships": "

If the option requires access to a port, then this VPC security group allows access to the port.

" } @@ -1940,6 +2350,11 @@ "refs": { } }, + "CopyDBClusterSnapshotResult": { + "base": null, + "refs": { + } + }, "CopyDBParameterGroupResult": { "base": null, "refs": { @@ -1955,6 +2370,21 @@ "refs": { } }, + "CreateDBClusterResult": { + "base": null, + "refs": { + } + }, + "CreateDBClusterParameterGroupResult": { + "base": null, + "refs": { + } + }, + "CreateDBClusterSnapshotResult": { + "base": null, + "refs": { + } + }, "CreateDBInstanceResult": { "base": null, "refs": { @@ -1995,6 +2425,16 @@ "refs": { } }, + "DeleteDBClusterResult": { + "base": null, + "refs": { + } + }, + "DeleteDBClusterSnapshotResult": { + "base": null, + "refs": { + } + }, "DeleteDBInstanceResult": { "base": null, "refs": { @@ -2010,11 +2450,26 @@ "refs": { } }, + "DescribeEngineDefaultClusterParametersResult": { + "base": null, + "refs": { + } + }, "DescribeEngineDefaultParametersResult": { "base": null, "refs": { } }, + "FailoverDBClusterResult": { + "base": null, + "refs": { + } + }, + "ModifyDBClusterResult": { + "base": null, + "refs": { + } + }, "ModifyDBInstanceResult": { "base": null, "refs": { @@ -2055,6 +2510,16 @@ "refs": { } }, + "RestoreDBClusterFromSnapshotResult": { + "base": null, + "refs": { + } + }, + "RestoreDBClusterToPointInTimeResult": { + "base": null, + "refs": { + } + }, "RestoreDBInstanceFromDBSnapshotResult": { "base": null, "refs": {