RDS

public struct RDS

Client object for interacting with AWS RDS service.

Amazon Relational Database Service Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique. Amazon RDS gives you access to the capabilities of a MySQL, 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. 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. Amazon RDS API Reference For the alphabetical list of API actions, see API Actions. For the alphabetical list of data types, see Data Types. For a list of common query parameters, see Common Parameters. For descriptions of the error codes, see Common Errors. Amazon RDS User Guide For a summary of the Amazon RDS interfaces, see Available RDS Interfaces. For more information about how to use the Query API, see Using the Query API.

Member variables

Initialization

  • Initialize the RDS client

    Declaration

    Swift

    public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

    Parameters

    accessKeyId

    Public access key provided by AWS
    secretAccessKey

    Private access key provided by AWS
    sessionToken

    Token provided by STS.AssumeRole() which allows access to another AWS account
    region

    Region of server you want to communicate with
    endpoint

    Custom endpoint URL to use instead of standard AWS servers
    middlewares

    Array of middlewares to apply to requests and responses
    eventLoopGroupProvider

    EventLoopGroup to use. Use useAWSClientShared if the client shall manage its own EventLoopGroup.

API Calls

  • Associates an Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.

    Declaration

    Swift

    @discardableResult
public func addRoleToDBCluster(_ input: AddRoleToDBClusterMessage) -> EventLoopFuture<Void>

  • Associates an AWS 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.

    Declaration

    Swift

    @discardableResult
public func addRoleToDBInstance(_ input: AddRoleToDBInstanceMessage) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    public func addSourceIdentifierToSubscription(_ input: AddSourceIdentifierToSubscriptionMessage) -> EventLoopFuture<AddSourceIdentifierToSubscriptionResult>

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

    Declaration

    Swift

    @discardableResult
