RDS class

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.

Constructors

RDS({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

shapes → Map<String, Shape>

final

Methods

addRoleToDBCluster({required String dBClusterIdentifier, required String roleArn, String? featureName}) → Future<void>

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.

addRoleToDBInstance({required String dBInstanceIdentifier, required String featureName, required String roleArn}) → Future<void>

Associates an AWS Identity and Access Management (IAM) role with a DB instance.

addSourceIdentifierToSubscription({required String sourceIdentifier, required String subscriptionName}) → Future<AddSourceIdentifierToSubscriptionResult>

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

addTagsToResource({required String resourceName, required List<Tag> tags}) → Future<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.

applyPendingMaintenanceAction({required String applyAction, required String optInType, required String resourceIdentifier}) → Future<ApplyPendingMaintenanceActionResult>

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

authorizeDBSecurityGroupIngress({required String dBSecurityGroupName, String? cidrip, String? eC2SecurityGroupId, String? eC2SecurityGroupName, String? eC2SecurityGroupOwnerId}) → Future<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). For an overview of CIDR ranges, go to the Wikipedia Tutorial.

backtrackDBCluster({required DateTime backtrackTo, required String dBClusterIdentifier, bool? force, bool? useEarliestTimeOnPointInTimeUnavailable}) → Future<DBClusterBacktrack>

Backtracks a DB cluster to a specific time, without creating a new DB cluster.

cancelExportTask({required String exportTaskIdentifier}) → Future<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.

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

copyDBClusterParameterGroup({required String sourceDBClusterParameterGroupIdentifier, required String targetDBClusterParameterGroupDescription, required String targetDBClusterParameterGroupIdentifier, List<Tag>? tags}) → Future<CopyDBClusterParameterGroupResult>

Copies the specified DB cluster parameter group.

copyDBClusterSnapshot({required String sourceDBClusterSnapshotIdentifier, required String targetDBClusterSnapshotIdentifier, bool? copyTags, String? kmsKeyId, String? preSignedUrl, String? sourceRegion, List<Tag>? tags}) → Future<CopyDBClusterSnapshotResult>

Copies a snapshot of a DB cluster.

copyDBParameterGroup({required String sourceDBParameterGroupIdentifier, required String targetDBParameterGroupDescription, required String targetDBParameterGroupIdentifier, List<Tag>? tags}) → Future<CopyDBParameterGroupResult>

Copies the specified DB parameter group.

copyDBSnapshot({required String sourceDBSnapshotIdentifier, required String targetDBSnapshotIdentifier, bool? copyTags, String? kmsKeyId, String? optionGroupName, String? preSignedUrl, String? sourceRegion, List<Tag>? tags, String? targetCustomAvailabilityZone}) → Future<CopyDBSnapshotResult>

Copies the specified DB snapshot. The source DB snapshot must be in the available state.

copyOptionGroup({required String sourceOptionGroupIdentifier, required String targetOptionGroupDescription, required String targetOptionGroupIdentifier, List<Tag>? tags}) → Future<CopyOptionGroupResult>

Copies the specified option group.

createCustomAvailabilityZone({required String customAvailabilityZoneName, String? existingVpnId, String? newVpnTunnelName, String? vpnTunnelOriginatorIP}) → Future<CreateCustomAvailabilityZoneResult>

Creates a custom Availability Zone (AZ).

createDBCluster({required String dBClusterIdentifier, required String engine, List<String>? availabilityZones, int? backtrackWindow, int? backupRetentionPeriod, String? characterSetName, bool? copyTagsToSnapshot, String? dBClusterParameterGroupName, String? dBSubnetGroupName, String? databaseName, bool? deletionProtection, String? domain, String? domainIAMRoleName, List<String>? enableCloudwatchLogsExports, bool? enableGlobalWriteForwarding, bool? enableHttpEndpoint, bool? enableIAMDatabaseAuthentication, String? engineMode, String? engineVersion, String? globalClusterIdentifier, String? kmsKeyId, String? masterUserPassword, String? masterUsername, String? optionGroupName, int? port, String? preSignedUrl, String? preferredBackupWindow, String? preferredMaintenanceWindow, String? replicationSourceIdentifier, ScalingConfiguration? scalingConfiguration, String? sourceRegion, bool? storageEncrypted, List<Tag>? tags, List<String>? vpcSecurityGroupIds}) → Future<CreateDBClusterResult>

Creates a new Amazon Aurora DB cluster.

createDBClusterEndpoint({required String dBClusterEndpointIdentifier, required String dBClusterIdentifier, required String endpointType, List<String>? excludedMembers, List<String>? staticMembers, List<Tag>? tags}) → Future<DBClusterEndpoint>

Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

createDBClusterParameterGroup({required String dBClusterParameterGroupName, required String dBParameterGroupFamily, required String description, List<Tag>? tags}) → Future<CreateDBClusterParameterGroupResult>

Creates a new DB cluster parameter group.

createDBClusterSnapshot({required String dBClusterIdentifier, required String dBClusterSnapshotIdentifier, List<Tag>? tags}) → Future<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.

createDBInstance({required String dBInstanceClass, required String dBInstanceIdentifier, required String engine, int? allocatedStorage, bool? autoMinorVersionUpgrade, String? availabilityZone, int? backupRetentionPeriod, String? characterSetName, bool? copyTagsToSnapshot, String? dBClusterIdentifier, String? dBName, String? dBParameterGroupName, List<String>? dBSecurityGroups, String? dBSubnetGroupName, bool? deletionProtection, String? domain, String? domainIAMRoleName, List<String>? enableCloudwatchLogsExports, bool? enableCustomerOwnedIp, bool? enableIAMDatabaseAuthentication, bool? enablePerformanceInsights, String? engineVersion, int? iops, String? kmsKeyId, String? licenseModel, String? masterUserPassword, String? masterUsername, int? maxAllocatedStorage, int? monitoringInterval, String? monitoringRoleArn, bool? multiAZ, String? ncharCharacterSetName, String? optionGroupName, String? performanceInsightsKMSKeyId, int? performanceInsightsRetentionPeriod, int? port, String? preferredBackupWindow, String? preferredMaintenanceWindow, List<ProcessorFeature>? processorFeatures, int? promotionTier, bool? publiclyAccessible, bool? storageEncrypted, String? storageType, List<Tag>? tags, String? tdeCredentialArn, String? tdeCredentialPassword, String? timezone, List<String>? vpcSecurityGroupIds}) → Future<CreateDBInstanceResult>

Creates a new DB instance.

createDBInstanceReadReplica({required String dBInstanceIdentifier, required String sourceDBInstanceIdentifier, bool? autoMinorVersionUpgrade, String? availabilityZone, bool? copyTagsToSnapshot, String? dBInstanceClass, String? dBParameterGroupName, String? dBSubnetGroupName, bool? deletionProtection, String? domain, String? domainIAMRoleName, List<String>? enableCloudwatchLogsExports, bool? enableIAMDatabaseAuthentication, bool? enablePerformanceInsights, int? iops, String? kmsKeyId, int? maxAllocatedStorage, int? monitoringInterval, String? monitoringRoleArn, bool? multiAZ, String? optionGroupName, String? performanceInsightsKMSKeyId, int? performanceInsightsRetentionPeriod, int? port, String? preSignedUrl, List<ProcessorFeature>? processorFeatures, bool? publiclyAccessible, ReplicaMode? replicaMode, String? sourceRegion, String? storageType, List<Tag>? tags, bool? useDefaultProcessorFeatures, List<String>? vpcSecurityGroupIds}) → Future<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.

createDBParameterGroup({required String dBParameterGroupFamily, required String dBParameterGroupName, required String description, List<Tag>? tags}) → Future<CreateDBParameterGroupResult>

Creates a new DB parameter group.

createDBProxy({required List<UserAuthConfig> auth, required String dBProxyName, required EngineFamily engineFamily, required String roleArn, required List<String> vpcSubnetIds, bool? debugLogging, int? idleClientTimeout, bool? requireTLS, List<Tag>? tags, List<String>? vpcSecurityGroupIds}) → Future<CreateDBProxyResponse>

Creates a new DB proxy.

createDBSecurityGroup({required String dBSecurityGroupDescription, required String dBSecurityGroupName, List<Tag>? tags}) → Future<CreateDBSecurityGroupResult>

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

createDBSnapshot({required String dBInstanceIdentifier, required String dBSnapshotIdentifier, List<Tag>? tags}) → Future<CreateDBSnapshotResult>

Creates a snapshot of a DB instance. The source DB instance must be in the available or storage-optimization state.

createDBSubnetGroup({required String dBSubnetGroupDescription, required String dBSubnetGroupName, required List<String> subnetIds, List<Tag>? tags}) → Future<CreateDBSubnetGroupResult>

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

createEventSubscription({required String snsTopicArn, required String subscriptionName, bool? enabled, List<String>? eventCategories, List<String>? sourceIds, String? sourceType, List<Tag>? tags}) → Future<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.

createGlobalCluster({String? databaseName, bool? deletionProtection, String? engine, String? engineVersion, String? globalClusterIdentifier, String? sourceDBClusterIdentifier, bool? storageEncrypted}) → Future<CreateGlobalClusterResult>

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

createOptionGroup({required String engineName, required String majorEngineVersion, required String optionGroupDescription, required String optionGroupName, List<Tag>? tags}) → Future<CreateOptionGroupResult>

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

deleteCustomAvailabilityZone({required String customAvailabilityZoneId}) → Future<DeleteCustomAvailabilityZoneResult>

Deletes a custom Availability Zone (AZ).

deleteDBCluster({required String dBClusterIdentifier, String? finalDBSnapshotIdentifier, bool? skipFinalSnapshot}) → Future<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.

deleteDBClusterEndpoint({required String dBClusterEndpointIdentifier}) → Future<DBClusterEndpoint>

Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.

deleteDBClusterParameterGroup({required String dBClusterParameterGroupName}) → Future<void>

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

deleteDBClusterSnapshot({required String dBClusterSnapshotIdentifier}) → Future<DeleteDBClusterSnapshotResult>

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

deleteDBInstance({required String dBInstanceIdentifier, bool? deleteAutomatedBackups, String? finalDBSnapshotIdentifier, bool? skipFinalSnapshot}) → Future<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.

deleteDBInstanceAutomatedBackup({String? dBInstanceAutomatedBackupsArn, String? dbiResourceId}) → Future<DeleteDBInstanceAutomatedBackupResult>

Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.

deleteDBParameterGroup({required String dBParameterGroupName}) → Future<void>

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

deleteDBProxy({required String dBProxyName}) → Future<DeleteDBProxyResponse>

Deletes an existing proxy.

deleteDBSecurityGroup({required String dBSecurityGroupName}) → Future<void>

Deletes a DB security group.

deleteDBSnapshot({required String dBSnapshotIdentifier}) → Future<DeleteDBSnapshotResult>

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

deleteDBSubnetGroup({required String dBSubnetGroupName}) → Future<void>

Deletes a DB subnet group.

deleteEventSubscription({required String subscriptionName}) → Future<DeleteEventSubscriptionResult>

Deletes an RDS event notification subscription.

deleteGlobalCluster({required String globalClusterIdentifier}) → Future<DeleteGlobalClusterResult>

Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.

deleteInstallationMedia({required String installationMediaId}) → Future<InstallationMedia>

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

deleteOptionGroup({required String optionGroupName}) → Future<void>

Deletes an existing option group.

deregisterDBProxyTargets({required String dBProxyName, List<String>? dBClusterIdentifiers, List<String>? dBInstanceIdentifiers, String? targetGroupName}) → Future<void>

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

describeAccountAttributes() → Future<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.

describeCertificates({String? certificateIdentifier, List<Filter>? filters, String? marker, int? maxRecords}) → Future<CertificateMessage>

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

describeCustomAvailabilityZones({String? customAvailabilityZoneId, List<Filter>? filters, String? marker, int? maxRecords}) → Future<CustomAvailabilityZoneMessage>

Returns information about custom Availability Zones (AZs).

describeDBClusterBacktracks({required String dBClusterIdentifier, String? backtrackIdentifier, List<Filter>? filters, String? marker, int? maxRecords}) → Future<DBClusterBacktrackMessage>

Returns information about backtracks for a DB cluster.

describeDBClusterEndpoints({String? dBClusterEndpointIdentifier, String? dBClusterIdentifier, List<Filter>? filters, String? marker, int? maxRecords}) → Future<DBClusterEndpointMessage>

Returns information about endpoints for an Amazon Aurora DB cluster.

describeDBClusterParameterGroups({String? dBClusterParameterGroupName, List<Filter>? filters, String? marker, int? maxRecords}) → Future<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.

describeDBClusterParameters({required String dBClusterParameterGroupName, List<Filter>? filters, String? marker, int? maxRecords, String? source}) → Future<DBClusterParameterGroupDetails>

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

describeDBClusters({String? dBClusterIdentifier, List<Filter>? filters, bool? includeShared, String? marker, int? maxRecords}) → Future<DBClusterMessage>

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

describeDBClusterSnapshotAttributes({required String dBClusterSnapshotIdentifier}) → Future<DescribeDBClusterSnapshotAttributesResult>

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

describeDBClusterSnapshots({String? dBClusterIdentifier, String? dBClusterSnapshotIdentifier, List<Filter>? filters, bool? includePublic, bool? includeShared, String? marker, int? maxRecords, String? snapshotType}) → Future<DBClusterSnapshotMessage>

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

describeDBEngineVersions({String? dBParameterGroupFamily, bool? defaultOnly, String? engine, String? engineVersion, List<Filter>? filters, bool? includeAll, bool? listSupportedCharacterSets, bool? listSupportedTimezones, String? marker, int? maxRecords}) → Future<DBEngineVersionMessage>

Returns a list of the available DB engines.

describeDBInstanceAutomatedBackups({String? dBInstanceAutomatedBackupsArn, String? dBInstanceIdentifier, String? dbiResourceId, List<Filter>? filters, String? marker, int? maxRecords}) → Future<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.

describeDBInstances({String? dBInstanceIdentifier, List<Filter>? filters, String? marker, int? maxRecords}) → Future<DBInstanceMessage>

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

describeDBLogFiles({required String dBInstanceIdentifier, int? fileLastWritten, int? fileSize, String? filenameContains, List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeDBLogFilesResponse>

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

describeDBParameterGroups({String? dBParameterGroupName, List<Filter>? filters, String? marker, int? maxRecords}) → Future<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({required String dBParameterGroupName, List<Filter>? filters, String? marker, int? maxRecords, String? source}) → Future<DBParameterGroupDetails>

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

describeDBProxies({String? dBProxyName, List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeDBProxiesResponse>

Returns information about DB proxies.

describeDBProxyTargetGroups({required String dBProxyName, List<Filter>? filters, String? marker, int? maxRecords, String? targetGroupName}) → Future<DescribeDBProxyTargetGroupsResponse>

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

describeDBProxyTargets({required String dBProxyName, List<Filter>? filters, String? marker, int? maxRecords, String? targetGroupName}) → Future<DescribeDBProxyTargetsResponse>

Returns information about DBProxyTarget objects. This API supports pagination.

describeDBSecurityGroups({String? dBSecurityGroupName, List<Filter>? filters, String? marker, int? maxRecords}) → Future<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({required String dBSnapshotIdentifier}) → Future<DescribeDBSnapshotAttributesResult>

Returns a list of DB snapshot attribute names and values for a manual DB snapshot.

describeDBSnapshots({String? dBInstanceIdentifier, String? dBSnapshotIdentifier, String? dbiResourceId, List<Filter>? filters, bool? includePublic, bool? includeShared, String? marker, int? maxRecords, String? snapshotType}) → Future<DBSnapshotMessage>

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

describeDBSubnetGroups({String? dBSubnetGroupName, List<Filter>? filters, String? marker, int? maxRecords}) → Future<DBSubnetGroupMessage>

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

describeEngineDefaultClusterParameters({required String dBParameterGroupFamily, List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeEngineDefaultClusterParametersResult>

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

describeEngineDefaultParameters({required String dBParameterGroupFamily, List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeEngineDefaultParametersResult>

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

describeEventCategories({List<Filter>? filters, String? sourceType}) → Future<EventCategoriesMessage>

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.

describeEvents({int? duration, DateTime? endTime, List<String>? eventCategories, List<Filter>? filters, String? marker, int? maxRecords, String? sourceIdentifier, SourceType? sourceType, DateTime? startTime}) → Future<EventsMessage>

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.

describeEventSubscriptions({List<Filter>? filters, String? marker, int? maxRecords, String? subscriptionName}) → Future<EventSubscriptionsMessage>

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

describeExportTasks({String? exportTaskIdentifier, List<Filter>? filters, String? marker, int? maxRecords, String? sourceArn}) → Future<ExportTasksMessage>

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

describeGlobalClusters({List<Filter>? filters, String? globalClusterIdentifier, String? marker, int? maxRecords}) → Future<GlobalClustersMessage>

Returns information about Aurora global database clusters. This API supports pagination.

describeInstallationMedia({List<Filter>? filters, String? installationMediaId, String? marker, int? maxRecords}) → Future<InstallationMediaMessage>

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

describeOptionGroupOptions({required String engineName, List<Filter>? filters, String? majorEngineVersion, String? marker, int? maxRecords}) → Future<OptionGroupOptionsMessage>

Describes all available options.

describeOptionGroups({String? engineName, List<Filter>? filters, String? majorEngineVersion, String? marker, int? maxRecords, String? optionGroupName}) → Future<OptionGroups>

Describes the available option groups.

describeOrderableDBInstanceOptions({required String engine, String? availabilityZoneGroup, String? dBInstanceClass, String? engineVersion, List<Filter>? filters, String? licenseModel, String? marker, int? maxRecords, bool? vpc}) → Future<OrderableDBInstanceOptionsMessage>

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

describePendingMaintenanceActions({List<Filter>? filters, String? marker, int? maxRecords, String? resourceIdentifier}) → Future<PendingMaintenanceActionsMessage>

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

describeReservedDBInstances({String? dBInstanceClass, String? duration, List<Filter>? filters, String? leaseId, String? marker, int? maxRecords, bool? multiAZ, String? offeringType, String? productDescription, String? reservedDBInstanceId, String? reservedDBInstancesOfferingId}) → Future<ReservedDBInstanceMessage>

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

describeReservedDBInstancesOfferings({String? dBInstanceClass, String? duration, List<Filter>? filters, String? marker, int? maxRecords, bool? multiAZ, String? offeringType, String? productDescription, String? reservedDBInstancesOfferingId}) → Future<ReservedDBInstancesOfferingMessage>

Lists available reserved DB instance offerings.

describeSourceRegions({List<Filter>? filters, String? marker, int? maxRecords, String? regionName}) → Future<SourceRegionMessage>

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

describeValidDBInstanceModifications({required String dBInstanceIdentifier}) → Future<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.

downloadDBLogFilePortion({required String dBInstanceIdentifier, required String logFileName, String? marker, int? numberOfLines}) → Future<DownloadDBLogFilePortionDetails>

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

failoverDBCluster({required String dBClusterIdentifier, String? targetDBInstanceIdentifier}) → Future<FailoverDBClusterResult>

Forces a failover for a DB cluster.

importInstallationMedia({required String customAvailabilityZoneId, required String engine, required String engineInstallationMediaPath, required String engineVersion, required String oSInstallationMediaPath}) → Future<InstallationMedia>

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

listTagsForResource({required String resourceName, List<Filter>? filters}) → Future<TagListMessage>

Lists all tags on an Amazon RDS resource.

modifyCertificates({String? certificateIdentifier, bool? removeCustomerOverride}) → Future<ModifyCertificatesResult>

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.

modifyCurrentDBClusterCapacity({required String dBClusterIdentifier, int? capacity, int? secondsBeforeTimeout, String? timeoutAction}) → Future<DBClusterCapacityInfo>

Set the capacity of an Aurora Serverless DB cluster to a specific value.

modifyDBCluster({required String dBClusterIdentifier, bool? allowMajorVersionUpgrade, bool? applyImmediately, int? backtrackWindow, int? backupRetentionPeriod, CloudwatchLogsExportConfiguration? cloudwatchLogsExportConfiguration, bool? copyTagsToSnapshot, String? dBClusterParameterGroupName, String? dBInstanceParameterGroupName, bool? deletionProtection, String? domain, String? domainIAMRoleName, bool? enableGlobalWriteForwarding, bool? enableHttpEndpoint, bool? enableIAMDatabaseAuthentication, String? engineVersion, String? masterUserPassword, String? newDBClusterIdentifier, String? optionGroupName, int? port, String? preferredBackupWindow, String? preferredMaintenanceWindow, ScalingConfiguration? scalingConfiguration, List<String>? vpcSecurityGroupIds}) → Future<ModifyDBClusterResult>

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.

modifyDBClusterEndpoint({required String dBClusterEndpointIdentifier, String? endpointType, List<String>? excludedMembers, List<String>? staticMembers}) → Future<DBClusterEndpoint>

Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

modifyDBClusterParameterGroup({required String dBClusterParameterGroupName, required List<Parameter> parameters}) → Future<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.

modifyDBClusterSnapshotAttribute({required String attributeName, required String dBClusterSnapshotIdentifier, List<String>? valuesToAdd, List<String>? valuesToRemove}) → Future<ModifyDBClusterSnapshotAttributeResult>

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

modifyDBInstance({required String dBInstanceIdentifier, int? allocatedStorage, bool? allowMajorVersionUpgrade, bool? applyImmediately, bool? autoMinorVersionUpgrade, int? backupRetentionPeriod, String? cACertificateIdentifier, bool? certificateRotationRestart, CloudwatchLogsExportConfiguration? cloudwatchLogsExportConfiguration, bool? copyTagsToSnapshot, String? dBInstanceClass, String? dBParameterGroupName, int? dBPortNumber, List<String>? dBSecurityGroups, String? dBSubnetGroupName, bool? deletionProtection, String? domain, String? domainIAMRoleName, bool? enableCustomerOwnedIp, bool? enableIAMDatabaseAuthentication, bool? enablePerformanceInsights, String? engineVersion, int? iops, String? licenseModel, String? masterUserPassword, int? maxAllocatedStorage, int? monitoringInterval, String? monitoringRoleArn, bool? multiAZ, String? newDBInstanceIdentifier, String? optionGroupName, String? performanceInsightsKMSKeyId, int? performanceInsightsRetentionPeriod, String? preferredBackupWindow, String? preferredMaintenanceWindow, List<ProcessorFeature>? processorFeatures, int? promotionTier, bool? publiclyAccessible, ReplicaMode? replicaMode, String? storageType, String? tdeCredentialArn, String? tdeCredentialPassword, bool? useDefaultProcessorFeatures, List<String>? vpcSecurityGroupIds}) → Future<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({required String dBParameterGroupName, required List<Parameter> parameters}) → Future<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.

modifyDBProxy({required String dBProxyName, List<UserAuthConfig>? auth, bool? debugLogging, int? idleClientTimeout, String? newDBProxyName, bool? requireTLS, String? roleArn, List<String>? securityGroups}) → Future<ModifyDBProxyResponse>

Changes the settings for an existing DB proxy.

modifyDBProxyTargetGroup({required String dBProxyName, required String targetGroupName, ConnectionPoolConfiguration? connectionPoolConfig, String? newName}) → Future<ModifyDBProxyTargetGroupResponse>

Modifies the properties of a DBProxyTargetGroup.

modifyDBSnapshot({required String dBSnapshotIdentifier, String? engineVersion, String? optionGroupName}) → Future<ModifyDBSnapshotResult>

Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public.

modifyDBSnapshotAttribute({required String attributeName, required String dBSnapshotIdentifier, List<String>? valuesToAdd, List<String>? valuesToRemove}) → Future<ModifyDBSnapshotAttributeResult>

Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

modifyDBSubnetGroup({required String dBSubnetGroupName, required List<String> subnetIds, String? dBSubnetGroupDescription}) → Future<ModifyDBSubnetGroupResult>

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

modifyEventSubscription({required String subscriptionName, bool? enabled, List<String>? eventCategories, String? snsTopicArn, String? sourceType}) → Future<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.

modifyGlobalCluster({bool? deletionProtection, String? globalClusterIdentifier, String? newGlobalClusterIdentifier}) → Future<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.

modifyOptionGroup({required String optionGroupName, bool? applyImmediately, List<OptionConfiguration>? optionsToInclude, List<String>? optionsToRemove}) → Future<ModifyOptionGroupResult>

Modifies an existing option group.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

promoteReadReplica({required String dBInstanceIdentifier, int? backupRetentionPeriod, String? preferredBackupWindow}) → Future<PromoteReadReplicaResult>

Promotes a read replica DB instance to a standalone DB instance.

promoteReadReplicaDBCluster({required String dBClusterIdentifier}) → Future<PromoteReadReplicaDBClusterResult>

Promotes a read replica DB cluster to a standalone DB cluster.

purchaseReservedDBInstancesOffering({required String reservedDBInstancesOfferingId, int? dBInstanceCount, String? reservedDBInstanceId, List<Tag>? tags}) → Future<PurchaseReservedDBInstancesOfferingResult>

Purchases a reserved DB instance offering.

rebootDBInstance({required String dBInstanceIdentifier, bool? forceFailover}) → Future<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.

registerDBProxyTargets({required String dBProxyName, List<String>? dBClusterIdentifiers, List<String>? dBInstanceIdentifiers, String? targetGroupName}) → Future<RegisterDBProxyTargetsResponse>

Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.

removeFromGlobalCluster({String? dbClusterIdentifier, String? globalClusterIdentifier}) → Future<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.

removeRoleFromDBCluster({required String dBClusterIdentifier, required String roleArn, String? featureName}) → Future<void>

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.

removeRoleFromDBInstance({required String dBInstanceIdentifier, required String featureName, required String roleArn}) → Future<void>

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

removeSourceIdentifierFromSubscription({required String sourceIdentifier, required String subscriptionName}) → Future<RemoveSourceIdentifierFromSubscriptionResult>

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

removeTagsFromResource({required String resourceName, required List<String> tagKeys}) → Future<void>

Removes metadata tags from an Amazon RDS resource.

resetDBClusterParameterGroup({required String dBClusterParameterGroupName, List<Parameter>? parameters, bool? resetAllParameters}) → Future<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.

resetDBParameterGroup({required String dBParameterGroupName, List<Parameter>? parameters, bool? resetAllParameters}) → Future<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({required String dBClusterIdentifier, required String engine, required String masterUserPassword, required String masterUsername, required String s3BucketName, required String s3IngestionRoleArn, required String sourceEngine, required String sourceEngineVersion, List<String>? availabilityZones, int? backtrackWindow, int? backupRetentionPeriod, String? characterSetName, bool? copyTagsToSnapshot, String? dBClusterParameterGroupName, String? dBSubnetGroupName, String? databaseName, bool? deletionProtection, String? domain, String? domainIAMRoleName, List<String>? enableCloudwatchLogsExports, bool? enableIAMDatabaseAuthentication, String? engineVersion, String? kmsKeyId, String? optionGroupName, int? port, String? preferredBackupWindow, String? preferredMaintenanceWindow, String? s3Prefix, bool? storageEncrypted, List<Tag>? tags, List<String>? vpcSecurityGroupIds}) → Future<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. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

restoreDBClusterFromSnapshot({required String dBClusterIdentifier, required String engine, required String snapshotIdentifier, List<String>? availabilityZones, int? backtrackWindow, bool? copyTagsToSnapshot, String? dBClusterParameterGroupName, String? dBSubnetGroupName, String? databaseName, bool? deletionProtection, String? domain, String? domainIAMRoleName, List<String>? enableCloudwatchLogsExports, bool? enableIAMDatabaseAuthentication, String? engineMode, String? engineVersion, String? kmsKeyId, String? optionGroupName, int? port, ScalingConfiguration? scalingConfiguration, List<Tag>? tags, List<String>? vpcSecurityGroupIds}) → Future<RestoreDBClusterFromSnapshotResult>

Creates a new DB cluster from a DB snapshot or DB cluster snapshot. This action only applies to Aurora DB clusters.

restoreDBClusterToPointInTime({required String dBClusterIdentifier, required String sourceDBClusterIdentifier, int? backtrackWindow, bool? copyTagsToSnapshot, String? dBClusterParameterGroupName, String? dBSubnetGroupName, bool? deletionProtection, String? domain, String? domainIAMRoleName, List<String>? enableCloudwatchLogsExports, bool? enableIAMDatabaseAuthentication, String? kmsKeyId, String? optionGroupName, int? port, DateTime? restoreToTime, String? restoreType, List<Tag>? tags, bool? useLatestRestorableTime, List<String>? vpcSecurityGroupIds}) → Future<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 more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

restoreDBInstanceFromDBSnapshot({required String dBInstanceIdentifier, required String dBSnapshotIdentifier, bool? autoMinorVersionUpgrade, String? availabilityZone, bool? copyTagsToSnapshot, String? dBInstanceClass, String? dBName, String? dBParameterGroupName, String? dBSubnetGroupName, bool? deletionProtection, String? domain, String? domainIAMRoleName, List<String>? enableCloudwatchLogsExports, bool? enableCustomerOwnedIp, bool? enableIAMDatabaseAuthentication, String? engine, int? iops, String? licenseModel, bool? multiAZ, String? optionGroupName, int? port, List<ProcessorFeature>? processorFeatures, bool? publiclyAccessible, String? storageType, List<Tag>? tags, String? tdeCredentialArn, String? tdeCredentialPassword, bool? useDefaultProcessorFeatures, List<String>? vpcSecurityGroupIds}) → Future<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.

restoreDBInstanceFromS3({required String dBInstanceClass, required String dBInstanceIdentifier, required String engine, required String s3BucketName, required String s3IngestionRoleArn, required String sourceEngine, required String sourceEngineVersion, int? allocatedStorage, bool? autoMinorVersionUpgrade, String? availabilityZone, int? backupRetentionPeriod, bool? copyTagsToSnapshot, String? dBName, String? dBParameterGroupName, List<String>? dBSecurityGroups, String? dBSubnetGroupName, bool? deletionProtection, List<String>? enableCloudwatchLogsExports, bool? enableIAMDatabaseAuthentication, bool? enablePerformanceInsights, String? engineVersion, int? iops, String? kmsKeyId, String? licenseModel, String? masterUserPassword, String? masterUsername, int? maxAllocatedStorage, int? monitoringInterval, String? monitoringRoleArn, bool? multiAZ, String? optionGroupName, String? performanceInsightsKMSKeyId, int? performanceInsightsRetentionPeriod, int? port, String? preferredBackupWindow, String? preferredMaintenanceWindow, List<ProcessorFeature>? processorFeatures, bool? publiclyAccessible, String? s3Prefix, bool? storageEncrypted, String? storageType, List<Tag>? tags, bool? useDefaultProcessorFeatures, List<String>? vpcSecurityGroupIds}) → Future<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.

restoreDBInstanceToPointInTime({required String targetDBInstanceIdentifier, bool? autoMinorVersionUpgrade, String? availabilityZone, bool? copyTagsToSnapshot, String? dBInstanceClass, String? dBName, String? dBParameterGroupName, String? dBSubnetGroupName, bool? deletionProtection, String? domain, String? domainIAMRoleName, List<String>? enableCloudwatchLogsExports, bool? enableCustomerOwnedIp, bool? enableIAMDatabaseAuthentication, String? engine, int? iops, String? licenseModel, int? maxAllocatedStorage, bool? multiAZ, String? optionGroupName, int? port, List<ProcessorFeature>? processorFeatures, bool? publiclyAccessible, DateTime? restoreTime, String? sourceDBInstanceAutomatedBackupsArn, String? sourceDBInstanceIdentifier, String? sourceDbiResourceId, String? storageType, List<Tag>? tags, String? tdeCredentialArn, String? tdeCredentialPassword, bool? useDefaultProcessorFeatures, bool? useLatestRestorableTime, List<String>? vpcSecurityGroupIds}) → Future<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.

revokeDBSecurityGroupIngress({required String dBSecurityGroupName, String? cidrip, String? eC2SecurityGroupId, String? eC2SecurityGroupName, String? eC2SecurityGroupOwnerId}) → Future<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({required String kmsKeyId, required ActivityStreamMode mode, required String resourceArn, bool? applyImmediately}) → Future<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({required String dBClusterIdentifier}) → Future<StartDBClusterResult>

Starts an Amazon Aurora DB cluster that was stopped using the AWS console, the stop-db-cluster AWS CLI command, or the StopDBCluster action.

startDBInstance({required String dBInstanceIdentifier}) → Future<StartDBInstanceResult>

Starts an Amazon RDS DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the StopDBInstance action.

startDBInstanceAutomatedBackupsReplication({required String sourceDBInstanceArn, int? backupRetentionPeriod, String? kmsKeyId, String? preSignedUrl}) → Future<StartDBInstanceAutomatedBackupsReplicationResult>

Enables replication of automated backups to a different AWS Region.

startExportTask({required String exportTaskIdentifier, required String iamRoleArn, required String kmsKeyId, required String s3BucketName, required String sourceArn, List<String>? exportOnly, String? s3Prefix}) → Future<ExportTask>

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

stopActivityStream({required String resourceArn, bool? applyImmediately}) → Future<StopActivityStreamResponse>

Stops a database activity stream that was started using the AWS console, the start-activity-stream AWS CLI command, or the StartActivityStream action.

stopDBCluster({required String dBClusterIdentifier}) → Future<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.

stopDBInstance({required String dBInstanceIdentifier, String? dBSnapshotIdentifier}) → Future<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.

stopDBInstanceAutomatedBackupsReplication({required String sourceDBInstanceArn}) → Future<StopDBInstanceAutomatedBackupsReplicationResult>

Stops automated backup replication for a DB instance.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited