RDS
Service object for interacting with AWS RDS service.
public struct RDS: AWSService
<p>Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and
scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational
database and manages common database administration tasks, freeing up developers to focus on what makes their applications
and businesses unique.</p>
<p>Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server,
Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools
you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS
automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS
is flexible: you can scale your DB instance's compute resources and storage capacity to meet your
application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for
the resources you use.</p>
<p>This interface reference for Amazon RDS contains documentation for a programming or command line interface
you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might
require techniques such as polling or callback functions to determine when a command has been applied. In this
reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot,
or during the maintenance window. The reference structure is as follows, and we list following some related topics
from the user guide.</p>
<p>
<b>Amazon RDS API Reference</b>
</p>
<ul>
<li>
<p>For the alphabetical list of API actions, see
<a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Operations.html">API Actions</a>.</p>
</li>
<li>
<p>For the alphabetical list of data types, see
<a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Types.html">Data Types</a>.</p>
</li>
<li>
<p>For a list of common query parameters, see
<a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonParameters.html">Common Parameters</a>.</p>
</li>
<li>
<p>For descriptions of the error codes, see
<a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
</li>
</ul>
<p>
<b>Amazon RDS User Guide</b>
</p>
<ul>
<li>
<p>For a summary of the Amazon RDS interfaces, see
<a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Welcome.html#Welcome.Interfaces">Available RDS Interfaces</a>.</p>
</li>
<li>
<p>For more information about how to use the Query API, see
<a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Using_the_Query_API.html">Using the Query API</a>.</p>
</li>
</ul>
Inheritance
AWSService
Initializers
init(client:region:partition:endpoint:timeout:byteBufferAllocator:options:)
Initialize the RDS client
public init(
client: AWSClient,
region: SotoCore.Region? = nil,
partition: AWSPartition = .aws,
endpoint: String? = nil,
timeout: TimeAmount? = nil,
byteBufferAllocator: ByteBufferAllocator = ByteBufferAllocator(),
options: AWSServiceConfig.Options = []
)
Parameters
- client: AWSClient used to process requests
- region: Region of server you want to communicate with. This will override the partition parameter.
- partition: AWS partition where service resides, standard (.aws), china (.awscn), government (.awsusgov).
- endpoint: Custom endpoint URL to use instead of standard AWS servers
- timeout: Timeout value for HTTP requests
init(from:patch:)
Initializer required by AWSService.with(middlewares:timeout:byteBufferAllocator:options)
. You are not able to use this initializer directly as there are no public initializers for AWSServiceConfig.Patch
. Please use AWSService.with(middlewares:timeout:byteBufferAllocator:options)
instead.
public init(from: RDS, patch: AWSServiceConfig.Patch)
Properties
client
Client used for communication with AWS
public let client: AWSClient
config
Service configuration
public let config: AWSServiceConfig
Methods
addRoleToDBCluster(_:logger:on:)
@discardableResult public func addRoleToDBCluster(_ input: AddRoleToDBClusterMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Associates an Identity and Access Management (IAM) role with a DB cluster.
addRoleToDBInstance(_:logger:on:)
@discardableResult public func addRoleToDBInstance(_ input: AddRoleToDBInstanceMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.
To add a role to a DB instance, the status of the DB instance must be available
.
This command doesn't apply to RDS Custom.
addSourceIdentifierToSubscription(_:logger:on:)
public func addSourceIdentifierToSubscription(_ input: AddSourceIdentifierToSubscriptionMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<AddSourceIdentifierToSubscriptionResult>
Adds a source identifier to an existing RDS event notification subscription.
addTagsToResource(_:logger:on:)
@discardableResult public func addTagsToResource(_ input: AddTagsToResourceMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.
For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.
applyPendingMaintenanceAction(_:logger:on:)
public func applyPendingMaintenanceAction(_ input: ApplyPendingMaintenanceActionMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ApplyPendingMaintenanceActionResult>
Applies a pending maintenance action to a resource (for example, to a DB instance).
authorizeDBSecurityGroupIngress(_:logger:on:)
public func authorizeDBSecurityGroupIngress(_ input: AuthorizeDBSecurityGroupIngressMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<AuthorizeDBSecurityGroupIngressResult>
Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
backtrackDBCluster(_:logger:on:)
public func backtrackDBCluster(_ input: BacktrackDBClusterMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DBClusterBacktrack>
Backtracks a DB cluster to a specific time, without creating a new DB cluster.
For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide.
This action only applies to Aurora MySQL DB clusters.
cancelExportTask(_:logger:on:)
public func cancelExportTask(_ input: CancelExportTaskMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ExportTask>
Cancels an export task in progress that is exporting a snapshot to Amazon S3. Any data that has already been written to the S3 bucket isn't removed.
copyDBClusterParameterGroup(_:logger:on:)
public func copyDBClusterParameterGroup(_ input: CopyDBClusterParameterGroupMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CopyDBClusterParameterGroupResult>
Copies the specified DB cluster parameter group.
copyDBClusterSnapshot(_:logger:on:)
public func copyDBClusterSnapshot(_ input: CopyDBClusterSnapshotMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CopyDBClusterSnapshotResult>
Copies a snapshot of a DB cluster.
To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier
must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.
You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot
action
is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region,
you must provide the following values:
-
KmsKeyId
- The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. -
PreSignedUrl
- A URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot
action to be called in the source Amazon Web Services Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for theCopyDBClusterSnapshot
API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied.The pre-signed URL request must contain the following parameter values:
-
KmsKeyId
- The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both theCopyDBClusterSnapshot
action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL. -
DestinationRegion
- The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in. -
SourceDBClusterSnapshotIdentifier
- The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then yourSourceDBClusterSnapshotIdentifier
looks like the following example:arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify
SourceRegion
(or--source-region
for the CLI) instead of specifyingPreSignedUrl
manually. SpecifyingSourceRegion
autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region. -
-
TargetDBClusterSnapshotIdentifier
- The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region. -
SourceDBClusterSnapshotIdentifier
- The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as theSourceDBClusterSnapshotIdentifier
in the pre-signed URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified
by TargetDBClusterSnapshotIdentifier
while that DB cluster snapshot is in "copying" status.
For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
copyDBParameterGroup(_:logger:on:)
public func copyDBParameterGroup(_ input: CopyDBParameterGroupMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CopyDBParameterGroupResult>
Copies the specified DB parameter group.
copyDBSnapshot(_:logger:on:)
public func copyDBSnapshot(_ input: CopyDBSnapshotMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CopyDBSnapshotResult>
Copies the specified DB snapshot. The source DB snapshot must be in the available
state.
You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region
where you call the CopyDBSnapshot
action is the destination Amazon Web Services Region for the
DB snapshot copy.
This command doesn't apply to RDS Custom.
For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.
copyOptionGroup(_:logger:on:)
public func copyOptionGroup(_ input: CopyOptionGroupMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CopyOptionGroupResult>
Copies the specified option group.
createCustomDBEngineVersion(_:logger:on:)
public func createCustomDBEngineVersion(_ input: CreateCustomDBEngineVersionMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DBEngineVersion>
Creates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and specific AMI. The supported engines are the following:
-
Oracle Database 12.1 Enterprise Edition with the January 2021 or later RU/RUR
-
Oracle Database 19c Enterprise Edition with the January 2021 or later RU/RUR
Amazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software. The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create your database. With Amazon RDS Custom for Oracle, you upload your database installation files in Amazon S3.
When you create a custom engine version, you specify the files in a JSON document called a CEV manifest. This document describes installation .zip files stored in Amazon S3. RDS Custom creates your CEV from the installation files that you provided. This service model is called Bring Your Own Media (BYOM).
Creation takes approximately two hours. If creation fails, RDS Custom issues RDS-EVENT-0196
with
the message Creation failed for custom engine version
, and includes details about the failure.
For example, the event prints missing files.
After you create the CEV, it is available for use. You can create multiple CEVs, and create multiple RDS Custom instances from any CEV. You can also change the status of a CEV to make it available or inactive.
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with
Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the
CreateCustomDbEngineVersion
event aren't logged. However, you might see calls from the
API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for
the CreateCustomDbEngineVersion
event.
For more information, see Creating a CEV in the Amazon RDS User Guide.
createDBCluster(_:logger:on:)
public func createDBCluster(_ input: CreateDBClusterMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateDBClusterResult>
Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
You can use the ReplicationSourceIdentifier
parameter to create an Amazon
Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or
PostgreSQL DB instance. For cross-Region replication where the DB cluster identified by
ReplicationSourceIdentifier
is encrypted, also specify the
PreSignedUrl
parameter.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
createDBClusterEndpoint(_:logger:on:)
public func createDBClusterEndpoint(_ input: CreateDBClusterEndpointMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DBClusterEndpoint>
Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
createDBClusterParameterGroup(_:logger:on:)
public func createDBClusterParameterGroup(_ input: CreateDBClusterParameterGroupMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateDBClusterParameterGroupResult>
Creates a new DB cluster parameter group.
Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
A DB cluster parameter group is initially created with the default parameters for the
database engine used by instances in the DB cluster. To provide custom values for any of the
parameters, you must modify the group after creating it using
ModifyDBClusterParameterGroup
. Once you've created a DB cluster parameter group, you need to
associate it with your DB cluster using ModifyDBCluster
.
When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes
before creating your first DB cluster
that uses that DB cluster parameter group as the default parameter
group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter
group is used as the default for a new DB cluster. This is especially important for parameters
that are critical when creating the default database for a DB cluster, such as the character set
for the default database defined by the character_set_database
parameter. You can use the
Parameter Groups option of the Amazon RDS console or the
DescribeDBClusterParameters
action to verify
that your DB cluster parameter group has been created or modified.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
createDBClusterSnapshot(_:logger:on:)
public func createDBClusterSnapshot(_ input: CreateDBClusterSnapshotMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateDBClusterSnapshotResult>
Creates a snapshot of a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
createDBInstance(_:logger:on:)
public func createDBInstance(_ input: CreateDBInstanceMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateDBInstanceResult>
Creates a new DB instance.
createDBInstanceReadReplica(_:logger:on:)
public func createDBInstanceReadReplica(_ input: CreateDBInstanceReadReplicaMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateDBInstanceReadReplicaResult>
Creates a new DB instance that acts as a read replica for an existing source DB instance. You can create a read replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read Replicas in the Amazon RDS User Guide.
Amazon Aurora doesn't support this action. Call the CreateDBInstance
action to create a DB instance for an Aurora DB cluster.
All read replica DB instances are created with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified.
Your source DB instance must have backup retention enabled.
createDBParameterGroup(_:logger:on:)
public func createDBParameterGroup(_ input: CreateDBParameterGroupMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateDBParameterGroupResult>
Creates a new DB parameter group.
A DB parameter group is initially created with the default parameters for the
database engine used by the DB instance. To provide custom values for any of the
parameters, you must modify the group after creating it using
ModifyDBParameterGroup
. Once you've created a DB parameter group, you need to
associate it with your DB instance using ModifyDBInstance
. When you associate
a new DB parameter group with a running DB instance, you need to reboot the DB
instance without failover for the new DB parameter group and associated settings to take effect.
This command doesn't apply to RDS Custom.
After you create a DB parameter group, you should wait at least 5 minutes
before creating your first DB instance that uses that DB parameter group as the default parameter
group. This allows Amazon RDS to fully complete the create action before the parameter
group is used as the default for a new DB instance. This is especially important for parameters
that are critical when creating the default database for a DB instance, such as the character set
for the default database defined by the character_set_database
parameter. You can use the
Parameter Groups option of the Amazon RDS console or the
DescribeDBParameters command to verify
that your DB parameter group has been created or modified.
createDBProxy(_:logger:on:)
public func createDBProxy(_ input: CreateDBProxyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateDBProxyResponse>
Creates a new DB proxy.
createDBProxyEndpoint(_:logger:on:)
public func createDBProxyEndpoint(_ input: CreateDBProxyEndpointRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateDBProxyEndpointResponse>
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.
createDBSecurityGroup(_:logger:on:)
public func createDBSecurityGroup(_ input: CreateDBSecurityGroupMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateDBSecurityGroupResult>
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.
createDBSnapshot(_:logger:on:)
public func createDBSnapshot(_ input: CreateDBSnapshotMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateDBSnapshotResult>
Creates a snapshot of a DB instance. The source DB instance must be in the available
or
storage-optimization
state.
createDBSubnetGroup(_:logger:on:)
public func createDBSubnetGroup(_ input: CreateDBSubnetGroupMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateDBSubnetGroupResult>
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(_:logger:on:)
public func createEventSubscription(_ input: CreateEventSubscriptionMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateEventSubscriptionResult>
Creates an RDS event notification subscription. This action 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.
RDS event notification is only available for unencrypted SNS topics. If you specify an encrypted SNS topic, event notifications aren't sent for the topic.
createGlobalCluster(_:logger:on:)
public func createGlobalCluster(_ input: CreateGlobalClusterMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateGlobalClusterResult>
Creates an Aurora global database spread across multiple Amazon Web Services Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.
You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.
This action only applies to Aurora DB clusters.
createOptionGroup(_:logger:on:)
public func createOptionGroup(_ input: CreateOptionGroupMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateOptionGroupResult>
Creates a new option group. You can create up to 20 option groups.
This command doesn't apply to RDS Custom.
deleteCustomDBEngineVersion(_:logger:on:)
public func deleteCustomDBEngineVersion(_ input: DeleteCustomDBEngineVersionMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DBEngineVersion>
Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:
-
The CEV must not be the default for RDS Custom. If it is, change the default before running this command.
-
The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance.
Typically, deletion takes a few minutes.
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with
Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the
DeleteCustomDbEngineVersion
event aren't logged. However, you might see calls from the
API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for
the DeleteCustomDbEngineVersion
event.
For more information, see Deleting a CEV in the Amazon RDS User Guide.
deleteDBCluster(_:logger:on:)
public func deleteDBCluster(_ input: DeleteDBClusterMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteDBClusterResult>
The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
deleteDBClusterEndpoint(_:logger:on:)
public func deleteDBClusterEndpoint(_ input: DeleteDBClusterEndpointMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DBClusterEndpoint>
Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
deleteDBClusterParameterGroup(_:logger:on:)
@discardableResult public func deleteDBClusterParameterGroup(_ input: DeleteDBClusterParameterGroupMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
deleteDBClusterSnapshot(_:logger:on:)
public func deleteDBClusterSnapshot(_ input: DeleteDBClusterSnapshotMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteDBClusterSnapshotResult>
Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB cluster snapshot must be in the available
state to be
deleted.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
deleteDBInstance(_:logger:on:)
public func deleteDBInstance(_ input: DeleteDBInstanceMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteDBInstanceResult>
The DeleteDBInstance action deletes a previously provisioned DB instance.
When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered.
Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance
are not deleted.
If you request a final DB snapshot
the status of the Amazon RDS DB instance is deleting
until the DB snapshot is created. The API action DescribeDBInstance
is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.
When a DB instance is in a failure state and has a status of failed
, incompatible-restore
,
or incompatible-network
, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot
parameter.
If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:
-
The DB cluster is a read replica of another Amazon Aurora DB cluster.
-
The DB instance is the only instance in the DB cluster.
To delete a DB instance in this case, first call the
PromoteReadReplicaDBCluster
API action to promote the DB cluster so
it's no longer a read replica. After the promotion completes, then call the
DeleteDBInstance
API action to delete the final instance in the DB
cluster.
deleteDBInstanceAutomatedBackup(_:logger:on:)
public func deleteDBInstanceAutomatedBackup(_ input: DeleteDBInstanceAutomatedBackupMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteDBInstanceAutomatedBackupResult>
Deletes automated backups using the DbiResourceId
value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.
deleteDBParameterGroup(_:logger:on:)
@discardableResult public func deleteDBParameterGroup(_ input: DeleteDBParameterGroupMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.
deleteDBProxy(_:logger:on:)
public func deleteDBProxy(_ input: DeleteDBProxyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteDBProxyResponse>
Deletes an existing DB proxy.
deleteDBProxyEndpoint(_:logger:on:)
public func deleteDBProxyEndpoint(_ input: DeleteDBProxyEndpointRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteDBProxyEndpointResponse>
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.
deleteDBSecurityGroup(_:logger:on:)
@discardableResult public func deleteDBSecurityGroup(_ input: DeleteDBSecurityGroupMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes a DB security group.
The specified DB security group must not be associated with any DB instances.
deleteDBSnapshot(_:logger:on:)
public func deleteDBSnapshot(_ input: DeleteDBSnapshotMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteDBSnapshotResult>
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.
deleteDBSubnetGroup(_:logger:on:)
@discardableResult public func deleteDBSubnetGroup(_ input: DeleteDBSubnetGroupMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
deleteEventSubscription(_:logger:on:)
public func deleteEventSubscription(_ input: DeleteEventSubscriptionMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteEventSubscriptionResult>
Deletes an RDS event notification subscription.
deleteGlobalCluster(_:logger:on:)
public func deleteGlobalCluster(_ input: DeleteGlobalClusterMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteGlobalClusterResult>
Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.
This action only applies to Aurora DB clusters.
deleteOptionGroup(_:logger:on:)
@discardableResult public func deleteOptionGroup(_ input: DeleteOptionGroupMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes an existing option group.
deregisterDBProxyTargets(_:logger:on:)
public func deregisterDBProxyTargets(_ input: DeregisterDBProxyTargetsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeregisterDBProxyTargetsResponse>
Remove the association between one or more DBProxyTarget
data structures and a DBProxyTargetGroup
.
describeAccountAttributes(_:logger:on:)
public func describeAccountAttributes(_ input: DescribeAccountAttributesMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<AccountAttributesMessage>
Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
This command doesn't take any parameters.
describeCertificates(_:logger:on:)
public func describeCertificates(_ input: DescribeCertificatesMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CertificateMessage>
Lists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account.
describeDBClusterBacktracks(_:logger:on:)
public func describeDBClusterBacktracks(_ input: DescribeDBClusterBacktracksMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DBClusterBacktrackMessage>
Returns information about backtracks for a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora MySQL DB clusters.
describeDBClusterEndpoints(_:logger:on:)
public func describeDBClusterEndpoints(_ input: DescribeDBClusterEndpointsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DBClusterEndpointMessage>
Returns information about endpoints for an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
describeDBClusterParameterGroups(_:logger:on:)
public func describeDBClusterParameterGroups(_ input: DescribeDBClusterParameterGroupsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DBClusterParameterGroupsMessage>
Returns a list of DBClusterParameterGroup
descriptions. If a
DBClusterParameterGroupName
parameter is specified,
the list will contain only the description of the specified DB cluster parameter group.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
describeDBClusterParameters(_:logger:on:)
public func describeDBClusterParameters(_ input: DescribeDBClusterParametersMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DBClusterParameterGroupDetails>
Returns the detailed parameter list for a particular DB cluster parameter group.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
describeDBClusterSnapshotAttributes(_:logger:on:)
public func describeDBClusterSnapshotAttributes(_ input: DescribeDBClusterSnapshotAttributesMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeDBClusterSnapshotAttributesResult>
Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes
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 cluster snapshot. If all
is included in the list of
values for the restore
attribute, then the manual DB cluster 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 cluster snapshot, or to make the
manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute
API action.
describeDBClusterSnapshots(_:logger:on:)
public func describeDBClusterSnapshots(_ input: DescribeDBClusterSnapshotsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DBClusterSnapshotMessage>
Returns information about DB cluster snapshots. This API action supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
describeDBClusters(_:logger:on:)
public func describeDBClusters(_ input: DescribeDBClustersMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DBClusterMessage>
Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
describeDBEngineVersions(_:logger:on:)
public func describeDBEngineVersions(_ input: DescribeDBEngineVersionsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DBEngineVersionMessage>
Returns a list of the available DB engines.
describeDBInstanceAutomatedBackups(_:logger:on:)
public func describeDBInstanceAutomatedBackups(_ input: DescribeDBInstanceAutomatedBackupsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DBInstanceAutomatedBackupMessage>
Displays backups for both current and deleted
instances. For example, use this operation to
find details about automated backups for previously deleted instances. Current instances
with retention periods greater than zero (0) are returned for both the
DescribeDBInstanceAutomatedBackups
and
DescribeDBInstances
operations.
All parameters are optional.
describeDBInstances(_:logger:on:)
public func describeDBInstances(_ input: DescribeDBInstancesMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DBInstanceMessage>
Returns information about provisioned RDS instances. This API supports pagination.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
describeDBLogFiles(_:logger:on:)
public func describeDBLogFiles(_ input: DescribeDBLogFilesMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeDBLogFilesResponse>
Returns a list of DB log files for the DB instance.
This command doesn't apply to RDS Custom.
describeDBParameterGroups(_:logger:on:)
public func describeDBParameterGroups(_ input: DescribeDBParameterGroupsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DBParameterGroupsMessage>
Returns a list of DBParameterGroup
descriptions. If a DBParameterGroupName
is specified,
the list will contain only the description of the specified DB parameter group.
describeDBParameters(_:logger:on:)
public func describeDBParameters(_ input: DescribeDBParametersMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DBParameterGroupDetails>
Returns the detailed parameter list for a particular DB parameter group.
describeDBProxies(_:logger:on:)
public func describeDBProxies(_ input: DescribeDBProxiesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeDBProxiesResponse>
Returns information about DB proxies.
describeDBProxyEndpoints(_:logger:on:)
public func describeDBProxyEndpoints(_ input: DescribeDBProxyEndpointsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeDBProxyEndpointsResponse>
Returns information about DB proxy endpoints.
describeDBProxyTargetGroups(_:logger:on:)
public func describeDBProxyTargetGroups(_ input: DescribeDBProxyTargetGroupsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeDBProxyTargetGroupsResponse>
Returns information about DB proxy target groups, represented by DBProxyTargetGroup
data structures.
describeDBProxyTargets(_:logger:on:)
public func describeDBProxyTargets(_ input: DescribeDBProxyTargetsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeDBProxyTargetsResponse>
Returns information about DBProxyTarget
objects. This API supports pagination.
describeDBSecurityGroups(_:logger:on:)
public func describeDBSecurityGroups(_ input: DescribeDBSecurityGroupsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DBSecurityGroupMessage>
Returns a list of DBSecurityGroup
descriptions. If a DBSecurityGroupName
is specified,
the list will contain only the descriptions of the specified DB security group.
describeDBSnapshotAttributes(_:logger:on:)
public func describeDBSnapshotAttributes(_ input: DescribeDBSnapshotAttributesMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeDBSnapshotAttributesResult>
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.
describeDBSnapshots(_:logger:on:)
public func describeDBSnapshots(_ input: DescribeDBSnapshotsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DBSnapshotMessage>
Returns information about DB snapshots. This API action supports pagination.
describeDBSubnetGroups(_:logger:on:)
public func describeDBSubnetGroups(_ input: DescribeDBSubnetGroupsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DBSubnetGroupMessage>
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
describeEngineDefaultClusterParameters(_:logger:on:)
public func describeEngineDefaultClusterParameters(_ input: DescribeEngineDefaultClusterParametersMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeEngineDefaultClusterParametersResult>
Returns the default engine and system parameter information for the cluster database engine.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
describeEngineDefaultParameters(_:logger:on:)
public func describeEngineDefaultParameters(_ input: DescribeEngineDefaultParametersMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeEngineDefaultParametersResult>
Returns the default engine and system parameter information for the specified database engine.
describeEventCategories(_:logger:on:)
public func describeEventCategories(_ input: DescribeEventCategoriesMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<EventCategoriesMessage>
Displays a list of categories for all event source types, or, if specified, for a specified source type. You can also see this list in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide .
describeEventSubscriptions(_:logger:on:)
public func describeEventSubscriptions(_ input: DescribeEventSubscriptionsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<EventSubscriptionsMessage>
Lists all the subscription descriptions for a customer account. The description for a subscription includes
SubscriptionName
, SNSTopicARN
, CustomerID
, SourceType
, SourceID
, CreationTime
, and Status
.
If you specify a SubscriptionName
, lists the description for that subscription.
describeEvents(_:logger:on:)
public func describeEvents(_ input: DescribeEventsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<EventsMessage>
Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter.
By default, RDS returns events that were generated in the past hour.
describeExportTasks(_:logger:on:)
public func describeExportTasks(_ input: DescribeExportTasksMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ExportTasksMessage>
Returns information about a snapshot export to Amazon S3. This API operation supports pagination.
describeGlobalClusters(_:logger:on:)
public func describeGlobalClusters(_ input: DescribeGlobalClustersMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GlobalClustersMessage>
Returns information about Aurora global database clusters. This API supports pagination.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
describeOptionGroupOptions(_:logger:on:)
public func describeOptionGroupOptions(_ input: DescribeOptionGroupOptionsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<OptionGroupOptionsMessage>
Describes all available options.
describeOptionGroups(_:logger:on:)
public func describeOptionGroups(_ input: DescribeOptionGroupsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<OptionGroups>
Describes the available option groups.
describeOrderableDBInstanceOptions(_:logger:on:)
public func describeOrderableDBInstanceOptions(_ input: DescribeOrderableDBInstanceOptionsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<OrderableDBInstanceOptionsMessage>
Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.
describePendingMaintenanceActions(_:logger:on:)
public func describePendingMaintenanceActions(_ input: DescribePendingMaintenanceActionsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PendingMaintenanceActionsMessage>
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
describeReservedDBInstances(_:logger:on:)
public func describeReservedDBInstances(_ input: DescribeReservedDBInstancesMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ReservedDBInstanceMessage>
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
describeReservedDBInstancesOfferings(_:logger:on:)
public func describeReservedDBInstancesOfferings(_ input: DescribeReservedDBInstancesOfferingsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ReservedDBInstancesOfferingMessage>
Lists available reserved DB instance offerings.
describeSourceRegions(_:logger:on:)
public func describeSourceRegions(_ input: DescribeSourceRegionsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<SourceRegionMessage>
Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from. This API action supports pagination.
describeValidDBInstanceModifications(_:logger:on:)
public func describeValidDBInstanceModifications(_ input: DescribeValidDBInstanceModificationsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeValidDBInstanceModificationsResult>
You can call DescribeValidDBInstanceModifications
to learn what modifications you can make to
your DB instance. You can use this information when you call ModifyDBInstance
.
This command doesn't apply to RDS Custom.
downloadDBLogFilePortion(_:logger:on:)
public func downloadDBLogFilePortion(_ input: DownloadDBLogFilePortionMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DownloadDBLogFilePortionDetails>
Downloads all or a portion of the specified log file, up to 1 MB in size.
This command doesn't apply to RDS Custom.
failoverDBCluster(_:logger:on:)
public func failoverDBCluster(_ input: FailoverDBClusterMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<FailoverDBClusterResult>
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 readbable 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 deployments with two readable standby DB instances in the Amazon RDS User Guide.
failoverGlobalCluster(_:logger:on:)
public func failoverGlobalCluster(_ input: FailoverGlobalClusterMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<FailoverGlobalClusterResult>
Initiates the failover process for an Aurora global database (GlobalCluster).
A failover for an Aurora global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Aurora global database.
For more information about failing over an Amazon Aurora global database, see Managed planned failover for Amazon Aurora global databases in the Amazon Aurora User Guide.
This action applies to GlobalCluster (Aurora global databases) only. Use this action only on healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to reconfigure your Aurora global database topology.
listTagsForResource(_:logger:on:)
public func listTagsForResource(_ input: ListTagsForResourceMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<TagListMessage>
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.
modifyCertificates(_:logger:on:)
public func modifyCertificates(_ input: ModifyCertificatesMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ModifyCertificatesResult>
Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances, or remove the override.
By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB instances that is different from the default certificate provided by RDS. You can also use this operation to remove the override, so that new DB instances use the default certificate provided by RDS.
You might need to override the default certificate in the following situations:
-
You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet the RDS default CA certificate for the specified Amazon Web Services Region.
-
RDS has already moved to a new default CA certificate for the specified Amazon Web Services Region, but you are still in the process of supporting the new CA certificate. In this case, you temporarily need additional time to finish your application changes.
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
modifyCurrentDBClusterCapacity(_:logger:on:)
public func modifyCurrentDBClusterCapacity(_ input: ModifyCurrentDBClusterCapacityMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DBClusterCapacityInfo>
Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.
Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale
fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity
to set the capacity explicitly.
After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
If you call ModifyCurrentDBClusterCapacity
with the default TimeoutAction
, connections that
prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points,
see
Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
This action only applies to Aurora Serverless v1 DB clusters.
modifyCustomDBEngineVersion(_:logger:on:)
public func modifyCustomDBEngineVersion(_ input: ModifyCustomDBEngineVersionMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DBEngineVersion>
Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling
DescribeDBEngineVersions
.
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with
Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the
ModifyCustomDbEngineVersion
event aren't logged. However, you might see calls from the
API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for
the ModifyCustomDbEngineVersion
event.
For more information, see Modifying CEV status in the Amazon RDS User Guide.
modifyDBCluster(_:logger:on:)
public func modifyDBCluster(_ input: ModifyDBClusterMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ModifyDBClusterResult>
Modify the settings for an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can change one or more settings by specifying these parameters and the new values in the request.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
modifyDBClusterEndpoint(_:logger:on:)
public func modifyDBClusterEndpoint(_ input: ModifyDBClusterEndpointMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DBClusterEndpoint>
Modifies the properties of an endpoint in an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
modifyDBClusterParameterGroup(_:logger:on:)
public func modifyDBClusterParameterGroup(_ input: ModifyDBClusterParameterGroupMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DBClusterParameterGroupNameMessage>
Modifies the parameters of a DB cluster parameter group. To modify more than one parameter,
submit a list of the following: ParameterName
, ParameterValue
,
and ApplyMethod
. A maximum of 20
parameters can be modified in a single request.
After you create a DB cluster parameter group, you should wait at least 5 minutes
before creating your first DB cluster that uses that DB cluster parameter group as the default parameter
group. This allows Amazon RDS to fully complete the create action before the parameter
group is used as the default for a new DB cluster. This is especially important for parameters
that are critical when creating the default database for a DB cluster, such as the character set
for the default database defined by the character_set_database
parameter. You can use the
Parameter Groups option of the Amazon RDS console or the
DescribeDBClusterParameters
action to verify
that your DB cluster parameter group has been created or modified.
If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
modifyDBClusterSnapshotAttribute(_:logger:on:)
public func modifyDBClusterSnapshotAttribute(_ input: ModifyDBClusterSnapshotAttributeMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ModifyDBClusterSnapshotAttributeResult>
Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
To share a manual DB cluster 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 cluster snapshot. Use the value all
to
make the manual DB cluster snapshot public, which means that it can be copied or
restored by all Amazon Web Services accounts.
Don't add the all
value for any manual DB cluster snapshots
that contain private information that you don't want available to all Amazon Web Services
accounts.
If a manual DB cluster 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 cluster
snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API action. The accounts are
returned as values for the restore
attribute.
modifyDBInstance(_:logger:on:)
public func modifyDBInstance(_ input: ModifyDBInstanceMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ModifyDBInstanceResult>
Modifies settings for a DB instance.
You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
To learn what modifications you can make to your DB instance,
call DescribeValidDBInstanceModifications
before you call ModifyDBInstance
.
modifyDBParameterGroup(_:logger:on:)
public func modifyDBParameterGroup(_ input: ModifyDBParameterGroupMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DBParameterGroupNameMessage>
Modifies the parameters of a DB parameter group. To modify more than one parameter,
submit a list of the following: ParameterName
, ParameterValue
, and
ApplyMethod
. A maximum of 20 parameters can be modified in a single request.
After you modify a DB parameter group, you should wait at least 5 minutes
before creating your first DB instance that uses that DB parameter group as the default parameter
group. This allows Amazon RDS to fully complete the modify action before the parameter
group is used as the default for a new DB instance. This is especially important for parameters
that are critical when creating the default database for a DB instance, such as the character set
for the default database defined by the character_set_database
parameter. You can use the
Parameter Groups option of the Amazon RDS console or the
DescribeDBParameters command to verify
that your DB parameter group has been created or modified.
modifyDBProxy(_:logger:on:)
public func modifyDBProxy(_ input: ModifyDBProxyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ModifyDBProxyResponse>
Changes the settings for an existing DB proxy.
modifyDBProxyEndpoint(_:logger:on:)
public func modifyDBProxyEndpoint(_ input: ModifyDBProxyEndpointRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ModifyDBProxyEndpointResponse>
Changes the settings for an existing DB proxy endpoint.
modifyDBProxyTargetGroup(_:logger:on:)
public func modifyDBProxyTargetGroup(_ input: ModifyDBProxyTargetGroupRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ModifyDBProxyTargetGroupResponse>
Modifies the properties of a DBProxyTargetGroup
.
modifyDBSnapshot(_:logger:on:)
public func modifyDBSnapshot(_ input: ModifyDBSnapshotMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ModifyDBSnapshotResult>
Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public.
</p>
<p>Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command
doesn't apply to RDS Custom.</p>
modifyDBSnapshotAttribute(_:logger:on:)
public func modifyDBSnapshotAttribute(_ input: ModifyDBSnapshotAttributeMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ModifyDBSnapshotAttributeResult>
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 action. The accounts are returned as
values for the restore
attribute.
modifyDBSubnetGroup(_:logger:on:)
public func modifyDBSubnetGroup(_ input: ModifyDBSubnetGroupMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ModifyDBSubnetGroupResult>
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.
modifyEventSubscription(_:logger:on:)
public func modifyEventSubscription(_ input: ModifyEventSubscriptionMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ModifyEventSubscriptionResult>
Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change
source identifiers for a subscription, use the AddSourceIdentifierToSubscription
and RemoveSourceIdentifierFromSubscription
calls.
You can see a list of the event categories for a given source type (SourceType
)
in Events in the Amazon RDS User Guide
or by using the DescribeEventCategories
operation.
modifyGlobalCluster(_:logger:on:)
public func modifyGlobalCluster(_ input: ModifyGlobalClusterMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ModifyGlobalClusterResult>
Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
modifyOptionGroup(_:logger:on:)
public func modifyOptionGroup(_ input: ModifyOptionGroupMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ModifyOptionGroupResult>
Modifies an existing option group.
promoteReadReplica(_:logger:on:)
public func promoteReadReplica(_ input: PromoteReadReplicaMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PromoteReadReplicaResult>
Promotes a read replica DB instance to a standalone DB instance.
-
Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the
backing-up
status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion. -
This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.
promoteReadReplicaDBCluster(_:logger:on:)
public func promoteReadReplicaDBCluster(_ input: PromoteReadReplicaDBClusterMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PromoteReadReplicaDBClusterResult>
Promotes a read replica DB cluster to a standalone DB cluster.
purchaseReservedDBInstancesOffering(_:logger:on:)
public func purchaseReservedDBInstancesOffering(_ input: PurchaseReservedDBInstancesOfferingMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PurchaseReservedDBInstancesOfferingResult>
Purchases a reserved DB instance offering.
rebootDBCluster(_:logger:on:)
public func rebootDBCluster(_ input: RebootDBClusterMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<RebootDBClusterResult>
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 deployments with two readable standby DB instances in the Amazon RDS User Guide.
rebootDBInstance(_:logger:on:)
public func rebootDBInstance(_ input: RebootDBInstanceMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<RebootDBInstanceResult>
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.
registerDBProxyTargets(_:logger:on:)
public func registerDBProxyTargets(_ input: RegisterDBProxyTargetsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<RegisterDBProxyTargetsResponse>
Associate one or more DBProxyTarget
data structures with a DBProxyTargetGroup
.
removeFromGlobalCluster(_:logger:on:)
public func removeFromGlobalCluster(_ input: RemoveFromGlobalClusterMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<RemoveFromGlobalClusterResult>
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 action only applies to Aurora DB clusters.
removeRoleFromDBCluster(_:logger:on:)
@discardableResult public func removeRoleFromDBCluster(_ input: RemoveRoleFromDBClusterMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
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 deployments with two readable standby DB instances in the Amazon RDS User Guide.
removeRoleFromDBInstance(_:logger:on:)
@discardableResult public func removeRoleFromDBInstance(_ input: RemoveRoleFromDBInstanceMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.
removeSourceIdentifierFromSubscription(_:logger:on:)
public func removeSourceIdentifierFromSubscription(_ input: RemoveSourceIdentifierFromSubscriptionMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<RemoveSourceIdentifierFromSubscriptionResult>
Removes a source identifier from an existing RDS event notification subscription.
removeTagsFromResource(_:logger:on:)
@discardableResult public func removeTagsFromResource(_ input: RemoveTagsFromResourceMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
resetDBClusterParameterGroup(_:logger:on:)
public func resetDBClusterParameterGroup(_ input: ResetDBClusterParameterGroupMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DBClusterParameterGroupNameMessage>
Modifies the parameters of a DB cluster parameter group to the default value. To
reset specific parameters submit a list of the following: ParameterName
and ApplyMethod
. To reset the
entire DB cluster parameter group, specify the DBClusterParameterGroupName
and ResetAllParameters
parameters.
When resetting the entire group, dynamic parameters are updated immediately and static parameters
are set to pending-reboot
to take effect on the next DB instance restart
or RebootDBInstance
request. You must call RebootDBInstance
for every
DB instance in your DB cluster that you want the updated static parameter to apply to.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
resetDBParameterGroup(_:logger:on:)
public func resetDBParameterGroup(_ input: ResetDBParameterGroupMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DBParameterGroupNameMessage>
Modifies the parameters of a DB parameter group to the engine/system default value.
To reset specific parameters, provide a list of the following:
ParameterName
and ApplyMethod
. To reset the entire DB
parameter group, specify the DBParameterGroup
name and
ResetAllParameters
parameters. When resetting the entire group, dynamic
parameters are updated immediately and static parameters are set to
pending-reboot
to take effect on the next DB instance restart or
RebootDBInstance
request.
restoreDBClusterFromS3(_:logger:on:)
public func restoreDBClusterFromS3(_ input: RestoreDBClusterFromS3Message, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<RestoreDBClusterFromS3Result>
Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide.
This action only restores the DB cluster, not the DB instances for that DB
cluster. You must invoke the CreateDBInstance
action to create DB
instances for the restored DB cluster, specifying the identifier of the restored DB
cluster in DBClusterIdentifier
. You can create DB instances only after
the RestoreDBClusterFromS3
action has completed and the DB
cluster is available.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters. The source DB engine must be MySQL.
restoreDBClusterFromSnapshot(_:logger:on:)
public func restoreDBClusterFromSnapshot(_ input: RestoreDBClusterFromSnapshotMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<RestoreDBClusterFromSnapshotResult>
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group.
This action only restores the DB cluster, not the DB instances for that DB
cluster. You must invoke the CreateDBInstance
action to create DB
instances for the restored DB cluster, specifying the identifier of the restored DB
cluster in DBClusterIdentifier
. You can create DB instances only after
the RestoreDBClusterFromSnapshot
action has completed and the DB
cluster is available.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
restoreDBClusterToPointInTime(_:logger:on:)
public func restoreDBClusterToPointInTime(_ input: RestoreDBClusterToPointInTimeMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<RestoreDBClusterToPointInTimeResult>
Restores a DB cluster to an arbitrary point in time. Users can restore to any point
in time before LatestRestorableTime
for up to
BackupRetentionPeriod
days. The target DB cluster is created from the
source DB cluster with the same configuration as the original DB cluster, except that
the new DB cluster is created with the default DB security group.
For Aurora, this action only restores the DB cluster, not the DB instances for that DB
cluster. You must invoke the CreateDBInstance
action to create DB
instances for the restored DB cluster, specifying the identifier of the restored DB
cluster in DBClusterIdentifier
. You can create DB instances only after
the RestoreDBClusterToPointInTime
action has completed and the DB
cluster is available.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
restoreDBInstanceFromDBSnapshot(_:logger:on:)
public func restoreDBInstanceFromDBSnapshot(_ input: RestoreDBInstanceFromDBSnapshotMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<RestoreDBInstanceFromDBSnapshotResult>
Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most of the source's original configuration, including the default security group and DB parameter group. By default, the new DB instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.
If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original DB instance with the DB instance created from the snapshot.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier
must be the ARN of the shared DB snapshot.
This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot
.
restoreDBInstanceFromS3(_:logger:on:)
public func restoreDBInstanceFromS3(_ input: RestoreDBInstanceFromS3Message, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<RestoreDBInstanceFromS3Result>
Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom.
restoreDBInstanceToPointInTime(_:logger:on:)
public func restoreDBInstanceToPointInTime(_ input: RestoreDBInstanceToPointInTimeMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<RestoreDBInstanceToPointInTimeResult>
Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.
The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.
This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime
.
revokeDBSecurityGroupIngress(_:logger:on:)
public func revokeDBSecurityGroupIngress(_ input: RevokeDBSecurityGroupIngressMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<RevokeDBSecurityGroupIngressResult>
Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).
startActivityStream(_:logger:on:)
public func startActivityStream(_ input: StartActivityStreamRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<StartActivityStreamResponse>
Starts a database activity stream to monitor activity on the database. For more information, see Database Activity Streams in the Amazon Aurora User Guide.
startDBCluster(_:logger:on:)
public func startDBCluster(_ input: StartDBClusterMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<StartDBClusterResult>
Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the StopDBCluster action.
For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
startDBInstance(_:logger:on:)
public func startDBInstance(_ input: StartDBInstanceMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<StartDBInstanceResult>
Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.
For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.
For Aurora DB clusters, use StartDBCluster
instead.
startDBInstanceAutomatedBackupsReplication(_:logger:on:)
public func startDBInstanceAutomatedBackupsReplication(_ input: StartDBInstanceAutomatedBackupsReplicationMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<StartDBInstanceAutomatedBackupsReplicationResult>
Enables replication of automated backups to a different Amazon Web Services Region.
This command doesn't apply to RDS Custom.
For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
startExportTask(_:logger:on:)
public func startExportTask(_ input: StartExportTaskMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ExportTask>
Starts an export of a snapshot to Amazon S3. The provided IAM role must have access to the S3 bucket.
This command doesn't apply to RDS Custom.
stopActivityStream(_:logger:on:)
public func stopActivityStream(_ input: StopActivityStreamRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<StopActivityStreamResponse>
Stops a database activity stream that was started using the Amazon Web Services console,
the start-activity-stream
CLI command, or the StartActivityStream
action.
For more information, see Database Activity Streams in the Amazon Aurora User Guide.
stopDBCluster(_:logger:on:)
public func stopDBCluster(_ input: StopDBClusterMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<StopDBClusterResult>
Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.
For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
stopDBInstance(_:logger:on:)
public func stopDBInstance(_ input: StopDBInstanceMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<StopDBInstanceResult>
Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary.
For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.
For Aurora clusters, use StopDBCluster
instead.
stopDBInstanceAutomatedBackupsReplication(_:logger:on:)
public func stopDBInstanceAutomatedBackupsReplication(_ input: StopDBInstanceAutomatedBackupsReplicationMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<StopDBInstanceAutomatedBackupsReplicationResult>
Stops automated backup replication for a DB instance.
This command doesn't apply to RDS Custom.
For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
describeCertificatesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeCertificatesPaginator( _ input: DescribeCertificatesMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeCertificatesMessage, CertificateMessage>
Lists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeDBClusterBacktracksPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeDBClusterBacktracksPaginator( _ input: DescribeDBClusterBacktracksMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeDBClusterBacktracksMessage, DBClusterBacktrackMessage>
Returns information about backtracks for a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora MySQL DB clusters.
describeDBClusterEndpointsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeDBClusterEndpointsPaginator( _ input: DescribeDBClusterEndpointsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeDBClusterEndpointsMessage, DBClusterEndpointMessage>
Returns information about endpoints for an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
describeDBClusterParameterGroupsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeDBClusterParameterGroupsPaginator( _ input: DescribeDBClusterParameterGroupsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeDBClusterParameterGroupsMessage, DBClusterParameterGroupsMessage>
Returns a list of
DBClusterParameterGroup
descriptions. If aDBClusterParameterGroupName
parameter is specified, the list will contain only the description of the specified DB cluster parameter group.For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeDBClusterParametersPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeDBClusterParametersPaginator( _ input: DescribeDBClusterParametersMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeDBClusterParametersMessage, DBClusterParameterGroupDetails>
Returns the detailed parameter list for a particular DB cluster parameter group.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeDBClusterSnapshotsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeDBClusterSnapshotsPaginator( _ input: DescribeDBClusterSnapshotsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeDBClusterSnapshotsMessage, DBClusterSnapshotMessage>
Returns information about DB cluster snapshots. This API action supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeDBClustersPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeDBClustersPaginator( _ input: DescribeDBClustersMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeDBClustersMessage, DBClusterMessage>
Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeDBEngineVersionsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeDBEngineVersionsPaginator( _ input: DescribeDBEngineVersionsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeDBEngineVersionsMessage, DBEngineVersionMessage>
Returns a list of the available DB engines.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeDBInstanceAutomatedBackupsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeDBInstanceAutomatedBackupsPaginator( _ input: DescribeDBInstanceAutomatedBackupsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeDBInstanceAutomatedBackupsMessage, DBInstanceAutomatedBackupMessage>
Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the
DescribeDBInstanceAutomatedBackups
andDescribeDBInstances
operations.All parameters are optional.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeDBInstancesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeDBInstancesPaginator( _ input: DescribeDBInstancesMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeDBInstancesMessage, DBInstanceMessage>
Returns information about provisioned RDS instances. This API supports pagination.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
describeDBLogFilesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeDBLogFilesPaginator( _ input: DescribeDBLogFilesMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeDBLogFilesMessage, DescribeDBLogFilesResponse>
Returns a list of DB log files for the DB instance.
This command doesn't apply to RDS Custom.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeDBParameterGroupsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeDBParameterGroupsPaginator( _ input: DescribeDBParameterGroupsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeDBParameterGroupsMessage, DBParameterGroupsMessage>
Returns a list of
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onDBParameterGroup
descriptions. If aDBParameterGroupName
is specified, the list will contain only the description of the specified DB parameter group.
describeDBParametersPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeDBParametersPaginator( _ input: DescribeDBParametersMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeDBParametersMessage, DBParameterGroupDetails>
Returns the detailed parameter list for a particular DB parameter group.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeDBProxiesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeDBProxiesPaginator( _ input: DescribeDBProxiesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeDBProxiesRequest, DescribeDBProxiesResponse>
Returns information about DB proxies.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeDBProxyEndpointsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeDBProxyEndpointsPaginator( _ input: DescribeDBProxyEndpointsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeDBProxyEndpointsRequest, DescribeDBProxyEndpointsResponse>
Returns information about DB proxy endpoints.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeDBProxyTargetGroupsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeDBProxyTargetGroupsPaginator( _ input: DescribeDBProxyTargetGroupsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeDBProxyTargetGroupsRequest, DescribeDBProxyTargetGroupsResponse>
Returns information about DB proxy target groups, represented by
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onDBProxyTargetGroup
data structures.
describeDBProxyTargetsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeDBProxyTargetsPaginator( _ input: DescribeDBProxyTargetsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeDBProxyTargetsRequest, DescribeDBProxyTargetsResponse>
Returns information about
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onDBProxyTarget
objects. This API supports pagination.
describeDBSecurityGroupsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeDBSecurityGroupsPaginator( _ input: DescribeDBSecurityGroupsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeDBSecurityGroupsMessage, DBSecurityGroupMessage>
Returns a list of
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onDBSecurityGroup
descriptions. If aDBSecurityGroupName
is specified, the list will contain only the descriptions of the specified DB security group.
describeDBSnapshotsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeDBSnapshotsPaginator( _ input: DescribeDBSnapshotsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeDBSnapshotsMessage, DBSnapshotMessage>
Returns information about DB snapshots. This API action supports pagination.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeDBSubnetGroupsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeDBSubnetGroupsPaginator( _ input: DescribeDBSubnetGroupsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeDBSubnetGroupsMessage, DBSubnetGroupMessage>
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeEngineDefaultParametersPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeEngineDefaultParametersPaginator( _ input: DescribeEngineDefaultParametersMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeEngineDefaultParametersMessage, DescribeEngineDefaultParametersResult>
Returns the default engine and system parameter information for the specified database engine.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeEventSubscriptionsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeEventSubscriptionsPaginator( _ input: DescribeEventSubscriptionsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeEventSubscriptionsMessage, EventSubscriptionsMessage>
Lists all the subscription descriptions for a customer account. The description for a subscription includes
SubscriptionName
,SNSTopicARN
,CustomerID
,SourceType
,SourceID
,CreationTime
, andStatus
.If you specify a
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onSubscriptionName
, lists the description for that subscription.
describeEventsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeEventsPaginator( _ input: DescribeEventsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeEventsMessage, EventsMessage>
Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter.
By default, RDS returns events that were generated in the past hour.
describeExportTasksPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeExportTasksPaginator( _ input: DescribeExportTasksMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeExportTasksMessage, ExportTasksMessage>
Returns information about a snapshot export to Amazon S3. This API operation supports pagination.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeGlobalClustersPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeGlobalClustersPaginator( _ input: DescribeGlobalClustersMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeGlobalClustersMessage, GlobalClustersMessage>
Returns information about Aurora global database clusters. This API supports pagination.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
describeOptionGroupOptionsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeOptionGroupOptionsPaginator( _ input: DescribeOptionGroupOptionsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeOptionGroupOptionsMessage, OptionGroupOptionsMessage>
Describes all available options.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeOptionGroupsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeOptionGroupsPaginator( _ input: DescribeOptionGroupsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeOptionGroupsMessage, OptionGroups>
Describes the available option groups.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeOrderableDBInstanceOptionsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeOrderableDBInstanceOptionsPaginator( _ input: DescribeOrderableDBInstanceOptionsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeOrderableDBInstanceOptionsMessage, OrderableDBInstanceOptionsMessage>
Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describePendingMaintenanceActionsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describePendingMaintenanceActionsPaginator( _ input: DescribePendingMaintenanceActionsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribePendingMaintenanceActionsMessage, PendingMaintenanceActionsMessage>
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeReservedDBInstancesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeReservedDBInstancesPaginator( _ input: DescribeReservedDBInstancesMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeReservedDBInstancesMessage, ReservedDBInstanceMessage>
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeReservedDBInstancesOfferingsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeReservedDBInstancesOfferingsPaginator( _ input: DescribeReservedDBInstancesOfferingsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeReservedDBInstancesOfferingsMessage, ReservedDBInstancesOfferingMessage>
Lists available reserved DB instance offerings.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeSourceRegionsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeSourceRegionsPaginator( _ input: DescribeSourceRegionsMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeSourceRegionsMessage, SourceRegionMessage>
Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from. This API action supports pagination.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
downloadDBLogFilePortionPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func downloadDBLogFilePortionPaginator( _ input: DownloadDBLogFilePortionMessage, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DownloadDBLogFilePortionMessage, DownloadDBLogFilePortionDetails>
Downloads all or a portion of the specified log file, up to 1 MB in size.
This command doesn't apply to RDS Custom.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeCertificatesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeCertificatesPaginator<Result>(
_ input: DescribeCertificatesMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, CertificateMessage, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Lists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeCertificatesPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeCertificatesPaginator(
_ input: DescribeCertificatesMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (CertificateMessage, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeDBClusterBacktracksPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeDBClusterBacktracksPaginator<Result>(
_ input: DescribeDBClusterBacktracksMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DBClusterBacktrackMessage, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns information about backtracks for a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora MySQL DB clusters.
describeDBClusterBacktracksPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeDBClusterBacktracksPaginator(
_ input: DescribeDBClusterBacktracksMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DBClusterBacktrackMessage, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeDBClusterEndpointsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeDBClusterEndpointsPaginator<Result>(
_ input: DescribeDBClusterEndpointsMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DBClusterEndpointMessage, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns information about endpoints for an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
describeDBClusterEndpointsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeDBClusterEndpointsPaginator(
_ input: DescribeDBClusterEndpointsMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DBClusterEndpointMessage, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeDBClusterParameterGroupsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeDBClusterParameterGroupsPaginator<Result>(
_ input: DescribeDBClusterParameterGroupsMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DBClusterParameterGroupsMessage, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns a list of DBClusterParameterGroup
descriptions. If a
DBClusterParameterGroupName
parameter is specified,
the list will contain only the description of the specified DB cluster parameter group.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeDBClusterParameterGroupsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeDBClusterParameterGroupsPaginator(
_ input: DescribeDBClusterParameterGroupsMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DBClusterParameterGroupsMessage, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeDBClusterParametersPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeDBClusterParametersPaginator<Result>(
_ input: DescribeDBClusterParametersMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DBClusterParameterGroupDetails, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns the detailed parameter list for a particular DB cluster parameter group.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeDBClusterParametersPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeDBClusterParametersPaginator(
_ input: DescribeDBClusterParametersMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DBClusterParameterGroupDetails, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeDBClusterSnapshotsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeDBClusterSnapshotsPaginator<Result>(
_ input: DescribeDBClusterSnapshotsMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DBClusterSnapshotMessage, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns information about DB cluster snapshots. This API action supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeDBClusterSnapshotsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeDBClusterSnapshotsPaginator(
_ input: DescribeDBClusterSnapshotsMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DBClusterSnapshotMessage, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeDBClustersPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeDBClustersPaginator<Result>(
_ input: DescribeDBClustersMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DBClusterMessage, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeDBClustersPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeDBClustersPaginator(
_ input: DescribeDBClustersMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DBClusterMessage, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeDBEngineVersionsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeDBEngineVersionsPaginator<Result>(
_ input: DescribeDBEngineVersionsMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DBEngineVersionMessage, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns a list of the available DB engines.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeDBEngineVersionsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeDBEngineVersionsPaginator(
_ input: DescribeDBEngineVersionsMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DBEngineVersionMessage, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeDBInstanceAutomatedBackupsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeDBInstanceAutomatedBackupsPaginator<Result>(
_ input: DescribeDBInstanceAutomatedBackupsMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DBInstanceAutomatedBackupMessage, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Displays backups for both current and deleted
instances. For example, use this operation to
find details about automated backups for previously deleted instances. Current instances
with retention periods greater than zero (0) are returned for both the
DescribeDBInstanceAutomatedBackups
and
DescribeDBInstances
operations.
All parameters are optional.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeDBInstanceAutomatedBackupsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeDBInstanceAutomatedBackupsPaginator(
_ input: DescribeDBInstanceAutomatedBackupsMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DBInstanceAutomatedBackupMessage, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeDBInstancesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeDBInstancesPaginator<Result>(
_ input: DescribeDBInstancesMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DBInstanceMessage, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns information about provisioned RDS instances. This API supports pagination.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
describeDBInstancesPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeDBInstancesPaginator(
_ input: DescribeDBInstancesMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DBInstanceMessage, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeDBLogFilesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeDBLogFilesPaginator<Result>(
_ input: DescribeDBLogFilesMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeDBLogFilesResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns a list of DB log files for the DB instance.
This command doesn't apply to RDS Custom.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeDBLogFilesPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeDBLogFilesPaginator(
_ input: DescribeDBLogFilesMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeDBLogFilesResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeDBParameterGroupsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeDBParameterGroupsPaginator<Result>(
_ input: DescribeDBParameterGroupsMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DBParameterGroupsMessage, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns a list of DBParameterGroup
descriptions. If a DBParameterGroupName
is specified,
the list will contain only the description of the specified DB parameter group.
describeDBParameterGroupsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeDBParameterGroupsPaginator(
_ input: DescribeDBParameterGroupsMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DBParameterGroupsMessage, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeDBParametersPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeDBParametersPaginator<Result>(
_ input: DescribeDBParametersMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DBParameterGroupDetails, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns the detailed parameter list for a particular DB parameter group.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeDBParametersPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeDBParametersPaginator(
_ input: DescribeDBParametersMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DBParameterGroupDetails, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeDBProxiesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeDBProxiesPaginator<Result>(
_ input: DescribeDBProxiesRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeDBProxiesResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns information about DB proxies.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeDBProxiesPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeDBProxiesPaginator(
_ input: DescribeDBProxiesRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeDBProxiesResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeDBProxyEndpointsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeDBProxyEndpointsPaginator<Result>(
_ input: DescribeDBProxyEndpointsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeDBProxyEndpointsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns information about DB proxy endpoints.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeDBProxyEndpointsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeDBProxyEndpointsPaginator(
_ input: DescribeDBProxyEndpointsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeDBProxyEndpointsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeDBProxyTargetGroupsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeDBProxyTargetGroupsPaginator<Result>(
_ input: DescribeDBProxyTargetGroupsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeDBProxyTargetGroupsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns information about DB proxy target groups, represented by DBProxyTargetGroup
data structures.
describeDBProxyTargetGroupsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeDBProxyTargetGroupsPaginator(
_ input: DescribeDBProxyTargetGroupsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeDBProxyTargetGroupsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeDBProxyTargetsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeDBProxyTargetsPaginator<Result>(
_ input: DescribeDBProxyTargetsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeDBProxyTargetsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns information about DBProxyTarget
objects. This API supports pagination.
describeDBProxyTargetsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeDBProxyTargetsPaginator(
_ input: DescribeDBProxyTargetsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeDBProxyTargetsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeDBSecurityGroupsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeDBSecurityGroupsPaginator<Result>(
_ input: DescribeDBSecurityGroupsMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DBSecurityGroupMessage, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns a list of DBSecurityGroup
descriptions. If a DBSecurityGroupName
is specified,
the list will contain only the descriptions of the specified DB security group.
describeDBSecurityGroupsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeDBSecurityGroupsPaginator(
_ input: DescribeDBSecurityGroupsMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DBSecurityGroupMessage, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeDBSnapshotsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeDBSnapshotsPaginator<Result>(
_ input: DescribeDBSnapshotsMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DBSnapshotMessage, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns information about DB snapshots. This API action supports pagination.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeDBSnapshotsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeDBSnapshotsPaginator(
_ input: DescribeDBSnapshotsMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DBSnapshotMessage, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeDBSubnetGroupsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeDBSubnetGroupsPaginator<Result>(
_ input: DescribeDBSubnetGroupsMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DBSubnetGroupMessage, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeDBSubnetGroupsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeDBSubnetGroupsPaginator(
_ input: DescribeDBSubnetGroupsMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DBSubnetGroupMessage, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeEngineDefaultParametersPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeEngineDefaultParametersPaginator<Result>(
_ input: DescribeEngineDefaultParametersMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeEngineDefaultParametersResult, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns the default engine and system parameter information for the specified database engine.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeEngineDefaultParametersPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeEngineDefaultParametersPaginator(
_ input: DescribeEngineDefaultParametersMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeEngineDefaultParametersResult, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeEventSubscriptionsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeEventSubscriptionsPaginator<Result>(
_ input: DescribeEventSubscriptionsMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, EventSubscriptionsMessage, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Lists all the subscription descriptions for a customer account. The description for a subscription includes
SubscriptionName
, SNSTopicARN
, CustomerID
, SourceType
, SourceID
, CreationTime
, and Status
.
If you specify a SubscriptionName
, lists the description for that subscription.
describeEventSubscriptionsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeEventSubscriptionsPaginator(
_ input: DescribeEventSubscriptionsMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (EventSubscriptionsMessage, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeEventsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeEventsPaginator<Result>(
_ input: DescribeEventsMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, EventsMessage, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter.
By default, RDS returns events that were generated in the past hour.
describeEventsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeEventsPaginator(
_ input: DescribeEventsMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (EventsMessage, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeExportTasksPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeExportTasksPaginator<Result>(
_ input: DescribeExportTasksMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ExportTasksMessage, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns information about a snapshot export to Amazon S3. This API operation supports pagination.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeExportTasksPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeExportTasksPaginator(
_ input: DescribeExportTasksMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ExportTasksMessage, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeGlobalClustersPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeGlobalClustersPaginator<Result>(
_ input: DescribeGlobalClustersMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, GlobalClustersMessage, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns information about Aurora global database clusters. This API supports pagination.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
describeGlobalClustersPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeGlobalClustersPaginator(
_ input: DescribeGlobalClustersMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (GlobalClustersMessage, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeOptionGroupOptionsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeOptionGroupOptionsPaginator<Result>(
_ input: DescribeOptionGroupOptionsMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, OptionGroupOptionsMessage, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Describes all available options.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeOptionGroupOptionsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeOptionGroupOptionsPaginator(
_ input: DescribeOptionGroupOptionsMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (OptionGroupOptionsMessage, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeOptionGroupsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeOptionGroupsPaginator<Result>(
_ input: DescribeOptionGroupsMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, OptionGroups, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Describes the available option groups.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeOptionGroupsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeOptionGroupsPaginator(
_ input: DescribeOptionGroupsMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (OptionGroups, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeOrderableDBInstanceOptionsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeOrderableDBInstanceOptionsPaginator<Result>(
_ input: DescribeOrderableDBInstanceOptionsMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, OrderableDBInstanceOptionsMessage, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeOrderableDBInstanceOptionsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeOrderableDBInstanceOptionsPaginator(
_ input: DescribeOrderableDBInstanceOptionsMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (OrderableDBInstanceOptionsMessage, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describePendingMaintenanceActionsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describePendingMaintenanceActionsPaginator<Result>(
_ input: DescribePendingMaintenanceActionsMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, PendingMaintenanceActionsMessage, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describePendingMaintenanceActionsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describePendingMaintenanceActionsPaginator(
_ input: DescribePendingMaintenanceActionsMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (PendingMaintenanceActionsMessage, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeReservedDBInstancesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeReservedDBInstancesPaginator<Result>(
_ input: DescribeReservedDBInstancesMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ReservedDBInstanceMessage, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeReservedDBInstancesPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeReservedDBInstancesPaginator(
_ input: DescribeReservedDBInstancesMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ReservedDBInstanceMessage, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeReservedDBInstancesOfferingsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeReservedDBInstancesOfferingsPaginator<Result>(
_ input: DescribeReservedDBInstancesOfferingsMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ReservedDBInstancesOfferingMessage, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Lists available reserved DB instance offerings.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeReservedDBInstancesOfferingsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeReservedDBInstancesOfferingsPaginator(
_ input: DescribeReservedDBInstancesOfferingsMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ReservedDBInstancesOfferingMessage, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeSourceRegionsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeSourceRegionsPaginator<Result>(
_ input: DescribeSourceRegionsMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, SourceRegionMessage, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from. This API action supports pagination.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeSourceRegionsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeSourceRegionsPaginator(
_ input: DescribeSourceRegionsMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (SourceRegionMessage, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.downloadDBLogFilePortionPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func downloadDBLogFilePortionPaginator<Result>(
_ input: DownloadDBLogFilePortionMessage,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DownloadDBLogFilePortionDetails, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Downloads all or a portion of the specified log file, up to 1 MB in size.
This command doesn't apply to RDS Custom.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.downloadDBLogFilePortionPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func downloadDBLogFilePortionPaginator(
_ input: DownloadDBLogFilePortionMessage,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DownloadDBLogFilePortionDetails, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.waitUntilDBClusterSnapshotAvailable(_:maxWaitTime:logger:on:)
public func waitUntilDBClusterSnapshotAvailable(
_ input: DescribeDBClusterSnapshotsMessage,
maxWaitTime: TimeAmount? = nil,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil
) -> EventLoopFuture<Void>
waitUntilDBClusterSnapshotDeleted(_:maxWaitTime:logger:on:)
public func waitUntilDBClusterSnapshotDeleted(
_ input: DescribeDBClusterSnapshotsMessage,
maxWaitTime: TimeAmount? = nil,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil
) -> EventLoopFuture<Void>
waitUntilDBInstanceAvailable(_:maxWaitTime:logger:on:)
public func waitUntilDBInstanceAvailable(
_ input: DescribeDBInstancesMessage,
maxWaitTime: TimeAmount? = nil,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil
) -> EventLoopFuture<Void>
waitUntilDBInstanceDeleted(_:maxWaitTime:logger:on:)
public func waitUntilDBInstanceDeleted(
_ input: DescribeDBInstancesMessage,
maxWaitTime: TimeAmount? = nil,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil
) -> EventLoopFuture<Void>
waitUntilDBSnapshotAvailable(_:maxWaitTime:logger:on:)
public func waitUntilDBSnapshotAvailable(
_ input: DescribeDBSnapshotsMessage,
maxWaitTime: TimeAmount? = nil,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil
) -> EventLoopFuture<Void>
waitUntilDBSnapshotDeleted(_:maxWaitTime:logger:on:)
public func waitUntilDBSnapshotDeleted(
_ input: DescribeDBSnapshotsMessage,
maxWaitTime: TimeAmount? = nil,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil
) -> EventLoopFuture<Void>