public func addTagsToResource(_ input: AddTagsToResourceMessage) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    public func applyPendingMaintenanceAction(_ input: ApplyPendingMaintenanceActionMessage) -> EventLoopFuture<ApplyPendingMaintenanceActionResult>

  • 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 AWS 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.

    Declaration

    Swift

    public func authorizeDBSecurityGroupIngress(_ input: AuthorizeDBSecurityGroupIngressMessage) -> EventLoopFuture<AuthorizeDBSecurityGroupIngressResult>

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

    Declaration

    Swift

    public func backtrackDBCluster(_ input: BacktrackDBClusterMessage) -> EventLoopFuture<DBClusterBacktrack>

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

    Declaration

    Swift

    public func cancelExportTask(_ input: CancelExportTaskMessage) -> EventLoopFuture<ExportTask>

  • Copies the specified DB cluster parameter group. This action only applies to Aurora DB clusters.

    Declaration

    Swift

    public func copyDBClusterParameterGroup(_ input: CopyDBClusterParameterGroupMessage) -> EventLoopFuture<CopyDBClusterParameterGroupResult>

  • 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 AWS Region. In that case, the AWS Region where you call the CopyDBClusterSnapshot action is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the following values: KmsKeyId - The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source AWS Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the AWS 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 AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier 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 (AWS Signature Version 4) and Signature Version 4 Signing Process. If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or –source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region. TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination AWS 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 AWS Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL. To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in “copying” status. For more information on copying encrypted DB cluster snapshots from one AWS Region to another, see Copying a Snapshot in the Amazon Aurora User Guide. 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.

    Declaration

    Swift

    public func copyDBClusterSnapshot(_ input: CopyDBClusterSnapshotMessage) -> EventLoopFuture<CopyDBClusterSnapshotResult>

  • Copies the specified DB parameter group.

    Declaration

    Swift

    public func copyDBParameterGroup(_ input: CopyDBParameterGroupMessage) -> EventLoopFuture<CopyDBParameterGroupResult>

  • Copies the specified DB snapshot. The source DB snapshot must be in the “available” state. You can copy a snapshot from one AWS Region to another. In that case, the AWS Region where you call the CopyDBSnapshot action is the destination AWS Region for the DB snapshot copy. For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.

    Declaration

    Swift

    public func copyDBSnapshot(_ input: CopyDBSnapshotMessage) -> EventLoopFuture<CopyDBSnapshotResult>

  • Copies the specified option group.

    Declaration

    Swift

    public func copyOptionGroup(_ input: CopyOptionGroupMessage) -> EventLoopFuture<CopyOptionGroupResult>

  • Creates a custom Availability Zone (AZ). A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster. For more information about RDS on VMware, see the RDS on VMware User Guide.

    Declaration

    Swift

    public func createCustomAvailabilityZone(_ input: CreateCustomAvailabilityZoneMessage) -> EventLoopFuture<CreateCustomAvailabilityZoneResult>

  • Creates a new Amazon Aurora DB cluster. You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a read replica of another DB cluster or Amazon RDS MySQL DB instance. For cross-region replication where the DB cluster identified by ReplicationSourceIdentifier is encrypted, you must also specify the PreSignedUrl parameter. 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.

    Declaration

    Swift

    public func createDBCluster(_ input: CreateDBClusterMessage) -> EventLoopFuture<CreateDBClusterResult>

  • Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.

    Declaration

    Swift

    public func createDBClusterEndpoint(_ input: CreateDBClusterEndpointMessage) -> EventLoopFuture<DBClusterEndpoint>

  • Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you’ve created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters 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. This action only applies to Aurora DB clusters.

    Declaration

    Swift

    public func createDBClusterParameterGroup(_ input: CreateDBClusterParameterGroupMessage) -> EventLoopFuture<CreateDBClusterParameterGroupResult>

  • Creates a snapshot of 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 DB clusters.

    Declaration

    Swift

    public func createDBClusterSnapshot(_ input: CreateDBClusterSnapshotMessage) -> EventLoopFuture<CreateDBClusterSnapshotResult>

  • Creates a new DB instance.

    Declaration

    Swift

    public func createDBInstance(_ input: CreateDBInstanceMessage) -> EventLoopFuture<CreateDBInstanceResult>

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

    Declaration

    Swift

    public func createDBInstanceReadReplica(_ input: CreateDBInstanceReadReplicaMessage) -> EventLoopFuture<CreateDBInstanceReadReplicaResult>

  • Creates a new DB parameter group. A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you’ve created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect. After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

    Declaration

    Swift

    public func createDBParameterGroup(_ input: CreateDBParameterGroupMessage) -> EventLoopFuture<CreateDBParameterGroupResult>

  • Creates a new DB proxy.

    Declaration

    Swift

    public func createDBProxy(_ input: CreateDBProxyRequest) -> EventLoopFuture<CreateDBProxyResponse>

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

    Declaration

    Swift

    public func createDBSecurityGroup(_ input: CreateDBSecurityGroupMessage) -> EventLoopFuture<CreateDBSecurityGroupResult>

  • Creates a DBSnapshot. The source DBInstance must be in “available” state.

    Declaration

    Swift

    public func createDBSnapshot(_ input: CreateDBSnapshotMessage) -> EventLoopFuture<CreateDBSnapshotResult>

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

    Declaration

    Swift

    public func createDBSubnetGroup(_ input: CreateDBSubnetGroupMessage) -> EventLoopFuture<CreateDBSubnetGroupResult>

  • 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 SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, 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 SourceIdentifier, 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.

    Declaration

    Swift

    public func createEventSubscription(_ input: CreateEventSubscriptionMessage) -> EventLoopFuture<CreateEventSubscriptionResult>

  • Creates an Aurora global database spread across multiple 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.

    Declaration

    Swift

    public func createGlobalCluster(_ input: CreateGlobalClusterMessage) -> EventLoopFuture<CreateGlobalClusterResult>

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

    Declaration

    Swift

    public func createOptionGroup(_ input: CreateOptionGroupMessage) -> EventLoopFuture<CreateOptionGroupResult>

  • Deletes a custom Availability Zone (AZ). A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster. For more information about RDS on VMware, see the RDS on VMware User Guide.

    Declaration

    Swift

    public func deleteCustomAvailabilityZone(_ input: DeleteCustomAvailabilityZoneMessage) -> EventLoopFuture<DeleteCustomAvailabilityZoneResult>

  • 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. This action only applies to Aurora DB clusters.

    Declaration

    Swift

    public func deleteDBCluster(_ input: DeleteDBClusterMessage) -> EventLoopFuture<DeleteDBClusterResult>

  • Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.

    Declaration

    Swift

    public func deleteDBClusterEndpoint(_ input: DeleteDBClusterEndpointMessage) -> EventLoopFuture<DBClusterEndpoint>

  • 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. This action only applies to Aurora DB clusters.

    Declaration

    Swift

    @discardableResult
