The Amazon Resource Name (ARN) for the customer gateway certificate.
", "CreateCustomerGatewayRequest$DeviceName": "A name for the customer gateway device.
Length Constraints: Up to 255 characters.
", "CreateCustomerGatewayRequest$IpAddress": "IPv4 address for the customer gateway device's outside interface. The address must be static.
", - "CreateEgressOnlyInternetGatewayRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", + "CreateEgressOnlyInternetGatewayRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
", "CreateEgressOnlyInternetGatewayResult$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "CreateFleetError$ErrorCode": "The error code that indicates why the instance could not be launched. For more information about error codes, see Error codes.
", "CreateFleetError$ErrorMessage": "The error message that describes why the instance could not be launched. For more information about error messages, see Error codes.
", @@ -19386,12 +19386,14 @@ "CreateManagedPrefixListRequest$PrefixListName": "A name for the prefix list.
Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.
The IP address type.
Valid Values: IPv4 | IPv6
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Constraints: Up to 255 UTF-8 characters in length.
", - "CreateNatGatewayRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
Constraint: Maximum 64 ASCII characters.
", + "CreateNatGatewayRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
Constraint: Maximum 64 ASCII characters.
", "CreateNatGatewayRequest$PrivateIpAddress": "The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.
", "CreateNatGatewayResult$ClientToken": "Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
", "CreateNetworkAclEntryRequest$CidrBlock": "The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).
The protocol number. A value of \"-1\" means all protocols. If you specify \"-1\" or a protocol number other than \"6\" (TCP), \"17\" (UDP), or \"1\" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol \"58\" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol \"58\" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.
", + "CreateNetworkAclRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
", + "CreateNetworkAclResult$ClientToken": "Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
", "CreateNetworkInsightsAccessScopeRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", "CreateNetworkInsightsPathRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", "CreateNetworkInterfacePermissionRequest$AwsAccountId": "The Amazon Web Services account ID.
", @@ -19409,6 +19411,8 @@ "CreateRestoreImageTaskResult$ImageId": "The AMI ID.
", "CreateRouteRequest$DestinationCidrBlock": "The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.
", + "CreateRouteTableRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
", + "CreateRouteTableResult$ClientToken": "Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
", "CreateSecurityGroupRequest$Description": "A description for the security group.
Constraints: Up to 255 characters in length
Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
", "CreateSecurityGroupRequest$GroupName": "The name of the security group.
Constraints: Up to 255 characters in length. Cannot start with sg-.
Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
", "CreateSecurityGroupResult$GroupId": "The ID of the security group.
", diff --git a/models/apis/ecs/2014-11-13/docs-2.json b/models/apis/ecs/2014-11-13/docs-2.json index ed4becb9dc3..53e5c92761d 100644 --- a/models/apis/ecs/2014-11-13/docs-2.json +++ b/models/apis/ecs/2014-11-13/docs-2.json @@ -5,7 +5,7 @@ "CreateCapacityProvider": "Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used in capacity provider strategies to facilitate cluster auto scaling.
Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on Fargate use the FARGATE and FARGATE_SPOT capacity providers. These providers are available to all accounts in the Amazon Web Services Regions that Fargate supports.
Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action.
When you call the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes the call doesn't have permissions to create the service-linked role, it isn't created. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
Runs and maintains your desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, see the UpdateService action.
Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. volumeConfigurations is only supported for REPLICA service and not DAEMON service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
Tasks for services that don't use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state and are reported as healthy by the load balancer.
There are two service scheduler strategies available:
REPLICA - The replica scheduling strategy places and maintains your desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
DAEMON - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It also stops tasks that don't meet the placement constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment is initiated by changing properties. For example, the deployment might be initiated by the task definition or by your desired count of a service. This is done with an UpdateService operation. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.
If a service uses the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment. Specifically, it represents it as a percentage of your desired number of tasks (rounded up to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can deploy without using additional cluster capacity. For example, if you set your service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. If they're in the RUNNING state, tasks for services that don't use a load balancer are considered healthy . If they're in the RUNNING state and reported as healthy by the load balancer, tasks for services that do use a load balancer are considered healthy . The default value for minimum healthy percent is 100%.
If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment. Specifically, it represents it as a percentage of the desired number of tasks (rounded down to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.
If a service uses either the CODE_DEPLOY or EXTERNAL deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state. This is while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used. This is the case even if they're currently visible when describing your service.
When creating a service that uses the EXTERNAL deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.
When the service scheduler launches new tasks, it determines task placement. For information about task placement and task placement strategies, see Amazon ECS task placement in the Amazon Elastic Container Service Developer Guide.
", - "CreateTaskSet": "Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.
You can create a maximum of 5 tasks sets for a deployment.
", + "CreateTaskSet": "Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.
For information about the maximum number of task sets and otther quotas, see Amazon ECS service quotas in the Amazon Elastic Container Service Developer Guide.
", "DeleteAccountSetting": "Disables an account setting for a specified user, role, or the root user for an account.
", "DeleteAttributes": "Deletes one or more custom attributes from an Amazon ECS resource.
", "DeleteCapacityProvider": "Deletes the specified capacity provider.
The FARGATE and FARGATE_SPOT capacity providers are reserved and can't be deleted. You can disassociate them from a cluster using either the PutClusterCapacityProviders API or by deleting the cluster.
Prior to a capacity provider being deleted, the capacity provider must be removed from the capacity provider strategy from all services. The UpdateService API can be used to remove a capacity provider from a service's capacity provider strategy. When updating a service, the forceNewDeployment option can be used to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity provider are transitioned to use the capacity from the remaining capacity providers. Only capacity providers that aren't associated with a cluster can be deleted. To remove a capacity provider from a cluster, you can either use PutClusterCapacityProviders or delete the cluster.
An object representing the networking details for a task or service.
", + "base": "An object representing the networking details for a task or service. For example awsvpcConfiguration={subnets=[\"subnet-12344321\"],securityGroups=[\"sg-12344321\"]}
The VPC subnets and security groups that are associated with a task.
All specified subnets and security groups must be from the same VPC.
The number of instantiations of the specified task definition to place and keep running in your service.
This is required if schedulingStrategy is REPLICA or isn't specified. If schedulingStrategy is DAEMON then this isn't required.
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of 0 is used.
If you do not use an Elastic Load Balancing, we recommend that you use the startPeriod in the task definition health check parameters. For more information, see Health check.
If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
", "DeploymentConfiguration$maximumPercent": "If a service is using the rolling update (ECS) deployment type, the maximumPercent parameter represents an upper limit on the number of your service's tasks that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desiredCount (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the REPLICA service scheduler and has a desiredCount of four tasks and a maximumPercent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default maximumPercent value for a service using the REPLICA service scheduler is 200%.
If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.
If a service is using the rolling update (ECS) deployment type, the minimumHealthyPercent represents a lower limit on the number of your service's tasks that must remain in the RUNNING state during a deployment, as a percentage of the desiredCount (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desiredCount of four tasks and a minimumHealthyPercent of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks.
For services that do not use a load balancer, the following should be noted:
A service is considered healthy if all essential containers within the tasks in the service pass their health checks.
If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a RUNNING state before the task is counted towards the minimum healthy percent total.
If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings.
For services are that do use a load balancer, the following should be noted:
If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and is running tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.
If a service is using the rolling update (ECS) deployment type, the minimumHealthyPercent represents a lower limit on the number of your service's tasks that must remain in the RUNNING state during a deployment, as a percentage of the desiredCount (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desiredCount of four tasks and a minimumHealthyPercent of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks.
For services that do not use a load balancer, the following should be noted:
A service is considered healthy if all essential containers within the tasks in the service pass their health checks.
If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a RUNNING state before the task is counted towards the minimum healthy percent total.
If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings.
For services that do use a load balancer, the following should be noted:
If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and is running tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.
The maximum number of account setting results returned by DescribeCapacityProviders in paginated output. When this parameter is used, DescribeCapacityProviders only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeCapacityProviders request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then DescribeCapacityProviders returns up to 10 results and a nextToken value if applicable.
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.
", "HealthCheck$interval": "The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
", @@ -502,7 +502,7 @@ } }, "ContainerDependency": { - "base": "The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.
Your Amazon ECS container instances require at least version 1.26.0 of the container agent to use container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
For tasks that use the Fargate launch type, the task or service requires the following platforms:
Linux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.
Your Amazon ECS container instances require at least version 1.26.0 of the container agent to use container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
For tasks that use the Fargate launch type, the task or service requires the following platforms:
Linux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
For more information about how to create a container dependency, see Container dependency in the Amazon Elastic Container Service Developer Guide.
", "refs": { "ContainerDependencies$member": null } @@ -1958,7 +1958,7 @@ "ServiceConnectTlsConfiguration": { "base": "An object that represents the configuration for Service Connect TLS.
", "refs": { - "ServiceConnectService$tls": null + "ServiceConnectService$tls": "A reference to an object that represents a Transport Layer Security (TLS) configuration.
" } }, "ServiceEvent": { @@ -2372,7 +2372,7 @@ "StartTaskRequest$taskDefinition": "The family and revision (family:revision) or full ARN of the task definition to start. If a revision isn't specified, the latest ACTIVE revision is used.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.
", "StopTaskRequest$task": "The task ID of the task to stop.
", - "StopTaskRequest$reason": "An optional message specified when a task is stopped. For example, if you're using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.
", + "StopTaskRequest$reason": "An optional message specified when a task is stopped. For example, if you're using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task.
", "StringList$member": null, "StringMap$key": null, "StringMap$value": null, @@ -2765,7 +2765,7 @@ "TaskStopCode": { "base": null, "refs": { - "Task$stopCode": "The stop code indicating why a task was stopped. The stoppedReason might contain additional details.
For more information about stop code, see Stopped tasks error codes in the Amazon ECS User Guide.
The following are valid values:
TaskFailedToStart
EssentialContainerExited
UserInitiated
TerminationNotice
ServiceSchedulerInitiated
SpotInterruption
The stop code indicating why a task was stopped. The stoppedReason might contain additional details.
For more information about stop code, see Stopped tasks error codes in the Amazon ECS User Guide.
" } }, "TaskVolumeConfiguration": { @@ -2845,7 +2845,7 @@ } }, "Ulimit": { - "base": "The ulimit settings to pass to the container.
Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and the default hard limit is 4096.
You can specify the ulimit settings for a container in a task definition.
The ulimit settings to pass to the container.
Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and the default hard limit is 65535.
You can specify the ulimit settings for a container in a task definition.
A list of ulimits to set in the container. If a ulimit value is specified in a task definition, it overrides the default values set by Docker. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run. Valid naming values are displayed in the Ulimit data type.
Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and the default hard limit is 4096.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
This parameter is not supported for Windows containers.
A list of ulimits to set in the container. If a ulimit value is specified in a task definition, it overrides the default values set by Docker. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run. Valid naming values are displayed in the Ulimit data type.
Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and the default hard limit is 65535.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
This parameter is not supported for Windows containers.
Creates a new DB proxy.
", "CreateDBProxyEndpoint": "Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters. You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC.
Creates a new DB security group. DB security groups control access to a DB instance.
A DB security group controls access to EC2-Classic DB instances that are not in a VPC.
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
Creates a new DB shard group for Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.
Valid for: Aurora DB clusters only
", "CreateDBSnapshot": "Creates a snapshot of a DB instance. The source DB instance must be in the available or storage-optimization state.
Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.
", "CreateEventSubscription": "Creates an RDS event notification subscription. This operation requires a topic Amazon Resource Name (ARN) 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) that you want to be notified of and provide a list of RDS sources (SourceIds) that triggers the events. You can also provide a list of event categories (EventCategories) for events that 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 SourceIds = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify SourceIds, you receive notice of the events for that source type for all your RDS sources. If you don't specify either the SourceType or the SourceIds, you are notified of events generated from all RDS sources belonging to your customer account.
For more information about subscribing to an event for RDS DB engines, see Subscribing to Amazon RDS event notification in the Amazon RDS User Guide.
For more information about subscribing to an event for Aurora DB engines, see Subscribing to Amazon RDS event notification in the Amazon Aurora User Guide.
", @@ -47,6 +48,7 @@ "DeleteDBProxy": "Deletes an existing DB proxy.
", "DeleteDBProxyEndpoint": "Deletes a DBProxyEndpoint. Doing so removes the ability to access the DB proxy using the endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write or read-only operations, or using a different VPC than the DB proxy's default VPC.
Deletes a DB security group.
The specified DB security group must not be associated with any DB instances.
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
Deletes an Aurora Limitless Database DB shard group.
", "DeleteDBSnapshot": "Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB snapshot must be in the available state to be deleted.
Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
Deletes an RDS event notification subscription.
", @@ -78,6 +80,7 @@ "DescribeDBProxyTargets": "Returns information about DBProxyTarget objects. This API supports pagination.
Describes the recommendations to resolve the issues for your DB instances, DB clusters, and DB parameter groups.
", "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.
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
Describes existing Aurora Limitless Database DB shard groups.
", "DescribeDBSnapshotAttributes": "Returns a list of DB snapshot attribute names and values for a manual DB snapshot.
When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If all is included in the list of values for the restore attribute, then the manual DB snapshot is public and can be copied or restored by all Amazon Web Services accounts.
To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.
Describes the tenant databases that exist in a DB snapshot. This command only applies to RDS for Oracle DB instances in the multi-tenant configuration.
You can use this command to inspect the tenant databases within a snapshot before restoring it. You can't directly interact with the tenant databases in a DB snapshot. If you restore a snapshot that was taken from DB instance using the multi-tenant configuration, you restore all its tenant databases.
", "DescribeDBSnapshots": "Returns information about DB snapshots. This API action supports pagination.
", @@ -102,7 +105,7 @@ "DisableHttpEndpoint": "Disables the HTTP endpoint for the specified DB cluster. Disabling this endpoint disables RDS Data API.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
This operation applies only to Aurora PostgreSQL Serverless v2 and provisioned DB clusters. To disable the HTTP endpoint for Aurora Serverless v1 DB clusters, use the EnableHttpEndpoint parameter of the ModifyDBCluster operation.
Downloads all or a portion of the specified log file, up to 1 MB in size.
This command doesn't apply to RDS Custom.
", "EnableHttpEndpoint": "Enables the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.
When enabled, this endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
This operation applies only to Aurora PostgreSQL Serverless v2 and provisioned DB clusters. To enable the HTTP endpoint for Aurora Serverless v1 DB clusters, use the EnableHttpEndpoint parameter of the ModifyDBCluster operation.
Forces a failover for a DB cluster.
For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).
For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).
An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary DB instance fails.
To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure 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 DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
", + "FailoverDBCluster": "Forces a failover for a DB cluster.
For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).
For a Multi-AZ DB cluster, after RDS terminates the primary DB instance, the internal monitoring system detects that the primary DB instance is unhealthy and promotes a readable standby (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). Failover times are typically less than 35 seconds.
An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary DB instance fails.
To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure 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 DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
", "FailoverGlobalCluster": "Promotes the specified secondary DB cluster to be the primary DB cluster in the global database cluster to fail over or switch over a global database. Switchover operations were previously called \"managed planned failovers.\"
Although this operation can be used either to fail over or to switch over a global database cluster, its intended use is for global database failover. To switch over a global database cluster, we recommend that you use the SwitchoverGlobalCluster operation instead.
How you use this operation depends on whether you are failing over or switching over your global database cluster:
Failing over - Specify the AllowDataLoss parameter and don't specify the Switchover parameter.
Switching over - Specify the Switchover parameter or omit it, but don't specify the AllowDataLoss parameter.
About failing over and switching over
While failing over and switching over a global database cluster both change the primary DB cluster, you use these operations for different reasons:
Failing over - Use this operation to respond to an unplanned event, such as a Regional disaster in the primary Region. Failing over can result in a loss of write transaction data that wasn't replicated to the chosen secondary before the failover event occurred. However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writer DB instance guarantees that the data is in a transactionally consistent state.
For more information about failing over an Amazon Aurora global database, see Performing managed failovers for Aurora global databases in the Amazon Aurora User Guide.
Switching over - Use this operation on a healthy global database cluster for planned events, such as Regional rotation or to fail back to the original primary DB cluster after a failover operation. With this operation, there is no data loss.
For more information about switching over an Amazon Aurora global database, see Performing switchovers for Aurora global databases in the Amazon Aurora User Guide.
Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
", "ModifyActivityStream": "Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only, whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy, and then lock your activity stream. Restarting the activity stream isn't required. For more information, see Modifying a database activity stream in the Amazon RDS User Guide.
This operation is supported for RDS for Oracle and Microsoft SQL Server.
", @@ -119,6 +122,7 @@ "ModifyDBProxyEndpoint": "Changes the settings for an existing DB proxy endpoint.
", "ModifyDBProxyTargetGroup": "Modifies the properties of a DBProxyTargetGroup.
Updates the recommendation status and recommended action status for the specified recommendation.
", + "ModifyDBShardGroup": "Modifies the settings of an Aurora Limitless Database DB shard group. You can change one or more settings by specifying these parameters and the new values in the request.
", "ModifyDBSnapshot": "Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public.
Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This operation doesn't apply to RDS Custom or RDS for Db2.
", "ModifyDBSnapshotAttribute": "Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.
To share a manual DB snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all Amazon Web Services accounts.
Don't add the all value for any manual DB snapshots that contain private information that you don't want available to all Amazon Web Services accounts.
If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.
To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as values for the restore attribute.
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.
", @@ -131,6 +135,7 @@ "PurchaseReservedDBInstancesOffering": "Purchases a reserved DB instance offering.
", "RebootDBCluster": "You might need to reboot your DB cluster, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB cluster parameter group associated with the DB cluster, reboot the DB cluster for the changes to take effect.
Rebooting a DB cluster restarts the database engine service. Rebooting a DB cluster results in a momentary outage, during which the DB cluster status is set to rebooting.
Use this operation only for a non-Aurora Multi-AZ DB cluster.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
", "RebootDBInstance": "You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.
Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.
For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom.
If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.
You might need to reboot your DB shard group, usually for maintenance reasons. For example, if you make certain modifications, reboot the DB shard group for the changes to take effect.
This operation applies only to Aurora Limitless Database DBb shard groups.
", "RegisterDBProxyTargets": "Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.
Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different Region.
This operation only applies to Aurora DB clusters.
Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
", @@ -567,6 +572,7 @@ "CreateDBClusterMessage$PubliclyAccessible": "Specifies whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Valid for Cluster Type: Multi-AZ DB clusters only
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
Valid for Cluster Type: Multi-AZ DB clusters only
", "CreateDBClusterMessage$EnablePerformanceInsights": "Specifies whether to turn on Performance Insights for the DB cluster.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
", + "CreateDBClusterMessage$EnableLimitlessDatabase": "Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.
Valid for: Aurora DB clusters only
", "CreateDBClusterMessage$ManageMasterUserPassword": "Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
", "CreateDBInstanceMessage$MultiAZ": "Specifies whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
This setting doesn't apply to the following DB instances:
Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)
RDS Custom
Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts read replica.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the read replica from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
", "CreateDBInstanceReadReplicaMessage$DedicatedLogVolume": "Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
", "CreateDBInstanceReadReplicaMessage$UpgradeStorageConfig": "Whether to upgrade the storage file system configuration on the read replica. This option migrates the read replica from the old storage file system layout to the preferred layout.
", + "CreateDBShardGroupMessage$PubliclyAccessible": "Specifies whether the DB shard group is publicly accessible.
When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB shard group doesn't permit it.
When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB shard group is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB shard group is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB shard group is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public.
Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.
", "CreateGlobalClusterMessage$DeletionProtection": "Specifies whether to enable deletion protection for the new global database cluster. The global database can't be deleted when deletion protection is enabled.
", "CreateGlobalClusterMessage$StorageEncrypted": "Specifies whether to enable storage encryption for the new global database cluster.
Constraints:
Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the setting from the source DB cluster.
Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
", "DBInstanceAutomatedBackup$DedicatedLogVolume": "Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
", "DBInstanceAutomatedBackup$MultiTenant": "Specifies whether the automatic backup is for a DB instance in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
", + "DBShardGroup$PubliclyAccessible": "Indicates whether the DB shard group is publicly accessible.
When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB shard group doesn't permit it.
When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.
For more information, see CreateDBShardGroup.
This setting is only for Aurora Limitless Database.
", "DBSnapshot$MultiTenant": "Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
", "DeleteBlueGreenDeploymentRequest$DeleteTarget": "Specifies whether to delete the resources in the green environment. You can't specify this option if the blue/green deployment status is SWITCHOVER_COMPLETED.
Specifies whether to remove automated backups immediately after the DB cluster is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted.
", @@ -639,6 +647,7 @@ "ModifyDBClusterMessage$ManageMasterUserPassword": "Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can't specify MasterUserPassword.
If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. In this case, RDS deletes the secret and uses the new password for the master user specified by MasterUserPassword.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
", "ModifyDBClusterMessage$RotateMasterUserPassword": "Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
You must apply the change immediately when rotating the master user password.
Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
", + "ModifyDBClusterMessage$EnableLimitlessDatabase": "Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.
Valid for: Aurora DB clusters only
", "ModifyDBInstanceMessage$MultiAZ": "Specifies whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.
This setting doesn't apply to RDS Custom DB instances.
", "ModifyDBInstanceMessage$AutoMinorVersionUpgrade": "Specifies whether minor version upgrades are applied automatically to the DB instance during the maintenance window. An outage occurs when all the following conditions are met:
The automatic upgrade is enabled for the maintenance window.
A newer minor version is available.
RDS has enabled automatic patching for the engine version.
If any of the preceding conditions isn't met, Amazon RDS applies the change as soon as possible and doesn't cause an outage.
For an RDS Custom DB instance, don't enable this setting. Otherwise, the operation returns an error.
", "ModifyDBInstanceMessage$CopyTagsToSnapshot": "Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags aren't copied.
This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see ModifyDBCluster.
A list of DBSecurityGroup instances.
The specified DB shard group name must be unique in your Amazon Web Services account in the specified Amazon Web Services Region.
", + "refs": { + } + }, + "DBShardGroupNotFoundFault": { + "base": "The specified DB shard group name wasn't found.
", + "refs": { + } + }, + "DBShardGroupsList": { + "base": null, + "refs": { + "DescribeDBShardGroupsResponse$DBShardGroups": "Contains a list of DB shard groups for the user.
" + } + }, "DBSnapshot": { "base": "Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the DescribeDBSnapshots action.
The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
", + "DBShardGroup$MaxACU": "The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
", + "LimitlessDatabase$MinRequiredACU": "The minimum required capacity for Aurora Limitless Database in Aurora capacity units (ACUs).
", + "ModifyDBShardGroupMessage$MaxACU": "The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
", "OrderableDBInstanceOption$MinIopsPerGib": "Minimum provisioned IOPS per GiB for a DB instance.
", "OrderableDBInstanceOption$MaxIopsPerGib": "Maximum provisioned IOPS per GiB for a DB instance.
", "OrderableDBInstanceOption$MinStorageThroughputPerIops": "Minimum storage throughput to provisioned IOPS ratio for a DB instance.
", @@ -2728,6 +2783,7 @@ "DescribeDBProxyTargetsRequest$Filters": "This parameter is not currently supported.
", "DescribeDBRecommendationsMessage$Filters": "A filter that specifies one or more recommendations to describe.
Supported Filters:
recommendation-id - Accepts a list of recommendation identifiers. The results list only includes the recommendations whose identifier is one of the specified filter values.
status - Accepts a list of recommendation statuses.
Valid values:
active - The recommendations which are ready for you to apply.
pending - The applied or scheduled recommendations which are in progress.
resolved - The recommendations which are completed.
dismissed - The recommendations that you dismissed.
The results list only includes the recommendations whose status is one of the specified filter values.
severity - Accepts a list of recommendation severities. The results list only includes the recommendations whose severity is one of the specified filter values.
Valid values:
high
medium
low
informational
type-id - Accepts a list of recommendation type identifiers. The results list only includes the recommendations whose type is one of the specified filter values.
dbi-resource-id - Accepts a list of database resource identifiers. The results list only includes the recommendations that generated for the specified databases.
cluster-resource-id - Accepts a list of cluster resource identifiers. The results list only includes the recommendations that generated for the specified clusters.
pg-arn - Accepts a list of parameter group ARNs. The results list only includes the recommendations that generated for the specified parameter groups.
cluster-pg-arn - Accepts a list of cluster parameter group ARNs. The results list only includes the recommendations that generated for the specified cluster parameter groups.
This parameter isn't currently supported.
", + "DescribeDBShardGroupsMessage$Filters": "A filter that specifies one or more DB shard groups to describe.
", "DescribeDBSnapshotTenantDatabasesMessage$Filters": "A filter that specifies one or more tenant databases to describe.
Supported filters:
tenant-db-name - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.
tenant-database-resource-id - Tenant database resource identifiers. The results list only includes information about the tenant databases contained within the DB snapshots.
dbi-resource-id - DB instance resource identifiers. The results list only includes information about snapshots containing tenant databases contained within the DB instances identified by these resource identifiers.
db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).
db-snapshot-id - Accepts DB snapshot identifiers.
snapshot-type - Accepts types of DB snapshots.
A filter that specifies one or more DB snapshots to describe.
Supported filters:
db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).
db-snapshot-id - Accepts DB snapshot identifiers.
dbi-resource-id - Accepts identifiers of source DB instances.
snapshot-type - Accepts types of DB snapshots.
engine - Accepts names of database engines.
This parameter isn't currently supported.
", @@ -2938,6 +2994,7 @@ "CreateDBInstanceReadReplicaMessage$StorageThroughput": "Specifies the storage throughput value for the read replica.
This setting doesn't apply to RDS Custom or Amazon Aurora DB instances.
", "CreateDBInstanceReadReplicaMessage$AllocatedStorage": "The amount of storage (in gibibytes) to allocate initially for the read replica. Follow the allocation rules specified in CreateDBInstance.
Be sure to allocate enough storage for your read replica so that the create operation can succeed. You can also allocate additional storage for future growth.
The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.
", + "CreateDBShardGroupMessage$ComputeRedundancy": "Specifies whether to create standby instances for the DB shard group. Valid values are the following:
0 - Creates a single, primary DB instance for each physical shard. This is the default value, and the only one supported for the preview.
1 - Creates a primary DB instance and a standby instance in a different Availability Zone (AZ) for each physical shard.
2 - Creates a primary DB instance and two standby instances in different AZs for each physical shard.
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
The number of days for which automatic DB snapshots are retained.
", "DBCluster$Port": "The port that the database engine is listening on.
", @@ -2960,6 +3017,7 @@ "DBInstanceAutomatedBackup$Iops": "The IOPS (I/O operations per second) value for the automated backup.
", "DBInstanceAutomatedBackup$BackupRetentionPeriod": "The retention period for the automated backups.
", "DBInstanceAutomatedBackup$StorageThroughput": "The storage throughput for the automated backup.
", + "DBShardGroup$ComputeRedundancy": "Specifies whether to create standby instances for the DB shard group. Valid values are the following:
0 - Creates a single, primary DB instance for each physical shard. This is the default value, and the only one supported for the preview.
1 - Creates a primary DB instance and a standby instance in a different Availability Zone (AZ) for each physical shard.
2 - Creates a primary DB instance and two standby instances in different AZs for each physical shard.
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
", "DBSnapshot$StorageThroughput": "Specifies the storage throughput for the DB 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 you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
", @@ -2969,7 +3027,7 @@ "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 you can retrieve the remaining results.
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 you can retrieve the remaining results.
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 you can retrieve the remaining results.
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 you can retrieve the remaining results.
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 you can retrieve the remaining results.
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 you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
", "DescribeDBInstanceAutomatedBackupsMessage$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 you can retrieve the remaining results.
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 you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
", @@ -3201,6 +3259,11 @@ "refs": { } }, + "InvalidDBShardGroupStateFault": { + "base": "The DB shard group must be in the available state.
", + "refs": { + } + }, "InvalidDBSnapshotStateFault": { "base": "The state of the DB snapshot doesn't allow deletion.
", "refs": { @@ -3251,6 +3314,11 @@ "refs": { } }, + "InvalidMaxAcuFault": { + "base": "The maximum capacity of the DB shard group must be 48-7168 Aurora capacity units (ACUs).
", + "refs": { + } + }, "InvalidOptionGroupStateFault": { "base": "The option group isn't in the available state.
", "refs": { @@ -3305,6 +3373,18 @@ "CreateCustomDBEngineVersionMessage$KMSKeyId": "The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS.
If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in Creating a symmetric encryption KMS key in the Amazon Web Services Key Management Service Developer Guide.
You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.
" } }, + "LimitlessDatabase": { + "base": "Contains details for Aurora Limitless Database.
", + "refs": { + "DBCluster$LimitlessDatabase": "The details for Aurora Limitless Database.
" + } + }, + "LimitlessDatabaseStatus": { + "base": null, + "refs": { + "LimitlessDatabase$Status": "The status of Aurora Limitless Database.
" + } + }, "ListTagsForResourceMessage": { "base": "", "refs": { @@ -3374,6 +3454,11 @@ "DBInstance$MasterUserSecret": "The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
" } }, + "MaxDBShardGroupLimitReached": { + "base": "The maximum number of DB shard groups for your Amazon Web Services account in the specified Amazon Web Services Region has been reached.
", + "refs": { + } + }, "MaxRecords": { "base": null, "refs": { @@ -3382,6 +3467,7 @@ "DescribeDBProxyEndpointsRequest$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.
", "DescribeDBProxyTargetGroupsRequest$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.
", "DescribeDBProxyTargetsRequest$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.
", + "DescribeDBShardGroupsMessage$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 you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100
", "DescribeExportTasksMessage$MaxRecords": "The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later DescribeExportTasks request to retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" } }, @@ -3537,6 +3623,11 @@ "refs": { } }, + "ModifyDBShardGroupMessage": { + "base": null, + "refs": { + } + }, "ModifyDBSnapshotAttributeMessage": { "base": "", "refs": { @@ -3984,6 +4075,11 @@ "refs": { } }, + "RebootDBShardGroupMessage": { + "base": null, + "refs": { + } + }, "RecommendedAction": { "base": "The recommended actions to apply to resolve the issues associated with your DB instances, DB clusters, and DB parameter groups.
", "refs": { @@ -4633,12 +4729,14 @@ "CreateDBProxyRequest$RoleArn": "The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
", "CreateDBSecurityGroupMessage$DBSecurityGroupName": "The name for the DB security group. This value is stored as a lowercase string.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Must not be \"Default\"
Example: mysecuritygroup
The description for the DB security group.
", + "CreateDBShardGroupMessage$DBShardGroupIdentifier": "The name of the DB shard group.
", + "CreateDBShardGroupMessage$DBClusterIdentifier": "The name of the primary DB cluster for the DB shard group.
", "CreateDBSnapshotMessage$DBSnapshotIdentifier": "The identifier for the DB snapshot.
Constraints:
Can't be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
The identifier of the DB instance that you want to create the snapshot of.
Constraints:
Must match the identifier of an existing DBInstance.
The name for the DB subnet group. This value is stored as a lowercase string.
Constraints:
Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.
Must not be default.
First character must be a letter.
Example: mydbsubnetgroup
The description for the DB subnet group.
", "CreateEventSubscriptionMessage$SubscriptionName": "The name of the subscription.
Constraints: The name must be less than 255 characters.
", - "CreateEventSubscriptionMessage$SnsTopicArn": "The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
", + "CreateEventSubscriptionMessage$SnsTopicArn": "The Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS automatically creates the ARN when you create a topic and subscribe to it.
RDS doesn't support FIFO (first in, first out) topics. For more information, see Message ordering and deduplication (FIFO topics) in the Amazon Simple Notification Service Developer Guide.
The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.
Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
The cluster identifier for this global database cluster. This parameter is stored as a lowercase string.
", "CreateGlobalClusterMessage$SourceDBClusterIdentifier": "The Amazon Resource Name (ARN) to use as the primary cluster of the global database.
If you provide a value for this parameter, don't specify values for the following settings because Amazon Aurora uses the values from the specified source DB cluster:
DatabaseName
Engine
EngineVersion
StorageEncrypted
The status of the DB security group.
", "DBSecurityGroupMessage$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.
The Amazon Web Services Region-unique, immutable identifier for the DB shard group.
", + "DBShardGroup$DBShardGroupIdentifier": "The name of the DB shard group.
", + "DBShardGroup$DBClusterIdentifier": "The name of the primary DB cluster for the DB shard group.
", + "DBShardGroup$Status": "The status of the DB shard group.
", + "DBShardGroup$Endpoint": "The connection endpoint for the DB shard group.
", "DBSnapshot$DBSnapshotIdentifier": "Specifies the identifier for the DB snapshot.
", "DBSnapshot$DBInstanceIdentifier": "Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
", "DBSnapshot$Engine": "Specifies the name of the database engine.
", @@ -4939,6 +5042,7 @@ "DeleteDBParameterGroupMessage$DBParameterGroupName": "The name of the DB parameter group.
Constraints:
Must be the name of an existing DB parameter group
You can't delete a default DB parameter group
Can't be associated with any DB instances
The name of the DB proxy to delete.
", "DeleteDBSecurityGroupMessage$DBSecurityGroupName": "The name of the DB security group to delete.
You can't delete the default DB security group.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Must not be \"Default\"
Teh name of the DB shard group to delete.
", "DeleteDBSnapshotMessage$DBSnapshotIdentifier": "The DB snapshot identifier.
Constraints: Must be the name of an existing DB snapshot in the available state.
The name of the database subnet group to delete.
You can't delete the default subnet group.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mydbsubnetgroup
The name of the RDS event notification subscription you want to delete.
", @@ -5012,6 +5116,9 @@ "DescribeDBRecommendationsMessage$Marker": "An optional pagination token provided by a previous DescribeDBRecommendations request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
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.
The user-supplied DB shard group identifier or the Amazon Resource Name (ARN) of the DB shard group. If this parameter is specified, information for only the specific DB shard group is returned. This parameter isn't case-sensitive.
Constraints:
If supplied, must match an existing DB shard group identifier.
An optional pagination token provided by a previous DescribeDBShardGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A pagination token that can be used in a later DescribeDBClusters request.
The identifier for the DB snapshot to describe the attributes for.
", "DescribeDBSnapshotTenantDatabasesMessage$DBInstanceIdentifier": "The ID of the DB instance used to create the DB snapshots. This parameter isn't case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBInstance.
The ID of a DB snapshot that contains the tenant databases to describe. This value is stored as a lowercase string.
Constraints:
If you specify this parameter, the value must match the ID of an existing DB snapshot.
If you specify an automatic snapshot, you must also specify SnapshotType.
The identifier of the recommendation to update.
", "ModifyDBRecommendationMessage$Locale": "The language of the modified recommendation.
", "ModifyDBRecommendationMessage$Status": "The recommendation status to update.
Valid values:
active
dismissed
The name of the DB shard group to modify.
", "ModifyDBSnapshotAttributeMessage$DBSnapshotIdentifier": "The identifier for the DB snapshot to modify the attributes for.
", "ModifyDBSnapshotAttributeMessage$AttributeName": "The name of the DB snapshot attribute to modify.
To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, set this value to restore.
To view the list of attributes available to modify, use the DescribeDBSnapshotAttributes API operation.
The identifier of the DB snapshot to modify.
", @@ -5324,6 +5432,7 @@ "ReadersArnList$member": null, "RebootDBClusterMessage$DBClusterIdentifier": "The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBCluster.
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
The name of the DB shard group to reboot.
", "RecommendedAction$ActionId": "The unique identifier of the recommended action.
", "RecommendedAction$Title": "A short description to summarize the action. The description might contain markdown.
", "RecommendedAction$Description": "A detailed description of the action. The description might contain markdown.
", @@ -5841,7 +5950,7 @@ "TargetDBInstanceClass": { "base": null, "refs": { - "CreateBlueGreenDeploymentRequest$TargetDBInstanceClass": "Specify the DB instance class for the databases in the green environment.
" + "CreateBlueGreenDeploymentRequest$TargetDBInstanceClass": "Specify the DB instance class for the databases in the green environment.
This parameter only applies to RDS DB instances, because DB instances within an Aurora DB cluster can have multiple different instance classes. If you're creating a blue/green deployment from an Aurora DB cluster, don't specify this parameter. After the green environment is created, you can individually modify the instance classes of the DB instances within the green DB cluster.
" } }, "TargetDBParameterGroupName": { @@ -5946,6 +6055,11 @@ "SupportedTimezonesList$member": null } }, + "UnsupportedDBEngineVersionFault": { + "base": "The specified DB engine version isn't supported for Aurora Limitless Database.
", + "refs": { + } + }, "UpgradeTarget": { "base": "The version of the database engine that a DB instance can be upgraded to.
", "refs": { diff --git a/models/apis/rds/2014-10-31/examples-1.json b/models/apis/rds/2014-10-31/examples-1.json index 5b1599a476d..65d2712e6d0 100644 --- a/models/apis/rds/2014-10-31/examples-1.json +++ b/models/apis/rds/2014-10-31/examples-1.json @@ -1097,6 +1097,35 @@ "title": "To create a global DB cluster" } ], + "CreateIntegration": [ + { + "input": { + "IntegrationName": "my-integration", + "SourceArn": "arn:aws:rds:us-east-1:123456789012:cluster:my-cluster", + "TargetArn": "arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8" + }, + "output": { + "CreateTime": "2023-12-28T17:20:20.629Z", + "IntegrationName": "my-integration", + "KMSKeyId": "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa", + "SourceArn": "arn:aws:rds:us-east-1:123456789012:cluster:my-cluster", + "Status": "creating", + "Tags": [ + + ], + "TargetArn": "arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a zero-ETL integration with Amazon Redshift.", + "id": "to-create-a-zero-etl-integration-1679688377231", + "title": "To create a zero-ETL integration" + } + ], "CreateOptionGroup": [ { "input": { @@ -1627,6 +1656,33 @@ "title": "To delete a global DB cluster" } ], + "DeleteIntegration": [ + { + "input": { + "IntegrationIdentifier": "5b9f3d79-7392-4a3e-896c-58eaa1b53231" + }, + "output": { + "CreateTime": "2023-12-28T17:20:20.629Z", + "IntegrationName": "my-integration", + "KMSKeyId": "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa", + "SourceArn": "arn:aws:rds:us-east-1:123456789012:cluster:my-cluster", + "Status": "deleting", + "Tags": [ + + ], + "TargetArn": "arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a zero-ETL integration with Amazon Redshift.", + "id": "to-delete-a-zero-etl-integration-1679688377231", + "title": "To delete a zero-ETL integration" + } + ], "DeleteOptionGroup": [ { "input": { @@ -3119,6 +3175,37 @@ "title": "To describe global DB clusters" } ], + "DescribeIntegrations": [ + { + "input": { + "IntegrationIdentifier": "5b9f3d79-7392-4a3e-896c-58eaa1b53231" + }, + "output": { + "Integrations": [ + { + "CreateTime": "2023-12-28T17:20:20.629Z", + "IntegrationName": "my-integration", + "KMSKeyId": "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa", + "SourceArn": "arn:aws:rds:us-east-1:123456789012:cluster:my-cluster", + "Status": "active", + "Tags": [ + + ], + "TargetArn": "arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves information about a zero-ETL integration with Amazon Redshift.", + "id": "to-describe-a-zero-etl-integration-1679688377231", + "title": "To describe a zero-ETL integration" + } + ], "DescribeOptionGroupOptions": [ { "input": { diff --git a/models/apis/storagegateway/2013-06-30/api-2.json b/models/apis/storagegateway/2013-06-30/api-2.json index 3d276e296aa..65c39cf5b77 100644 --- a/models/apis/storagegateway/2013-06-30/api-2.json +++ b/models/apis/storagegateway/2013-06-30/api-2.json @@ -2666,7 +2666,9 @@ "Ec2InstanceId":{"shape":"Ec2InstanceId"}, "Ec2InstanceRegion":{"shape":"Ec2InstanceRegion"}, "HostEnvironment":{"shape":"HostEnvironment"}, - "HostEnvironmentId":{"shape":"HostEnvironmentId"} + "HostEnvironmentId":{"shape":"HostEnvironmentId"}, + "DeprecationDate":{"shape":"DeprecationDate"}, + "SoftwareVersion":{"shape":"SoftwareVersion"} } }, "GatewayName":{ diff --git a/models/apis/storagegateway/2013-06-30/docs-2.json b/models/apis/storagegateway/2013-06-30/docs-2.json index 2ef87db329c..3120443e1c0 100644 --- a/models/apis/storagegateway/2013-06-30/docs-2.json +++ b/models/apis/storagegateway/2013-06-30/docs-2.json @@ -47,7 +47,7 @@ "DescribeStorediSCSIVolumes": "Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.
", "DescribeTapeArchives": "Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.
If a specific TapeARN is not specified, Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.
Returns a list of virtual tape recovery points that are available for the specified tape gateway.
A recovery point is a point-in-time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. This operation is only supported in the tape gateway type.
", - "DescribeTapes": "Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes associated with the specified gateway. This operation is only supported in the tape gateway type.
Returns a description of virtual tapes that correspond to the specified Amazon Resource Names (ARNs). If TapeARN is not specified, returns a description of the virtual tapes associated with the specified gateway. This operation is only supported for the tape gateway type.
The operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit field in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of tapes.
Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume, and tape gateway types.
The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.
", "DescribeVTLDevices": "Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, Storage Gateway returns VTL device information.
This operation is only supported in the tape gateway type.
", "DescribeWorkingStorage": "Returns information about the working storage of a gateway. This operation is only supported in the stored volumes gateway type. This operation is deprecated in cached volumes API version (20120630). Use DescribeUploadBuffer instead.
Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored volume gateway.
The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.
", @@ -66,15 +66,15 @@ "ListVolumeInitiators": "Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. This operation is only supported in the cached volume and stored volume gateway types.
", "ListVolumeRecoveryPoints": "Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type.
Each cache volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot or clone a new cached volume from a source volume. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.
", "ListVolumes": "Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the DescribeCachediSCSIVolumes API.
The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the Limit field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only supported in the cached volume and stored volume gateway types.
Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to S3. Amazon S3.
Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways.
For more information, see Getting file upload notification in the Amazon S3 File Gateway User Guide.
", - "RefreshCache": "Refreshes the cached inventory of objects for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed, or replaced since the gateway last listed the bucket's contents and cached the results. This operation does not import files into the S3 File Gateway cache storage. It only updates the cached inventory to reflect changes in the inventory of the objects in the S3 bucket. This operation is only supported in the S3 File Gateway types.
You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see Getting notified about file operations in the Storage Gateway User Guide. This operation is Only supported for S3 File Gateways.
When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through a CloudWatch event when your RefreshCache operation completes.
Throttle limit: This API is asynchronous, so the gateway will accept no more than two refreshes at any time. We recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more information, see Getting notified about file operations in the Storage Gateway User Guide.
Wait at least 60 seconds between consecutive RefreshCache API requests.
If you invoke the RefreshCache API when two requests are already being processed, any new request will cause an InvalidGatewayRequestException error because too many requests were sent to the server.
The S3 bucket name does not need to be included when entering the list of folders in the FolderList parameter.
For more information, see Getting notified about file operations in the Storage Gateway User Guide.
", + "NotifyWhenUploaded": "Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to Amazon S3.
Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways.
For more information, see Getting file upload notification in the Amazon S3 File Gateway User Guide.
", + "RefreshCache": "Refreshes the cached inventory of objects for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed, or replaced since the gateway last listed the bucket's contents and cached the results. This operation does not import files into the S3 File Gateway cache storage. It only updates the cached inventory to reflect changes in the inventory of the objects in the S3 bucket. This operation is only supported in the S3 File Gateway types.
You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see Getting notified about file operations in the Amazon S3 File Gateway User Guide. This operation is Only supported for S3 File Gateways.
When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through a CloudWatch event when your RefreshCache operation completes.
Throttle limit: This API is asynchronous, so the gateway will accept no more than two refreshes at any time. We recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more information, see Getting notified about file operations in the Amazon S3 File Gateway User Guide.
Wait at least 60 seconds between consecutive RefreshCache API requests.
If you invoke the RefreshCache API when two requests are already being processed, any new request will cause an InvalidGatewayRequestException error because too many requests were sent to the server.
The S3 bucket name does not need to be included when entering the list of folders in the FolderList parameter.
For more information, see Getting notified about file operations in the Amazon S3 File Gateway User Guide.
", "RemoveTagsFromResource": "Removes one or more tags from the specified resource. This operation is supported in storage gateways of all types.
", "ResetCache": "Resets all cache disks that have encountered an error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters an error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point, you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types.
If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.
Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS, that is, archive. This operation is only supported in the tape gateway type.
Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway. This operation is only supported in the tape gateway type.
", "RetrieveTapeRecoveryPoint": "Retrieves the recovery point for the specified virtual tape. This operation is only supported in the tape gateway type.
A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.
The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a tape gateway. There is no charge for retrieving recovery points.
Sets the password for your VM local console. When you log in to the local console for the first time, you log in to the VM with the default credentials. We recommend that you set a new password. You don't need to know the default password to set a new password.
", "SetSMBGuestPassword": "Sets the password for the guest user smbguest. The smbguest user is the user when the authentication method for the file share is set to GuestAccess. This operation only supported for S3 File Gateways
Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.
The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the host VM.
If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.
After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.
When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway.
If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.
", + "ShutdownGateway": "Shuts down a Tape Gateway or Volume Gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.
This API action cannot be used to shut down S3 File Gateway or FSx File Gateway.
The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the host VM.
If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.
After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.
When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway.
If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.
", "StartAvailabilityMonitorTest": "Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment. This request only initiates the test and that a successful response only indicates that the test was started. It doesn't indicate that the test passed. For the status of the test, invoke the DescribeAvailabilityMonitorTest API.
Starting this test will cause your gateway to go offline for a brief period.
Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups.
When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any additional API calls. For more information, see ActivateGateway.
To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.
", "UpdateAutomaticTapeCreationPolicy": "Updates the automatic tape creation policy of a gateway. Use this to update the policy with a new set of automatic tape creation rules. This is only supported for tape gateways.
By default, there is no automatic tape creation policy.
A gateway can have only one automatic tape creation policy.
Date after which this gateway will not receive software updates for new features and bug fixes.
" + "DescribeGatewayInformationOutput$DeprecationDate": "Date after which this gateway will not receive software updates for new features and bug fixes.
", + "GatewayInfo$DeprecationDate": "Date after which this gateway will not receive software updates for new features and bug fixes.
" } }, "DescribeAvailabilityMonitorTestInput": { @@ -2042,7 +2043,8 @@ "SoftwareVersion": { "base": null, "refs": { - "DescribeGatewayInformationOutput$SoftwareVersion": "The version number of the software running on the gateway appliance.
" + "DescribeGatewayInformationOutput$SoftwareVersion": "The version number of the software running on the gateway appliance.
", + "GatewayInfo$SoftwareVersion": "The version number of the software running on the gateway appliance.
" } }, "Squash": { diff --git a/models/apis/storagegateway/2013-06-30/endpoint-rule-set-1.json b/models/apis/storagegateway/2013-06-30/endpoint-rule-set-1.json index 9f3c8e2c2b9..b0a53a28b97 100644 --- a/models/apis/storagegateway/2013-06-30/endpoint-rule-set-1.json +++ b/models/apis/storagegateway/2013-06-30/endpoint-rule-set-1.json @@ -40,7 +40,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -83,7 +82,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -96,7 +96,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -110,7 +109,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -133,7 +131,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -168,7 +165,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -179,14 +175,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -200,14 +198,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -216,11 +212,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -231,14 +227,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -252,7 +250,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -272,7 +269,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -283,14 +279,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -301,9 +299,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], diff --git a/service/ec2/api.go b/service/ec2/api.go index 94c46afae1b..795600954ad 100644 --- a/service/ec2/api.go +++ b/service/ec2/api.go @@ -71474,7 +71474,7 @@ type CreateEgressOnlyInternetGatewayInput struct { _ struct{} `type:"structure"` // Unique, case-sensitive identifier that you provide to ensure the idempotency - // of the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). + // of the request. For more information, see Ensuring idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). ClientToken *string `type:"string"` // Checks whether you have the required permissions for the action, without @@ -74816,7 +74816,7 @@ type CreateNatGatewayInput struct { AllocationId *string `type:"string"` // Unique, case-sensitive identifier that you provide to ensure the idempotency - // of the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // of the request. For more information, see Ensuring idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). // // Constraint: Maximum 64 ASCII characters. ClientToken *string `type:"string" idempotencyToken:"true"` @@ -75185,6 +75185,10 @@ func (s CreateNetworkAclEntryOutput) GoString() string { type CreateNetworkAclInput struct { _ struct{} `type:"structure"` + // Unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. For more information, see Ensuring idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). + ClientToken *string `type:"string" idempotencyToken:"true"` + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have // the required permissions, the error response is DryRunOperation. Otherwise, @@ -75231,6 +75235,12 @@ func (s *CreateNetworkAclInput) Validate() error { return nil } +// SetClientToken sets the ClientToken field's value. +func (s *CreateNetworkAclInput) SetClientToken(v string) *CreateNetworkAclInput { + s.ClientToken = &v + return s +} + // SetDryRun sets the DryRun field's value. func (s *CreateNetworkAclInput) SetDryRun(v bool) *CreateNetworkAclInput { s.DryRun = &v @@ -75252,6 +75262,10 @@ func (s *CreateNetworkAclInput) SetVpcId(v string) *CreateNetworkAclInput { type CreateNetworkAclOutput struct { _ struct{} `type:"structure"` + // Unique, case-sensitive identifier to ensure the idempotency of the request. + // Only returned if a client token was provided in the request. + ClientToken *string `locationName:"clientToken" type:"string"` + // Information about the network ACL. NetworkAcl *NetworkAcl `locationName:"networkAcl" type:"structure"` } @@ -75274,6 +75288,12 @@ func (s CreateNetworkAclOutput) GoString() string { return s.String() } +// SetClientToken sets the ClientToken field's value. +func (s *CreateNetworkAclOutput) SetClientToken(v string) *CreateNetworkAclOutput { + s.ClientToken = &v + return s +} + // SetNetworkAcl sets the NetworkAcl field's value. func (s *CreateNetworkAclOutput) SetNetworkAcl(v *NetworkAcl) *CreateNetworkAclOutput { s.NetworkAcl = v @@ -76826,6 +76846,10 @@ func (s *CreateRouteOutput) SetReturn(v bool) *CreateRouteOutput { type CreateRouteTableInput struct { _ struct{} `type:"structure"` + // Unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. For more information, see Ensuring idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). + ClientToken *string `type:"string" idempotencyToken:"true"` + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have // the required permissions, the error response is DryRunOperation. Otherwise, @@ -76872,6 +76896,12 @@ func (s *CreateRouteTableInput) Validate() error { return nil } +// SetClientToken sets the ClientToken field's value. +func (s *CreateRouteTableInput) SetClientToken(v string) *CreateRouteTableInput { + s.ClientToken = &v + return s +} + // SetDryRun sets the DryRun field's value. func (s *CreateRouteTableInput) SetDryRun(v bool) *CreateRouteTableInput { s.DryRun = &v @@ -76893,6 +76923,10 @@ func (s *CreateRouteTableInput) SetVpcId(v string) *CreateRouteTableInput { type CreateRouteTableOutput struct { _ struct{} `type:"structure"` + // Unique, case-sensitive identifier to ensure the idempotency of the request. + // Only returned if a client token was provided in the request. + ClientToken *string `locationName:"clientToken" type:"string"` + // Information about the route table. RouteTable *RouteTable `locationName:"routeTable" type:"structure"` } @@ -76915,6 +76949,12 @@ func (s CreateRouteTableOutput) GoString() string { return s.String() } +// SetClientToken sets the ClientToken field's value. +func (s *CreateRouteTableOutput) SetClientToken(v string) *CreateRouteTableOutput { + s.ClientToken = &v + return s +} + // SetRouteTable sets the RouteTable field's value. func (s *CreateRouteTableOutput) SetRouteTable(v *RouteTable) *CreateRouteTableOutput { s.RouteTable = v @@ -189824,6 +189864,9 @@ const ( // AvailabilityZoneStateUnavailable is a AvailabilityZoneState enum value AvailabilityZoneStateUnavailable = "unavailable" + + // AvailabilityZoneStateConstrained is a AvailabilityZoneState enum value + AvailabilityZoneStateConstrained = "constrained" ) // AvailabilityZoneState_Values returns all elements of the AvailabilityZoneState enum @@ -189833,6 +189876,7 @@ func AvailabilityZoneState_Values() []string { AvailabilityZoneStateInformation, AvailabilityZoneStateImpaired, AvailabilityZoneStateUnavailable, + AvailabilityZoneStateConstrained, } } @@ -198438,6 +198482,9 @@ const ( // SubnetStateAvailable is a SubnetState enum value SubnetStateAvailable = "available" + + // SubnetStateUnavailable is a SubnetState enum value + SubnetStateUnavailable = "unavailable" ) // SubnetState_Values returns all elements of the SubnetState enum @@ -198445,6 +198492,7 @@ func SubnetState_Values() []string { return []string{ SubnetStatePending, SubnetStateAvailable, + SubnetStateUnavailable, } } diff --git a/service/ecs/api.go b/service/ecs/api.go index 47430653ba4..7056bce97b9 100644 --- a/service/ecs/api.go +++ b/service/ecs/api.go @@ -480,7 +480,9 @@ func (c *ECS) CreateTaskSetRequest(input *CreateTaskSetInput) (req *request.Requ // see Amazon ECS deployment types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) // in the Amazon Elastic Container Service Developer Guide. // -// You can create a maximum of 5 tasks sets for a deployment. +// For information about the maximum number of task sets and otther quotas, +// see Amazon ECS service quotas (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html) +// in the Amazon Elastic Container Service Developer Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7118,7 +7120,8 @@ func (s *AutoScalingGroupProviderUpdate) SetManagedTerminationProtection(v strin return s } -// An object representing the networking details for a task or service. +// An object representing the networking details for a task or service. For +// example awsvpcConfiguration={subnets=["subnet-12344321"],securityGroups=["sg-12344321"]} type AwsVpcConfiguration struct { _ struct{} `type:"structure"` @@ -9159,7 +9162,7 @@ type ContainerDefinition struct { // set by the operating system with the exception of the nofile resource limit // parameter which Fargate overrides. The nofile resource limit sets a restriction // on the number of open files that a container can use. The default nofile - // soft limit is 1024 and the default hard limit is 4096. + // soft limit is 1024 and the default hard limit is 65535. // // This parameter requires version 1.18 of the Docker Remote API or greater // on your container instance. To check the Docker Remote API version on your @@ -9584,6 +9587,10 @@ func (s *ContainerDefinition) SetWorkingDirectory(v string) *ContainerDefinition // - Linux platform version 1.3.0 or later. // // - Windows platform version 1.0.0 or later. +// +// For more information about how to create a container dependency, see Container +// dependency (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/example_task_definitions.html#example_task_definition-containerdependency) +// in the Amazon Elastic Container Service Developer Guide. type ContainerDependency struct { _ struct{} `type:"structure"` @@ -12546,7 +12553,7 @@ type DeploymentConfiguration struct { // passed their health checks. The amount of time the service scheduler can // wait for is determined by the container health check settings. // - // For services are that do use a load balancer, the following should be noted: + // For services that do use a load balancer, the following should be noted: // // * If a task has no essential containers with a health check defined, the // service scheduler will wait for the load balancer target group health @@ -21717,7 +21724,8 @@ type ServiceConnectService struct { // Connect. Timeout *TimeoutConfiguration `locationName:"timeout" type:"structure"` - // An object that represents the configuration for Service Connect TLS. + // A reference to an object that represents a Transport Layer Security (TLS) + // configuration. Tls *ServiceConnectTlsConfiguration `locationName:"tls" type:"structure"` } @@ -22938,7 +22946,7 @@ type StopTaskInput struct { // An optional message specified when a task is stopped. For example, if you're // using a custom scheduler, you can use this parameter to specify the reason // for stopping the task here, and the message appears in subsequent DescribeTasks - // API operations on this task. Up to 255 characters are allowed in this message. + // API operations on this task. Reason *string `locationName:"reason" type:"string"` // The task ID of the task to stop. @@ -24016,20 +24024,6 @@ type Task struct { // // For more information about stop code, see Stopped tasks error codes (https://docs.aws.amazon.com/AmazonECS/latest/userguide/stopped-task-error-codes.html) // in the Amazon ECS User Guide. - // - // The following are valid values: - // - // * TaskFailedToStart - // - // * EssentialContainerExited - // - // * UserInitiated - // - // * TerminationNotice - // - // * ServiceSchedulerInitiated - // - // * SpotInterruption StopCode *string `locationName:"stopCode" type:"string" enum:"TaskStopCode"` // The Unix timestamp for the time when the task was stopped. More specifically, @@ -25815,7 +25809,7 @@ func (s *Tmpfs) SetSize(v int64) *Tmpfs { // set by the operating system with the exception of the nofile resource limit // parameter which Fargate overrides. The nofile resource limit sets a restriction // on the number of open files that a container can use. The default nofile -// soft limit is 1024 and the default hard limit is 4096. +// soft limit is 1024 and the default hard limit is 65535. // // You can specify the ulimit settings for a container in a task definition. type Ulimit struct { diff --git a/service/outposts/api.go b/service/outposts/api.go index 23c6ddfd607..549f7211760 100644 --- a/service/outposts/api.go +++ b/service/outposts/api.go @@ -6465,9 +6465,7 @@ type StartConnectionInput struct { ClientPublicKey *string `min:"44" type:"string" required:"true"` // The serial number of the dongle. - // - // DeviceSerialNumber is a required field - DeviceSerialNumber *string `min:"1" type:"string" required:"true"` + DeviceSerialNumber *string `min:"1" type:"string"` // The device index of the network interface on the Outpost server. // @@ -6508,9 +6506,6 @@ func (s *StartConnectionInput) Validate() error { if s.ClientPublicKey != nil && len(*s.ClientPublicKey) < 44 { invalidParams.Add(request.NewErrParamMinLen("ClientPublicKey", 44)) } - if s.DeviceSerialNumber == nil { - invalidParams.Add(request.NewErrParamRequired("DeviceSerialNumber")) - } if s.DeviceSerialNumber != nil && len(*s.DeviceSerialNumber) < 1 { invalidParams.Add(request.NewErrParamMinLen("DeviceSerialNumber", 1)) } diff --git a/service/rds/api.go b/service/rds/api.go index a0577bdc5f1..0f5bd4eb774 100644 --- a/service/rds/api.go +++ b/service/rds/api.go @@ -2693,6 +2693,110 @@ func (c *RDS) CreateDBSecurityGroupWithContext(ctx aws.Context, input *CreateDBS return out, req.Send() } +const opCreateDBShardGroup = "CreateDBShardGroup" + +// CreateDBShardGroupRequest generates a "aws/request.Request" representing the +// client's request for the CreateDBShardGroup operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateDBShardGroup for more information on using the CreateDBShardGroup +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the CreateDBShardGroupRequest method. +// req, resp := client.CreateDBShardGroupRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBShardGroup +func (c *RDS) CreateDBShardGroupRequest(input *CreateDBShardGroupInput) (req *request.Request, output *CreateDBShardGroupOutput) { + op := &request.Operation{ + Name: opCreateDBShardGroup, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreateDBShardGroupInput{} + } + + output = &CreateDBShardGroupOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateDBShardGroup API operation for Amazon Relational Database Service. +// +// Creates a new DB shard group for Aurora Limitless Database. You must enable +// Aurora Limitless Database to create a DB shard group. +// +// Valid for: Aurora DB clusters only +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Relational Database Service's +// API operation CreateDBShardGroup for usage and error information. +// +// Returned Error Codes: +// +// - ErrCodeDBShardGroupAlreadyExistsFault "DBShardGroupAlreadyExists" +// The specified DB shard group name must be unique in your Amazon Web Services +// account in the specified Amazon Web Services Region. +// +// - ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" +// DBClusterIdentifier doesn't refer to an existing DB cluster. +// +// - ErrCodeMaxDBShardGroupLimitReached "MaxDBShardGroupLimitReached" +// The maximum number of DB shard groups for your Amazon Web Services account +// in the specified Amazon Web Services Region has been reached. +// +// - ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" +// The requested operation can't be performed while the cluster is in this state. +// +// - ErrCodeInvalidMaxAcuFault "InvalidMaxAcu" +// The maximum capacity of the DB shard group must be 48-7168 Aurora capacity +// units (ACUs). +// +// - ErrCodeUnsupportedDBEngineVersionFault "UnsupportedDBEngineVersion" +// The specified DB engine version isn't supported for Aurora Limitless Database. +// +// - ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" +// The DB subnet group doesn't cover all Availability Zones after it's created +// because of users' change. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBShardGroup +func (c *RDS) CreateDBShardGroup(input *CreateDBShardGroupInput) (*CreateDBShardGroupOutput, error) { + req, out := c.CreateDBShardGroupRequest(input) + return out, req.Send() +} + +// CreateDBShardGroupWithContext is the same as CreateDBShardGroup with the addition of +// the ability to pass a context and additional request options. +// +// See CreateDBShardGroup for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *RDS) CreateDBShardGroupWithContext(ctx aws.Context, input *CreateDBShardGroupInput, opts ...request.Option) (*CreateDBShardGroupOutput, error) { + req, out := c.CreateDBShardGroupRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateDBSnapshot = "CreateDBSnapshot" // CreateDBSnapshotRequest generates a "aws/request.Request" representing the @@ -4588,6 +4692,91 @@ func (c *RDS) DeleteDBSecurityGroupWithContext(ctx aws.Context, input *DeleteDBS return out, req.Send() } +const opDeleteDBShardGroup = "DeleteDBShardGroup" + +// DeleteDBShardGroupRequest generates a "aws/request.Request" representing the +// client's request for the DeleteDBShardGroup operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteDBShardGroup for more information on using the DeleteDBShardGroup +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the DeleteDBShardGroupRequest method. +// req, resp := client.DeleteDBShardGroupRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBShardGroup +func (c *RDS) DeleteDBShardGroupRequest(input *DeleteDBShardGroupInput) (req *request.Request, output *DeleteDBShardGroupOutput) { + op := &request.Operation{ + Name: opDeleteDBShardGroup, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeleteDBShardGroupInput{} + } + + output = &DeleteDBShardGroupOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteDBShardGroup API operation for Amazon Relational Database Service. +// +// Deletes an Aurora Limitless Database DB shard group. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Relational Database Service's +// API operation DeleteDBShardGroup for usage and error information. +// +// Returned Error Codes: +// +// - ErrCodeDBShardGroupNotFoundFault "DBShardGroupNotFound" +// The specified DB shard group name wasn't found. +// +// - ErrCodeInvalidDBShardGroupStateFault "InvalidDBShardGroupState" +// The DB shard group must be in the available state. +// +// - ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" +// The requested operation can't be performed while the cluster is in this state. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBShardGroup +func (c *RDS) DeleteDBShardGroup(input *DeleteDBShardGroupInput) (*DeleteDBShardGroupOutput, error) { + req, out := c.DeleteDBShardGroupRequest(input) + return out, req.Send() +} + +// DeleteDBShardGroupWithContext is the same as DeleteDBShardGroup with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteDBShardGroup for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *RDS) DeleteDBShardGroupWithContext(ctx aws.Context, input *DeleteDBShardGroupInput, opts ...request.Option) (*DeleteDBShardGroupOutput, error) { + req, out := c.DeleteDBShardGroupRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeleteDBSnapshot = "DeleteDBSnapshot" // DeleteDBSnapshotRequest generates a "aws/request.Request" representing the @@ -8398,6 +8587,88 @@ func (c *RDS) DescribeDBSecurityGroupsPagesWithContext(ctx aws.Context, input *D return p.Err() } +const opDescribeDBShardGroups = "DescribeDBShardGroups" + +// DescribeDBShardGroupsRequest generates a "aws/request.Request" representing the +// client's request for the DescribeDBShardGroups operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeDBShardGroups for more information on using the DescribeDBShardGroups +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the DescribeDBShardGroupsRequest method. +// req, resp := client.DescribeDBShardGroupsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBShardGroups +func (c *RDS) DescribeDBShardGroupsRequest(input *DescribeDBShardGroupsInput) (req *request.Request, output *DescribeDBShardGroupsOutput) { + op := &request.Operation{ + Name: opDescribeDBShardGroups, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeDBShardGroupsInput{} + } + + output = &DescribeDBShardGroupsOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeDBShardGroups API operation for Amazon Relational Database Service. +// +// Describes existing Aurora Limitless Database DB shard groups. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Relational Database Service's +// API operation DescribeDBShardGroups for usage and error information. +// +// Returned Error Codes: +// +// - ErrCodeDBShardGroupNotFoundFault "DBShardGroupNotFound" +// The specified DB shard group name wasn't found. +// +// - ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" +// DBClusterIdentifier doesn't refer to an existing DB cluster. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBShardGroups +func (c *RDS) DescribeDBShardGroups(input *DescribeDBShardGroupsInput) (*DescribeDBShardGroupsOutput, error) { + req, out := c.DescribeDBShardGroupsRequest(input) + return out, req.Send() +} + +// DescribeDBShardGroupsWithContext is the same as DescribeDBShardGroups with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeDBShardGroups for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *RDS) DescribeDBShardGroupsWithContext(ctx aws.Context, input *DescribeDBShardGroupsInput, opts ...request.Option) (*DescribeDBShardGroupsOutput, error) { + req, out := c.DescribeDBShardGroupsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDescribeDBSnapshotAttributes = "DescribeDBSnapshotAttributes" // DescribeDBSnapshotAttributesRequest generates a "aws/request.Request" representing the @@ -11418,9 +11689,11 @@ func (c *RDS) FailoverDBClusterRequest(input *FailoverDBClusterInput) (req *requ // Replicas (read-only instances) in the DB cluster to be the primary DB instance // (the cluster writer). // -// For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the -// readable standby DB instances (read-only instances) in the DB cluster to -// be the primary DB instance (the cluster writer). +// For a Multi-AZ DB cluster, after RDS terminates the primary DB instance, +// the internal monitoring system detects that the primary DB instance is unhealthy +// and promotes a readable standby (read-only instances) in the DB cluster to +// be the primary DB instance (the cluster writer). Failover times are typically +// less than 35 seconds. // // An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, // if one exists, when the primary DB instance fails. A Multi-AZ DB cluster @@ -13151,6 +13424,98 @@ func (c *RDS) ModifyDBRecommendationWithContext(ctx aws.Context, input *ModifyDB return out, req.Send() } +const opModifyDBShardGroup = "ModifyDBShardGroup" + +// ModifyDBShardGroupRequest generates a "aws/request.Request" representing the +// client's request for the ModifyDBShardGroup operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ModifyDBShardGroup for more information on using the ModifyDBShardGroup +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the ModifyDBShardGroupRequest method. +// req, resp := client.ModifyDBShardGroupRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBShardGroup +func (c *RDS) ModifyDBShardGroupRequest(input *ModifyDBShardGroupInput) (req *request.Request, output *ModifyDBShardGroupOutput) { + op := &request.Operation{ + Name: opModifyDBShardGroup, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &ModifyDBShardGroupInput{} + } + + output = &ModifyDBShardGroupOutput{} + req = c.newRequest(op, input, output) + return +} + +// ModifyDBShardGroup API operation for Amazon Relational Database Service. +// +// Modifies the settings of an Aurora Limitless Database DB shard group. You +// can change one or more settings by specifying these parameters and the new +// values in the request. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Relational Database Service's +// API operation ModifyDBShardGroup for usage and error information. +// +// Returned Error Codes: +// +// - ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" +// The requested operation can't be performed while the cluster is in this state. +// +// - ErrCodeDBShardGroupAlreadyExistsFault "DBShardGroupAlreadyExists" +// The specified DB shard group name must be unique in your Amazon Web Services +// account in the specified Amazon Web Services Region. +// +// - ErrCodeDBShardGroupNotFoundFault "DBShardGroupNotFound" +// The specified DB shard group name wasn't found. +// +// - ErrCodeInvalidMaxAcuFault "InvalidMaxAcu" +// The maximum capacity of the DB shard group must be 48-7168 Aurora capacity +// units (ACUs). +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBShardGroup +func (c *RDS) ModifyDBShardGroup(input *ModifyDBShardGroupInput) (*ModifyDBShardGroupOutput, error) { + req, out := c.ModifyDBShardGroupRequest(input) + return out, req.Send() +} + +// ModifyDBShardGroupWithContext is the same as ModifyDBShardGroup with the addition of +// the ability to pass a context and additional request options. +// +// See ModifyDBShardGroup for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *RDS) ModifyDBShardGroupWithContext(ctx aws.Context, input *ModifyDBShardGroupInput, opts ...request.Option) (*ModifyDBShardGroupOutput, error) { + req, out := c.ModifyDBShardGroupRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opModifyDBSnapshot = "ModifyDBSnapshot" // ModifyDBSnapshotRequest generates a "aws/request.Request" representing the @@ -14260,6 +14625,92 @@ func (c *RDS) RebootDBInstanceWithContext(ctx aws.Context, input *RebootDBInstan return out, req.Send() } +const opRebootDBShardGroup = "RebootDBShardGroup" + +// RebootDBShardGroupRequest generates a "aws/request.Request" representing the +// client's request for the RebootDBShardGroup operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See RebootDBShardGroup for more information on using the RebootDBShardGroup +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the RebootDBShardGroupRequest method. +// req, resp := client.RebootDBShardGroupRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RebootDBShardGroup +func (c *RDS) RebootDBShardGroupRequest(input *RebootDBShardGroupInput) (req *request.Request, output *RebootDBShardGroupOutput) { + op := &request.Operation{ + Name: opRebootDBShardGroup, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &RebootDBShardGroupInput{} + } + + output = &RebootDBShardGroupOutput{} + req = c.newRequest(op, input, output) + return +} + +// RebootDBShardGroup API operation for Amazon Relational Database Service. +// +// You might need to reboot your DB shard group, usually for maintenance reasons. +// For example, if you make certain modifications, reboot the DB shard group +// for the changes to take effect. +// +// This operation applies only to Aurora Limitless Database DBb shard groups. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Relational Database Service's +// API operation RebootDBShardGroup for usage and error information. +// +// Returned Error Codes: +// +// - ErrCodeDBShardGroupNotFoundFault "DBShardGroupNotFound" +// The specified DB shard group name wasn't found. +// +// - ErrCodeInvalidDBShardGroupStateFault "InvalidDBShardGroupState" +// The DB shard group must be in the available state. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RebootDBShardGroup +func (c *RDS) RebootDBShardGroup(input *RebootDBShardGroupInput) (*RebootDBShardGroupOutput, error) { + req, out := c.RebootDBShardGroupRequest(input) + return out, req.Send() +} + +// RebootDBShardGroupWithContext is the same as RebootDBShardGroup with the addition of +// the ability to pass a context and additional request options. +// +// See RebootDBShardGroup for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *RDS) RebootDBShardGroupWithContext(ctx aws.Context, input *RebootDBShardGroupInput, opts ...request.Option) (*RebootDBShardGroupOutput, error) { + req, out := c.RebootDBShardGroupRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opRegisterDBProxyTargets = "RegisterDBProxyTargets" // RegisterDBProxyTargetsRequest generates a "aws/request.Request" representing the @@ -20401,6 +20852,12 @@ type CreateBlueGreenDeploymentInput struct { TargetDBClusterParameterGroupName *string `min:"1" type:"string"` // Specify the DB instance class for the databases in the green environment. + // + // This parameter only applies to RDS DB instances, because DB instances within + // an Aurora DB cluster can have multiple different instance classes. If you're + // creating a blue/green deployment from an Aurora DB cluster, don't specify + // this parameter. After the green environment is created, you can individually + // modify the instance classes of the DB instances within the green DB cluster. TargetDBInstanceClass *string `min:"5" type:"string"` // The DB parameter group associated with the DB instance in the green environment. @@ -21613,6 +22070,12 @@ type CreateDBClusterInput struct { // Valid for Cluster Type: Aurora DB clusters only EnableIAMDatabaseAuthentication *bool `type:"boolean"` + // Specifies whether to enable Aurora Limitless Database. You must enable Aurora + // Limitless Database to create a DB shard group. + // + // Valid for: Aurora DB clusters only + EnableLimitlessDatabase *bool `type:"boolean"` + // Specifies whether read replicas can forward write operations to the writer // DB instance in the DB cluster. By default, write operations aren't allowed // on reader DB instances. @@ -22253,6 +22716,12 @@ func (s *CreateDBClusterInput) SetEnableIAMDatabaseAuthentication(v bool) *Creat return s } +// SetEnableLimitlessDatabase sets the EnableLimitlessDatabase field's value. +func (s *CreateDBClusterInput) SetEnableLimitlessDatabase(v bool) *CreateDBClusterInput { + s.EnableLimitlessDatabase = &v + return s +} + // SetEnableLocalWriteForwarding sets the EnableLocalWriteForwarding field's value. func (s *CreateDBClusterInput) SetEnableLocalWriteForwarding(v bool) *CreateDBClusterInput { s.EnableLocalWriteForwarding = &v @@ -25829,6 +26298,258 @@ func (s *CreateDBSecurityGroupOutput) SetDBSecurityGroup(v *DBSecurityGroup) *Cr return s } +type CreateDBShardGroupInput struct { + _ struct{} `type:"structure"` + + // Specifies whether to create standby instances for the DB shard group. Valid + // values are the following: + // + // * 0 - Creates a single, primary DB instance for each physical shard. This + // is the default value, and the only one supported for the preview. + // + // * 1 - Creates a primary DB instance and a standby instance in a different + // Availability Zone (AZ) for each physical shard. + // + // * 2 - Creates a primary DB instance and two standby instances in different + // AZs for each physical shard. + ComputeRedundancy *int64 `type:"integer"` + + // The name of the primary DB cluster for the DB shard group. + // + // DBClusterIdentifier is a required field + DBClusterIdentifier *string `type:"string" required:"true"` + + // The name of the DB shard group. + // + // DBShardGroupIdentifier is a required field + DBShardGroupIdentifier *string `type:"string" required:"true"` + + // The maximum capacity of the DB shard group in Aurora capacity units (ACUs). + // + // MaxACU is a required field + MaxACU *float64 `type:"double" required:"true"` + + // Specifies whether the DB shard group is publicly accessible. + // + // When the DB shard group is publicly accessible, its Domain Name System (DNS) + // endpoint resolves to the private IP address from within the DB shard group's + // virtual private cloud (VPC). It resolves to the public IP address from outside + // of the DB shard group's VPC. Access to the DB shard group is ultimately controlled + // by the security group it uses. That public access is not permitted if the + // security group assigned to the DB shard group doesn't permit it. + // + // When the DB shard group isn't publicly accessible, it is an internal DB shard + // group with a DNS name that resolves to a private IP address. + // + // Default: The default behavior varies depending on whether DBSubnetGroupName + // is specified. + // + // If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, + // the following applies: + // + // * If the default VPC in the target Region doesn’t have an internet gateway + // attached to it, the DB shard group is private. + // + // * If the default VPC in the target Region has an internet gateway attached + // to it, the DB shard group is public. + // + // If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, + // the following applies: + // + // * If the subnets are part of a VPC that doesn’t have an internet gateway + // attached to it, the DB shard group is private. + // + // * If the subnets are part of a VPC that has an internet gateway attached + // to it, the DB shard group is public. + PubliclyAccessible *bool `type:"boolean"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateDBShardGroupInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateDBShardGroupInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateDBShardGroupInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateDBShardGroupInput"} + if s.DBClusterIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("DBClusterIdentifier")) + } + if s.DBShardGroupIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("DBShardGroupIdentifier")) + } + if s.MaxACU == nil { + invalidParams.Add(request.NewErrParamRequired("MaxACU")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetComputeRedundancy sets the ComputeRedundancy field's value. +func (s *CreateDBShardGroupInput) SetComputeRedundancy(v int64) *CreateDBShardGroupInput { + s.ComputeRedundancy = &v + return s +} + +// SetDBClusterIdentifier sets the DBClusterIdentifier field's value. +func (s *CreateDBShardGroupInput) SetDBClusterIdentifier(v string) *CreateDBShardGroupInput { + s.DBClusterIdentifier = &v + return s +} + +// SetDBShardGroupIdentifier sets the DBShardGroupIdentifier field's value. +func (s *CreateDBShardGroupInput) SetDBShardGroupIdentifier(v string) *CreateDBShardGroupInput { + s.DBShardGroupIdentifier = &v + return s +} + +// SetMaxACU sets the MaxACU field's value. +func (s *CreateDBShardGroupInput) SetMaxACU(v float64) *CreateDBShardGroupInput { + s.MaxACU = &v + return s +} + +// SetPubliclyAccessible sets the PubliclyAccessible field's value. +func (s *CreateDBShardGroupInput) SetPubliclyAccessible(v bool) *CreateDBShardGroupInput { + s.PubliclyAccessible = &v + return s +} + +type CreateDBShardGroupOutput struct { + _ struct{} `type:"structure"` + + // Specifies whether to create standby instances for the DB shard group. Valid + // values are the following: + // + // * 0 - Creates a single, primary DB instance for each physical shard. This + // is the default value, and the only one supported for the preview. + // + // * 1 - Creates a primary DB instance and a standby instance in a different + // Availability Zone (AZ) for each physical shard. + // + // * 2 - Creates a primary DB instance and two standby instances in different + // AZs for each physical shard. + ComputeRedundancy *int64 `type:"integer"` + + // The name of the primary DB cluster for the DB shard group. + DBClusterIdentifier *string `type:"string"` + + // The name of the DB shard group. + DBShardGroupIdentifier *string `type:"string"` + + // The Amazon Web Services Region-unique, immutable identifier for the DB shard + // group. + DBShardGroupResourceId *string `type:"string"` + + // The connection endpoint for the DB shard group. + Endpoint *string `type:"string"` + + // The maximum capacity of the DB shard group in Aurora capacity units (ACUs). + MaxACU *float64 `type:"double"` + + // Indicates whether the DB shard group is publicly accessible. + // + // When the DB shard group is publicly accessible, its Domain Name System (DNS) + // endpoint resolves to the private IP address from within the DB shard group's + // virtual private cloud (VPC). It resolves to the public IP address from outside + // of the DB shard group's VPC. Access to the DB shard group is ultimately controlled + // by the security group it uses. That public access isn't permitted if the + // security group assigned to the DB shard group doesn't permit it. + // + // When the DB shard group isn't publicly accessible, it is an internal DB shard + // group with a DNS name that resolves to a private IP address. + // + // For more information, see CreateDBShardGroup. + // + // This setting is only for Aurora Limitless Database. + PubliclyAccessible *bool `type:"boolean"` + + // The status of the DB shard group. + Status *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateDBShardGroupOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateDBShardGroupOutput) GoString() string { + return s.String() +} + +// SetComputeRedundancy sets the ComputeRedundancy field's value. +func (s *CreateDBShardGroupOutput) SetComputeRedundancy(v int64) *CreateDBShardGroupOutput { + s.ComputeRedundancy = &v + return s +} + +// SetDBClusterIdentifier sets the DBClusterIdentifier field's value. +func (s *CreateDBShardGroupOutput) SetDBClusterIdentifier(v string) *CreateDBShardGroupOutput { + s.DBClusterIdentifier = &v + return s +} + +// SetDBShardGroupIdentifier sets the DBShardGroupIdentifier field's value. +func (s *CreateDBShardGroupOutput) SetDBShardGroupIdentifier(v string) *CreateDBShardGroupOutput { + s.DBShardGroupIdentifier = &v + return s +} + +// SetDBShardGroupResourceId sets the DBShardGroupResourceId field's value. +func (s *CreateDBShardGroupOutput) SetDBShardGroupResourceId(v string) *CreateDBShardGroupOutput { + s.DBShardGroupResourceId = &v + return s +} + +// SetEndpoint sets the Endpoint field's value. +func (s *CreateDBShardGroupOutput) SetEndpoint(v string) *CreateDBShardGroupOutput { + s.Endpoint = &v + return s +} + +// SetMaxACU sets the MaxACU field's value. +func (s *CreateDBShardGroupOutput) SetMaxACU(v float64) *CreateDBShardGroupOutput { + s.MaxACU = &v + return s +} + +// SetPubliclyAccessible sets the PubliclyAccessible field's value. +func (s *CreateDBShardGroupOutput) SetPubliclyAccessible(v bool) *CreateDBShardGroupOutput { + s.PubliclyAccessible = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *CreateDBShardGroupOutput) SetStatus(v string) *CreateDBShardGroupOutput { + s.Status = &v + return s +} + type CreateDBSnapshotInput struct { _ struct{} `type:"structure"` @@ -26092,9 +26813,13 @@ type CreateEventSubscriptionInput struct { EventCategories []*string `locationNameList:"EventCategory" type:"list"` // The Amazon Resource Name (ARN) of the SNS topic created for event notification. - // The ARN is created by Amazon SNS when you create a topic and subscribe to + // SNS automatically creates the ARN when you create a topic and subscribe to // it. // + // RDS doesn't support FIFO (first in, first out) topics. For more information, + // see Message ordering and deduplication (FIFO topics) (https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html) + // in the Amazon Simple Notification Service Developer Guide. + // // SnsTopicArn is a required field SnsTopicArn *string `type:"string" required:"true"` @@ -27258,6 +27983,9 @@ type DBCluster struct { // The latest time to which a database can be restored with point-in-time restore. LatestRestorableTime *time.Time `type:"timestamp"` + // The details for Aurora Limitless Database. + LimitlessDatabase *LimitlessDatabase `type:"structure"` + // Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, // not enabled, requested, or is in the process of enabling it. LocalWriteForwardingStatus *string `type:"string" enum:"LocalWriteForwardingStatus"` @@ -27732,6 +28460,12 @@ func (s *DBCluster) SetLatestRestorableTime(v time.Time) *DBCluster { return s } +// SetLimitlessDatabase sets the LimitlessDatabase field's value. +func (s *DBCluster) SetLimitlessDatabase(v *LimitlessDatabase) *DBCluster { + s.LimitlessDatabase = v + return s +} + // SetLocalWriteForwardingStatus sets the LocalWriteForwardingStatus field's value. func (s *DBCluster) SetLocalWriteForwardingStatus(v string) *DBCluster { s.LocalWriteForwardingStatus = &v @@ -31897,6 +32631,125 @@ func (s *DBSecurityGroupMembership) SetStatus(v string) *DBSecurityGroupMembersh return s } +type DBShardGroup struct { + _ struct{} `type:"structure"` + + // Specifies whether to create standby instances for the DB shard group. Valid + // values are the following: + // + // * 0 - Creates a single, primary DB instance for each physical shard. This + // is the default value, and the only one supported for the preview. + // + // * 1 - Creates a primary DB instance and a standby instance in a different + // Availability Zone (AZ) for each physical shard. + // + // * 2 - Creates a primary DB instance and two standby instances in different + // AZs for each physical shard. + ComputeRedundancy *int64 `type:"integer"` + + // The name of the primary DB cluster for the DB shard group. + DBClusterIdentifier *string `type:"string"` + + // The name of the DB shard group. + DBShardGroupIdentifier *string `type:"string"` + + // The Amazon Web Services Region-unique, immutable identifier for the DB shard + // group. + DBShardGroupResourceId *string `type:"string"` + + // The connection endpoint for the DB shard group. + Endpoint *string `type:"string"` + + // The maximum capacity of the DB shard group in Aurora capacity units (ACUs). + MaxACU *float64 `type:"double"` + + // Indicates whether the DB shard group is publicly accessible. + // + // When the DB shard group is publicly accessible, its Domain Name System (DNS) + // endpoint resolves to the private IP address from within the DB shard group's + // virtual private cloud (VPC). It resolves to the public IP address from outside + // of the DB shard group's VPC. Access to the DB shard group is ultimately controlled + // by the security group it uses. That public access isn't permitted if the + // security group assigned to the DB shard group doesn't permit it. + // + // When the DB shard group isn't publicly accessible, it is an internal DB shard + // group with a DNS name that resolves to a private IP address. + // + // For more information, see CreateDBShardGroup. + // + // This setting is only for Aurora Limitless Database. + PubliclyAccessible *bool `type:"boolean"` + + // The status of the DB shard group. + Status *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DBShardGroup) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DBShardGroup) GoString() string { + return s.String() +} + +// SetComputeRedundancy sets the ComputeRedundancy field's value. +func (s *DBShardGroup) SetComputeRedundancy(v int64) *DBShardGroup { + s.ComputeRedundancy = &v + return s +} + +// SetDBClusterIdentifier sets the DBClusterIdentifier field's value. +func (s *DBShardGroup) SetDBClusterIdentifier(v string) *DBShardGroup { + s.DBClusterIdentifier = &v + return s +} + +// SetDBShardGroupIdentifier sets the DBShardGroupIdentifier field's value. +func (s *DBShardGroup) SetDBShardGroupIdentifier(v string) *DBShardGroup { + s.DBShardGroupIdentifier = &v + return s +} + +// SetDBShardGroupResourceId sets the DBShardGroupResourceId field's value. +func (s *DBShardGroup) SetDBShardGroupResourceId(v string) *DBShardGroup { + s.DBShardGroupResourceId = &v + return s +} + +// SetEndpoint sets the Endpoint field's value. +func (s *DBShardGroup) SetEndpoint(v string) *DBShardGroup { + s.Endpoint = &v + return s +} + +// SetMaxACU sets the MaxACU field's value. +func (s *DBShardGroup) SetMaxACU(v float64) *DBShardGroup { + s.MaxACU = &v + return s +} + +// SetPubliclyAccessible sets the PubliclyAccessible field's value. +func (s *DBShardGroup) SetPubliclyAccessible(v bool) *DBShardGroup { + s.PubliclyAccessible = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *DBShardGroup) SetStatus(v string) *DBShardGroup { + s.Status = &v + return s +} + // Contains the details of an Amazon RDS DB snapshot. // // This data type is used as a response element in the DescribeDBSnapshots action. @@ -34267,6 +35120,171 @@ func (s DeleteDBSecurityGroupOutput) GoString() string { return s.String() } +type DeleteDBShardGroupInput struct { + _ struct{} `type:"structure"` + + // Teh name of the DB shard group to delete. + // + // DBShardGroupIdentifier is a required field + DBShardGroupIdentifier *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteDBShardGroupInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteDBShardGroupInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteDBShardGroupInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteDBShardGroupInput"} + if s.DBShardGroupIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("DBShardGroupIdentifier")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDBShardGroupIdentifier sets the DBShardGroupIdentifier field's value. +func (s *DeleteDBShardGroupInput) SetDBShardGroupIdentifier(v string) *DeleteDBShardGroupInput { + s.DBShardGroupIdentifier = &v + return s +} + +type DeleteDBShardGroupOutput struct { + _ struct{} `type:"structure"` + + // Specifies whether to create standby instances for the DB shard group. Valid + // values are the following: + // + // * 0 - Creates a single, primary DB instance for each physical shard. This + // is the default value, and the only one supported for the preview. + // + // * 1 - Creates a primary DB instance and a standby instance in a different + // Availability Zone (AZ) for each physical shard. + // + // * 2 - Creates a primary DB instance and two standby instances in different + // AZs for each physical shard. + ComputeRedundancy *int64 `type:"integer"` + + // The name of the primary DB cluster for the DB shard group. + DBClusterIdentifier *string `type:"string"` + + // The name of the DB shard group. + DBShardGroupIdentifier *string `type:"string"` + + // The Amazon Web Services Region-unique, immutable identifier for the DB shard + // group. + DBShardGroupResourceId *string `type:"string"` + + // The connection endpoint for the DB shard group. + Endpoint *string `type:"string"` + + // The maximum capacity of the DB shard group in Aurora capacity units (ACUs). + MaxACU *float64 `type:"double"` + + // Indicates whether the DB shard group is publicly accessible. + // + // When the DB shard group is publicly accessible, its Domain Name System (DNS) + // endpoint resolves to the private IP address from within the DB shard group's + // virtual private cloud (VPC). It resolves to the public IP address from outside + // of the DB shard group's VPC. Access to the DB shard group is ultimately controlled + // by the security group it uses. That public access isn't permitted if the + // security group assigned to the DB shard group doesn't permit it. + // + // When the DB shard group isn't publicly accessible, it is an internal DB shard + // group with a DNS name that resolves to a private IP address. + // + // For more information, see CreateDBShardGroup. + // + // This setting is only for Aurora Limitless Database. + PubliclyAccessible *bool `type:"boolean"` + + // The status of the DB shard group. + Status *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteDBShardGroupOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteDBShardGroupOutput) GoString() string { + return s.String() +} + +// SetComputeRedundancy sets the ComputeRedundancy field's value. +func (s *DeleteDBShardGroupOutput) SetComputeRedundancy(v int64) *DeleteDBShardGroupOutput { + s.ComputeRedundancy = &v + return s +} + +// SetDBClusterIdentifier sets the DBClusterIdentifier field's value. +func (s *DeleteDBShardGroupOutput) SetDBClusterIdentifier(v string) *DeleteDBShardGroupOutput { + s.DBClusterIdentifier = &v + return s +} + +// SetDBShardGroupIdentifier sets the DBShardGroupIdentifier field's value. +func (s *DeleteDBShardGroupOutput) SetDBShardGroupIdentifier(v string) *DeleteDBShardGroupOutput { + s.DBShardGroupIdentifier = &v + return s +} + +// SetDBShardGroupResourceId sets the DBShardGroupResourceId field's value. +func (s *DeleteDBShardGroupOutput) SetDBShardGroupResourceId(v string) *DeleteDBShardGroupOutput { + s.DBShardGroupResourceId = &v + return s +} + +// SetEndpoint sets the Endpoint field's value. +func (s *DeleteDBShardGroupOutput) SetEndpoint(v string) *DeleteDBShardGroupOutput { + s.Endpoint = &v + return s +} + +// SetMaxACU sets the MaxACU field's value. +func (s *DeleteDBShardGroupOutput) SetMaxACU(v float64) *DeleteDBShardGroupOutput { + s.MaxACU = &v + return s +} + +// SetPubliclyAccessible sets the PubliclyAccessible field's value. +func (s *DeleteDBShardGroupOutput) SetPubliclyAccessible(v bool) *DeleteDBShardGroupOutput { + s.PubliclyAccessible = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *DeleteDBShardGroupOutput) SetStatus(v string) *DeleteDBShardGroupOutput { + s.Status = &v + return s +} + type DeleteDBSnapshotInput struct { _ struct{} `type:"structure"` @@ -36524,7 +37542,7 @@ type DescribeDBClustersInput struct { // // Default: 100 // - // Constraints: Minimum 20, maximum 100. + // Constraints: Minimum 20, maximum 100 MaxRecords *int64 `type:"integer"` } @@ -38635,6 +39653,141 @@ func (s *DescribeDBSecurityGroupsOutput) SetMarker(v string) *DescribeDBSecurity return s } +type DescribeDBShardGroupsInput struct { + _ struct{} `type:"structure"` + + // The user-supplied DB shard group identifier or the Amazon Resource Name (ARN) + // of the DB shard group. If this parameter is specified, information for only + // the specific DB shard group is returned. This parameter isn't case-sensitive. + // + // Constraints: + // + // * If supplied, must match an existing DB shard group identifier. + DBShardGroupIdentifier *string `type:"string"` + + // A filter that specifies one or more DB shard groups to describe. + Filters []*Filter `locationNameList:"Filter" type:"list"` + + // An optional pagination token provided by a previous DescribeDBShardGroups + // request. If this parameter is specified, the response includes only records + // beyond the marker, up to the value specified by MaxRecords. + Marker *string `type:"string"` + + // The maximum number of records to include in the response. If more records + // exist than the specified MaxRecords value, a pagination token called a marker + // is included in the response so you can retrieve the remaining results. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100 + MaxRecords *int64 `min:"20" type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeDBShardGroupsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeDBShardGroupsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeDBShardGroupsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeDBShardGroupsInput"} + if s.MaxRecords != nil && *s.MaxRecords < 20 { + invalidParams.Add(request.NewErrParamMinValue("MaxRecords", 20)) + } + if s.Filters != nil { + for i, v := range s.Filters { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDBShardGroupIdentifier sets the DBShardGroupIdentifier field's value. +func (s *DescribeDBShardGroupsInput) SetDBShardGroupIdentifier(v string) *DescribeDBShardGroupsInput { + s.DBShardGroupIdentifier = &v + return s +} + +// SetFilters sets the Filters field's value. +func (s *DescribeDBShardGroupsInput) SetFilters(v []*Filter) *DescribeDBShardGroupsInput { + s.Filters = v + return s +} + +// SetMarker sets the Marker field's value. +func (s *DescribeDBShardGroupsInput) SetMarker(v string) *DescribeDBShardGroupsInput { + s.Marker = &v + return s +} + +// SetMaxRecords sets the MaxRecords field's value. +func (s *DescribeDBShardGroupsInput) SetMaxRecords(v int64) *DescribeDBShardGroupsInput { + s.MaxRecords = &v + return s +} + +type DescribeDBShardGroupsOutput struct { + _ struct{} `type:"structure"` + + // Contains a list of DB shard groups for the user. + DBShardGroups []*DBShardGroup `locationNameList:"DBShardGroup" type:"list"` + + // A pagination token that can be used in a later DescribeDBClusters request. + Marker *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeDBShardGroupsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeDBShardGroupsOutput) GoString() string { + return s.String() +} + +// SetDBShardGroups sets the DBShardGroups field's value. +func (s *DescribeDBShardGroupsOutput) SetDBShardGroups(v []*DBShardGroup) *DescribeDBShardGroupsOutput { + s.DBShardGroups = v + return s +} + +// SetMarker sets the Marker field's value. +func (s *DescribeDBShardGroupsOutput) SetMarker(v string) *DescribeDBShardGroupsOutput { + s.Marker = &v + return s +} + type DescribeDBSnapshotAttributesInput struct { _ struct{} `type:"structure"` @@ -43962,6 +45115,48 @@ func (s *IssueDetails) SetPerformanceIssueDetails(v *PerformanceIssueDetails) *I return s } +// Contains details for Aurora Limitless Database. +type LimitlessDatabase struct { + _ struct{} `type:"structure"` + + // The minimum required capacity for Aurora Limitless Database in Aurora capacity + // units (ACUs). + MinRequiredACU *float64 `type:"double"` + + // The status of Aurora Limitless Database. + Status *string `type:"string" enum:"LimitlessDatabaseStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LimitlessDatabase) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LimitlessDatabase) GoString() string { + return s.String() +} + +// SetMinRequiredACU sets the MinRequiredACU field's value. +func (s *LimitlessDatabase) SetMinRequiredACU(v float64) *LimitlessDatabase { + s.MinRequiredACU = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *LimitlessDatabase) SetStatus(v string) *LimitlessDatabase { + s.Status = &v + return s +} + type ListTagsForResourceInput struct { _ struct{} `type:"structure"` @@ -45590,6 +46785,12 @@ type ModifyDBClusterInput struct { // Valid for Cluster Type: Aurora DB clusters only EnableIAMDatabaseAuthentication *bool `type:"boolean"` + // Specifies whether to enable Aurora Limitless Database. You must enable Aurora + // Limitless Database to create a DB shard group. + // + // Valid for: Aurora DB clusters only + EnableLimitlessDatabase *bool `type:"boolean"` + // Specifies whether read replicas can forward write operations to the writer // DB instance in the DB cluster. By default, write operations aren't allowed // on reader DB instances. @@ -46088,6 +47289,12 @@ func (s *ModifyDBClusterInput) SetEnableIAMDatabaseAuthentication(v bool) *Modif return s } +// SetEnableLimitlessDatabase sets the EnableLimitlessDatabase field's value. +func (s *ModifyDBClusterInput) SetEnableLimitlessDatabase(v bool) *ModifyDBClusterInput { + s.EnableLimitlessDatabase = &v + return s +} + // SetEnableLocalWriteForwarding sets the EnableLocalWriteForwarding field's value. func (s *ModifyDBClusterInput) SetEnableLocalWriteForwarding(v bool) *ModifyDBClusterInput { s.EnableLocalWriteForwarding = &v @@ -48394,6 +49601,180 @@ func (s *ModifyDBRecommendationOutput) SetDBRecommendation(v *DBRecommendation) return s } +type ModifyDBShardGroupInput struct { + _ struct{} `type:"structure"` + + // The name of the DB shard group to modify. + // + // DBShardGroupIdentifier is a required field + DBShardGroupIdentifier *string `type:"string" required:"true"` + + // The maximum capacity of the DB shard group in Aurora capacity units (ACUs). + MaxACU *float64 `type:"double"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ModifyDBShardGroupInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ModifyDBShardGroupInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ModifyDBShardGroupInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ModifyDBShardGroupInput"} + if s.DBShardGroupIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("DBShardGroupIdentifier")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDBShardGroupIdentifier sets the DBShardGroupIdentifier field's value. +func (s *ModifyDBShardGroupInput) SetDBShardGroupIdentifier(v string) *ModifyDBShardGroupInput { + s.DBShardGroupIdentifier = &v + return s +} + +// SetMaxACU sets the MaxACU field's value. +func (s *ModifyDBShardGroupInput) SetMaxACU(v float64) *ModifyDBShardGroupInput { + s.MaxACU = &v + return s +} + +type ModifyDBShardGroupOutput struct { + _ struct{} `type:"structure"` + + // Specifies whether to create standby instances for the DB shard group. Valid + // values are the following: + // + // * 0 - Creates a single, primary DB instance for each physical shard. This + // is the default value, and the only one supported for the preview. + // + // * 1 - Creates a primary DB instance and a standby instance in a different + // Availability Zone (AZ) for each physical shard. + // + // * 2 - Creates a primary DB instance and two standby instances in different + // AZs for each physical shard. + ComputeRedundancy *int64 `type:"integer"` + + // The name of the primary DB cluster for the DB shard group. + DBClusterIdentifier *string `type:"string"` + + // The name of the DB shard group. + DBShardGroupIdentifier *string `type:"string"` + + // The Amazon Web Services Region-unique, immutable identifier for the DB shard + // group. + DBShardGroupResourceId *string `type:"string"` + + // The connection endpoint for the DB shard group. + Endpoint *string `type:"string"` + + // The maximum capacity of the DB shard group in Aurora capacity units (ACUs). + MaxACU *float64 `type:"double"` + + // Indicates whether the DB shard group is publicly accessible. + // + // When the DB shard group is publicly accessible, its Domain Name System (DNS) + // endpoint resolves to the private IP address from within the DB shard group's + // virtual private cloud (VPC). It resolves to the public IP address from outside + // of the DB shard group's VPC. Access to the DB shard group is ultimately controlled + // by the security group it uses. That public access isn't permitted if the + // security group assigned to the DB shard group doesn't permit it. + // + // When the DB shard group isn't publicly accessible, it is an internal DB shard + // group with a DNS name that resolves to a private IP address. + // + // For more information, see CreateDBShardGroup. + // + // This setting is only for Aurora Limitless Database. + PubliclyAccessible *bool `type:"boolean"` + + // The status of the DB shard group. + Status *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ModifyDBShardGroupOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ModifyDBShardGroupOutput) GoString() string { + return s.String() +} + +// SetComputeRedundancy sets the ComputeRedundancy field's value. +func (s *ModifyDBShardGroupOutput) SetComputeRedundancy(v int64) *ModifyDBShardGroupOutput { + s.ComputeRedundancy = &v + return s +} + +// SetDBClusterIdentifier sets the DBClusterIdentifier field's value. +func (s *ModifyDBShardGroupOutput) SetDBClusterIdentifier(v string) *ModifyDBShardGroupOutput { + s.DBClusterIdentifier = &v + return s +} + +// SetDBShardGroupIdentifier sets the DBShardGroupIdentifier field's value. +func (s *ModifyDBShardGroupOutput) SetDBShardGroupIdentifier(v string) *ModifyDBShardGroupOutput { + s.DBShardGroupIdentifier = &v + return s +} + +// SetDBShardGroupResourceId sets the DBShardGroupResourceId field's value. +func (s *ModifyDBShardGroupOutput) SetDBShardGroupResourceId(v string) *ModifyDBShardGroupOutput { + s.DBShardGroupResourceId = &v + return s +} + +// SetEndpoint sets the Endpoint field's value. +func (s *ModifyDBShardGroupOutput) SetEndpoint(v string) *ModifyDBShardGroupOutput { + s.Endpoint = &v + return s +} + +// SetMaxACU sets the MaxACU field's value. +func (s *ModifyDBShardGroupOutput) SetMaxACU(v float64) *ModifyDBShardGroupOutput { + s.MaxACU = &v + return s +} + +// SetPubliclyAccessible sets the PubliclyAccessible field's value. +func (s *ModifyDBShardGroupOutput) SetPubliclyAccessible(v bool) *ModifyDBShardGroupOutput { + s.PubliclyAccessible = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *ModifyDBShardGroupOutput) SetStatus(v string) *ModifyDBShardGroupOutput { + s.Status = &v + return s +} + type ModifyDBSnapshotAttributeInput struct { _ struct{} `type:"structure"` @@ -51930,6 +53311,171 @@ func (s *RebootDBInstanceOutput) SetDBInstance(v *DBInstance) *RebootDBInstanceO return s } +type RebootDBShardGroupInput struct { + _ struct{} `type:"structure"` + + // The name of the DB shard group to reboot. + // + // DBShardGroupIdentifier is a required field + DBShardGroupIdentifier *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RebootDBShardGroupInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RebootDBShardGroupInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *RebootDBShardGroupInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "RebootDBShardGroupInput"} + if s.DBShardGroupIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("DBShardGroupIdentifier")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDBShardGroupIdentifier sets the DBShardGroupIdentifier field's value. +func (s *RebootDBShardGroupInput) SetDBShardGroupIdentifier(v string) *RebootDBShardGroupInput { + s.DBShardGroupIdentifier = &v + return s +} + +type RebootDBShardGroupOutput struct { + _ struct{} `type:"structure"` + + // Specifies whether to create standby instances for the DB shard group. Valid + // values are the following: + // + // * 0 - Creates a single, primary DB instance for each physical shard. This + // is the default value, and the only one supported for the preview. + // + // * 1 - Creates a primary DB instance and a standby instance in a different + // Availability Zone (AZ) for each physical shard. + // + // * 2 - Creates a primary DB instance and two standby instances in different + // AZs for each physical shard. + ComputeRedundancy *int64 `type:"integer"` + + // The name of the primary DB cluster for the DB shard group. + DBClusterIdentifier *string `type:"string"` + + // The name of the DB shard group. + DBShardGroupIdentifier *string `type:"string"` + + // The Amazon Web Services Region-unique, immutable identifier for the DB shard + // group. + DBShardGroupResourceId *string `type:"string"` + + // The connection endpoint for the DB shard group. + Endpoint *string `type:"string"` + + // The maximum capacity of the DB shard group in Aurora capacity units (ACUs). + MaxACU *float64 `type:"double"` + + // Indicates whether the DB shard group is publicly accessible. + // + // When the DB shard group is publicly accessible, its Domain Name System (DNS) + // endpoint resolves to the private IP address from within the DB shard group's + // virtual private cloud (VPC). It resolves to the public IP address from outside + // of the DB shard group's VPC. Access to the DB shard group is ultimately controlled + // by the security group it uses. That public access isn't permitted if the + // security group assigned to the DB shard group doesn't permit it. + // + // When the DB shard group isn't publicly accessible, it is an internal DB shard + // group with a DNS name that resolves to a private IP address. + // + // For more information, see CreateDBShardGroup. + // + // This setting is only for Aurora Limitless Database. + PubliclyAccessible *bool `type:"boolean"` + + // The status of the DB shard group. + Status *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RebootDBShardGroupOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RebootDBShardGroupOutput) GoString() string { + return s.String() +} + +// SetComputeRedundancy sets the ComputeRedundancy field's value. +func (s *RebootDBShardGroupOutput) SetComputeRedundancy(v int64) *RebootDBShardGroupOutput { + s.ComputeRedundancy = &v + return s +} + +// SetDBClusterIdentifier sets the DBClusterIdentifier field's value. +func (s *RebootDBShardGroupOutput) SetDBClusterIdentifier(v string) *RebootDBShardGroupOutput { + s.DBClusterIdentifier = &v + return s +} + +// SetDBShardGroupIdentifier sets the DBShardGroupIdentifier field's value. +func (s *RebootDBShardGroupOutput) SetDBShardGroupIdentifier(v string) *RebootDBShardGroupOutput { + s.DBShardGroupIdentifier = &v + return s +} + +// SetDBShardGroupResourceId sets the DBShardGroupResourceId field's value. +func (s *RebootDBShardGroupOutput) SetDBShardGroupResourceId(v string) *RebootDBShardGroupOutput { + s.DBShardGroupResourceId = &v + return s +} + +// SetEndpoint sets the Endpoint field's value. +func (s *RebootDBShardGroupOutput) SetEndpoint(v string) *RebootDBShardGroupOutput { + s.Endpoint = &v + return s +} + +// SetMaxACU sets the MaxACU field's value. +func (s *RebootDBShardGroupOutput) SetMaxACU(v float64) *RebootDBShardGroupOutput { + s.MaxACU = &v + return s +} + +// SetPubliclyAccessible sets the PubliclyAccessible field's value. +func (s *RebootDBShardGroupOutput) SetPubliclyAccessible(v bool) *RebootDBShardGroupOutput { + s.PubliclyAccessible = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *RebootDBShardGroupOutput) SetStatus(v string) *RebootDBShardGroupOutput { + s.Status = &v + return s +} + // The recommended actions to apply to resolve the issues associated with your // DB instances, DB clusters, and DB parameter groups. type RecommendedAction struct { @@ -60966,6 +62512,46 @@ func IntegrationStatus_Values() []string { } } +const ( + // LimitlessDatabaseStatusActive is a LimitlessDatabaseStatus enum value + LimitlessDatabaseStatusActive = "active" + + // LimitlessDatabaseStatusNotInUse is a LimitlessDatabaseStatus enum value + LimitlessDatabaseStatusNotInUse = "not-in-use" + + // LimitlessDatabaseStatusEnabled is a LimitlessDatabaseStatus enum value + LimitlessDatabaseStatusEnabled = "enabled" + + // LimitlessDatabaseStatusDisabled is a LimitlessDatabaseStatus enum value + LimitlessDatabaseStatusDisabled = "disabled" + + // LimitlessDatabaseStatusEnabling is a LimitlessDatabaseStatus enum value + LimitlessDatabaseStatusEnabling = "enabling" + + // LimitlessDatabaseStatusDisabling is a LimitlessDatabaseStatus enum value + LimitlessDatabaseStatusDisabling = "disabling" + + // LimitlessDatabaseStatusModifyingMaxCapacity is a LimitlessDatabaseStatus enum value + LimitlessDatabaseStatusModifyingMaxCapacity = "modifying-max-capacity" + + // LimitlessDatabaseStatusError is a LimitlessDatabaseStatus enum value + LimitlessDatabaseStatusError = "error" +) + +// LimitlessDatabaseStatus_Values returns all elements of the LimitlessDatabaseStatus enum +func LimitlessDatabaseStatus_Values() []string { + return []string{ + LimitlessDatabaseStatusActive, + LimitlessDatabaseStatusNotInUse, + LimitlessDatabaseStatusEnabled, + LimitlessDatabaseStatusDisabled, + LimitlessDatabaseStatusEnabling, + LimitlessDatabaseStatusDisabling, + LimitlessDatabaseStatusModifyingMaxCapacity, + LimitlessDatabaseStatusError, + } +} + const ( // LocalWriteForwardingStatusEnabled is a LocalWriteForwardingStatus enum value LocalWriteForwardingStatusEnabled = "enabled" diff --git a/service/rds/errors.go b/service/rds/errors.go index e9713c8edca..a349b65f4fa 100644 --- a/service/rds/errors.go +++ b/service/rds/errors.go @@ -338,6 +338,19 @@ const ( // groups. ErrCodeDBSecurityGroupQuotaExceededFault = "QuotaExceeded.DBSecurityGroup" + // ErrCodeDBShardGroupAlreadyExistsFault for service response error code + // "DBShardGroupAlreadyExists". + // + // The specified DB shard group name must be unique in your Amazon Web Services + // account in the specified Amazon Web Services Region. + ErrCodeDBShardGroupAlreadyExistsFault = "DBShardGroupAlreadyExists" + + // ErrCodeDBShardGroupNotFoundFault for service response error code + // "DBShardGroupNotFound". + // + // The specified DB shard group name wasn't found. + ErrCodeDBShardGroupNotFoundFault = "DBShardGroupNotFound" + // ErrCodeDBSnapshotAlreadyExistsFault for service response error code // "DBSnapshotAlreadyExists". // @@ -614,6 +627,12 @@ const ( // The state of the DB security group doesn't allow deletion. ErrCodeInvalidDBSecurityGroupStateFault = "InvalidDBSecurityGroupState" + // ErrCodeInvalidDBShardGroupStateFault for service response error code + // "InvalidDBShardGroupState". + // + // The DB shard group must be in the available state. + ErrCodeInvalidDBShardGroupStateFault = "InvalidDBShardGroupState" + // ErrCodeInvalidDBSnapshotStateFault for service response error code // "InvalidDBSnapshotState". // @@ -678,6 +697,13 @@ const ( // The integration is in an invalid state and can't perform the requested operation. ErrCodeInvalidIntegrationStateFault = "InvalidIntegrationStateFault" + // ErrCodeInvalidMaxAcuFault for service response error code + // "InvalidMaxAcu". + // + // The maximum capacity of the DB shard group must be 48-7168 Aurora capacity + // units (ACUs). + ErrCodeInvalidMaxAcuFault = "InvalidMaxAcu" + // ErrCodeInvalidOptionGroupStateFault for service response error code // "InvalidOptionGroupStateFault". // @@ -724,6 +750,13 @@ const ( // An error occurred accessing an Amazon Web Services KMS key. ErrCodeKMSKeyNotAccessibleFault = "KMSKeyNotAccessibleFault" + // ErrCodeMaxDBShardGroupLimitReached for service response error code + // "MaxDBShardGroupLimitReached". + // + // The maximum number of DB shard groups for your Amazon Web Services account + // in the specified Amazon Web Services Region has been reached. + ErrCodeMaxDBShardGroupLimitReached = "MaxDBShardGroupLimitReached" + // ErrCodeNetworkTypeNotSupported for service response error code // "NetworkTypeNotSupported". // @@ -904,4 +937,10 @@ const ( // You attempted to create more tenant databases than are permitted in your // Amazon Web Services account. ErrCodeTenantDatabaseQuotaExceededFault = "TenantDatabaseQuotaExceeded" + + // ErrCodeUnsupportedDBEngineVersionFault for service response error code + // "UnsupportedDBEngineVersion". + // + // The specified DB engine version isn't supported for Aurora Limitless Database. + ErrCodeUnsupportedDBEngineVersionFault = "UnsupportedDBEngineVersion" ) diff --git a/service/rds/examples_test.go b/service/rds/examples_test.go index 81e39393c46..9747cbb4843 100644 --- a/service/rds/examples_test.go +++ b/service/rds/examples_test.go @@ -1202,6 +1202,46 @@ func ExampleRDS_CreateGlobalCluster_shared00() { fmt.Println(result) } +// To create a zero-ETL integration +// The following example creates a zero-ETL integration with Amazon Redshift. +func ExampleRDS_CreateIntegration_shared00() { + svc := rds.New(session.New()) + input := &rds.CreateIntegrationInput{ + IntegrationName: aws.String("my-integration"), + SourceArn: aws.String("arn:aws:rds:us-east-1:123456789012:cluster:my-cluster"), + TargetArn: aws.String("arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8"), + } + + result, err := svc.CreateIntegration(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case rds.ErrCodeDBClusterNotFoundFault: + fmt.Println(rds.ErrCodeDBClusterNotFoundFault, aerr.Error()) + case rds.ErrCodeDBInstanceNotFoundFault: + fmt.Println(rds.ErrCodeDBInstanceNotFoundFault, aerr.Error()) + case rds.ErrCodeIntegrationAlreadyExistsFault: + fmt.Println(rds.ErrCodeIntegrationAlreadyExistsFault, aerr.Error()) + case rds.ErrCodeIntegrationQuotaExceededFault: + fmt.Println(rds.ErrCodeIntegrationQuotaExceededFault, aerr.Error()) + case rds.ErrCodeKMSKeyNotAccessibleFault: + fmt.Println(rds.ErrCodeKMSKeyNotAccessibleFault, aerr.Error()) + case rds.ErrCodeIntegrationConflictOperationFault: + fmt.Println(rds.ErrCodeIntegrationConflictOperationFault, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + // To Create an Amazon RDS option group // The following example creates a new Amazon RDS option group for Oracle MySQL version // 8,0 named MyOptionGroup. @@ -1689,6 +1729,38 @@ func ExampleRDS_DeleteGlobalCluster_shared00() { fmt.Println(result) } +// To delete a zero-ETL integration +// The following example deletes a zero-ETL integration with Amazon Redshift. +func ExampleRDS_DeleteIntegration_shared00() { + svc := rds.New(session.New()) + input := &rds.DeleteIntegrationInput{ + IntegrationIdentifier: aws.String("5b9f3d79-7392-4a3e-896c-58eaa1b53231"), + } + + result, err := svc.DeleteIntegration(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case rds.ErrCodeIntegrationNotFoundFault: + fmt.Println(rds.ErrCodeIntegrationNotFoundFault, aerr.Error()) + case rds.ErrCodeIntegrationConflictOperationFault: + fmt.Println(rds.ErrCodeIntegrationConflictOperationFault, aerr.Error()) + case rds.ErrCodeInvalidIntegrationStateFault: + fmt.Println(rds.ErrCodeInvalidIntegrationStateFault, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + // To delete an option group // The following example deletes the specified option group. func ExampleRDS_DeleteOptionGroup_shared00() { @@ -2555,6 +2627,35 @@ func ExampleRDS_DescribeGlobalClusters_shared00() { fmt.Println(result) } +// To describe a zero-ETL integration +// The following example retrieves information about a zero-ETL integration with Amazon +// Redshift. +func ExampleRDS_DescribeIntegrations_shared00() { + svc := rds.New(session.New()) + input := &rds.DescribeIntegrationsInput{ + IntegrationIdentifier: aws.String("5b9f3d79-7392-4a3e-896c-58eaa1b53231"), + } + + result, err := svc.DescribeIntegrations(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case rds.ErrCodeIntegrationNotFoundFault: + fmt.Println(rds.ErrCodeIntegrationNotFoundFault, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + // To describe all available options // The following example lists the options for an RDS for MySQL version 8.0 DB instance. func ExampleRDS_DescribeOptionGroupOptions_shared00() { diff --git a/service/rds/rdsiface/interface.go b/service/rds/rdsiface/interface.go index ce4645f8712..61bd17ad01c 100644 --- a/service/rds/rdsiface/interface.go +++ b/service/rds/rdsiface/interface.go @@ -160,6 +160,10 @@ type RDSAPI interface { CreateDBSecurityGroupWithContext(aws.Context, *rds.CreateDBSecurityGroupInput, ...request.Option) (*rds.CreateDBSecurityGroupOutput, error) CreateDBSecurityGroupRequest(*rds.CreateDBSecurityGroupInput) (*request.Request, *rds.CreateDBSecurityGroupOutput) + CreateDBShardGroup(*rds.CreateDBShardGroupInput) (*rds.CreateDBShardGroupOutput, error) + CreateDBShardGroupWithContext(aws.Context, *rds.CreateDBShardGroupInput, ...request.Option) (*rds.CreateDBShardGroupOutput, error) + CreateDBShardGroupRequest(*rds.CreateDBShardGroupInput) (*request.Request, *rds.CreateDBShardGroupOutput) + CreateDBSnapshot(*rds.CreateDBSnapshotInput) (*rds.CreateDBSnapshotOutput, error) CreateDBSnapshotWithContext(aws.Context, *rds.CreateDBSnapshotInput, ...request.Option) (*rds.CreateDBSnapshotOutput, error) CreateDBSnapshotRequest(*rds.CreateDBSnapshotInput) (*request.Request, *rds.CreateDBSnapshotOutput) @@ -240,6 +244,10 @@ type RDSAPI interface { DeleteDBSecurityGroupWithContext(aws.Context, *rds.DeleteDBSecurityGroupInput, ...request.Option) (*rds.DeleteDBSecurityGroupOutput, error) DeleteDBSecurityGroupRequest(*rds.DeleteDBSecurityGroupInput) (*request.Request, *rds.DeleteDBSecurityGroupOutput) + DeleteDBShardGroup(*rds.DeleteDBShardGroupInput) (*rds.DeleteDBShardGroupOutput, error) + DeleteDBShardGroupWithContext(aws.Context, *rds.DeleteDBShardGroupInput, ...request.Option) (*rds.DeleteDBShardGroupOutput, error) + DeleteDBShardGroupRequest(*rds.DeleteDBShardGroupInput) (*request.Request, *rds.DeleteDBShardGroupOutput) + DeleteDBSnapshot(*rds.DeleteDBSnapshotInput) (*rds.DeleteDBSnapshotOutput, error) DeleteDBSnapshotWithContext(aws.Context, *rds.DeleteDBSnapshotInput, ...request.Option) (*rds.DeleteDBSnapshotOutput, error) DeleteDBSnapshotRequest(*rds.DeleteDBSnapshotInput) (*request.Request, *rds.DeleteDBSnapshotOutput) @@ -427,6 +435,10 @@ type RDSAPI interface { DescribeDBSecurityGroupsPages(*rds.DescribeDBSecurityGroupsInput, func(*rds.DescribeDBSecurityGroupsOutput, bool) bool) error DescribeDBSecurityGroupsPagesWithContext(aws.Context, *rds.DescribeDBSecurityGroupsInput, func(*rds.DescribeDBSecurityGroupsOutput, bool) bool, ...request.Option) error + DescribeDBShardGroups(*rds.DescribeDBShardGroupsInput) (*rds.DescribeDBShardGroupsOutput, error) + DescribeDBShardGroupsWithContext(aws.Context, *rds.DescribeDBShardGroupsInput, ...request.Option) (*rds.DescribeDBShardGroupsOutput, error) + DescribeDBShardGroupsRequest(*rds.DescribeDBShardGroupsInput) (*request.Request, *rds.DescribeDBShardGroupsOutput) + DescribeDBSnapshotAttributes(*rds.DescribeDBSnapshotAttributesInput) (*rds.DescribeDBSnapshotAttributesOutput, error) DescribeDBSnapshotAttributesWithContext(aws.Context, *rds.DescribeDBSnapshotAttributesInput, ...request.Option) (*rds.DescribeDBSnapshotAttributesOutput, error) DescribeDBSnapshotAttributesRequest(*rds.DescribeDBSnapshotAttributesInput) (*request.Request, *rds.DescribeDBSnapshotAttributesOutput) @@ -645,6 +657,10 @@ type RDSAPI interface { ModifyDBRecommendationWithContext(aws.Context, *rds.ModifyDBRecommendationInput, ...request.Option) (*rds.ModifyDBRecommendationOutput, error) ModifyDBRecommendationRequest(*rds.ModifyDBRecommendationInput) (*request.Request, *rds.ModifyDBRecommendationOutput) + ModifyDBShardGroup(*rds.ModifyDBShardGroupInput) (*rds.ModifyDBShardGroupOutput, error) + ModifyDBShardGroupWithContext(aws.Context, *rds.ModifyDBShardGroupInput, ...request.Option) (*rds.ModifyDBShardGroupOutput, error) + ModifyDBShardGroupRequest(*rds.ModifyDBShardGroupInput) (*request.Request, *rds.ModifyDBShardGroupOutput) + ModifyDBSnapshot(*rds.ModifyDBSnapshotInput) (*rds.ModifyDBSnapshotOutput, error) ModifyDBSnapshotWithContext(aws.Context, *rds.ModifyDBSnapshotInput, ...request.Option) (*rds.ModifyDBSnapshotOutput, error) ModifyDBSnapshotRequest(*rds.ModifyDBSnapshotInput) (*request.Request, *rds.ModifyDBSnapshotOutput) @@ -693,6 +709,10 @@ type RDSAPI interface { RebootDBInstanceWithContext(aws.Context, *rds.RebootDBInstanceInput, ...request.Option) (*rds.RebootDBInstanceOutput, error) RebootDBInstanceRequest(*rds.RebootDBInstanceInput) (*request.Request, *rds.RebootDBInstanceOutput) + RebootDBShardGroup(*rds.RebootDBShardGroupInput) (*rds.RebootDBShardGroupOutput, error) + RebootDBShardGroupWithContext(aws.Context, *rds.RebootDBShardGroupInput, ...request.Option) (*rds.RebootDBShardGroupOutput, error) + RebootDBShardGroupRequest(*rds.RebootDBShardGroupInput) (*request.Request, *rds.RebootDBShardGroupOutput) + RegisterDBProxyTargets(*rds.RegisterDBProxyTargetsInput) (*rds.RegisterDBProxyTargetsOutput, error) RegisterDBProxyTargetsWithContext(aws.Context, *rds.RegisterDBProxyTargetsInput, ...request.Option) (*rds.RegisterDBProxyTargetsOutput, error) RegisterDBProxyTargetsRequest(*rds.RegisterDBProxyTargetsInput) (*request.Request, *rds.RegisterDBProxyTargetsOutput) diff --git a/service/storagegateway/api.go b/service/storagegateway/api.go index cd7fa8ff931..5d2b484977e 100644 --- a/service/storagegateway/api.go +++ b/service/storagegateway/api.go @@ -4252,10 +4252,17 @@ func (c *StorageGateway) DescribeTapesRequest(input *DescribeTapesInput) (req *r // DescribeTapes API operation for AWS Storage Gateway. // -// Returns a description of the specified Amazon Resource Name (ARN) of virtual -// tapes. If a TapeARN is not specified, returns a description of all virtual -// tapes associated with the specified gateway. This operation is only supported -// in the tape gateway type. +// Returns a description of virtual tapes that correspond to the specified Amazon +// Resource Names (ARNs). If TapeARN is not specified, returns a description +// of the virtual tapes associated with the specified gateway. This operation +// is only supported for the tape gateway type. +// +// The operation supports pagination. By default, the operation returns a maximum +// of up to 100 tapes. You can optionally specify the Limit field in the body +// to limit the number of tapes in the response. If the number of tapes returned +// in the response is truncated, the response includes a Marker field. You can +// use this Marker value in your subsequent request to retrieve the next set +// of tapes. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6466,7 +6473,7 @@ func (c *StorageGateway) NotifyWhenUploadedRequest(input *NotifyWhenUploadedInpu // NotifyWhenUploaded API operation for AWS Storage Gateway. // // Sends you notification through CloudWatch Events when all files written to -// your file share have been uploaded to S3. Amazon S3. +// your file share have been uploaded to Amazon S3. // // Storage Gateway can send a notification through Amazon CloudWatch Events // when all files written to your file share up to that point in time have been @@ -6572,9 +6579,9 @@ func (c *StorageGateway) RefreshCacheRequest(input *RefreshCacheInput) (req *req // // You can subscribe to be notified through an Amazon CloudWatch event when // your RefreshCache operation completes. For more information, see Getting -// notified about file operations (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification) -// in the Storage Gateway User Guide. This operation is Only supported for S3 -// File Gateways. +// notified about file operations (https://docs.aws.amazon.com/filegateway/latest/files3/monitoring-file-gateway.html#get-notification) +// in the Amazon S3 File Gateway User Guide. This operation is Only supported +// for S3 File Gateways. // // When this API is called, it only initiates the refresh operation. When the // API call completes and returns a success code, it doesn't necessarily mean @@ -6586,8 +6593,8 @@ func (c *StorageGateway) RefreshCacheRequest(input *RefreshCacheInput) (req *req // Throttle limit: This API is asynchronous, so the gateway will accept no more // than two refreshes at any time. We recommend using the refresh-complete CloudWatch // event notification before issuing additional requests. For more information, -// see Getting notified about file operations (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification) -// in the Storage Gateway User Guide. +// see Getting notified about file operations (https://docs.aws.amazon.com/filegateway/latest/files3/monitoring-file-gateway.html#get-notification) +// in the Amazon S3 File Gateway User Guide. // // - Wait at least 60 seconds between consecutive RefreshCache API requests. // @@ -6598,8 +6605,8 @@ func (c *StorageGateway) RefreshCacheRequest(input *RefreshCacheInput) (req *req // The S3 bucket name does not need to be included when entering the list of // folders in the FolderList parameter. // -// For more information, see Getting notified about file operations (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification) -// in the Storage Gateway User Guide. +// For more information, see Getting notified about file operations (https://docs.aws.amazon.com/filegateway/latest/files3/monitoring-file-gateway.html#get-notification) +// in the Amazon S3 File Gateway User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7222,8 +7229,11 @@ func (c *StorageGateway) ShutdownGatewayRequest(input *ShutdownGatewayInput) (re // ShutdownGateway API operation for AWS Storage Gateway. // -// Shuts down a gateway. To specify which gateway to shut down, use the Amazon -// Resource Name (ARN) of the gateway in the body of your request. +// Shuts down a Tape Gateway or Volume Gateway. To specify which gateway to +// shut down, use the Amazon Resource Name (ARN) of the gateway in the body +// of your request. +// +// This API action cannot be used to shut down S3 File Gateway or FSx File Gateway. // // The operation shuts down the gateway service component running in the gateway's // virtual machine (VM) and not the host VM. @@ -17274,6 +17284,10 @@ func (s *FileSystemAssociationSummary) SetGatewayARN(v string) *FileSystemAssoci type GatewayInfo struct { _ struct{} `type:"structure"` + // Date after which this gateway will not receive software updates for new features + // and bug fixes. + DeprecationDate *string `min:"1" type:"string"` + // The ID of the Amazon EC2 instance that was used to launch the gateway. Ec2InstanceId *string `type:"string"` @@ -17307,6 +17321,9 @@ type GatewayInfo struct { // the gateway. This value is only available for certain host environments, // and its format depends on the host environment type. HostEnvironmentId *string `min:"1" type:"string"` + + // The version number of the software running on the gateway appliance. + SoftwareVersion *string `type:"string"` } // String returns the string representation. @@ -17327,6 +17344,12 @@ func (s GatewayInfo) GoString() string { return s.String() } +// SetDeprecationDate sets the DeprecationDate field's value. +func (s *GatewayInfo) SetDeprecationDate(v string) *GatewayInfo { + s.DeprecationDate = &v + return s +} + // SetEc2InstanceId sets the Ec2InstanceId field's value. func (s *GatewayInfo) SetEc2InstanceId(v string) *GatewayInfo { s.Ec2InstanceId = &v @@ -17381,6 +17404,12 @@ func (s *GatewayInfo) SetHostEnvironmentId(v string) *GatewayInfo { return s } +// SetSoftwareVersion sets the SoftwareVersion field's value. +func (s *GatewayInfo) SetSoftwareVersion(v string) *GatewayInfo { + s.SoftwareVersion = &v + return s +} + // An internal server error has occurred during the request. For more information, // see the error and message fields. type InternalServerError struct {