public func deleteDBClusterParameterGroup(_ input: DeleteDBClusterParameterGroupMessage) -> EventLoopFuture<Void>

  • 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. This action only applies to Aurora DB clusters.

    Declaration

    Swift

    public func deleteDBClusterSnapshot(_ input: DeleteDBClusterSnapshotMessage) -> EventLoopFuture<DeleteDBClusterSnapshotResult>

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

    Declaration

    Swift

    public func deleteDBInstance(_ input: DeleteDBInstanceMessage) -> EventLoopFuture<DeleteDBInstanceResult>

  • Deletes automated backups based on the source instance’s DbiResourceId value or the restorable instance’s resource ID.

    Declaration

    Swift

    public func deleteDBInstanceAutomatedBackup(_ input: DeleteDBInstanceAutomatedBackupMessage) -> EventLoopFuture<DeleteDBInstanceAutomatedBackupResult>

  • Deletes a specified DB parameter group. The DB parameter group to be deleted can’t be associated with any DB instances.

    Declaration

    Swift

    @discardableResult
public func deleteDBParameterGroup(_ input: DeleteDBParameterGroupMessage) -> EventLoopFuture<Void>

  • Deletes an existing proxy.

    Declaration

    Swift

    public func deleteDBProxy(_ input: DeleteDBProxyRequest) -> EventLoopFuture<DeleteDBProxyResponse>

  • Deletes a DB security group. The specified DB security group must not be associated with any DB instances.

    Declaration

    Swift

    @discardableResult
public func deleteDBSecurityGroup(_ input: DeleteDBSecurityGroupMessage) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    public func deleteDBSnapshot(_ input: DeleteDBSnapshotMessage) -> EventLoopFuture<DeleteDBSnapshotResult>

  • Deletes a DB subnet group. The specified database subnet group must not be associated with any DB instances.

    Declaration

    Swift

    @discardableResult
public func deleteDBSubnetGroup(_ input: DeleteDBSubnetGroupMessage) -> EventLoopFuture<Void>

  • Deletes an RDS event notification subscription.

    Declaration

    Swift

    public func deleteEventSubscription(_ input: DeleteEventSubscriptionMessage) -> EventLoopFuture<DeleteEventSubscriptionResult>

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

    Declaration

    Swift

    public func deleteGlobalCluster(_ input: DeleteGlobalClusterMessage) -> EventLoopFuture<DeleteGlobalClusterResult>

  • Deletes the installation medium for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.

    Declaration

    Swift

    public func deleteInstallationMedia(_ input: DeleteInstallationMediaMessage) -> EventLoopFuture<InstallationMedia>

  • Deletes an existing option group.

    Declaration

    Swift

    @discardableResult
public func deleteOptionGroup(_ input: DeleteOptionGroupMessage) -> EventLoopFuture<Void>

  • Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.

    Declaration

    Swift

    public func deregisterDBProxyTargets(_ input: DeregisterDBProxyTargetsRequest) -> EventLoopFuture<DeregisterDBProxyTargetsResponse>

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

    Declaration

    Swift

    public func describeAccountAttributes(_ input: DescribeAccountAttributesMessage) -> EventLoopFuture<AccountAttributesMessage>

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

    Declaration

    Swift

    public func describeCertificates(_ input: DescribeCertificatesMessage) -> EventLoopFuture<CertificateMessage>

  • Returns information about custom Availability Zones (AZs). A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster. For more information about RDS on VMware, see the RDS on VMware User Guide.

    Declaration

    Swift

    public func describeCustomAvailabilityZones(_ input: DescribeCustomAvailabilityZonesMessage) -> EventLoopFuture<CustomAvailabilityZoneMessage>

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

    Declaration

    Swift

    public func describeDBClusterBacktracks(_ input: DescribeDBClusterBacktracksMessage) -> EventLoopFuture<DBClusterBacktrackMessage>

  • Returns information about endpoints for an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.

    Declaration

    Swift

    public func describeDBClusterEndpoints(_ input: DescribeDBClusterEndpointsMessage) -> EventLoopFuture<DBClusterEndpointMessage>

  • 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. This action only applies to Aurora DB clusters.

    Declaration

    Swift

    public func describeDBClusterParameterGroups(_ input: DescribeDBClusterParameterGroupsMessage) -> EventLoopFuture<DBClusterParameterGroupsMessage>

  • 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. This action only applies to Aurora DB clusters.

    Declaration

    Swift

    public func describeDBClusterParameters(_ input: DescribeDBClusterParametersMessage) -> EventLoopFuture<DBClusterParameterGroupDetails>

  • Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot. When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS 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 AWS accounts. To add or remove access for an AWS 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. This action only applies to Aurora DB clusters.

    Declaration

    Swift

    public func describeDBClusterSnapshotAttributes(_ input: DescribeDBClusterSnapshotAttributesMessage) -> EventLoopFuture<DescribeDBClusterSnapshotAttributesResult>

  • Returns information about DB cluster snapshots. This API action 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.

    Declaration

    Swift

    public func describeDBClusterSnapshots(_ input: DescribeDBClusterSnapshotsMessage) -> EventLoopFuture<DBClusterSnapshotMessage>

  • Returns information about provisioned Aurora DB clusters. This API supports pagination. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

    Declaration

    Swift

    public func describeDBClusters(_ input: DescribeDBClustersMessage) -> EventLoopFuture<DBClusterMessage>

  • Returns a list of the available DB engines.

    Declaration

    Swift

    public func describeDBEngineVersions(_ input: DescribeDBEngineVersionsMessage) -> EventLoopFuture<DBEngineVersionMessage>

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

    Declaration

    Swift

    public func describeDBInstanceAutomatedBackups(_ input: DescribeDBInstanceAutomatedBackupsMessage) -> EventLoopFuture<DBInstanceAutomatedBackupMessage>

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

    Declaration

    Swift

    public func describeDBInstances(_ input: DescribeDBInstancesMessage) -> EventLoopFuture<DBInstanceMessage>

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

    Declaration

    Swift

    public func describeDBLogFiles(_ input: DescribeDBLogFilesMessage) -> EventLoopFuture<DescribeDBLogFilesResponse>

  • Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

    Declaration

    Swift

    public func describeDBParameterGroups(_ input: DescribeDBParameterGroupsMessage) -> EventLoopFuture<DBParameterGroupsMessage>

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

    Declaration

    Swift

    public func describeDBParameters(_ input: DescribeDBParametersMessage) -> EventLoopFuture<DBParameterGroupDetails>

  • Returns information about DB proxies.

    Declaration

    Swift

    public func describeDBProxies(_ input: DescribeDBProxiesRequest) -> EventLoopFuture<DescribeDBProxiesResponse>

  • Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.

    Declaration

    Swift

    public func describeDBProxyTargetGroups(_ input: DescribeDBProxyTargetGroupsRequest) -> EventLoopFuture<DescribeDBProxyTargetGroupsResponse>

  • Returns information about DBProxyTarget objects. This API supports pagination.

    Declaration

    Swift

    public func describeDBProxyTargets(_ input: DescribeDBProxyTargetsRequest) -> EventLoopFuture<DescribeDBProxyTargetsResponse>

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

    Declaration

    Swift

    public func describeDBSecurityGroups(_ input: DescribeDBSecurityGroupsMessage) -> EventLoopFuture<DBSecurityGroupMessage>

  • Returns a list of DB snapshot attribute names and values for a manual DB snapshot. When sharing snapshots with other AWS accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the AWS 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 AWS accounts. To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.

    Declaration

    Swift

    public func describeDBSnapshotAttributes(_ input: DescribeDBSnapshotAttributesMessage) -> EventLoopFuture<DescribeDBSnapshotAttributesResult>

  • Returns information about DB snapshots. This API action supports pagination.

    Declaration

    Swift

    public func describeDBSnapshots(_ input: DescribeDBSnapshotsMessage) -> EventLoopFuture<DBSnapshotMessage>

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

    Declaration

    Swift

    public func describeDBSubnetGroups(_ input: DescribeDBSubnetGroupsMessage) -> EventLoopFuture<DBSubnetGroupMessage>

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

    Declaration

    Swift

    public func describeEngineDefaultClusterParameters(_ input: DescribeEngineDefaultClusterParametersMessage) -> EventLoopFuture<DescribeEngineDefaultClusterParametersResult>

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

    Declaration

    Swift

    public func describeEngineDefaultParameters(_ input: DescribeEngineDefaultParametersMessage) -> EventLoopFuture<DescribeEngineDefaultParametersResult>

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

    Declaration

    Swift

    public func describeEventCategories(_ input: DescribeEventCategoriesMessage) -> EventLoopFuture<EventCategoriesMessage>

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

    Declaration

    Swift

    public func describeEventSubscriptions(_ input: DescribeEventSubscriptionsMessage) -> EventLoopFuture<EventSubscriptionsMessage>

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

    Declaration

    Swift

    public func describeEvents(_ input: DescribeEventsMessage) -> EventLoopFuture<EventsMessage>

  • Returns information about a snapshot export to Amazon S3. This API operation supports pagination.

    Declaration

    Swift

    public func describeExportTasks(_ input: DescribeExportTasksMessage) -> EventLoopFuture<ExportTasksMessage>

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

    Declaration

    Swift

    public func describeGlobalClusters(_ input: DescribeGlobalClustersMessage) -> EventLoopFuture<GlobalClustersMessage>

  • Describes the available installation media for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.

    Declaration

    Swift

    public func describeInstallationMedia(_ input: DescribeInstallationMediaMessage) -> EventLoopFuture<InstallationMediaMessage>

  • Describes all available options.

    Declaration

    Swift

    public func describeOptionGroupOptions(_ input: DescribeOptionGroupOptionsMessage) -> EventLoopFuture<OptionGroupOptionsMessage>

  • Describes the available option groups.

    Declaration

    Swift

    public func describeOptionGroups(_ input: DescribeOptionGroupsMessage) -> EventLoopFuture<OptionGroups>

  • Returns a list of orderable DB instance options for the specified engine.

    Declaration

    Swift

    public func describeOrderableDBInstanceOptions(_ input: DescribeOrderableDBInstanceOptionsMessage) -> EventLoopFuture<OrderableDBInstanceOptionsMessage>

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

    Declaration

    Swift

    public func describePendingMaintenanceActions(_ input: DescribePendingMaintenanceActionsMessage) -> EventLoopFuture<PendingMaintenanceActionsMessage>

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

    Declaration

    Swift

    public func describeReservedDBInstances(_ input: DescribeReservedDBInstancesMessage) -> EventLoopFuture<ReservedDBInstanceMessage>

  • Lists available reserved DB instance offerings.

    Declaration

    Swift

    public func describeReservedDBInstancesOfferings(_ input: DescribeReservedDBInstancesOfferingsMessage) -> EventLoopFuture<ReservedDBInstancesOfferingMessage>

  • Returns a list of the source AWS Regions where the current AWS Region can create a read replica or copy a DB snapshot from. This API action supports pagination.

    Declaration

    Swift

    public func describeSourceRegions(_ input: DescribeSourceRegionsMessage) -> EventLoopFuture<SourceRegionMessage>

  • You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.

    Declaration

    Swift

    public func describeValidDBInstanceModifications(_ input: DescribeValidDBInstanceModificationsMessage) -> EventLoopFuture<DescribeValidDBInstanceModificationsResult>

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

    Declaration

    Swift

    public func downloadDBLogFilePortion(_ input: DownloadDBLogFilePortionMessage) -> EventLoopFuture<DownloadDBLogFilePortionDetails>

  • Forces a failover for a DB cluster. A failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer). Amazon Aurora will automatically fail over to an Aurora Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.

    Declaration

    Swift

    public func failoverDBCluster(_ input: FailoverDBClusterMessage) -> EventLoopFuture<FailoverDBClusterResult>

  • Imports the installation media for a DB engine that requires an on-premises customer provided license, such as SQL Server.

    Declaration

    Swift

    public func importInstallationMedia(_ input: ImportInstallationMediaMessage) -> EventLoopFuture<InstallationMedia>

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

    Declaration

    Swift

    public func listTagsForResource(_ input: ListTagsForResourceMessage) -> EventLoopFuture<TagListMessage>

  • Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances temporarily, 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 AWS Region. RDS has already moved to a new default CA certificate for the specified AWS 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.

    Declaration

    Swift

    public func modifyCertificates(_ input: ModifyCertificatesMessage) -> EventLoopFuture<ModifyCertificatesResult>

  • Set the capacity of an Aurora Serverless DB cluster to a specific value. Aurora Serverless 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 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, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide. If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.

    Declaration

    Swift

    public func modifyCurrentDBClusterCapacity(_ input: ModifyCurrentDBClusterCapacityMessage) -> EventLoopFuture<DBClusterCapacityInfo>

  • Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.

    Declaration

    Swift

    public func modifyDBCluster(_ input: ModifyDBClusterMessage) -> EventLoopFuture<ModifyDBClusterResult>

  • Modifies the properties of an endpoint in an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.

    Declaration

    Swift

    public func modifyDBClusterEndpoint(_ input: ModifyDBClusterEndpointMessage) -> EventLoopFuture<DBClusterEndpoint>

  • Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters 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 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. This action only applies to Aurora DB clusters.

    Declaration

    Swift

    public func modifyDBClusterParameterGroup(_ input: ModifyDBClusterParameterGroupMessage) -> EventLoopFuture<DBClusterParameterGroupNameMessage>

  • 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 AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS 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 AWS 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 AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can’t use all as a value for that parameter in this case. To view which AWS accounts have access to copy or restore a manual DB 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. This action only applies to Aurora DB clusters.

    Declaration

    Swift

    public func modifyDBClusterSnapshotAttribute(_ input: ModifyDBClusterSnapshotAttributeMessage) -> EventLoopFuture<ModifyDBClusterSnapshotAttributeResult>

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

    Declaration

    Swift

    public func modifyDBInstance(_ input: ModifyDBInstanceMessage) -> EventLoopFuture<ModifyDBInstanceResult>

  • Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect. After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

    Declaration

    Swift

    public func modifyDBParameterGroup(_ input: ModifyDBParameterGroupMessage) -> EventLoopFuture<DBParameterGroupNameMessage>

  • Changes the settings for an existing DB proxy.

    Declaration

    Swift

    public func modifyDBProxy(_ input: ModifyDBProxyRequest) -> EventLoopFuture<ModifyDBProxyResponse>

  • Modifies the properties of a DBProxyTargetGroup.

    Declaration

    Swift

    public func modifyDBProxyTargetGroup(_ input: ModifyDBProxyTargetGroupRequest) -> EventLoopFuture<ModifyDBProxyTargetGroupResponse>

  • Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public. Amazon RDS supports upgrading DB snapshots for MySQL, Oracle, and PostgreSQL.

    Declaration

    Swift

    public func modifyDBSnapshot(_ input: ModifyDBSnapshotMessage) -> EventLoopFuture<ModifyDBSnapshotResult>

  • 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 AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS 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 AWS accounts. Don’t add the all value for any manual DB snapshots that contain private information that you don’t want available to all AWS accounts. If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can’t use all as a value for that parameter in this case. To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action. The accounts are returned as values for the restore attribute.

    Declaration

    Swift

    public func modifyDBSnapshotAttribute(_ input: ModifyDBSnapshotAttributeMessage) -> EventLoopFuture<ModifyDBSnapshotAttributeResult>

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

    Declaration

    Swift

    public func modifyDBSubnetGroup(_ input: ModifyDBSubnetGroupMessage) -> EventLoopFuture<ModifyDBSubnetGroupResult>

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

    Declaration

    Swift

    public func modifyEventSubscription(_ input: ModifyEventSubscriptionMessage) -> EventLoopFuture<ModifyEventSubscriptionResult>

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

    Declaration

    Swift

    public func modifyGlobalCluster(_ input: ModifyGlobalClusterMessage) -> EventLoopFuture<ModifyGlobalClusterResult>

  • Modifies an existing option group.

    Declaration

    Swift

    public func modifyOptionGroup(_ input: ModifyOptionGroupMessage) -> EventLoopFuture<ModifyOptionGroupResult>

  • 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 and Aurora PostgreSQL.

    Declaration

    Swift

    public func promoteReadReplica(_ input: PromoteReadReplicaMessage) -> EventLoopFuture<PromoteReadReplicaResult>

  • Promotes a read replica DB cluster to a standalone DB cluster. This action only applies to Aurora DB clusters.

    Declaration

    Swift

    public func promoteReadReplicaDBCluster(_ input: PromoteReadReplicaDBClusterMessage) -> EventLoopFuture<PromoteReadReplicaDBClusterResult>

  • Purchases a reserved DB instance offering.

    Declaration

    Swift

    public func purchaseReservedDBInstancesOffering(_ input: PurchaseReservedDBInstancesOfferingMessage) -> EventLoopFuture<PurchaseReservedDBInstancesOfferingResult>

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

    Declaration

    Swift

    public func rebootDBInstance(_ input: RebootDBInstanceMessage) -> EventLoopFuture<RebootDBInstanceResult>

  • Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.

    Declaration

    Swift

    public func registerDBProxyTargets(_ input: RegisterDBProxyTargetsRequest) -> EventLoopFuture<RegisterDBProxyTargetsResponse>

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

    Declaration

    Swift

    public func removeFromGlobalCluster(_ input: RemoveFromGlobalClusterMessage) -> EventLoopFuture<RemoveFromGlobalClusterResult>

  • Disassociates an AWS Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.

    Declaration

    Swift

    @discardableResult
public func removeRoleFromDBCluster(_ input: RemoveRoleFromDBClusterMessage) -> EventLoopFuture<Void>

  • Disassociates an AWS Identity and Access Management (IAM) role from a DB instance.

    Declaration

    Swift

    @discardableResult
public func removeRoleFromDBInstance(_ input: RemoveRoleFromDBInstanceMessage) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    public func removeSourceIdentifierFromSubscription(_ input: RemoveSourceIdentifierFromSubscriptionMessage) -> EventLoopFuture<RemoveSourceIdentifierFromSubscriptionResult>

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

    Declaration

    Swift

    @discardableResult
public func removeTagsFromResource(_ input: RemoveTagsFromResourceMessage) -> EventLoopFuture<Void>

  • Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.

    Declaration

    Swift

    public func resetDBClusterParameterGroup(_ input: ResetDBClusterParameterGroupMessage) -> EventLoopFuture<DBClusterParameterGroupNameMessage>

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

    Declaration

    Swift

    public func resetDBParameterGroup(_ input: ResetDBParameterGroupMessage) -> EventLoopFuture<DBParameterGroupNameMessage>

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

    Declaration

    Swift

    public func restoreDBClusterFromS3(_ input: RestoreDBClusterFromS3Message) -> EventLoopFuture<RestoreDBClusterFromS3Result>

  • Creates a new DB cluster from a DB snapshot or DB cluster snapshot. This action only applies to Aurora DB clusters. 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, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.

    Declaration

    Swift

    public func restoreDBClusterFromSnapshot(_ input: RestoreDBClusterFromSnapshotMessage) -> EventLoopFuture<RestoreDBClusterFromSnapshotResult>

  • 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. 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, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.

    Declaration

    Swift

    public func restoreDBClusterToPointInTime(_ input: RestoreDBClusterToPointInTimeMessage) -> EventLoopFuture<RestoreDBClusterToPointInTimeResult>

  • Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security group and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment. If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn’t allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot. 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.

    Declaration

    Swift

    public func restoreDBInstanceFromDBSnapshot(_ input: RestoreDBInstanceFromDBSnapshotMessage) -> EventLoopFuture<RestoreDBInstanceFromDBSnapshotResult>

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

    Declaration

    Swift

    public func restoreDBInstanceFromS3(_ input: RestoreDBInstanceFromS3Message) -> EventLoopFuture<RestoreDBInstanceFromS3Result>

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

    Declaration

    Swift

    public func restoreDBInstanceToPointInTime(_ input: RestoreDBInstanceToPointInTimeMessage) -> EventLoopFuture<RestoreDBInstanceToPointInTimeResult>

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

    Declaration

    Swift

    public func revokeDBSecurityGroupIngress(_ input: RevokeDBSecurityGroupIngressMessage) -> EventLoopFuture<RevokeDBSecurityGroupIngressResult>

  • Starts a database activity stream to monitor activity on the database. For more information, see Database Activity Streams in the Amazon Aurora User Guide.

    Declaration

    Swift

    public func startActivityStream(_ input: StartActivityStreamRequest) -> EventLoopFuture<StartActivityStreamResponse>

  • Starts an Amazon Aurora DB cluster that was stopped using the AWS console, the stop-db-cluster AWS 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.

    Declaration

    Swift

    public func startDBCluster(_ input: StartDBClusterMessage) -> EventLoopFuture<StartDBClusterResult>

  • Starts an Amazon RDS DB instance that was stopped using the AWS console, the stop-db-instance AWS 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 Aurora MySQL and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.

    Declaration

    Swift

    public func startDBInstance(_ input: StartDBInstanceMessage) -> EventLoopFuture<StartDBInstanceResult>

  • Starts an export of a snapshot to Amazon S3. The provided IAM role must have access to the S3 bucket.

    Declaration

    Swift

    public func startExportTask(_ input: StartExportTaskMessage) -> EventLoopFuture<ExportTask>

  • Stops a database activity stream that was started using the AWS console, the start-activity-stream AWS CLI command, or the StartActivityStream action. For more information, see Database Activity Streams in the Amazon Aurora User Guide.

    Declaration

    Swift

    public func stopActivityStream(_ input: StopActivityStreamRequest) -> EventLoopFuture<StopActivityStreamResponse>

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

    Declaration

    Swift

    public func stopDBCluster(_ input: StopDBClusterMessage) -> EventLoopFuture<StopDBClusterResult>

  • 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 Aurora MySQL and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.

    Declaration

    Swift

    public func stopDBInstance(_ input: StopDBInstanceMessage) -> EventLoopFuture<StopDBInstanceResult>

Paginators

Shapes

Enums

  • Undocumented

    See more

    Declaration

    Swift

    public enum ActivityStreamMode : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ActivityStreamStatus : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ApplyMethod : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum AuthScheme : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum DBProxyStatus : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum EngineFamily : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum IAMAuthMode : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ReplicaMode : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum SourceType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum TargetHealthReason : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum TargetState : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum TargetType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum WriteForwardingStatus : String, CustomStringConvertible, Codable