Struct aws_sdk_rds::Client
source · [−]pub struct Client { /* private fields */ }
Expand description
Client for Amazon Relational Database Service
Client for invoking operations on Amazon Relational Database Service. Each operation on Amazon Relational Database Service is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_rds::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_rds::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_rds::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn add_role_to_db_cluster(&self) -> AddRoleToDBCluster
pub fn add_role_to_db_cluster(&self) -> AddRoleToDBCluster
Constructs a fluent builder for the AddRoleToDBCluster
operation.
- The fluent builder is configurable:
db_cluster_identifier(impl Into<String>)
/set_db_cluster_identifier(Option<String>)
:The name of the DB cluster to associate the IAM role with.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example
arn:aws:iam::123456789012:role/AuroraAccessRole
.feature_name(impl Into<String>)
/set_feature_name(Option<String>)
:The name of the feature for the DB cluster that the IAM role is to be associated with. For information about supported feature names, see
DBEngineVersion
.
- On success, responds with
AddRoleToDbClusterOutput
- On failure, responds with
SdkError<AddRoleToDBClusterError>
sourcepub fn add_role_to_db_instance(&self) -> AddRoleToDBInstance
pub fn add_role_to_db_instance(&self) -> AddRoleToDBInstance
Constructs a fluent builder for the AddRoleToDBInstance
operation.
- The fluent builder is configurable:
db_instance_identifier(impl Into<String>)
/set_db_instance_identifier(Option<String>)
:The name of the DB instance to associate the IAM role with.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for example
arn:aws:iam::123456789012:role/AccessRole
.feature_name(impl Into<String>)
/set_feature_name(Option<String>)
:The name of the feature for the DB instance that the IAM role is to be associated with. For information about supported feature names, see
DBEngineVersion
.
- On success, responds with
AddRoleToDbInstanceOutput
- On failure, responds with
SdkError<AddRoleToDBInstanceError>
sourcepub fn add_source_identifier_to_subscription(
&self
) -> AddSourceIdentifierToSubscription
pub fn add_source_identifier_to_subscription(
&self
) -> AddSourceIdentifierToSubscription
Constructs a fluent builder for the AddSourceIdentifierToSubscription
operation.
- The fluent builder is configurable:
subscription_name(impl Into<String>)
/set_subscription_name(Option<String>)
:The name of the RDS event notification subscription you want to add a source identifier to.
source_identifier(impl Into<String>)
/set_source_identifier(Option<String>)
:The identifier of the event source to be added.
Constraints:
-
If the source type is a DB instance, a
DBInstanceIdentifier
value must be supplied. -
If the source type is a DB cluster, a
DBClusterIdentifier
value must be supplied. -
If the source type is a DB parameter group, a
DBParameterGroupName
value must be supplied. -
If the source type is a DB security group, a
DBSecurityGroupName
value must be supplied. -
If the source type is a DB snapshot, a
DBSnapshotIdentifier
value must be supplied. -
If the source type is a DB cluster snapshot, a
DBClusterSnapshotIdentifier
value must be supplied. -
If the source type is an RDS Proxy, a
DBProxyName
value must be supplied.
-
- On success, responds with
AddSourceIdentifierToSubscriptionOutput
with field(s):event_subscription(Option<EventSubscription>)
:Contains the results of a successful invocation of the
DescribeEventSubscriptions
action.
- On failure, responds with
SdkError<AddSourceIdentifierToSubscriptionError>
Constructs a fluent builder for the AddTagsToResource
operation.
- The fluent builder is configurable:
resource_name(impl Into<String>)
/set_resource_name(Option<String>)
:The Amazon RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tags to be assigned to the Amazon RDS resource.
- On success, responds with
AddTagsToResourceOutput
- On failure, responds with
SdkError<AddTagsToResourceError>
sourcepub fn apply_pending_maintenance_action(&self) -> ApplyPendingMaintenanceAction
pub fn apply_pending_maintenance_action(&self) -> ApplyPendingMaintenanceAction
Constructs a fluent builder for the ApplyPendingMaintenanceAction
operation.
- The fluent builder is configurable:
resource_identifier(impl Into<String>)
/set_resource_identifier(Option<String>)
:The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
apply_action(impl Into<String>)
/set_apply_action(Option<String>)
:The pending maintenance action to apply to this resource.
Valid values:
system-update
,db-upgrade
,hardware-maintenance
,ca-certificate-rotation
opt_in_type(impl Into<String>)
/set_opt_in_type(Option<String>)
:A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type
immediate
can’t be undone.Valid values:
-
immediate
- Apply the maintenance action immediately. -
next-maintenance
- Apply the maintenance action during the next maintenance window for the resource. -
undo-opt-in
- Cancel any existingnext-maintenance
opt-in requests.
-
- On success, responds with
ApplyPendingMaintenanceActionOutput
with field(s):resource_pending_maintenance_actions(Option<ResourcePendingMaintenanceActions>)
:Describes the pending maintenance actions for a resource.
- On failure, responds with
SdkError<ApplyPendingMaintenanceActionError>
Constructs a fluent builder for the AuthorizeDBSecurityGroupIngress
operation.
- The fluent builder is configurable:
db_security_group_name(impl Into<String>)
/set_db_security_group_name(Option<String>)
:The name of the DB security group to add authorization to.
cidrip(impl Into<String>)
/set_cidrip(Option<String>)
:The IP range to authorize.
ec2_security_group_name(impl Into<String>)
/set_ec2_security_group_name(Option<String>)
:Name of the EC2 security group to authorize. For VPC DB security groups,
EC2SecurityGroupId
must be provided. Otherwise,EC2SecurityGroupOwnerId
and eitherEC2SecurityGroupName
orEC2SecurityGroupId
must be provided.ec2_security_group_id(impl Into<String>)
/set_ec2_security_group_id(Option<String>)
:Id of the EC2 security group to authorize. For VPC DB security groups,
EC2SecurityGroupId
must be provided. Otherwise,EC2SecurityGroupOwnerId
and eitherEC2SecurityGroupName
orEC2SecurityGroupId
must be provided.ec2_security_group_owner_id(impl Into<String>)
/set_ec2_security_group_owner_id(Option<String>)
:Amazon Web Services account number of the owner of the EC2 security group specified in the
EC2SecurityGroupName
parameter. The Amazon Web Services access key ID isn’t an acceptable value. For VPC DB security groups,EC2SecurityGroupId
must be provided. Otherwise,EC2SecurityGroupOwnerId
and eitherEC2SecurityGroupName
orEC2SecurityGroupId
must be provided.
- On success, responds with
AuthorizeDbSecurityGroupIngressOutput
with field(s):db_security_group(Option<DbSecurityGroup>)
:Contains the details for an Amazon RDS DB security group.
This data type is used as a response element in the
DescribeDBSecurityGroups
action.
- On failure, responds with
SdkError<AuthorizeDBSecurityGroupIngressError>
sourcepub fn backtrack_db_cluster(&self) -> BacktrackDBCluster
pub fn backtrack_db_cluster(&self) -> BacktrackDBCluster
Constructs a fluent builder for the BacktrackDBCluster
operation.
- The fluent builder is configurable:
db_cluster_identifier(impl Into<String>)
/set_db_cluster_identifier(Option<String>)
:The DB cluster identifier of the DB cluster to be backtracked. This parameter is stored as a lowercase string.
Constraints:
-
Must contain from 1 to 63 alphanumeric characters or hyphens.
-
First character must be a letter.
-
Can’t end with a hyphen or contain two consecutive hyphens.
Example:
my-cluster1
-
backtrack_to(DateTime)
/set_backtrack_to(Option<DateTime>)
:The timestamp of the time to backtrack the DB cluster to, specified in ISO 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia page.
If the specified time isn’t a consistent time for the DB cluster, Aurora automatically chooses the nearest possible consistent time for the DB cluster.
Constraints:
-
Must contain a valid ISO 8601 timestamp.
-
Can’t contain a timestamp set in the future.
Example:
2017-07-08T18:00Z
-
force(bool)
/set_force(Option<bool>)
:A value that indicates whether to force the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.
use_earliest_time_on_point_in_time_unavailable(bool)
/set_use_earliest_time_on_point_in_time_unavailable(Option<bool>)
:A value that indicates whether to backtrack the DB cluster to the earliest possible backtrack time when BacktrackTo is set to a timestamp earlier than the earliest backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest backtrack time, an error occurs.
- On success, responds with
BacktrackDbClusterOutput
with field(s):db_cluster_identifier(Option<String>)
:Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
backtrack_identifier(Option<String>)
:Contains the backtrack identifier.
backtrack_to(Option<DateTime>)
:The timestamp of the time to which the DB cluster was backtracked.
backtracked_from(Option<DateTime>)
:The timestamp of the time from which the DB cluster was backtracked.
backtrack_request_creation_time(Option<DateTime>)
:The timestamp of the time at which the backtrack was requested.
status(Option<String>)
:The status of the backtrack. This property returns one of the following values:
-
applying
- The backtrack is currently being applied to or rolled back from the DB cluster. -
completed
- The backtrack has successfully been applied to or rolled back from the DB cluster. -
failed
- An error occurred while the backtrack was applied to or rolled back from the DB cluster. -
pending
- The backtrack is currently pending application to or rollback from the DB cluster.
-
- On failure, responds with
SdkError<BacktrackDBClusterError>
sourcepub fn cancel_export_task(&self) -> CancelExportTask
pub fn cancel_export_task(&self) -> CancelExportTask
Constructs a fluent builder for the CancelExportTask
operation.
- The fluent builder is configurable:
export_task_identifier(impl Into<String>)
/set_export_task_identifier(Option<String>)
:The identifier of the snapshot export task to cancel.
- On success, responds with
CancelExportTaskOutput
with field(s):export_task_identifier(Option<String>)
:A unique identifier for the snapshot export task. This ID isn’t an identifier for the Amazon S3 bucket where the snapshot is exported to.
source_arn(Option<String>)
:The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
export_only(Option<Vec<String>>)
:The data exported from the snapshot. Valid values are the following:
-
database
- Export all the data from a specified database. -
database.table
table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL. -
database.schema
schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. -
database.schema.table
table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
-
snapshot_time(Option<DateTime>)
:The time that the snapshot was created.
task_start_time(Option<DateTime>)
:The time that the snapshot export task started.
task_end_time(Option<DateTime>)
:The time that the snapshot export task completed.
s3_bucket(Option<String>)
:The Amazon S3 bucket that the snapshot is exported to.
s3_prefix(Option<String>)
:The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
iam_role_arn(Option<String>)
:The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
kms_key_id(Option<String>)
:The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot when it’s exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key.
status(Option<String>)
:The progress status of the export task.
percent_progress(i32)
:The progress of the snapshot export task as a percentage.
total_extracted_data_in_gb(i32)
:The total amount of data exported, in gigabytes.
failure_cause(Option<String>)
:The reason the export failed, if it failed.
warning_message(Option<String>)
:A warning about the snapshot export task.
- On failure, responds with
SdkError<CancelExportTaskError>
sourcepub fn copy_db_cluster_parameter_group(&self) -> CopyDBClusterParameterGroup
pub fn copy_db_cluster_parameter_group(&self) -> CopyDBClusterParameterGroup
Constructs a fluent builder for the CopyDBClusterParameterGroup
operation.
- The fluent builder is configurable:
source_db_cluster_parameter_group_identifier(impl Into<String>)
/set_source_db_cluster_parameter_group_identifier(Option<String>)
:The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide.
Constraints:
-
Must specify a valid DB cluster parameter group.
-
target_db_cluster_parameter_group_identifier(impl Into<String>)
/set_target_db_cluster_parameter_group_identifier(Option<String>)
:The identifier for the copied DB cluster parameter group.
Constraints:
-
Can’t be null, empty, or blank
-
Must contain from 1 to 255 letters, numbers, or hyphens
-
First character must be a letter
-
Can’t end with a hyphen or contain two consecutive hyphens
Example:
my-cluster-param-group1
-
target_db_cluster_parameter_group_description(impl Into<String>)
/set_target_db_cluster_parameter_group_description(Option<String>)
:A description for the copied DB cluster parameter group.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
- On success, responds with
CopyDbClusterParameterGroupOutput
with field(s):db_cluster_parameter_group(Option<DbClusterParameterGroup>)
:Contains the details of an Amazon RDS DB cluster parameter group.
This data type is used as a response element in the
DescribeDBClusterParameterGroups
action.
- On failure, responds with
SdkError<CopyDBClusterParameterGroupError>
sourcepub fn copy_db_cluster_snapshot(&self) -> CopyDBClusterSnapshot
pub fn copy_db_cluster_snapshot(&self) -> CopyDBClusterSnapshot
Constructs a fluent builder for the CopyDBClusterSnapshot
operation.
- The fluent builder is configurable:
source_db_cluster_snapshot_identifier(impl Into<String>)
/set_source_db_cluster_snapshot_identifier(Option<String>)
:The identifier of the DB cluster snapshot to copy. This parameter isn’t case-sensitive.
You can’t copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.
Constraints:
-
Must specify a valid system snapshot in the “available” state.
-
If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier.
-
If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.
Example:
my-cluster-snapshot1
-
target_db_cluster_snapshot_identifier(impl Into<String>)
/set_target_db_cluster_snapshot_identifier(Option<String>)
:The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn’t case-sensitive.
Constraints:
-
Must contain from 1 to 63 letters, numbers, or hyphens.
-
First character must be a letter.
-
Can’t end with a hyphen or contain two consecutive hyphens.
Example:
my-cluster-snapshot2
-
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key.
If you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for
KmsKeyId
to encrypt the copy with a new KMS key. If you don’t specify a value forKmsKeyId
, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.If you copy an encrypted DB cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for
KmsKeyId
.To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set
KmsKeyId
to the Amazon Web Services KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can’t use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.If you copy an unencrypted DB cluster snapshot and specify a value for the
KmsKeyId
parameter, an error is returned.pre_signed_url(impl Into<String>)
/set_pre_signed_url(Option<String>)
:When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the
CopyDBClusterSnapshot
API operation in the Amazon Web Services Region that contains the source DB cluster snapshot to copy. Use thePreSignedUrl
parameter when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don’t specifyPreSignedUrl
when copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.This setting applies only to Amazon Web Services GovCloud (US) Regions. It’s ignored in other Amazon Web Services Regions.
The presigned URL must be a valid request for the
CopyDBClusterSnapshot
API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request must contain the following parameter values:-
KmsKeyId
- The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both theCopyDBClusterSnapshot
operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL. -
DestinationRegion
- The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in. -
SourceDBClusterSnapshotIdentifier
- The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then yourSourceDBClusterSnapshotIdentifier
looks like the following example:arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify
SourceRegion
(or–source-region
for the CLI) instead of specifyingPreSignedUrl
manually. SpecifyingSourceRegion
autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.-
copy_tags(bool)
/set_copy_tags(Option<bool>)
:A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
- On success, responds with
CopyDbClusterSnapshotOutput
with field(s):db_cluster_snapshot(Option<DbClusterSnapshot>)
:Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the
DescribeDBClusterSnapshots
action.
- On failure, responds with
SdkError<CopyDBClusterSnapshotError>
sourcepub fn copy_db_parameter_group(&self) -> CopyDBParameterGroup
pub fn copy_db_parameter_group(&self) -> CopyDBParameterGroup
Constructs a fluent builder for the CopyDBParameterGroup
operation.
- The fluent builder is configurable:
source_db_parameter_group_identifier(impl Into<String>)
/set_source_db_parameter_group_identifier(Option<String>)
:The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
Constraints:
-
Must specify a valid DB parameter group.
-
target_db_parameter_group_identifier(impl Into<String>)
/set_target_db_parameter_group_identifier(Option<String>)
:The identifier for the copied DB parameter group.
Constraints:
-
Can’t be null, empty, or blank
-
Must contain from 1 to 255 letters, numbers, or hyphens
-
First character must be a letter
-
Can’t end with a hyphen or contain two consecutive hyphens
Example:
my-db-parameter-group
-
target_db_parameter_group_description(impl Into<String>)
/set_target_db_parameter_group_description(Option<String>)
:A description for the copied DB parameter group.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
- On success, responds with
CopyDbParameterGroupOutput
with field(s):db_parameter_group(Option<DbParameterGroup>)
:Contains the details of an Amazon RDS DB parameter group.
This data type is used as a response element in the
DescribeDBParameterGroups
action.
- On failure, responds with
SdkError<CopyDBParameterGroupError>
sourcepub fn copy_db_snapshot(&self) -> CopyDBSnapshot
pub fn copy_db_snapshot(&self) -> CopyDBSnapshot
Constructs a fluent builder for the CopyDBSnapshot
operation.
- The fluent builder is configurable:
source_db_snapshot_identifier(impl Into<String>)
/set_source_db_snapshot_identifier(Option<String>)
:The identifier for the source DB snapshot.
If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier. For example, you might specify
rds:mysql-instance1-snapshot-20130805
.If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB snapshot ARN. For example, you might specify
arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
.If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.
If you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Web Services Region.
Constraints:
-
Must specify a valid system snapshot in the “available” state.
Example:
rds:mydb-2012-04-02-00-01
Example:
arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
-
target_db_snapshot_identifier(impl Into<String>)
/set_target_db_snapshot_identifier(Option<String>)
:The identifier for the copy of the snapshot.
Constraints:
-
Can’t be null, empty, or blank
-
Must contain from 1 to 255 letters, numbers, or hyphens
-
First character must be a letter
-
Can’t end with a hyphen or contain two consecutive hyphens
Example:
my-db-snapshot
-
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:The Amazon Web Services KMS key identifier for an encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you copy an encrypted DB snapshot from your Amazon Web Services account, you can specify a value for this parameter to encrypt the copy with a new KMS key. If you don’t specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot.
If you copy an encrypted DB snapshot that is shared from another Amazon Web Services account, then you must specify a value for this parameter.
If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.
If you copy an encrypted snapshot to a different Amazon Web Services Region, then you must specify an Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can’t use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
copy_tags(bool)
/set_copy_tags(Option<bool>)
:A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags are not copied.
pre_signed_url(impl Into<String>)
/set_pre_signed_url(Option<String>)
:When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the
CopyDBSnapshot
API operation in the source Amazon Web Services Region that contains the source DB snapshot to copy.This setting applies only to Amazon Web Services GovCloud (US) Regions. It’s ignored in other Amazon Web Services Regions.
You must specify this parameter when you copy an encrypted DB snapshot from another Amazon Web Services Region by using the Amazon RDS API. Don’t specify
PreSignedUrl
when you are copying an encrypted DB snapshot in the same Amazon Web Services Region.The presigned URL must be a valid request for the
CopyDBClusterSnapshot
API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request must contain the following parameter values:-
DestinationRegion
- The Amazon Web Services Region that the encrypted DB snapshot is copied to. This Amazon Web Services Region is the same one where theCopyDBSnapshot
operation is called that contains this presigned URL.For example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the
CopyDBSnapshot
operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to theCopyDBSnapshot
operation in the us-west-2 Amazon Web Services Region. For this example, theDestinationRegion
in the presigned URL must be set to the us-east-1 Amazon Web Services Region. -
KmsKeyId
- The KMS key identifier for the KMS key to use to encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the same identifier for both theCopyDBSnapshot
operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL. -
SourceDBSnapshotIdentifier
- The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, then yourSourceDBSnapshotIdentifier
looks like the following example:arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify
SourceRegion
(or–source-region
for the CLI) instead of specifyingPreSignedUrl
manually. SpecifyingSourceRegion
autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.-
option_group_name(impl Into<String>)
/set_option_group_name(Option<String>)
:The name of an option group to associate with the copy of the snapshot.
Specify this option if you are copying a snapshot from one Amazon Web Services Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across Amazon Web Services Regions. For more information, see Option group considerations in the Amazon RDS User Guide.
target_custom_availability_zone(impl Into<String>)
/set_target_custom_availability_zone(Option<String>)
:The external custom Availability Zone (CAZ) identifier for the target CAZ.
Example:
rds-caz-aiqhTgQv
.
- On success, responds with
CopyDbSnapshotOutput
with field(s):db_snapshot(Option<DbSnapshot>)
:Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the
DescribeDBSnapshots
action.
- On failure, responds with
SdkError<CopyDBSnapshotError>
sourcepub fn copy_option_group(&self) -> CopyOptionGroup
pub fn copy_option_group(&self) -> CopyOptionGroup
Constructs a fluent builder for the CopyOptionGroup
operation.
- The fluent builder is configurable:
source_option_group_identifier(impl Into<String>)
/set_source_option_group_identifier(Option<String>)
:The identifier for the source option group.
Constraints:
-
Must specify a valid option group.
-
target_option_group_identifier(impl Into<String>)
/set_target_option_group_identifier(Option<String>)
:The identifier for the copied option group.
Constraints:
-
Can’t be null, empty, or blank
-
Must contain from 1 to 255 letters, numbers, or hyphens
-
First character must be a letter
-
Can’t end with a hyphen or contain two consecutive hyphens
Example:
my-option-group
-
target_option_group_description(impl Into<String>)
/set_target_option_group_description(Option<String>)
:The description for the copied option group.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
- On success, responds with
CopyOptionGroupOutput
with field(s): - On failure, responds with
SdkError<CopyOptionGroupError>
sourcepub fn create_custom_db_engine_version(&self) -> CreateCustomDBEngineVersion
pub fn create_custom_db_engine_version(&self) -> CreateCustomDBEngineVersion
Constructs a fluent builder for the CreateCustomDBEngineVersion
operation.
- The fluent builder is configurable:
engine(impl Into<String>)
/set_engine(Option<String>)
:The database engine to use for your custom engine version (CEV). The only supported value is
custom-oracle-ee
.engine_version(impl Into<String>)
/set_engine_version(Option<String>)
:The name of your CEV. The name format is
19.customized_string
. For example, a valid name is19.my_cev1
. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination ofEngine
andEngineVersion
is unique per customer per Region.database_installation_files_s3_bucket_name(impl Into<String>)
/set_database_installation_files_s3_bucket_name(Option<String>)
:The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is
my-custom-installation-files
.database_installation_files_s3_prefix(impl Into<String>)
/set_database_installation_files_s3_prefix(Option<String>)
:The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is
123456789012/cev1
. If this setting isn’t specified, no prefix is assumed.kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS.
If you have an existing symmetric KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don’t already have a symmetric KMS key in your account, follow the instructions in Creating symmetric KMS keys in the Amazon Web Services Key Management Service Developer Guide.
You can choose the same symmetric key when you create a CEV and a DB instance, or choose different keys.
description(impl Into<String>)
/set_description(Option<String>)
:An optional description of your CEV.
manifest(impl Into<String>)
/set_manifest(Option<String>)
:The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.
The following JSON fields are valid:
- MediaImportTemplateVersion
-
Version of the CEV manifest. The date is in the format
YYYY-MM-DD
. - databaseInstallationFileNames
-
Ordered list of installation files for the CEV.
- opatchFileNames
-
Ordered list of OPatch installers used for the Oracle DB engine.
- psuRuPatchFileNames
-
The PSU and RU patches for this CEV.
- OtherPatchFileNames
-
The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches.
For more information, see Creating the CEV manifest in the Amazon RDS User Guide.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
- On success, responds with
CreateCustomDbEngineVersionOutput
with field(s):engine(Option<String>)
:The name of the database engine.
engine_version(Option<String>)
:The version number of the database engine.
db_parameter_group_family(Option<String>)
:The name of the DB parameter group family for the database engine.
db_engine_description(Option<String>)
:The description of the database engine.
db_engine_version_description(Option<String>)
:The description of the database engine version.
default_character_set(Option<CharacterSet>)
:The default character set for new instances of this engine version, if the
CharacterSetName
parameter of the CreateDBInstance API isn’t specified.supported_character_sets(Option<Vec<CharacterSet>>)
:A list of the character sets supported by this engine for the
CharacterSetName
parameter of theCreateDBInstance
operation.supported_nchar_character_sets(Option<Vec<CharacterSet>>)
:A list of the character sets supported by the Oracle DB engine for the
NcharCharacterSetName
parameter of theCreateDBInstance
operation.valid_upgrade_target(Option<Vec<UpgradeTarget>>)
:A list of engine versions that this database engine version can be upgraded to.
supported_timezones(Option<Vec<Timezone>>)
:A list of the time zones supported by this engine for the
Timezone
parameter of theCreateDBInstance
action.exportable_log_types(Option<Vec<String>>)
:The types of logs that the database engine has available for export to CloudWatch Logs.
supports_log_exports_to_cloudwatch_logs(bool)
:A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
supports_read_replica(bool)
:Indicates whether the database engine version supports read replicas.
supported_engine_modes(Option<Vec<String>>)
:A list of the supported DB engine modes.
supported_feature_names(Option<Vec<String>>)
:A list of features supported by the DB engine.
The supported features vary by DB engine and DB engine version.
To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:
aws rds describe-db-engine-versions –engine <engine_name> –engine-version <engine_version></engine_version> </engine_name>
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:
aws rds describe-db-engine-versions –engine postgres –engine-version 13.3
The supported features are listed under
SupportedFeatureNames
in the output.status(Option<String>)
:The status of the DB engine version, either
available
ordeprecated
.supports_parallel_query(bool)
:A value that indicates whether you can use Aurora parallel query with a specific DB engine version.
supports_global_databases(bool)
:A value that indicates whether you can use Aurora global databases with a specific DB engine version.
major_engine_version(Option<String>)
:The major engine version of the CEV.
database_installation_files_s3_bucket_name(Option<String>)
:The name of the Amazon S3 bucket that contains your database installation files.
database_installation_files_s3_prefix(Option<String>)
:The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
db_engine_version_arn(Option<String>)
:The ARN of the custom engine version.
kms_key_id(Option<String>)
:The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
create_time(Option<DateTime>)
:The creation time of the DB engine version.
tag_list(Option<Vec<Tag>>)
:A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
supports_babelfish(bool)
:A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
- On failure, responds with
SdkError<CreateCustomDBEngineVersionError>
sourcepub fn create_db_cluster(&self) -> CreateDBCluster
pub fn create_db_cluster(&self) -> CreateDBCluster
Constructs a fluent builder for the CreateDBCluster
operation.
- The fluent builder is configurable:
availability_zones(Vec<String>)
/set_availability_zones(Option<Vec<String>>)
:A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.
For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
backup_retention_period(i32)
/set_backup_retention_period(Option<i32>)
:The number of days for which automated backups are retained.
Default: 1
Constraints:
-
Must be a value from 1 to 35
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
character_set_name(impl Into<String>)
/set_character_set_name(Option<String>)
:A value that indicates that the DB cluster should be associated with the specified CharacterSet.
Valid for: Aurora DB clusters only
database_name(impl Into<String>)
/set_database_name(Option<String>)
:The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn’t create a database in the DB cluster you are creating.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
db_cluster_identifier(impl Into<String>)
/set_db_cluster_identifier(Option<String>)
:The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
-
Must contain from 1 to 63 letters, numbers, or hyphens.
-
First character must be a letter.
-
Can’t end with a hyphen or contain two consecutive hyphens.
Example:
my-cluster1
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
db_cluster_parameter_group_name(impl Into<String>)
/set_db_cluster_parameter_group_name(Option<String>)
:The name of the DB cluster parameter group to associate with this DB cluster. If you do not specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.
Constraints:
-
If supplied, must match the name of an existing DB cluster parameter group.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
vpc_security_group_ids(Vec<String>)
/set_vpc_security_group_ids(Option<Vec<String>>)
:A list of EC2 VPC security groups to associate with this DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
db_subnet_group_name(impl Into<String>)
/set_db_subnet_group_name(Option<String>)
:A DB subnet group to associate with this DB cluster.
This setting is required to create a Multi-AZ DB cluster.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example:
mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
engine(impl Into<String>)
/set_engine(Option<String>)
:The name of the database engine to be used for this DB cluster.
Valid Values:
-
aurora
(for MySQL 5.6-compatible Aurora) -
aurora-mysql
(for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora) -
aurora-postgresql
-
mysql
-
postgres
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
engine_version(impl Into<String>)
/set_engine_version(Option<String>)
:The version number of the database engine to use.
To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:
aws rds describe-db-engine-versions –engine aurora –query “DBEngineVersions[].EngineVersion”
To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:
aws rds describe-db-engine-versions –engine aurora-mysql –query “DBEngineVersions[].EngineVersion”
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions –engine aurora-postgresql –query “DBEngineVersions[].EngineVersion”
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions –engine mysql –query “DBEngineVersions[].EngineVersion”
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions –engine postgres –query “DBEngineVersions[].EngineVersion”
Aurora MySQL
For information, see MySQL on Amazon RDS Versions in the Amazon Aurora User Guide.
Aurora PostgreSQL
For information, see Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.
MySQL
For information, see MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
PostgreSQL
For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
port(i32)
/set_port(Option<i32>)
:The port number on which the instances in the DB cluster accept connections.
RDS for MySQL and Aurora MySQL
Default:
3306
Valid values:
1150-65535
RDS for PostgreSQL and Aurora PostgreSQL
Default:
5432
Valid values:
1150-65535
Valid for: Aurora DB clusters and Multi-AZ DB clusters
master_username(impl Into<String>)
/set_master_username(Option<String>)
:The name of the master user for the DB cluster.
Constraints:
-
Must be 1 to 16 letters or numbers.
-
First character must be a letter.
-
Can’t be a reserved word for the chosen database engine.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
master_user_password(impl Into<String>)
/set_master_user_password(Option<String>)
:The password for the master database user. This password can contain any printable ASCII character except “/”, “”“, or “@”.
Constraints: Must contain from 8 to 41 characters.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
option_group_name(impl Into<String>)
/set_option_group_name(Option<String>)
:A value that indicates that the DB cluster should be associated with the specified option group.
DB clusters are associated with a default option group that can’t be modified.
preferred_backup_window(impl Into<String>)
/set_preferred_backup_window(Option<String>)
:The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod
parameter.The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Constraints:
-
Must be in the format
hh24:mi-hh24:mi
. -
Must be in Universal Coordinated Time (UTC).
-
Must not conflict with the preferred maintenance window.
-
Must be at least 30 minutes.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
preferred_maintenance_window(impl Into<String>)
/set_preferred_maintenance_window(Option<String>)
:The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format:
ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
replication_source_identifier(impl Into<String>)
/set_replication_source_identifier(Option<String>)
:The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
Valid for: Aurora DB clusters only
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:Tags to assign to the DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
storage_encrypted(bool)
/set_storage_encrypted(Option<bool>)
:A value that indicates whether the DB cluster is encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
When a KMS key isn’t specified in
KmsKeyId
:-
If
ReplicationSourceIdentifier
identifies an encrypted source, then Amazon RDS will use the KMS key used to encrypt the source. Otherwise, Amazon RDS will use your default KMS key. -
If the
StorageEncrypted
parameter is enabled andReplicationSourceIdentifier
isn’t specified, then Amazon RDS will use your default KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you must set
KmsKeyId
to a KMS key identifier that is valid in the destination Amazon Web Services Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
pre_signed_url(impl Into<String>)
/set_pre_signed_url(Option<String>)
:When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another, an URL that contains a Signature Version 4 signed request for the
CreateDBCluster
operation to be called in the source Amazon Web Services Region where the DB cluster is replicated from. SpecifyPreSignedUrl
only when you are performing cross-Region replication from an encrypted DB cluster.The presigned URL must be a valid request for the
CreateDBCluster
API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster to copy.The presigned URL request must contain the following parameter values:
-
KmsKeyId
- The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both theCreateDBCluster
operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL. -
DestinationRegion
- The name of the Amazon Web Services Region that Aurora read replica will be created in. -
ReplicationSourceIdentifier
- The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster from the us-west-2 Amazon Web Services Region, then yourReplicationSourceIdentifier
would look like Example:arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify
SourceRegion
(or–source-region
for the CLI) instead of specifyingPreSignedUrl
manually. SpecifyingSourceRegion
autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.Valid for: Aurora DB clusters only
-
enable_iam_database_authentication(bool)
/set_enable_iam_database_authentication(Option<bool>)
:A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn’t enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
backtrack_window(i64)
/set_backtrack_window(Option<i64>)
:The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
-
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora MySQL DB clusters only
-
enable_cloudwatch_logs_exports(Vec<String>)
/set_enable_cloudwatch_logs_exports(Option<Vec<String>>)
:The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are
error
,general
, andslowquery
.RDS for PostgreSQL
Possible values are
postgresql
andupgrade
.Aurora MySQL
Possible values are
audit
,error
,general
, andslowquery
.Aurora PostgreSQL
Possible value is
postgresql
.For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
engine_mode(impl Into<String>)
/set_engine_mode(Option<String>)
:The DB engine mode of the DB cluster, either
provisioned
,serverless
,parallelquery
,global
, ormultimaster
.The
parallelquery
engine mode isn’t required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.The
global
engine mode isn’t required for Aurora MySQL version 1.22 and higher 1.x versions, andglobal
engine mode isn’t required for any 2.x versions.The
multimaster
engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.The
serverless
engine mode only applies for Aurora Serverless v1 DB clusters.For Aurora PostgreSQL, the
global
engine mode isn’t required, and both theparallelquery
and themultimaster
engine modes currently aren’t supported.Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide:
Valid for: Aurora DB clusters only
scaling_configuration(ScalingConfiguration)
/set_scaling_configuration(Option<ScalingConfiguration>)
:For DB clusters in
serverless
DB engine mode, the scaling properties of the DB cluster.Valid for: Aurora DB clusters only
deletion_protection(bool)
/set_deletion_protection(Option<bool>)
:A value that indicates whether the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection isn’t enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
global_cluster_identifier(impl Into<String>)
/set_global_cluster_identifier(Option<String>)
:The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
Valid for: Aurora DB clusters only
enable_http_endpoint(bool)
/set_enable_http_endpoint(Option<bool>)
:A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint is disabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
copy_tags_to_snapshot(bool)
/set_copy_tags_to_snapshot(Option<bool>)
:A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
domain(impl Into<String>)
/set_domain(Option<String>)
:The Active Directory directory ID to create the DB cluster in.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.
For more information, see Kerberos authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
domain_iam_role_name(impl Into<String>)
/set_domain_iam_role_name(Option<String>)
:Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
enable_global_write_forwarding(bool)
/set_enable_global_write_forwarding(Option<bool>)
:A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (
GlobalCluster
). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the
FailoverGlobalCluster
API operation, but it does nothing until then.Valid for: Aurora DB clusters only
db_cluster_instance_class(impl Into<String>)
/set_db_cluster_instance_class(Option<String>)
:The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.
This setting is required to create a Multi-AZ DB cluster.
Valid for: Multi-AZ DB clusters only
allocated_storage(i32)
/set_allocated_storage(Option<i32>)
:The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
This setting is required to create a Multi-AZ DB cluster.
Valid for: Multi-AZ DB clusters only
storage_type(impl Into<String>)
/set_storage_type(Option<String>)
:Specifies the storage type to be associated with the DB cluster.
This setting is required to create a Multi-AZ DB cluster.
Valid values:
io1
When specified, a value for the
Iops
parameter is required.Default:
io1
Valid for: Multi-AZ DB clusters only
iops(i32)
/set_iops(Option<i32>)
:The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid
Iops
values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide.This setting is required to create a Multi-AZ DB cluster.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
Valid for: Multi-AZ DB clusters only
publicly_accessible(bool)
/set_publicly_accessible(Option<bool>)
:A value that indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster’s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster’s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn’t permitted if the security group assigned to the DB cluster doesn’t permit it.
When the DB cluster isn’t publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether
DBSubnetGroupName
is specified.If
DBSubnetGroupName
isn’t specified, andPubliclyAccessible
isn’t specified, the following applies:-
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
-
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If
DBSubnetGroupName
is specified, andPubliclyAccessible
isn’t specified, the following applies:-
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
-
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Multi-AZ DB clusters only
-
auto_minor_version_upgrade(bool)
/set_auto_minor_version_upgrade(Option<bool>)
:A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
Valid for: Multi-AZ DB clusters only
monitoring_interval(i32)
/set_monitoring_interval(Option<i32>)
:The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If
MonitoringRoleArn
is specified, also setMonitoringInterval
to a value other than 0.Valid Values:
0, 1, 5, 10, 15, 30, 60
Valid for: Multi-AZ DB clusters only
monitoring_role_arn(impl Into<String>)
/set_monitoring_role_arn(Option<String>)
:The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see Setting up and enabling Enhanced Monitoring in the Amazon RDS User Guide.If
MonitoringInterval
is set to a value other than 0, supply aMonitoringRoleArn
value.Valid for: Multi-AZ DB clusters only
enable_performance_insights(bool)
/set_enable_performance_insights(Option<bool>)
:A value that indicates whether to turn on Performance Insights for the DB cluster.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
performance_insights_kms_key_id(impl Into<String>)
/set_performance_insights_kms_key_id(Option<String>)
:The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don’t specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.Valid for: Multi-AZ DB clusters only
performance_insights_retention_period(i32)
/set_performance_insights_retention_period(Option<i32>)
:The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
-
7
-
month * 31, where month is a number of months from 1-23
-
731
For example, the following values are valid:
-
93 (3 months * 31)
-
341 (11 months * 31)
-
589 (19 months * 31)
-
731
If you specify a retention period such as 94, which isn’t a valid value, RDS issues an error.
Valid for: Multi-AZ DB clusters only
-
serverless_v2_scaling_configuration(ServerlessV2ScalingConfiguration)
/set_serverless_v2_scaling_configuration(Option<ServerlessV2ScalingConfiguration>)
:Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
network_type(impl Into<String>)
/set_network_type(Option<String>)
:The network type of the DB cluster.
Valid values:
-
IPV4
-
DUAL
The network type is determined by the
DBSubnetGroup
specified for the DB cluster. ADBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL
).For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
-
- On success, responds with
CreateDbClusterOutput
with field(s):db_cluster(Option<DbCluster>)
:Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,PromoteReadReplicaDBCluster
,RestoreDBClusterFromS3
,RestoreDBClusterFromSnapshot
,RestoreDBClusterToPointInTime
,StartDBCluster
, andStopDBCluster
.For a Multi-AZ DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,RebootDBCluster
,RestoreDBClusterFromSnapshot
, andRestoreDBClusterToPointInTime
.For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
- On failure, responds with
SdkError<CreateDBClusterError>
sourcepub fn create_db_cluster_endpoint(&self) -> CreateDBClusterEndpoint
pub fn create_db_cluster_endpoint(&self) -> CreateDBClusterEndpoint
Constructs a fluent builder for the CreateDBClusterEndpoint
operation.
- The fluent builder is configurable:
db_cluster_identifier(impl Into<String>)
/set_db_cluster_identifier(Option<String>)
:The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
db_cluster_endpoint_identifier(impl Into<String>)
/set_db_cluster_endpoint_identifier(Option<String>)
:The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
endpoint_type(impl Into<String>)
/set_endpoint_type(Option<String>)
:The type of the endpoint, one of:
READER
,WRITER
,ANY
.static_members(Vec<String>)
/set_static_members(Option<Vec<String>>)
:List of DB instance identifiers that are part of the custom endpoint group.
excluded_members(Vec<String>)
/set_excluded_members(Option<Vec<String>>)
:List of DB instance identifiers that aren’t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. This parameter is relevant only if the list of static members is empty.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tags to be assigned to the Amazon RDS resource.
- On success, responds with
CreateDbClusterEndpointOutput
with field(s):db_cluster_endpoint_identifier(Option<String>)
:The identifier associated with the endpoint. This parameter is stored as a lowercase string.
db_cluster_identifier(Option<String>)
:The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
db_cluster_endpoint_resource_identifier(Option<String>)
:A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
endpoint(Option<String>)
:The DNS address of the endpoint.
status(Option<String>)
:The current status of the endpoint. One of:
creating
,available
,deleting
,inactive
,modifying
. Theinactive
state applies to an endpoint that can’t be used for a certain kind of cluster, such as awriter
endpoint for a read-only secondary cluster in a global database.endpoint_type(Option<String>)
:The type of the endpoint. One of:
READER
,WRITER
,CUSTOM
.custom_endpoint_type(Option<String>)
:The type associated with a custom endpoint. One of:
READER
,WRITER
,ANY
.static_members(Option<Vec<String>>)
:List of DB instance identifiers that are part of the custom endpoint group.
excluded_members(Option<Vec<String>>)
:List of DB instance identifiers that aren’t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
db_cluster_endpoint_arn(Option<String>)
:The Amazon Resource Name (ARN) for the endpoint.
- On failure, responds with
SdkError<CreateDBClusterEndpointError>
sourcepub fn create_db_cluster_parameter_group(&self) -> CreateDBClusterParameterGroup
pub fn create_db_cluster_parameter_group(&self) -> CreateDBClusterParameterGroup
Constructs a fluent builder for the CreateDBClusterParameterGroup
operation.
- The fluent builder is configurable:
db_cluster_parameter_group_name(impl Into<String>)
/set_db_cluster_parameter_group_name(Option<String>)
:The name of the DB cluster parameter group.
Constraints:
-
Must not match the name of an existing DB cluster parameter group.
This value is stored as a lowercase string.
-
db_parameter_group_family(impl Into<String>)
/set_db_parameter_group_family(Option<String>)
:The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
Aurora MySQL
Example:
aurora5.6
,aurora-mysql5.7
,aurora-mysql8.0
Aurora PostgreSQL
Example:
aurora-postgresql9.6
RDS for MySQL
Example:
mysql8.0
RDS for PostgreSQL
Example:
postgres12
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions –query “DBEngineVersions[].DBParameterGroupFamily” –engine
For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:
aws rds describe-db-engine-versions –query “DBEngineVersions[].DBParameterGroupFamily” –engine aurora-postgresql
The output contains duplicates.
The following are the valid DB engine values:
-
aurora
(for MySQL 5.6-compatible Aurora) -
aurora-mysql
(for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora) -
aurora-postgresql
-
mysql
-
postgres
-
description(impl Into<String>)
/set_description(Option<String>)
:The description for the DB cluster parameter group.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:Tags to assign to the DB cluster parameter group.
- On success, responds with
CreateDbClusterParameterGroupOutput
with field(s):db_cluster_parameter_group(Option<DbClusterParameterGroup>)
:Contains the details of an Amazon RDS DB cluster parameter group.
This data type is used as a response element in the
DescribeDBClusterParameterGroups
action.
- On failure, responds with
SdkError<CreateDBClusterParameterGroupError>
sourcepub fn create_db_cluster_snapshot(&self) -> CreateDBClusterSnapshot
pub fn create_db_cluster_snapshot(&self) -> CreateDBClusterSnapshot
Constructs a fluent builder for the CreateDBClusterSnapshot
operation.
- The fluent builder is configurable:
db_cluster_snapshot_identifier(impl Into<String>)
/set_db_cluster_snapshot_identifier(Option<String>)
:The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.
Constraints:
-
Must contain from 1 to 63 letters, numbers, or hyphens.
-
First character must be a letter.
-
Can’t end with a hyphen or contain two consecutive hyphens.
Example:
my-cluster1-snapshot1
-
db_cluster_identifier(impl Into<String>)
/set_db_cluster_identifier(Option<String>)
:The identifier of the DB cluster to create a snapshot for. This parameter isn’t case-sensitive.
Constraints:
-
Must match the identifier of an existing DBCluster.
Example:
my-cluster1
-
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tags to be assigned to the DB cluster snapshot.
- On success, responds with
CreateDbClusterSnapshotOutput
with field(s):db_cluster_snapshot(Option<DbClusterSnapshot>)
:Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the
DescribeDBClusterSnapshots
action.
- On failure, responds with
SdkError<CreateDBClusterSnapshotError>
sourcepub fn create_db_instance(&self) -> CreateDBInstance
pub fn create_db_instance(&self) -> CreateDBInstance
Constructs a fluent builder for the CreateDBInstance
operation.
- The fluent builder is configurable:
db_name(impl Into<String>)
/set_db_name(Option<String>)
:The meaning of this parameter differs according to the database engine you use.
MySQL
The name of the database to create when the DB instance is created. If this parameter isn’t specified, no database is created in the DB instance.
Constraints:
-
Must contain 1 to 64 letters or numbers.
-
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
-
Can’t be a word reserved by the specified database engine
MariaDB
The name of the database to create when the DB instance is created. If this parameter isn’t specified, no database is created in the DB instance.
Constraints:
-
Must contain 1 to 64 letters or numbers.
-
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
-
Can’t be a word reserved by the specified database engine
PostgreSQL
The name of the database to create when the DB instance is created. If this parameter isn’t specified, a database named
postgres
is created in the DB instance.Constraints:
-
Must contain 1 to 63 letters, numbers, or underscores.
-
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
-
Can’t be a word reserved by the specified database engine
Oracle
The Oracle System ID (SID) of the created DB instance. If you specify
null
, the default valueORCL
is used. You can’t specify the string NULL, or any other reserved word, forDBName
.Default:
ORCL
Constraints:
-
Can’t be longer than 8 characters
Amazon RDS Custom for Oracle
The Oracle System ID (SID) of the created RDS Custom DB instance. If you don’t specify a value, the default value is
ORCL
.Default:
ORCL
Constraints:
-
It must contain 1 to 8 alphanumeric characters.
-
It must contain a letter.
-
It can’t be a word reserved by the database engine.
Amazon RDS Custom for SQL Server
Not applicable. Must be null.
SQL Server
Not applicable. Must be null.
Amazon Aurora MySQL
The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If this parameter isn’t specified for an Aurora MySQL DB cluster, no database is created in the DB cluster.
Constraints:
-
It must contain 1 to 64 alphanumeric characters.
-
It can’t be a word reserved by the database engine.
Amazon Aurora PostgreSQL
The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created. If this parameter isn’t specified for an Aurora PostgreSQL DB cluster, a database named
postgres
is created in the DB cluster.Constraints:
-
It must contain 1 to 63 alphanumeric characters.
-
It must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0 to 9).
-
It can’t be a word reserved by the database engine.
-
db_instance_identifier(impl Into<String>)
/set_db_instance_identifier(Option<String>)
:The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
-
Must contain from 1 to 63 letters, numbers, or hyphens.
-
First character must be a letter.
-
Can’t end with a hyphen or contain two consecutive hyphens.
Example:
mydbinstance
-
allocated_storage(i32)
/set_allocated_storage(Option<i32>)
:The amount of storage in gibibytes (GiB) to allocate for the DB instance.
Type: Integer
Amazon Aurora
Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
Amazon RDS Custom
Constraints to the amount of storage for each storage type are the following:
-
General Purpose (SSD) storage (gp2): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
-
Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
MySQL
Constraints to the amount of storage for each storage type are the following:
-
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
-
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
-
Magnetic storage (standard): Must be an integer from 5 to 3072.
MariaDB
Constraints to the amount of storage for each storage type are the following:
-
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
-
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
-
Magnetic storage (standard): Must be an integer from 5 to 3072.
PostgreSQL
Constraints to the amount of storage for each storage type are the following:
-
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
-
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
-
Magnetic storage (standard): Must be an integer from 5 to 3072.
Oracle
Constraints to the amount of storage for each storage type are the following:
-
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
-
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
-
Magnetic storage (standard): Must be an integer from 10 to 3072.
SQL Server
Constraints to the amount of storage for each storage type are the following:
-
General Purpose (SSD) storage (gp2):
-
Enterprise and Standard editions: Must be an integer from 20 to 16384.
-
Web and Express editions: Must be an integer from 20 to 16384.
-
-
Provisioned IOPS storage (io1):
-
Enterprise and Standard editions: Must be an integer from 100 to 16384.
-
Web and Express editions: Must be an integer from 100 to 16384.
-
-
Magnetic storage (standard):
-
Enterprise and Standard editions: Must be an integer from 20 to 1024.
-
Web and Express editions: Must be an integer from 20 to 1024.
-
-
db_instance_class(impl Into<String>)
/set_db_instance_class(Option<String>)
:The compute and memory capacity of the DB instance, for example db.m5.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide.
engine(impl Into<String>)
/set_engine(Option<String>)
:The name of the database engine to be used for this instance.
Not every database engine is available for every Amazon Web Services Region.
Valid Values:
-
aurora
(for MySQL 5.6-compatible Aurora) -
aurora-mysql
(for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora) -
aurora-postgresql
-
custom-oracle-ee (for RDS Custom for Oracle instances)
-
custom-sqlserver-ee (for RDS Custom for SQL Server instances)
-
custom-sqlserver-se (for RDS Custom for SQL Server instances)
-
custom-sqlserver-web (for RDS Custom for SQL Server instances)
-
mariadb
-
mysql
-
oracle-ee
-
oracle-ee-cdb
-
oracle-se2
-
oracle-se2-cdb
-
postgres
-
sqlserver-ee
-
sqlserver-se
-
sqlserver-ex
-
sqlserver-web
-
master_username(impl Into<String>)
/set_master_username(Option<String>)
:The name for the master user.
Amazon Aurora
Not applicable. The name for the master user is managed by the DB cluster.
Amazon RDS
Constraints:
-
Required.
-
Must be 1 to 16 letters, numbers, or underscores.
-
First character must be a letter.
-
Can’t be a reserved word for the chosen database engine.
-
master_user_password(impl Into<String>)
/set_master_user_password(Option<String>)
:The password for the master user. The password can include any printable ASCII character except “/”, “”“, or “@”.
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
db_security_groups(Vec<String>)
/set_db_security_groups(Option<Vec<String>>)
:A list of DB security groups to associate with this DB instance.
This setting applies to the legacy EC2-Classic platform, which is no longer used to create new DB instances. Use the
VpcSecurityGroupIds
setting instead.vpc_security_group_ids(Vec<String>)
/set_vpc_security_group_ids(Option<Vec<String>>)
:A list of Amazon EC2 VPC security groups to associate with this DB instance.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster.
Default: The default EC2 VPC security group for the DB subnet group’s VPC.
availability_zone(impl Into<String>)
/set_availability_zone(Option<String>)
:The Availability Zone (AZ) where the database will be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
Amazon Aurora
Each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don’t specify one.
Default: A random, system-chosen Availability Zone in the endpoint’s Amazon Web Services Region.
Example:
us-east-1d
Constraint: The
AvailabilityZone
parameter can’t be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.db_subnet_group_name(impl Into<String>)
/set_db_subnet_group_name(Option<String>)
:A DB subnet group to associate with this DB instance.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example:
mydbsubnetgroup
preferred_maintenance_window(impl Into<String>)
/set_preferred_maintenance_window(Option<String>)
:The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.
Format:
ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
db_parameter_group_name(impl Into<String>)
/set_db_parameter_group_name(Option<String>)
:The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then the default DB parameter group for the specified DB engine and version is used.
This setting doesn’t apply to RDS Custom.
Constraints:
-
Must be 1 to 255 letters, numbers, or hyphens.
-
First character must be a letter
-
Can’t end with a hyphen or contain two consecutive hyphens
-
backup_retention_period(i32)
/set_backup_retention_period(Option<i32>)
:The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster.
Default: 1
Constraints:
-
Must be a value from 0 to 35
-
Can’t be set to 0 if the DB instance is a source to read replicas
-
Can’t be set to 0 for an RDS Custom for Oracle DB instance
-
preferred_backup_window(impl Into<String>)
/set_preferred_backup_window(Option<String>)
:The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster.
Constraints:
-
Must be in the format
hh24:mi-hh24:mi
. -
Must be in Universal Coordinated Time (UTC).
-
Must not conflict with the preferred maintenance window.
-
Must be at least 30 minutes.
-
port(i32)
/set_port(Option<i32>)
:The port number on which the database accepts connections.
MySQL
Default:
3306
Valid values:
1150-65535
Type: Integer
MariaDB
Default:
3306
Valid values:
1150-65535
Type: Integer
PostgreSQL
Default:
5432
Valid values:
1150-65535
Type: Integer
Oracle
Default:
1521
Valid values:
1150-65535
SQL Server
Default:
1433
Valid values:
1150-65535
except1234
,1434
,3260
,3343
,3389
,47001
, and49152-49156
.Amazon Aurora
Default:
3306
Valid values:
1150-65535
Type: Integer
multi_az(bool)
/set_multi_az(Option<bool>)
:A value that indicates whether the DB instance is a Multi-AZ deployment. You can’t set the
AvailabilityZone
parameter if the DB instance is a Multi-AZ deployment.This setting doesn’t apply to RDS Custom.
Amazon Aurora
Not applicable. DB instance Availability Zones (AZs) are managed by the DB cluster.
engine_version(impl Into<String>)
/set_engine_version(Option<String>)
:The version number of the database engine to use.
For a list of valid engine versions, use the
DescribeDBEngineVersions
operation.The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every Amazon Web Services Region.
Amazon Aurora
Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.
Amazon RDS Custom for Oracle
A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV name has the following format:
19.customized_string
. An example identifier is19.my_cev1
. For more information, see Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.Amazon RDS Custom for SQL Server
See RDS Custom for SQL Server general requirements in the Amazon RDS User Guide.
MariaDB
For information, see MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.
Microsoft SQL Server
For information, see Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide.
MySQL
For information, see MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
Oracle
For information, see Oracle Database Engine Release Notes in the Amazon RDS User Guide.
PostgreSQL
For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
auto_minor_version_upgrade(bool)
/set_auto_minor_version_upgrade(Option<bool>)
:A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
If you create an RDS Custom DB instance, you must set
AutoMinorVersionUpgrade
tofalse
.license_model(impl Into<String>)
/set_license_model(Option<String>)
:License model information for this DB instance.
Valid values:
license-included
|bring-your-own-license
|general-public-license
This setting doesn’t apply to RDS Custom.
Amazon Aurora
Not applicable.
iops(i32)
/set_iops(Option<i32>)
:The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid
Iops
values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide.Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.
Amazon Aurora
Not applicable. Storage is managed by the DB cluster.
option_group_name(impl Into<String>)
/set_option_group_name(Option<String>)
:A value that indicates that the DB instance should be associated with the specified option group.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can’t be removed from an option group. Also, that option group can’t be removed from a DB instance after it is associated with a DB instance.
This setting doesn’t apply to RDS Custom.
Amazon Aurora
Not applicable.
character_set_name(impl Into<String>)
/set_character_set_name(Option<String>)
:For supported engines, this value indicates that the DB instance should be associated with the specified
CharacterSet
.This setting doesn’t apply to RDS Custom. However, if you need to change the character set, you can change it on the database itself.
Amazon Aurora
Not applicable. The character set is managed by the DB cluster. For more information, see
CreateDBCluster
.nchar_character_set_name(impl Into<String>)
/set_nchar_character_set_name(Option<String>)
:The name of the NCHAR character set for the Oracle DB instance.
This parameter doesn’t apply to RDS Custom.
publicly_accessible(bool)
/set_publicly_accessible(Option<bool>)
:A value that indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance’s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance’s VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn’t permit it.
When the DB instance isn’t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether
DBSubnetGroupName
is specified.If
DBSubnetGroupName
isn’t specified, andPubliclyAccessible
isn’t specified, the following applies:-
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB instance is private.
-
If the default VPC in the target Region has an internet gateway attached to it, the DB instance is public.
If
DBSubnetGroupName
is specified, andPubliclyAccessible
isn’t specified, the following applies:-
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB instance is private.
-
If the subnets are part of a VPC that has an internet gateway attached to it, the DB instance is public.
-
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:Tags to assign to the DB instance.
db_cluster_identifier(impl Into<String>)
/set_db_cluster_identifier(Option<String>)
:The identifier of the DB cluster that the instance will belong to.
This setting doesn’t apply to RDS Custom.
storage_type(impl Into<String>)
/set_storage_type(Option<String>)
:Specifies the storage type to be associated with the DB instance.
Valid values:
standard | gp2 | io1
If you specify
io1
, you must also include a value for theIops
parameter.Default:
io1
if theIops
parameter is specified, otherwisegp2
Amazon Aurora
Not applicable. Storage is managed by the DB cluster.
tde_credential_arn(impl Into<String>)
/set_tde_credential_arn(Option<String>)
:The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn’t apply to RDS Custom.
Amazon Aurora
Not applicable.
tde_credential_password(impl Into<String>)
/set_tde_credential_password(Option<String>)
:The password for the given ARN from the key store in order to access the device.
This setting doesn’t apply to RDS Custom.
storage_encrypted(bool)
/set_storage_encrypted(Option<bool>)
:A value that indicates whether the DB instance is encrypted. By default, it isn’t encrypted.
For RDS Custom instances, either set this parameter to
true
or leave it unset. If you set this parameter tofalse
, RDS reports an error.Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster.
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:The Amazon Web Services KMS key identifier for an encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
Amazon Aurora
Not applicable. The Amazon Web Services KMS key identifier is managed by the DB cluster. For more information, see
CreateDBCluster
.If
StorageEncrypted
is enabled, and you do not specify a value for theKmsKeyId
parameter, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.Amazon RDS Custom
A KMS key is required for RDS Custom instances. For most RDS engines, if you leave this parameter empty while enabling
StorageEncrypted
, the engine uses the default KMS key. However, RDS Custom doesn’t use the default key when this parameter is empty. You must explicitly specify a key.domain(impl Into<String>)
/set_domain(Option<String>)
:The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn’t apply to RDS Custom.
Amazon Aurora
Not applicable. The domain is managed by the DB cluster.
copy_tags_to_snapshot(bool)
/set_copy_tags_to_snapshot(Option<bool>)
:A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
monitoring_interval(i32)
/set_monitoring_interval(Option<i32>)
:The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.
If
MonitoringRoleArn
is specified, then you must setMonitoringInterval
to a value other than 0.This setting doesn’t apply to RDS Custom.
Valid Values:
0, 1, 5, 10, 15, 30, 60
monitoring_role_arn(impl Into<String>)
/set_monitoring_role_arn(Option<String>)
:The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.If
MonitoringInterval
is set to a value other than 0, then you must supply aMonitoringRoleArn
value.This setting doesn’t apply to RDS Custom.
domain_iam_role_name(impl Into<String>)
/set_domain_iam_role_name(Option<String>)
:Specify the name of the IAM role to be used when making API calls to the Directory Service.
This setting doesn’t apply to RDS Custom.
Amazon Aurora
Not applicable. The domain is managed by the DB cluster.
promotion_tier(i32)
/set_promotion_tier(Option<i32>)
:A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
This setting doesn’t apply to RDS Custom.
Default: 1
Valid Values: 0 - 15
timezone(impl Into<String>)
/set_timezone(Option<String>)
:The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
enable_iam_database_authentication(bool)
/set_enable_iam_database_authentication(Option<bool>)
:A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn’t enabled.
For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn’t apply to RDS Custom.
Amazon Aurora
Not applicable. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
enable_performance_insights(bool)
/set_enable_performance_insights(Option<bool>)
:A value that indicates whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
This setting doesn’t apply to RDS Custom.
performance_insights_kms_key_id(impl Into<String>)
/set_performance_insights_kms_key_id(Option<String>)
:The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.This setting doesn’t apply to RDS Custom.
performance_insights_retention_period(i32)
/set_performance_insights_retention_period(Option<i32>)
:The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
-
7
-
month * 31, where month is a number of months from 1-23
-
731
For example, the following values are valid:
-
93 (3 months * 31)
-
341 (11 months * 31)
-
589 (19 months * 31)
-
731
If you specify a retention period such as 94, which isn’t a valid value, RDS issues an error.
This setting doesn’t apply to RDS Custom.
-
enable_cloudwatch_logs_exports(Vec<String>)
/set_enable_cloudwatch_logs_exports(Option<Vec<String>>)
:The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
Amazon Aurora
Not applicable. CloudWatch Logs exports are managed by the DB cluster.
RDS Custom
Not applicable.
MariaDB
Possible values are
audit
,error
,general
, andslowquery
.Microsoft SQL Server
Possible values are
agent
anderror
.MySQL
Possible values are
audit
,error
,general
, andslowquery
.Oracle
Possible values are
alert
,audit
,listener
,trace
, andoemagent
.PostgreSQL
Possible values are
postgresql
andupgrade
.processor_features(Vec<ProcessorFeature>)
/set_processor_features(Option<Vec<ProcessorFeature>>)
:The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn’t apply to RDS Custom.
Amazon Aurora
Not applicable.
deletion_protection(bool)
/set_deletion_protection(Option<bool>)
:A value that indicates whether the DB instance has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection isn’t enabled. For more information, see Deleting a DB Instance.
Amazon Aurora
Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see
CreateDBCluster
. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.max_allocated_storage(i32)
/set_max_allocated_storage(Option<i32>)
:The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn’t apply to RDS Custom.
Amazon Aurora
Not applicable. Storage is managed by the DB cluster.
enable_customer_owned_ip(bool)
/set_enable_customer_owned_ip(Option<bool>)
:A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
custom_iam_instance_profile(impl Into<String>)
/set_custom_iam_instance_profile(Option<String>)
:The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
-
The profile must exist in your account.
-
The profile must have an IAM role that Amazon EC2 has permissions to assume.
-
The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom
.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom.
-
backup_target(impl Into<String>)
/set_backup_target(Option<String>)
:Specifies where automated backups and manual snapshots are stored.
Possible values are
outposts
(Amazon Web Services Outposts) andregion
(Amazon Web Services Region). The default isregion
.For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
network_type(impl Into<String>)
/set_network_type(Option<String>)
:The network type of the DB instance.
Valid values:
-
IPV4
-
DUAL
The network type is determined by the
DBSubnetGroup
specified for the DB instance. ADBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL
).For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
-
- On success, responds with
CreateDbInstanceOutput
with field(s):db_instance(Option<DbInstance>)
:Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
- On failure, responds with
SdkError<CreateDBInstanceError>
sourcepub fn create_db_instance_read_replica(&self) -> CreateDBInstanceReadReplica
pub fn create_db_instance_read_replica(&self) -> CreateDBInstanceReadReplica
Constructs a fluent builder for the CreateDBInstanceReadReplica
operation.
- The fluent builder is configurable:
db_instance_identifier(impl Into<String>)
/set_db_instance_identifier(Option<String>)
:The DB instance identifier of the read replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.
source_db_instance_identifier(impl Into<String>)
/set_source_db_instance_identifier(Option<String>)
:The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to five read replicas.
Constraints:
-
Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance.
-
Can specify a DB instance that is a MySQL read replica only if the source is running MySQL 5.6 or later.
-
For the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the Amazon RDS User Guide.
-
For the limitations of SQL Server read replicas, see Read Replica Limitations with Microsoft SQL Server in the Amazon RDS User Guide.
-
Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-Region replication).
-
The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.
-
If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier.
-
If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn’t apply to SQL Server or RDS Custom, which don’t support cross-Region replicas.
-
db_instance_class(impl Into<String>)
/set_db_instance_class(Option<String>)
:The compute and memory capacity of the read replica, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: Inherits from the source DB instance.
availability_zone(impl Into<String>)
/set_availability_zone(Option<String>)
:The Availability Zone (AZ) where the read replica will be created.
Default: A random, system-chosen Availability Zone in the endpoint’s Amazon Web Services Region.
Example:
us-east-1d
port(i32)
/set_port(Option<i32>)
:The port number that the DB instance uses for connections.
Default: Inherits from the source DB instance
Valid Values:
1150-65535
multi_az(bool)
/set_multi_az(Option<bool>)
:A value that indicates whether the read replica is in a Multi-AZ deployment.
You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your read replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.
This setting doesn’t apply to RDS Custom.
auto_minor_version_upgrade(bool)
/set_auto_minor_version_upgrade(Option<bool>)
:A value that indicates whether minor engine upgrades are applied automatically to the read replica during the maintenance window.
This setting doesn’t apply to RDS Custom.
Default: Inherits from the source DB instance
iops(i32)
/set_iops(Option<i32>)
:The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
option_group_name(impl Into<String>)
/set_option_group_name(Option<String>)
:The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.
For SQL Server, you must use the option group associated with the source instance.
This setting doesn’t apply to RDS Custom.
db_parameter_group_name(impl Into<String>)
/set_db_parameter_group_name(Option<String>)
:The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for
DBParameterGroupName
, then Amazon RDS uses theDBParameterGroup
of source DB instance for a same Region read replica, or the defaultDBParameterGroup
for the specified DB engine for a cross-Region read replica.Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. It isn’t supported for RDS Custom.
Constraints:
-
Must be 1 to 255 letters, numbers, or hyphens.
-
First character must be a letter
-
Can’t end with a hyphen or contain two consecutive hyphens
-
publicly_accessible(bool)
/set_publicly_accessible(Option<bool>)
:A value that indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster’s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster’s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn’t permitted if the security group assigned to the DB cluster doesn’t permit it.
When the DB instance isn’t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see
CreateDBInstance
.tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
db_subnet_group_name(impl Into<String>)
/set_db_subnet_group_name(Option<String>)
:Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn’t created in a VPC.
Constraints:
-
Can only be specified if the source DB instance identifier specifies a DB instance in another Amazon Web Services Region.
-
If supplied, must match the name of an existing DBSubnetGroup.
-
The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.
-
All read replicas in one Amazon Web Services Region that are created from the same source DB instance must either:>
-
Specify DB subnet groups from the same VPC. All these read replicas are created in the same VPC.
-
Not specify a DB subnet group. All these read replicas are created outside of any VPC.
-
Example:
mydbsubnetgroup
-
vpc_security_group_ids(Vec<String>)
/set_vpc_security_group_ids(Option<Vec<String>>)
:A list of Amazon EC2 VPC security groups to associate with the read replica.
This setting doesn’t apply to RDS Custom.
Default: The default EC2 VPC security group for the DB subnet group’s VPC.
storage_type(impl Into<String>)
/set_storage_type(Option<String>)
:Specifies the storage type to be associated with the read replica.
Valid values:
standard | gp2 | io1
If you specify
io1
, you must also include a value for theIops
parameter.Default:
io1
if theIops
parameter is specified, otherwisegp2
copy_tags_to_snapshot(bool)
/set_copy_tags_to_snapshot(Option<bool>)
:A value that indicates whether to copy all tags from the read replica to snapshots of the read replica. By default, tags are not copied.
monitoring_interval(i32)
/set_monitoring_interval(Option<i32>)
:The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If
MonitoringRoleArn
is specified, then you must also setMonitoringInterval
to a value other than 0.This setting doesn’t apply to RDS Custom.
Valid Values:
0, 1, 5, 10, 15, 30, 60
monitoring_role_arn(impl Into<String>)
/set_monitoring_role_arn(Option<String>)
:The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.If
MonitoringInterval
is set to a value other than 0, then you must supply aMonitoringRoleArn
value.This setting doesn’t apply to RDS Custom.
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:The Amazon Web Services KMS key identifier for an encrypted read replica.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance, then do not specify a value for this parameter. A read replica in the same Amazon Web Services Region is always encrypted with the same KMS key as the source DB instance.
If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can’t use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.
You can’t create an encrypted read replica from an unencrypted DB instance.
This setting doesn’t apply to RDS Custom, which uses the same KMS key as the primary replica.
pre_signed_url(impl Into<String>)
/set_pre_signed_url(Option<String>)
:When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4 signed request for the
CreateDBInstanceReadReplica
API operation in the source Amazon Web Services Region that contains the source DB instance.This setting applies only to Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions. It’s ignored in other Amazon Web Services Regions.
You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don’t specify
PreSignedUrl
when you are creating an encrypted read replica in the same Amazon Web Services Region.The presigned URL must be a valid request for the
CreateDBInstanceReadReplica
API operation that can run in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:-
DestinationRegion
- The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where theCreateDBInstanceReadReplica
operation is called that contains this presigned URL.For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the
CreateDBInstanceReadReplica
operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to theCreateDBInstanceReadReplica
operation in the us-west-2 Amazon Web Services Region. For this example, theDestinationRegion
in the presigned URL must be set to the us-east-1 Amazon Web Services Region. -
KmsKeyId
- The KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both theCreateDBInstanceReadReplica
operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL. -
SourceDBInstanceIdentifier
- The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then yourSourceDBInstanceIdentifier
looks like the following example:arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify
SourceRegion
(or–source-region
for the CLI) instead of specifyingPreSignedUrl
manually. SpecifyingSourceRegion
autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.SourceRegion
isn’t supported for SQL Server, because Amazon RDS for SQL Server doesn’t support cross-Region read replicas.This setting doesn’t apply to RDS Custom.
-
enable_iam_database_authentication(bool)
/set_enable_iam_database_authentication(Option<bool>)
:A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn’t enabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn’t apply to RDS Custom.
enable_performance_insights(bool)
/set_enable_performance_insights(Option<bool>)
:A value that indicates whether to enable Performance Insights for the read replica.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
This setting doesn’t apply to RDS Custom.
performance_insights_kms_key_id(impl Into<String>)
/set_performance_insights_kms_key_id(Option<String>)
:The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.This setting doesn’t apply to RDS Custom.
performance_insights_retention_period(i32)
/set_performance_insights_retention_period(Option<i32>)
:The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
-
7
-
month * 31, where month is a number of months from 1-23
-
731
For example, the following values are valid:
-
93 (3 months * 31)
-
341 (11 months * 31)
-
589 (19 months * 31)
-
731
If you specify a retention period such as 94, which isn’t a valid value, RDS issues an error.
This setting doesn’t apply to RDS Custom.
-
enable_cloudwatch_logs_exports(Vec<String>)
/set_enable_cloudwatch_logs_exports(Option<Vec<String>>)
:The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn’t apply to RDS Custom.
processor_features(Vec<ProcessorFeature>)
/set_processor_features(Option<Vec<ProcessorFeature>>)
:The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn’t apply to RDS Custom.
use_default_processor_features(bool)
/set_use_default_processor_features(Option<bool>)
:A value that indicates whether the DB instance class of the DB instance uses its default processor features.
This setting doesn’t apply to RDS Custom.
deletion_protection(bool)
/set_deletion_protection(Option<bool>)
:A value that indicates whether the DB instance has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection isn’t enabled. For more information, see Deleting a DB Instance.
domain(impl Into<String>)
/set_domain(Option<String>)
:The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn’t apply to RDS Custom.
domain_iam_role_name(impl Into<String>)
/set_domain_iam_role_name(Option<String>)
:Specify the name of the IAM role to be used when making API calls to the Directory Service.
This setting doesn’t apply to RDS Custom.
replica_mode(ReplicaMode)
/set_replica_mode(Option<ReplicaMode>)
:The open mode of the replica database: mounted or read-only.
This parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn’t use Active Data Guard to transmit information to the mounted replica. Because it doesn’t accept user connections, a mounted replica can’t serve a read-only workload.
You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
For RDS Custom, you must specify this parameter and set it to
mounted
. The value won’t be set by default. After replica creation, you can manage the open mode manually.max_allocated_storage(i32)
/set_max_allocated_storage(Option<i32>)
:The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
custom_iam_instance_profile(impl Into<String>)
/set_custom_iam_instance_profile(Option<String>)
:The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
-
The profile must exist in your account.
-
The profile must have an IAM role that Amazon EC2 has permissions to assume.
-
The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom
.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom.
-
network_type(impl Into<String>)
/set_network_type(Option<String>)
:The network type of the DB instance.
Valid values:
-
IPV4
-
DUAL
The network type is determined by the
DBSubnetGroup
specified for read replica. ADBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL
).For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
-
- On success, responds with
CreateDbInstanceReadReplicaOutput
with field(s):db_instance(Option<DbInstance>)
:Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
- On failure, responds with
SdkError<CreateDBInstanceReadReplicaError>
sourcepub fn create_db_parameter_group(&self) -> CreateDBParameterGroup
pub fn create_db_parameter_group(&self) -> CreateDBParameterGroup
Constructs a fluent builder for the CreateDBParameterGroup
operation.
- The fluent builder is configurable:
db_parameter_group_name(impl Into<String>)
/set_db_parameter_group_name(Option<String>)
:The name of the DB parameter group.
Constraints:
-
Must be 1 to 255 letters, numbers, or hyphens.
-
First character must be a letter
-
Can’t end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
-
db_parameter_group_family(impl Into<String>)
/set_db_parameter_group_family(Option<String>)
:The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions –query “DBEngineVersions[].DBParameterGroupFamily” –engine
For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:
aws rds describe-db-engine-versions –query “DBEngineVersions[].DBParameterGroupFamily” –engine mysql
The output contains duplicates.
The following are the valid DB engine values:
-
aurora
(for MySQL 5.6-compatible Aurora) -
aurora-mysql
(for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora) -
aurora-postgresql
-
mariadb
-
mysql
-
oracle-ee
-
oracle-ee-cdb
-
oracle-se2
-
oracle-se2-cdb
-
postgres
-
sqlserver-ee
-
sqlserver-se
-
sqlserver-ex
-
sqlserver-web
-
description(impl Into<String>)
/set_description(Option<String>)
:The description for the DB parameter group.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:Tags to assign to the DB parameter group.
- On success, responds with
CreateDbParameterGroupOutput
with field(s):db_parameter_group(Option<DbParameterGroup>)
:Contains the details of an Amazon RDS DB parameter group.
This data type is used as a response element in the
DescribeDBParameterGroups
action.
- On failure, responds with
SdkError<CreateDBParameterGroupError>
sourcepub fn create_db_proxy(&self) -> CreateDBProxy
pub fn create_db_proxy(&self) -> CreateDBProxy
Constructs a fluent builder for the CreateDBProxy
operation.
- The fluent builder is configurable:
db_proxy_name(impl Into<String>)
/set_db_proxy_name(Option<String>)
:The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can’t end with a hyphen or contain two consecutive hyphens.
engine_family(EngineFamily)
/set_engine_family(Option<EngineFamily>)
:The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify
MYSQL
. For Aurora PostgreSQL and RDS for PostgreSQL databases, specifyPOSTGRESQL
.auth(Vec<UserAuthConfig>)
/set_auth(Option<Vec<UserAuthConfig>>)
:The authorization mechanism that the proxy uses.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
vpc_subnet_ids(Vec<String>)
/set_vpc_subnet_ids(Option<Vec<String>>)
:One or more VPC subnet IDs to associate with the new proxy.
vpc_security_group_ids(Vec<String>)
/set_vpc_security_group_ids(Option<Vec<String>>)
:One or more VPC security group IDs to associate with the new proxy.
require_tls(bool)
/set_require_tls(bool)
:A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.
idle_client_timeout(i32)
/set_idle_client_timeout(Option<i32>)
:The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.
debug_logging(bool)
/set_debug_logging(bool)
:Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
- On success, responds with
CreateDbProxyOutput
with field(s):db_proxy(Option<DbProxy>)
:The
DBProxy
structure corresponding to the new proxy.
- On failure, responds with
SdkError<CreateDBProxyError>
sourcepub fn create_db_proxy_endpoint(&self) -> CreateDBProxyEndpoint
pub fn create_db_proxy_endpoint(&self) -> CreateDBProxyEndpoint
Constructs a fluent builder for the CreateDBProxyEndpoint
operation.
- The fluent builder is configurable:
db_proxy_name(impl Into<String>)
/set_db_proxy_name(Option<String>)
:The name of the DB proxy associated with the DB proxy endpoint that you create.
db_proxy_endpoint_name(impl Into<String>)
/set_db_proxy_endpoint_name(Option<String>)
:The name of the DB proxy endpoint to create.
vpc_subnet_ids(Vec<String>)
/set_vpc_subnet_ids(Option<Vec<String>>)
:The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a different set of subnet IDs than for the original DB proxy.
vpc_security_group_ids(Vec<String>)
/set_vpc_security_group_ids(Option<Vec<String>>)
:The VPC security group IDs for the DB proxy endpoint that you create. You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.
target_role(DbProxyEndpointTargetRole)
/set_target_role(Option<DbProxyEndpointTargetRole>)
:A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. The default is
READ_WRITE
.tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
- On success, responds with
CreateDbProxyEndpointOutput
with field(s):db_proxy_endpoint(Option<DbProxyEndpoint>)
:The
DBProxyEndpoint
object that is created by the API operation. The DB proxy endpoint that you create might provide capabilities such as read/write or read-only operations, or using a different VPC than the proxy’s default VPC.
- On failure, responds with
SdkError<CreateDBProxyEndpointError>
sourcepub fn create_db_security_group(&self) -> CreateDBSecurityGroup
pub fn create_db_security_group(&self) -> CreateDBSecurityGroup
Constructs a fluent builder for the CreateDBSecurityGroup
operation.
- The fluent builder is configurable:
db_security_group_name(impl Into<String>)
/set_db_security_group_name(Option<String>)
:The name for the DB security group. This value is stored as a lowercase string.
Constraints:
-
Must be 1 to 255 letters, numbers, or hyphens.
-
First character must be a letter
-
Can’t end with a hyphen or contain two consecutive hyphens
-
Must not be “Default”
Example:
mysecuritygroup
-
db_security_group_description(impl Into<String>)
/set_db_security_group_description(Option<String>)
:The description for the DB security group.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:Tags to assign to the DB security group.
- On success, responds with
CreateDbSecurityGroupOutput
with field(s):db_security_group(Option<DbSecurityGroup>)
:Contains the details for an Amazon RDS DB security group.
This data type is used as a response element in the
DescribeDBSecurityGroups
action.
- On failure, responds with
SdkError<CreateDBSecurityGroupError>
sourcepub fn create_db_snapshot(&self) -> CreateDBSnapshot
pub fn create_db_snapshot(&self) -> CreateDBSnapshot
Constructs a fluent builder for the CreateDBSnapshot
operation.
- The fluent builder is configurable:
db_snapshot_identifier(impl Into<String>)
/set_db_snapshot_identifier(Option<String>)
:The identifier for the DB snapshot.
Constraints:
-
Can’t be null, empty, or blank
-
Must contain from 1 to 255 letters, numbers, or hyphens
-
First character must be a letter
-
Can’t end with a hyphen or contain two consecutive hyphens
Example:
my-snapshot-id
-
db_instance_identifier(impl Into<String>)
/set_db_instance_identifier(Option<String>)
:The identifier of the DB instance that you want to create the snapshot of.
Constraints:
-
Must match the identifier of an existing DBInstance.
-
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
- On success, responds with
CreateDbSnapshotOutput
with field(s):db_snapshot(Option<DbSnapshot>)
:Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the
DescribeDBSnapshots
action.
- On failure, responds with
SdkError<CreateDBSnapshotError>
sourcepub fn create_db_subnet_group(&self) -> CreateDBSubnetGroup
pub fn create_db_subnet_group(&self) -> CreateDBSubnetGroup
Constructs a fluent builder for the CreateDBSubnetGroup
operation.
- The fluent builder is configurable:
db_subnet_group_name(impl Into<String>)
/set_db_subnet_group_name(Option<String>)
:The name for the DB subnet group. This value is stored as a lowercase string.
Constraints:
-
Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.
-
Must not be default.
-
First character must be a letter.
Example:
mydbsubnetgroup
-
db_subnet_group_description(impl Into<String>)
/set_db_subnet_group_description(Option<String>)
:The description for the DB subnet group.
subnet_ids(Vec<String>)
/set_subnet_ids(Option<Vec<String>>)
:The EC2 Subnet IDs for the DB subnet group.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:Tags to assign to the DB subnet group.
- On success, responds with
CreateDbSubnetGroupOutput
with field(s):db_subnet_group(Option<DbSubnetGroup>)
:Contains the details of an Amazon RDS DB subnet group.
This data type is used as a response element in the
DescribeDBSubnetGroups
action.
- On failure, responds with
SdkError<CreateDBSubnetGroupError>
sourcepub fn create_event_subscription(&self) -> CreateEventSubscription
pub fn create_event_subscription(&self) -> CreateEventSubscription
Constructs a fluent builder for the CreateEventSubscription
operation.
- The fluent builder is configurable:
subscription_name(impl Into<String>)
/set_subscription_name(Option<String>)
:The name of the subscription.
Constraints: The name must be less than 255 characters.
sns_topic_arn(impl Into<String>)
/set_sns_topic_arn(Option<String>)
:The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
source_type(impl Into<String>)
/set_source_type(Option<String>)
:The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to
db-instance
. For RDS Proxy events, specifydb-proxy
. If this value isn’t specified, all events are returned.Valid values:
db-instance
|db-cluster
|db-parameter-group
|db-security-group
|db-snapshot
|db-cluster-snapshot
|db-proxy
event_categories(Vec<String>)
/set_event_categories(Option<Vec<String>>)
:A list of event categories for a particular source type (
SourceType
) that you want to subscribe to. You can see a list of the categories for a given source type in the “Amazon RDS event categories and event messages” section of the Amazon RDS User Guide or the Amazon Aurora User Guide . You can also see this list by using theDescribeEventCategories
operation.source_ids(Vec<String>)
/set_source_ids(Option<Vec<String>>)
:The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can’t end with a hyphen or contain two consecutive hyphens.
Constraints:
-
If
SourceIds
are supplied,SourceType
must also be provided. -
If the source type is a DB instance, a
DBInstanceIdentifier
value must be supplied. -
If the source type is a DB cluster, a
DBClusterIdentifier
value must be supplied. -
If the source type is a DB parameter group, a
DBParameterGroupName
value must be supplied. -
If the source type is a DB security group, a
DBSecurityGroupName
value must be supplied. -
If the source type is a DB snapshot, a
DBSnapshotIdentifier
value must be supplied. -
If the source type is a DB cluster snapshot, a
DBClusterSnapshotIdentifier
value must be supplied. -
If the source type is an RDS Proxy, a
DBProxyName
value must be supplied.
-
enabled(bool)
/set_enabled(Option<bool>)
:A value that indicates whether to activate the subscription. If the event notification subscription isn’t activated, the subscription is created but not active.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
- On success, responds with
CreateEventSubscriptionOutput
with field(s):event_subscription(Option<EventSubscription>)
:Contains the results of a successful invocation of the
DescribeEventSubscriptions
action.
- On failure, responds with
SdkError<CreateEventSubscriptionError>
sourcepub fn create_global_cluster(&self) -> CreateGlobalCluster
pub fn create_global_cluster(&self) -> CreateGlobalCluster
Constructs a fluent builder for the CreateGlobalCluster
operation.
- The fluent builder is configurable:
global_cluster_identifier(impl Into<String>)
/set_global_cluster_identifier(Option<String>)
:The cluster identifier of the new global database cluster.
source_db_cluster_identifier(impl Into<String>)
/set_source_db_cluster_identifier(Option<String>)
:The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional.
engine(impl Into<String>)
/set_engine(Option<String>)
:The name of the database engine to be used for this DB cluster.
engine_version(impl Into<String>)
/set_engine_version(Option<String>)
:The engine version of the Aurora global database.
deletion_protection(bool)
/set_deletion_protection(Option<bool>)
:The deletion protection setting for the new global database. The global database can’t be deleted when deletion protection is enabled.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon Aurora will not create a database in the global database cluster you are creating.
storage_encrypted(bool)
/set_storage_encrypted(Option<bool>)
:The storage encryption setting for the new global database cluster.
- On success, responds with
CreateGlobalClusterOutput
with field(s):global_cluster(Option<GlobalCluster>)
:A data type representing an Aurora global database.
- On failure, responds with
SdkError<CreateGlobalClusterError>
sourcepub fn create_option_group(&self) -> CreateOptionGroup
pub fn create_option_group(&self) -> CreateOptionGroup
Constructs a fluent builder for the CreateOptionGroup
operation.
- The fluent builder is configurable:
option_group_name(impl Into<String>)
/set_option_group_name(Option<String>)
:Specifies the name of the option group to be created.
Constraints:
-
Must be 1 to 255 letters, numbers, or hyphens
-
First character must be a letter
-
Can’t end with a hyphen or contain two consecutive hyphens
Example:
myoptiongroup
-
engine_name(impl Into<String>)
/set_engine_name(Option<String>)
:Specifies the name of the engine that this option group should be associated with.
Valid Values:
-
mariadb
-
mysql
-
oracle-ee
-
oracle-ee-cdb
-
oracle-se2
-
oracle-se2-cdb
-
postgres
-
sqlserver-ee
-
sqlserver-se
-
sqlserver-ex
-
sqlserver-web
-
major_engine_version(impl Into<String>)
/set_major_engine_version(Option<String>)
:Specifies the major version of the engine that this option group should be associated with.
option_group_description(impl Into<String>)
/set_option_group_description(Option<String>)
:The description of the option group.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:Tags to assign to the option group.
- On success, responds with
CreateOptionGroupOutput
with field(s): - On failure, responds with
SdkError<CreateOptionGroupError>
sourcepub fn delete_custom_db_engine_version(&self) -> DeleteCustomDBEngineVersion
pub fn delete_custom_db_engine_version(&self) -> DeleteCustomDBEngineVersion
Constructs a fluent builder for the DeleteCustomDBEngineVersion
operation.
- The fluent builder is configurable:
engine(impl Into<String>)
/set_engine(Option<String>)
:The database engine. The only supported engine is
custom-oracle-ee
.engine_version(impl Into<String>)
/set_engine_version(Option<String>)
:The custom engine version (CEV) for your DB instance. This option is required for RDS Custom, but optional for Amazon RDS. The combination of
Engine
andEngineVersion
is unique per customer per Amazon Web Services Region.
- On success, responds with
DeleteCustomDbEngineVersionOutput
with field(s):engine(Option<String>)
:The name of the database engine.
engine_version(Option<String>)
:The version number of the database engine.
db_parameter_group_family(Option<String>)
:The name of the DB parameter group family for the database engine.
db_engine_description(Option<String>)
:The description of the database engine.
db_engine_version_description(Option<String>)
:The description of the database engine version.
default_character_set(Option<CharacterSet>)
:The default character set for new instances of this engine version, if the
CharacterSetName
parameter of the CreateDBInstance API isn’t specified.supported_character_sets(Option<Vec<CharacterSet>>)
:A list of the character sets supported by this engine for the
CharacterSetName
parameter of theCreateDBInstance
operation.supported_nchar_character_sets(Option<Vec<CharacterSet>>)
:A list of the character sets supported by the Oracle DB engine for the
NcharCharacterSetName
parameter of theCreateDBInstance
operation.valid_upgrade_target(Option<Vec<UpgradeTarget>>)
:A list of engine versions that this database engine version can be upgraded to.
supported_timezones(Option<Vec<Timezone>>)
:A list of the time zones supported by this engine for the
Timezone
parameter of theCreateDBInstance
action.exportable_log_types(Option<Vec<String>>)
:The types of logs that the database engine has available for export to CloudWatch Logs.
supports_log_exports_to_cloudwatch_logs(bool)
:A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
supports_read_replica(bool)
:Indicates whether the database engine version supports read replicas.
supported_engine_modes(Option<Vec<String>>)
:A list of the supported DB engine modes.
supported_feature_names(Option<Vec<String>>)
:A list of features supported by the DB engine.
The supported features vary by DB engine and DB engine version.
To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:
aws rds describe-db-engine-versions –engine <engine_name> –engine-version <engine_version></engine_version> </engine_name>
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:
aws rds describe-db-engine-versions –engine postgres –engine-version 13.3
The supported features are listed under
SupportedFeatureNames
in the output.status(Option<String>)
:The status of the DB engine version, either
available
ordeprecated
.supports_parallel_query(bool)
:A value that indicates whether you can use Aurora parallel query with a specific DB engine version.
supports_global_databases(bool)
:A value that indicates whether you can use Aurora global databases with a specific DB engine version.
major_engine_version(Option<String>)
:The major engine version of the CEV.
database_installation_files_s3_bucket_name(Option<String>)
:The name of the Amazon S3 bucket that contains your database installation files.
database_installation_files_s3_prefix(Option<String>)
:The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
db_engine_version_arn(Option<String>)
:The ARN of the custom engine version.
kms_key_id(Option<String>)
:The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
create_time(Option<DateTime>)
:The creation time of the DB engine version.
tag_list(Option<Vec<Tag>>)
:A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
supports_babelfish(bool)
:A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
- On failure, responds with
SdkError<DeleteCustomDBEngineVersionError>
sourcepub fn delete_db_cluster(&self) -> DeleteDBCluster
pub fn delete_db_cluster(&self) -> DeleteDBCluster
Constructs a fluent builder for the DeleteDBCluster
operation.
- The fluent builder is configurable:
db_cluster_identifier(impl Into<String>)
/set_db_cluster_identifier(Option<String>)
:The DB cluster identifier for the DB cluster to be deleted. This parameter isn’t case-sensitive.
Constraints:
-
Must match an existing DBClusterIdentifier.
-
skip_final_snapshot(bool)
/set_skip_final_snapshot(bool)
:A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. If skip is specified, no DB cluster snapshot is created. If skip isn’t specified, a DB cluster snapshot is created before the DB cluster is deleted. By default, skip isn’t specified, and the DB cluster snapshot is created. By default, this parameter is disabled.
You must specify a
FinalDBSnapshotIdentifier
parameter ifSkipFinalSnapshot
is disabled.final_db_snapshot_identifier(impl Into<String>)
/set_final_db_snapshot_identifier(Option<String>)
:The DB cluster snapshot identifier of the new DB cluster snapshot created when
SkipFinalSnapshot
is disabled.Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the
SkipFinalShapshot
parameter results in an error.Constraints:
-
Must be 1 to 255 letters, numbers, or hyphens.
-
First character must be a letter
-
Can’t end with a hyphen or contain two consecutive hyphens
-
- On success, responds with
DeleteDbClusterOutput
with field(s):db_cluster(Option<DbCluster>)
:Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,PromoteReadReplicaDBCluster
,RestoreDBClusterFromS3
,RestoreDBClusterFromSnapshot
,RestoreDBClusterToPointInTime
,StartDBCluster
, andStopDBCluster
.For a Multi-AZ DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,RebootDBCluster
,RestoreDBClusterFromSnapshot
, andRestoreDBClusterToPointInTime
.For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
- On failure, responds with
SdkError<DeleteDBClusterError>
sourcepub fn delete_db_cluster_endpoint(&self) -> DeleteDBClusterEndpoint
pub fn delete_db_cluster_endpoint(&self) -> DeleteDBClusterEndpoint
Constructs a fluent builder for the DeleteDBClusterEndpoint
operation.
- The fluent builder is configurable:
db_cluster_endpoint_identifier(impl Into<String>)
/set_db_cluster_endpoint_identifier(Option<String>)
:The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.
- On success, responds with
DeleteDbClusterEndpointOutput
with field(s):db_cluster_endpoint_identifier(Option<String>)
:The identifier associated with the endpoint. This parameter is stored as a lowercase string.
db_cluster_identifier(Option<String>)
:The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
db_cluster_endpoint_resource_identifier(Option<String>)
:A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
endpoint(Option<String>)
:The DNS address of the endpoint.
status(Option<String>)
:The current status of the endpoint. One of:
creating
,available
,deleting
,inactive
,modifying
. Theinactive
state applies to an endpoint that can’t be used for a certain kind of cluster, such as awriter
endpoint for a read-only secondary cluster in a global database.endpoint_type(Option<String>)
:The type of the endpoint. One of:
READER
,WRITER
,CUSTOM
.custom_endpoint_type(Option<String>)
:The type associated with a custom endpoint. One of:
READER
,WRITER
,ANY
.static_members(Option<Vec<String>>)
:List of DB instance identifiers that are part of the custom endpoint group.
excluded_members(Option<Vec<String>>)
:List of DB instance identifiers that aren’t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
db_cluster_endpoint_arn(Option<String>)
:The Amazon Resource Name (ARN) for the endpoint.
- On failure, responds with
SdkError<DeleteDBClusterEndpointError>
sourcepub fn delete_db_cluster_parameter_group(&self) -> DeleteDBClusterParameterGroup
pub fn delete_db_cluster_parameter_group(&self) -> DeleteDBClusterParameterGroup
Constructs a fluent builder for the DeleteDBClusterParameterGroup
operation.
- The fluent builder is configurable:
db_cluster_parameter_group_name(impl Into<String>)
/set_db_cluster_parameter_group_name(Option<String>)
:The name of the DB cluster parameter group.
Constraints:
-
Must be the name of an existing DB cluster parameter group.
-
You can’t delete a default DB cluster parameter group.
-
Can’t be associated with any DB clusters.
-
- On success, responds with
DeleteDbClusterParameterGroupOutput
- On failure, responds with
SdkError<DeleteDBClusterParameterGroupError>
sourcepub fn delete_db_cluster_snapshot(&self) -> DeleteDBClusterSnapshot
pub fn delete_db_cluster_snapshot(&self) -> DeleteDBClusterSnapshot
Constructs a fluent builder for the DeleteDBClusterSnapshot
operation.
- The fluent builder is configurable:
db_cluster_snapshot_identifier(impl Into<String>)
/set_db_cluster_snapshot_identifier(Option<String>)
:The identifier of the DB cluster snapshot to delete.
Constraints: Must be the name of an existing DB cluster snapshot in the
available
state.
- On success, responds with
DeleteDbClusterSnapshotOutput
with field(s):db_cluster_snapshot(Option<DbClusterSnapshot>)
:Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the
DescribeDBClusterSnapshots
action.
- On failure, responds with
SdkError<DeleteDBClusterSnapshotError>
sourcepub fn delete_db_instance(&self) -> DeleteDBInstance
pub fn delete_db_instance(&self) -> DeleteDBInstance
Constructs a fluent builder for the DeleteDBInstance
operation.
- The fluent builder is configurable:
db_instance_identifier(impl Into<String>)
/set_db_instance_identifier(Option<String>)
:The DB instance identifier for the DB instance to be deleted. This parameter isn’t case-sensitive.
Constraints:
-
Must match the name of an existing DB instance.
-
skip_final_snapshot(bool)
/set_skip_final_snapshot(bool)
:A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance. If you enable this parameter, RDS doesn’t create a DB snapshot. If you don’t enable this parameter, RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn’t enabled, and the DB snapshot is created.
If you don’t enable this parameter, you must specify the
FinalDBSnapshotIdentifier
parameter.When a DB instance is in a failure state and has a status of
failed
,incompatible-restore
, orincompatible-network
, RDS can delete the instance only if you enable this parameter.If you delete a read replica or an RDS Custom instance, you must enable this setting.
This setting is required for RDS Custom.
final_db_snapshot_identifier(impl Into<String>)
/set_final_db_snapshot_identifier(Option<String>)
:The
DBSnapshotIdentifier
of the newDBSnapshot
created when theSkipFinalSnapshot
parameter is disabled.If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.
This setting doesn’t apply to RDS Custom.
Constraints:
-
Must be 1 to 255 letters or numbers.
-
First character must be a letter.
-
Can’t end with a hyphen or contain two consecutive hyphens.
-
Can’t be specified when deleting a read replica.
-
delete_automated_backups(bool)
/set_delete_automated_backups(Option<bool>)
:A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn’t case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.
- On success, responds with
DeleteDbInstanceOutput
with field(s):db_instance(Option<DbInstance>)
:Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
- On failure, responds with
SdkError<DeleteDBInstanceError>
sourcepub fn delete_db_instance_automated_backup(
&self
) -> DeleteDBInstanceAutomatedBackup
pub fn delete_db_instance_automated_backup(
&self
) -> DeleteDBInstanceAutomatedBackup
Constructs a fluent builder for the DeleteDBInstanceAutomatedBackup
operation.
- The fluent builder is configurable:
dbi_resource_id(impl Into<String>)
/set_dbi_resource_id(Option<String>)
:The identifier for the source DB instance, which can’t be changed and which is unique to an Amazon Web Services Region.
db_instance_automated_backups_arn(impl Into<String>)
/set_db_instance_automated_backups_arn(Option<String>)
:The Amazon Resource Name (ARN) of the automated backups to delete, for example,
arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.This setting doesn’t apply to RDS Custom.
- On success, responds with
DeleteDbInstanceAutomatedBackupOutput
with field(s):db_instance_automated_backup(Option<DbInstanceAutomatedBackup>)
:An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.
- On failure, responds with
SdkError<DeleteDBInstanceAutomatedBackupError>
sourcepub fn delete_db_parameter_group(&self) -> DeleteDBParameterGroup
pub fn delete_db_parameter_group(&self) -> DeleteDBParameterGroup
Constructs a fluent builder for the DeleteDBParameterGroup
operation.
- The fluent builder is configurable:
db_parameter_group_name(impl Into<String>)
/set_db_parameter_group_name(Option<String>)
:The name of the DB parameter group.
Constraints:
-
Must be the name of an existing DB parameter group
-
You can’t delete a default DB parameter group
-
Can’t be associated with any DB instances
-
- On success, responds with
DeleteDbParameterGroupOutput
- On failure, responds with
SdkError<DeleteDBParameterGroupError>
sourcepub fn delete_db_proxy(&self) -> DeleteDBProxy
pub fn delete_db_proxy(&self) -> DeleteDBProxy
Constructs a fluent builder for the DeleteDBProxy
operation.
- The fluent builder is configurable:
db_proxy_name(impl Into<String>)
/set_db_proxy_name(Option<String>)
:The name of the DB proxy to delete.
- On success, responds with
DeleteDbProxyOutput
with field(s):db_proxy(Option<DbProxy>)
:The data structure representing the details of the DB proxy that you delete.
- On failure, responds with
SdkError<DeleteDBProxyError>
sourcepub fn delete_db_proxy_endpoint(&self) -> DeleteDBProxyEndpoint
pub fn delete_db_proxy_endpoint(&self) -> DeleteDBProxyEndpoint
Constructs a fluent builder for the DeleteDBProxyEndpoint
operation.
- The fluent builder is configurable:
db_proxy_endpoint_name(impl Into<String>)
/set_db_proxy_endpoint_name(Option<String>)
:The name of the DB proxy endpoint to delete.
- On success, responds with
DeleteDbProxyEndpointOutput
with field(s):db_proxy_endpoint(Option<DbProxyEndpoint>)
:The data structure representing the details of the DB proxy endpoint that you delete.
- On failure, responds with
SdkError<DeleteDBProxyEndpointError>
sourcepub fn delete_db_security_group(&self) -> DeleteDBSecurityGroup
pub fn delete_db_security_group(&self) -> DeleteDBSecurityGroup
Constructs a fluent builder for the DeleteDBSecurityGroup
operation.
- The fluent builder is configurable:
db_security_group_name(impl Into<String>)
/set_db_security_group_name(Option<String>)
:The name of the DB security group to delete.
You can’t delete the default DB security group.
Constraints:
-
Must be 1 to 255 letters, numbers, or hyphens.
-
First character must be a letter
-
Can’t end with a hyphen or contain two consecutive hyphens
-
Must not be “Default”
-
- On success, responds with
DeleteDbSecurityGroupOutput
- On failure, responds with
SdkError<DeleteDBSecurityGroupError>
sourcepub fn delete_db_snapshot(&self) -> DeleteDBSnapshot
pub fn delete_db_snapshot(&self) -> DeleteDBSnapshot
Constructs a fluent builder for the DeleteDBSnapshot
operation.
- The fluent builder is configurable:
db_snapshot_identifier(impl Into<String>)
/set_db_snapshot_identifier(Option<String>)
:The DB snapshot identifier.
Constraints: Must be the name of an existing DB snapshot in the
available
state.
- On success, responds with
DeleteDbSnapshotOutput
with field(s):db_snapshot(Option<DbSnapshot>)
:Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the
DescribeDBSnapshots
action.
- On failure, responds with
SdkError<DeleteDBSnapshotError>
sourcepub fn delete_db_subnet_group(&self) -> DeleteDBSubnetGroup
pub fn delete_db_subnet_group(&self) -> DeleteDBSubnetGroup
Constructs a fluent builder for the DeleteDBSubnetGroup
operation.
- The fluent builder is configurable:
db_subnet_group_name(impl Into<String>)
/set_db_subnet_group_name(Option<String>)
:The name of the database subnet group to delete.
You can’t delete the default subnet group.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example:
mydbsubnetgroup
- On success, responds with
DeleteDbSubnetGroupOutput
- On failure, responds with
SdkError<DeleteDBSubnetGroupError>
sourcepub fn delete_event_subscription(&self) -> DeleteEventSubscription
pub fn delete_event_subscription(&self) -> DeleteEventSubscription
Constructs a fluent builder for the DeleteEventSubscription
operation.
- The fluent builder is configurable:
subscription_name(impl Into<String>)
/set_subscription_name(Option<String>)
:The name of the RDS event notification subscription you want to delete.
- On success, responds with
DeleteEventSubscriptionOutput
with field(s):event_subscription(Option<EventSubscription>)
:Contains the results of a successful invocation of the
DescribeEventSubscriptions
action.
- On failure, responds with
SdkError<DeleteEventSubscriptionError>
sourcepub fn delete_global_cluster(&self) -> DeleteGlobalCluster
pub fn delete_global_cluster(&self) -> DeleteGlobalCluster
Constructs a fluent builder for the DeleteGlobalCluster
operation.
- The fluent builder is configurable:
global_cluster_identifier(impl Into<String>)
/set_global_cluster_identifier(Option<String>)
:The cluster identifier of the global database cluster being deleted.
- On success, responds with
DeleteGlobalClusterOutput
with field(s):global_cluster(Option<GlobalCluster>)
:A data type representing an Aurora global database.
- On failure, responds with
SdkError<DeleteGlobalClusterError>
sourcepub fn delete_option_group(&self) -> DeleteOptionGroup
pub fn delete_option_group(&self) -> DeleteOptionGroup
Constructs a fluent builder for the DeleteOptionGroup
operation.
- The fluent builder is configurable:
option_group_name(impl Into<String>)
/set_option_group_name(Option<String>)
:The name of the option group to be deleted.
You can’t delete default option groups.
- On success, responds with
DeleteOptionGroupOutput
- On failure, responds with
SdkError<DeleteOptionGroupError>
sourcepub fn deregister_db_proxy_targets(&self) -> DeregisterDBProxyTargets
pub fn deregister_db_proxy_targets(&self) -> DeregisterDBProxyTargets
Constructs a fluent builder for the DeregisterDBProxyTargets
operation.
- The fluent builder is configurable:
db_proxy_name(impl Into<String>)
/set_db_proxy_name(Option<String>)
:The identifier of the
DBProxy
that is associated with theDBProxyTargetGroup
.target_group_name(impl Into<String>)
/set_target_group_name(Option<String>)
:The identifier of the
DBProxyTargetGroup
.db_instance_identifiers(Vec<String>)
/set_db_instance_identifiers(Option<Vec<String>>)
:One or more DB instance identifiers.
db_cluster_identifiers(Vec<String>)
/set_db_cluster_identifiers(Option<Vec<String>>)
:One or more DB cluster identifiers.
- On success, responds with
DeregisterDbProxyTargetsOutput
- On failure, responds with
SdkError<DeregisterDBProxyTargetsError>
sourcepub fn describe_account_attributes(&self) -> DescribeAccountAttributes
pub fn describe_account_attributes(&self) -> DescribeAccountAttributes
Constructs a fluent builder for the DescribeAccountAttributes
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
DescribeAccountAttributesOutput
with field(s):account_quotas(Option<Vec<AccountQuota>>)
:A list of
AccountQuota
objects. Within this list, each quota has a name, a count of usage toward the quota maximum, and a maximum value for the quota.
- On failure, responds with
SdkError<DescribeAccountAttributesError>
sourcepub fn describe_certificates(&self) -> DescribeCertificates
pub fn describe_certificates(&self) -> DescribeCertificates
Constructs a fluent builder for the DescribeCertificates
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
certificate_identifier(impl Into<String>)
/set_certificate_identifier(Option<String>)
:The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn’t case-sensitive.
Constraints:
-
Must match an existing CertificateIdentifier.
-
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter isn’t currently supported.
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous
DescribeCertificates
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
- On success, responds with
DescribeCertificatesOutput
with field(s):certificates(Option<Vec<Certificate>>)
:The list of
Certificate
objects for the Amazon Web Services account.marker(Option<String>)
:An optional pagination token provided by a previous
DescribeCertificates
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
- On failure, responds with
SdkError<DescribeCertificatesError>
sourcepub fn describe_db_cluster_backtracks(&self) -> DescribeDBClusterBacktracks
pub fn describe_db_cluster_backtracks(&self) -> DescribeDBClusterBacktracks
Constructs a fluent builder for the DescribeDBClusterBacktracks
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
db_cluster_identifier(impl Into<String>)
/set_db_cluster_identifier(Option<String>)
:The DB cluster identifier of the DB cluster to be described. This parameter is stored as a lowercase string.
Constraints:
-
Must contain from 1 to 63 alphanumeric characters or hyphens.
-
First character must be a letter.
-
Can’t end with a hyphen or contain two consecutive hyphens.
Example:
my-cluster1
-
backtrack_identifier(impl Into<String>)
/set_backtrack_identifier(Option<String>)
:If specified, this value is the backtrack identifier of the backtrack to be described.
Constraints:
-
Must contain a valid universally unique identifier (UUID). For more information about UUIDs, see A Universally Unique Identifier (UUID) URN Namespace.
Example:
123e4567-e89b-12d3-a456-426655440000
-
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:A filter that specifies one or more DB clusters to describe. Supported filters include the following:
-
db-cluster-backtrack-id
- Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers. -
db-cluster-backtrack-status
- Accepts any of the following backtrack status values:-
applying
-
completed
-
failed
-
pending
The results list includes information about only the backtracks identified by these values.
-
-
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous
DescribeDBClusterBacktracks
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
- On success, responds with
DescribeDbClusterBacktracksOutput
with field(s):marker(Option<String>)
:A pagination token that can be used in a later
DescribeDBClusterBacktracks
request.db_cluster_backtracks(Option<Vec<DbClusterBacktrack>>)
:Contains a list of backtracks for the user.
- On failure, responds with
SdkError<DescribeDBClusterBacktracksError>
sourcepub fn describe_db_cluster_endpoints(&self) -> DescribeDBClusterEndpoints
pub fn describe_db_cluster_endpoints(&self) -> DescribeDBClusterEndpoints
Constructs a fluent builder for the DescribeDBClusterEndpoints
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
db_cluster_identifier(impl Into<String>)
/set_db_cluster_identifier(Option<String>)
:The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
db_cluster_endpoint_identifier(impl Into<String>)
/set_db_cluster_endpoint_identifier(Option<String>)
:The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format
Name=endpoint_type,Values=endpoint_type1,endpoint_type2,…
.Name
can be one of:db-cluster-endpoint-type
,db-cluster-endpoint-custom-type
,db-cluster-endpoint-id
,db-cluster-endpoint-status
.Values
for thedb-cluster-endpoint-type
filter can be one or more of:reader
,writer
,custom
.Values
for thedb-cluster-endpoint-custom-type
filter can be one or more of:reader
,any
.Values
for thedb-cluster-endpoint-status
filter can be one or more of:available
,creating
,deleting
,inactive
,modifying
.max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous
DescribeDBClusterEndpoints
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
- On success, responds with
DescribeDbClusterEndpointsOutput
with field(s):marker(Option<String>)
:An optional pagination token provided by a previous
DescribeDBClusterEndpoints
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.db_cluster_endpoints(Option<Vec<DbClusterEndpoint>>)
:Contains the details of the endpoints associated with the cluster and matching any filter conditions.
- On failure, responds with
SdkError<DescribeDBClusterEndpointsError>
sourcepub fn describe_db_cluster_parameter_groups(
&self
) -> DescribeDBClusterParameterGroups
pub fn describe_db_cluster_parameter_groups(
&self
) -> DescribeDBClusterParameterGroups
Constructs a fluent builder for the DescribeDBClusterParameterGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
db_cluster_parameter_group_name(impl Into<String>)
/set_db_cluster_parameter_group_name(Option<String>)
:The name of a specific DB cluster parameter group to return details for.
Constraints:
-
If supplied, must match the name of an existing DBClusterParameterGroup.
-
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter isn’t currently supported.
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous
DescribeDBClusterParameterGroups
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
- On success, responds with
DescribeDbClusterParameterGroupsOutput
with field(s):marker(Option<String>)
:An optional pagination token provided by a previous
DescribeDBClusterParameterGroups
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.db_cluster_parameter_groups(Option<Vec<DbClusterParameterGroup>>)
:A list of DB cluster parameter groups.
- On failure, responds with
SdkError<DescribeDBClusterParameterGroupsError>
sourcepub fn describe_db_cluster_parameters(&self) -> DescribeDBClusterParameters
pub fn describe_db_cluster_parameters(&self) -> DescribeDBClusterParameters
Constructs a fluent builder for the DescribeDBClusterParameters
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
db_cluster_parameter_group_name(impl Into<String>)
/set_db_cluster_parameter_group_name(Option<String>)
:The name of a specific DB cluster parameter group to return parameter details for.
Constraints:
-
If supplied, must match the name of an existing DBClusterParameterGroup.
-
source(impl Into<String>)
/set_source(Option<String>)
:A value that indicates to return only parameters for a specific source. Parameter sources can be
engine
,service
, orcustomer
.filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter isn’t currently supported.
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous
DescribeDBClusterParameters
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
- On success, responds with
DescribeDbClusterParametersOutput
with field(s):parameters(Option<Vec<Parameter>>)
:Provides a list of parameters for the DB cluster parameter group.
marker(Option<String>)
:An optional pagination token provided by a previous
DescribeDBClusterParameters
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
- On failure, responds with
SdkError<DescribeDBClusterParametersError>
sourcepub fn describe_db_clusters(&self) -> DescribeDBClusters
pub fn describe_db_clusters(&self) -> DescribeDBClusters
Constructs a fluent builder for the DescribeDBClusters
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
db_cluster_identifier(impl Into<String>)
/set_db_cluster_identifier(Option<String>)
:The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn’t case-sensitive.
Constraints:
-
If supplied, must match an existing DBClusterIdentifier.
-
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:A filter that specifies one or more DB clusters to describe.
Supported filters:
-
clone-group-id
- Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups. -
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs. -
domain
- Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains. -
engine
- Accepts engine names. The results list only includes information about the DB clusters for these engines.
-
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous
DescribeDBClusters
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.include_shared(bool)
/set_include_shared(bool)
:Optional Boolean parameter that specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.
- On success, responds with
DescribeDbClustersOutput
with field(s):marker(Option<String>)
:A pagination token that can be used in a later DescribeDBClusters request.
db_clusters(Option<Vec<DbCluster>>)
:Contains a list of DB clusters for the user.
- On failure, responds with
SdkError<DescribeDBClustersError>
sourcepub fn describe_db_cluster_snapshot_attributes(
&self
) -> DescribeDBClusterSnapshotAttributes
pub fn describe_db_cluster_snapshot_attributes(
&self
) -> DescribeDBClusterSnapshotAttributes
Constructs a fluent builder for the DescribeDBClusterSnapshotAttributes
operation.
- The fluent builder is configurable:
db_cluster_snapshot_identifier(impl Into<String>)
/set_db_cluster_snapshot_identifier(Option<String>)
:The identifier for the DB cluster snapshot to describe the attributes for.
- On success, responds with
DescribeDbClusterSnapshotAttributesOutput
with field(s):db_cluster_snapshot_attributes_result(Option<DbClusterSnapshotAttributesResult>)
:Contains the results of a successful call to the
DescribeDBClusterSnapshotAttributes
API action.Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot. For more information, see the
ModifyDBClusterSnapshotAttribute
API action.
- On failure, responds with
SdkError<DescribeDBClusterSnapshotAttributesError>
sourcepub fn describe_db_cluster_snapshots(&self) -> DescribeDBClusterSnapshots
pub fn describe_db_cluster_snapshots(&self) -> DescribeDBClusterSnapshots
Constructs a fluent builder for the DescribeDBClusterSnapshots
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
db_cluster_identifier(impl Into<String>)
/set_db_cluster_identifier(Option<String>)
:The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can’t be used in conjunction with the
DBClusterSnapshotIdentifier
parameter. This parameter isn’t case-sensitive.Constraints:
-
If supplied, must match the identifier of an existing DBCluster.
-
db_cluster_snapshot_identifier(impl Into<String>)
/set_db_cluster_snapshot_identifier(Option<String>)
:A specific DB cluster snapshot identifier to describe. This parameter can’t be used in conjunction with the
DBClusterIdentifier
parameter. This value is stored as a lowercase string.Constraints:
-
If supplied, must match the identifier of an existing DBClusterSnapshot.
-
If this identifier is for an automated snapshot, the
SnapshotType
parameter must also be specified.
-
snapshot_type(impl Into<String>)
/set_snapshot_type(Option<String>)
:The type of DB cluster snapshots to be returned. You can specify one of the following values:
-
automated
- Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account. -
manual
- Return all DB cluster snapshots that have been taken by my Amazon Web Services account. -
shared
- Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account. -
public
- Return all DB cluster snapshots that have been marked as public.
If you don’t specify a
SnapshotType
value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling theIncludeShared
parameter. You can include public DB cluster snapshots with these results by enabling theIncludePublic
parameter.The
IncludeShared
andIncludePublic
parameters don’t apply forSnapshotType
values ofmanual
orautomated
. TheIncludePublic
parameter doesn’t apply whenSnapshotType
is set toshared
. TheIncludeShared
parameter doesn’t apply whenSnapshotType
is set topublic
.-
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:A filter that specifies one or more DB cluster snapshots to describe.
Supported filters:
-
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). -
db-cluster-snapshot-id
- Accepts DB cluster snapshot identifiers. -
snapshot-type
- Accepts types of DB cluster snapshots. -
engine
- Accepts names of database engines.
-
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous
DescribeDBClusterSnapshots
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.include_shared(bool)
/set_include_shared(bool)
:A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the
ModifyDBClusterSnapshotAttribute
API action.include_public(bool)
/set_include_public(bool)
:A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB cluster snapshot as public by using the
ModifyDBClusterSnapshotAttribute
API action.
- On success, responds with
DescribeDbClusterSnapshotsOutput
with field(s):marker(Option<String>)
:An optional pagination token provided by a previous
DescribeDBClusterSnapshots
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.db_cluster_snapshots(Option<Vec<DbClusterSnapshot>>)
:Provides a list of DB cluster snapshots for the user.
- On failure, responds with
SdkError<DescribeDBClusterSnapshotsError>
sourcepub fn describe_db_engine_versions(&self) -> DescribeDBEngineVersions
pub fn describe_db_engine_versions(&self) -> DescribeDBEngineVersions
Constructs a fluent builder for the DescribeDBEngineVersions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
engine(impl Into<String>)
/set_engine(Option<String>)
:The database engine to return.
Valid Values:
-
aurora
(for MySQL 5.6-compatible Aurora) -
aurora-mysql
(for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora) -
aurora-postgresql
-
mariadb
-
mysql
-
oracle-ee
-
oracle-ee-cdb
-
oracle-se2
-
oracle-se2-cdb
-
postgres
-
sqlserver-ee
-
sqlserver-se
-
sqlserver-ex
-
sqlserver-web
-
engine_version(impl Into<String>)
/set_engine_version(Option<String>)
:The database engine version to return.
Example:
5.1.49
db_parameter_group_family(impl Into<String>)
/set_db_parameter_group_family(Option<String>)
:The name of a specific DB parameter group family to return details for.
Constraints:
-
If supplied, must match an existing DBParameterGroupFamily.
-
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:A filter that specifies one or more DB engine versions to describe.
Supported filters:
-
db-parameter-group-family
- Accepts parameter groups family names. The results list only includes information about the DB engine versions for these parameter group families. -
engine
- Accepts engine names. The results list only includes information about the DB engine versions for these engines. -
engine-mode
- Accepts DB engine modes. The results list only includes information about the DB engine versions for these engine modes. Valid DB engine modes are the following:-
global
-
multimaster
-
parallelquery
-
provisioned
-
serverless
-
-
engine-version
- Accepts engine versions. The results list only includes information about the DB engine versions for these engine versions. -
status
- Accepts engine version statuses. The results list only includes information about the DB engine versions for these statuses. Valid statuses are the following:-
available
-
deprecated
-
-
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more than the
MaxRecords
value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.default_only(bool)
/set_default_only(bool)
:A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.
list_supported_character_sets(bool)
/set_list_supported_character_sets(Option<bool>)
:A value that indicates whether to list the supported character sets for each engine version.
If this parameter is enabled and the requested engine supports the
CharacterSetName
parameter forCreateDBInstance
, the response includes a list of supported character sets for each engine version.For RDS Custom, the default is not to list supported character sets. If you set
ListSupportedCharacterSets
totrue
, RDS Custom returns no results.list_supported_timezones(bool)
/set_list_supported_timezones(Option<bool>)
:A value that indicates whether to list the supported time zones for each engine version.
If this parameter is enabled and the requested engine supports the
TimeZone
parameter forCreateDBInstance
, the response includes a list of supported time zones for each engine version.For RDS Custom, the default is not to list supported time zones. If you set
ListSupportedTimezones
totrue
, RDS Custom returns no results.include_all(bool)
/set_include_all(Option<bool>)
:A value that indicates whether to include engine versions that aren’t available in the list. The default is to list only available engine versions.
- On success, responds with
DescribeDbEngineVersionsOutput
with field(s):marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.db_engine_versions(Option<Vec<DbEngineVersion>>)
:A list of
DBEngineVersion
elements.
- On failure, responds with
SdkError<DescribeDBEngineVersionsError>
sourcepub fn describe_db_instance_automated_backups(
&self
) -> DescribeDBInstanceAutomatedBackups
pub fn describe_db_instance_automated_backups(
&self
) -> DescribeDBInstanceAutomatedBackups
Constructs a fluent builder for the DescribeDBInstanceAutomatedBackups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
dbi_resource_id(impl Into<String>)
/set_dbi_resource_id(Option<String>)
:The resource ID of the DB instance that is the source of the automated backup. This parameter isn’t case-sensitive.
db_instance_identifier(impl Into<String>)
/set_db_instance_identifier(Option<String>)
:(Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance’ automated backup. This parameter isn’t case-sensitive.
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:A filter that specifies which resources to return based on status.
Supported filters are the following:
-
status
-
active
- automated backups for current instances -
retained
- automated backups for deleted instances and after backup replication is stopped -
creating
- automated backups that are waiting for the first automated snapshot to be available
-
-
db-instance-id
- Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs. -
dbi-resource-id
- Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.
Returns all resources by default. The status for each resource is specified in the response.
-
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.marker(impl Into<String>)
/set_marker(Option<String>)
:The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to
MaxRecords
.db_instance_automated_backups_arn(impl Into<String>)
/set_db_instance_automated_backups_arn(Option<String>)
:The Amazon Resource Name (ARN) of the replicated automated backups, for example,
arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.This setting doesn’t apply to RDS Custom.
- On success, responds with
DescribeDbInstanceAutomatedBackupsOutput
with field(s):marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.db_instance_automated_backups(Option<Vec<DbInstanceAutomatedBackup>>)
:A list of
DBInstanceAutomatedBackup
instances.
- On failure, responds with
SdkError<DescribeDBInstanceAutomatedBackupsError>
sourcepub fn describe_db_instances(&self) -> DescribeDBInstances
pub fn describe_db_instances(&self) -> DescribeDBInstances
Constructs a fluent builder for the DescribeDBInstances
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
db_instance_identifier(impl Into<String>)
/set_db_instance_identifier(Option<String>)
:The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn’t case-sensitive.
Constraints:
-
If supplied, must match the identifier of an existing DBInstance.
-
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:A filter that specifies one or more DB instances to describe.
Supported filters:
-
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs. -
db-instance-id
- Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs. -
dbi-resource-id
- Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers. -
domain
- Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains. -
engine
- Accepts engine names. The results list only includes information about the DB instances for these engines.
-
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous
DescribeDBInstances
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
- On success, responds with
DescribeDbInstancesOutput
with field(s):marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.db_instances(Option<Vec<DbInstance>>)
:A list of
DBInstance
instances.
- On failure, responds with
SdkError<DescribeDBInstancesError>
sourcepub fn describe_db_log_files(&self) -> DescribeDBLogFiles
pub fn describe_db_log_files(&self) -> DescribeDBLogFiles
Constructs a fluent builder for the DescribeDBLogFiles
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
db_instance_identifier(impl Into<String>)
/set_db_instance_identifier(Option<String>)
:The customer-assigned name of the DB instance that contains the log files you want to list.
Constraints:
-
Must match the identifier of an existing DBInstance.
-
filename_contains(impl Into<String>)
/set_filename_contains(Option<String>)
:Filters the available log files for log file names that contain the specified string.
file_last_written(i64)
/set_file_last_written(i64)
:Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.
file_size(i64)
/set_file_size(i64)
:Filters the available log files for files larger than the specified size.
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter isn’t currently supported.
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
marker(impl Into<String>)
/set_marker(Option<String>)
:The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
- On success, responds with
DescribeDbLogFilesOutput
with field(s):describe_db_log_files(Option<Vec<DescribeDbLogFilesDetails>>)
:The DB log files returned.
marker(Option<String>)
:A pagination token that can be used in a later
DescribeDBLogFiles
request.
- On failure, responds with
SdkError<DescribeDBLogFilesError>
sourcepub fn describe_db_parameter_groups(&self) -> DescribeDBParameterGroups
pub fn describe_db_parameter_groups(&self) -> DescribeDBParameterGroups
Constructs a fluent builder for the DescribeDBParameterGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
db_parameter_group_name(impl Into<String>)
/set_db_parameter_group_name(Option<String>)
:The name of a specific DB parameter group to return details for.
Constraints:
-
If supplied, must match the name of an existing DBClusterParameterGroup.
-
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter isn’t currently supported.
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous
DescribeDBParameterGroups
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
- On success, responds with
DescribeDbParameterGroupsOutput
with field(s):marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.db_parameter_groups(Option<Vec<DbParameterGroup>>)
:A list of
DBParameterGroup
instances.
- On failure, responds with
SdkError<DescribeDBParameterGroupsError>
sourcepub fn describe_db_parameters(&self) -> DescribeDBParameters
pub fn describe_db_parameters(&self) -> DescribeDBParameters
Constructs a fluent builder for the DescribeDBParameters
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
db_parameter_group_name(impl Into<String>)
/set_db_parameter_group_name(Option<String>)
:The name of a specific DB parameter group to return details for.
Constraints:
-
If supplied, must match the name of an existing DBParameterGroup.
-
source(impl Into<String>)
/set_source(Option<String>)
:The parameter types to return.
Default: All parameter types returned
Valid Values:
user | system | engine-default
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter isn’t currently supported.
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous
DescribeDBParameters
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
- On success, responds with
DescribeDbParametersOutput
with field(s):parameters(Option<Vec<Parameter>>)
:A list of
Parameter
values.marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On failure, responds with
SdkError<DescribeDBParametersError>
sourcepub fn describe_db_proxies(&self) -> DescribeDBProxies
pub fn describe_db_proxies(&self) -> DescribeDBProxies
Constructs a fluent builder for the DescribeDBProxies
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
db_proxy_name(impl Into<String>)
/set_db_proxy_name(Option<String>)
:The name of the DB proxy. If you omit this parameter, the output includes information about all DB proxies owned by your Amazon Web Services account ID.
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter is not currently supported.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
- On success, responds with
DescribeDbProxiesOutput
with field(s):db_proxies(Option<Vec<DbProxy>>)
:A return value representing an arbitrary number of
DBProxy
data structures.marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On failure, responds with
SdkError<DescribeDBProxiesError>
sourcepub fn describe_db_proxy_endpoints(&self) -> DescribeDBProxyEndpoints
pub fn describe_db_proxy_endpoints(&self) -> DescribeDBProxyEndpoints
Constructs a fluent builder for the DescribeDBProxyEndpoints
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
db_proxy_name(impl Into<String>)
/set_db_proxy_name(Option<String>)
:The name of the DB proxy whose endpoints you want to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with all your DB proxies.
db_proxy_endpoint_name(impl Into<String>)
/set_db_proxy_endpoint_name(Option<String>)
:The name of a DB proxy endpoint to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with the specified proxy.
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter is not currently supported.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
- On success, responds with
DescribeDbProxyEndpointsOutput
with field(s):db_proxy_endpoints(Option<Vec<DbProxyEndpoint>>)
:The list of
ProxyEndpoint
objects returned by the API operation.marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On failure, responds with
SdkError<DescribeDBProxyEndpointsError>
sourcepub fn describe_db_proxy_target_groups(&self) -> DescribeDBProxyTargetGroups
pub fn describe_db_proxy_target_groups(&self) -> DescribeDBProxyTargetGroups
Constructs a fluent builder for the DescribeDBProxyTargetGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
db_proxy_name(impl Into<String>)
/set_db_proxy_name(Option<String>)
:The identifier of the
DBProxy
associated with the target group.target_group_name(impl Into<String>)
/set_target_group_name(Option<String>)
:The identifier of the
DBProxyTargetGroup
to describe.filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter is not currently supported.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
- On success, responds with
DescribeDbProxyTargetGroupsOutput
with field(s):target_groups(Option<Vec<DbProxyTargetGroup>>)
:An arbitrary number of
DBProxyTargetGroup
objects, containing details of the corresponding target groups.marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On failure, responds with
SdkError<DescribeDBProxyTargetGroupsError>
sourcepub fn describe_db_proxy_targets(&self) -> DescribeDBProxyTargets
pub fn describe_db_proxy_targets(&self) -> DescribeDBProxyTargets
Constructs a fluent builder for the DescribeDBProxyTargets
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
db_proxy_name(impl Into<String>)
/set_db_proxy_name(Option<String>)
:The identifier of the
DBProxyTarget
to describe.target_group_name(impl Into<String>)
/set_target_group_name(Option<String>)
:The identifier of the
DBProxyTargetGroup
to describe.filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter is not currently supported.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
- On success, responds with
DescribeDbProxyTargetsOutput
with field(s):targets(Option<Vec<DbProxyTarget>>)
:An arbitrary number of
DBProxyTarget
objects, containing details of the corresponding targets.marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On failure, responds with
SdkError<DescribeDBProxyTargetsError>
sourcepub fn describe_db_security_groups(&self) -> DescribeDBSecurityGroups
pub fn describe_db_security_groups(&self) -> DescribeDBSecurityGroups
Constructs a fluent builder for the DescribeDBSecurityGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
db_security_group_name(impl Into<String>)
/set_db_security_group_name(Option<String>)
:The name of the DB security group to return details for.
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter isn’t currently supported.
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous
DescribeDBSecurityGroups
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
- On success, responds with
DescribeDbSecurityGroupsOutput
with field(s):marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.db_security_groups(Option<Vec<DbSecurityGroup>>)
:A list of
DBSecurityGroup
instances.
- On failure, responds with
SdkError<DescribeDBSecurityGroupsError>
sourcepub fn describe_db_snapshot_attributes(&self) -> DescribeDBSnapshotAttributes
pub fn describe_db_snapshot_attributes(&self) -> DescribeDBSnapshotAttributes
Constructs a fluent builder for the DescribeDBSnapshotAttributes
operation.
- The fluent builder is configurable:
db_snapshot_identifier(impl Into<String>)
/set_db_snapshot_identifier(Option<String>)
:The identifier for the DB snapshot to describe the attributes for.
- On success, responds with
DescribeDbSnapshotAttributesOutput
with field(s):db_snapshot_attributes_result(Option<DbSnapshotAttributesResult>)
:Contains the results of a successful call to the
DescribeDBSnapshotAttributes
API action.Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB snapshot. For more information, see the
ModifyDBSnapshotAttribute
API action.
- On failure, responds with
SdkError<DescribeDBSnapshotAttributesError>
sourcepub fn describe_db_snapshots(&self) -> DescribeDBSnapshots
pub fn describe_db_snapshots(&self) -> DescribeDBSnapshots
Constructs a fluent builder for the DescribeDBSnapshots
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
db_instance_identifier(impl Into<String>)
/set_db_instance_identifier(Option<String>)
:The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn’t case-sensitive.
Constraints:
-
If supplied, must match the identifier of an existing DBInstance.
-
db_snapshot_identifier(impl Into<String>)
/set_db_snapshot_identifier(Option<String>)
:A specific DB snapshot identifier to describe. This value is stored as a lowercase string.
Constraints:
-
If supplied, must match the identifier of an existing DBSnapshot.
-
If this identifier is for an automated snapshot, the
SnapshotType
parameter must also be specified.
-
snapshot_type(impl Into<String>)
/set_snapshot_type(Option<String>)
:The type of snapshots to be returned. You can specify one of the following values:
-
automated
- Return all DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account. -
manual
- Return all DB snapshots that have been taken by my Amazon Web Services account. -
shared
- Return all manual DB snapshots that have been shared to my Amazon Web Services account. -
public
- Return all DB snapshots that have been marked as public. -
awsbackup
- Return the DB snapshots managed by the Amazon Web Services Backup service.For information about Amazon Web Services Backup, see the Amazon Web Services Backup Developer Guide.
The
awsbackup
type does not apply to Aurora.
If you don’t specify a
SnapshotType
value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling theIncludeShared
parameter. You can include public snapshots with these results by enabling theIncludePublic
parameter.The
IncludeShared
andIncludePublic
parameters don’t apply forSnapshotType
values ofmanual
orautomated
. TheIncludePublic
parameter doesn’t apply whenSnapshotType
is set toshared
. TheIncludeShared
parameter doesn’t apply whenSnapshotType
is set topublic
.-
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:A filter that specifies one or more DB snapshots to describe.
Supported filters:
-
db-instance-id
- Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). -
db-snapshot-id
- Accepts DB snapshot identifiers. -
dbi-resource-id
- Accepts identifiers of source DB instances. -
snapshot-type
- Accepts types of DB snapshots. -
engine
- Accepts names of database engines.
-
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous
DescribeDBSnapshots
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.include_shared(bool)
/set_include_shared(bool)
:A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the
ModifyDBSnapshotAttribute
API action.This setting doesn’t apply to RDS Custom.
include_public(bool)
/set_include_public(bool)
:A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB snapshot as public by using the
ModifyDBSnapshotAttribute
API.This setting doesn’t apply to RDS Custom.
dbi_resource_id(impl Into<String>)
/set_dbi_resource_id(Option<String>)
:A specific DB resource ID to describe.
- On success, responds with
DescribeDbSnapshotsOutput
with field(s):marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.db_snapshots(Option<Vec<DbSnapshot>>)
:A list of
DBSnapshot
instances.
- On failure, responds with
SdkError<DescribeDBSnapshotsError>
sourcepub fn describe_db_subnet_groups(&self) -> DescribeDBSubnetGroups
pub fn describe_db_subnet_groups(&self) -> DescribeDBSubnetGroups
Constructs a fluent builder for the DescribeDBSubnetGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
db_subnet_group_name(impl Into<String>)
/set_db_subnet_group_name(Option<String>)
:The name of the DB subnet group to return details for.
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter isn’t currently supported.
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On success, responds with
DescribeDbSubnetGroupsOutput
with field(s):marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.db_subnet_groups(Option<Vec<DbSubnetGroup>>)
:A list of
DBSubnetGroup
instances.
- On failure, responds with
SdkError<DescribeDBSubnetGroupsError>
sourcepub fn describe_engine_default_cluster_parameters(
&self
) -> DescribeEngineDefaultClusterParameters
pub fn describe_engine_default_cluster_parameters(
&self
) -> DescribeEngineDefaultClusterParameters
Constructs a fluent builder for the DescribeEngineDefaultClusterParameters
operation.
- The fluent builder is configurable:
db_parameter_group_family(impl Into<String>)
/set_db_parameter_group_family(Option<String>)
:The name of the DB cluster parameter group family to return engine parameter information for.
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter isn’t currently supported.
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous
DescribeEngineDefaultClusterParameters
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
- On success, responds with
DescribeEngineDefaultClusterParametersOutput
with field(s):engine_defaults(Option<EngineDefaults>)
:Contains the result of a successful invocation of the
DescribeEngineDefaultParameters
action.
- On failure, responds with
SdkError<DescribeEngineDefaultClusterParametersError>
sourcepub fn describe_engine_default_parameters(
&self
) -> DescribeEngineDefaultParameters
pub fn describe_engine_default_parameters(
&self
) -> DescribeEngineDefaultParameters
Constructs a fluent builder for the DescribeEngineDefaultParameters
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
db_parameter_group_family(impl Into<String>)
/set_db_parameter_group_family(Option<String>)
:The name of the DB parameter group family.
Valid Values:
-
aurora5.6
-
aurora-mysql5.7
-
aurora-mysql8.0
-
aurora-postgresql10
-
aurora-postgresql11
-
aurora-postgresql12
-
aurora-postgresql13
-
mariadb10.2
-
mariadb10.3
-
mariadb10.4
-
mariadb10.5
-
mariadb10.6
-
mysql5.7
-
mysql8.0
-
postgres10
-
postgres11
-
postgres12
-
postgres13
-
postgres14
-
sqlserver-ee-11.0
-
sqlserver-ee-12.0
-
sqlserver-ee-13.0
-
sqlserver-ee-14.0
-
sqlserver-ee-15.0
-
sqlserver-ex-11.0
-
sqlserver-ex-12.0
-
sqlserver-ex-13.0
-
sqlserver-ex-14.0
-
sqlserver-ex-15.0
-
sqlserver-se-11.0
-
sqlserver-se-12.0
-
sqlserver-se-13.0
-
sqlserver-se-14.0
-
sqlserver-se-15.0
-
sqlserver-web-11.0
-
sqlserver-web-12.0
-
sqlserver-web-13.0
-
sqlserver-web-14.0
-
sqlserver-web-15.0
-
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter isn’t currently supported.
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous
DescribeEngineDefaultParameters
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
- On success, responds with
DescribeEngineDefaultParametersOutput
with field(s):engine_defaults(Option<EngineDefaults>)
:Contains the result of a successful invocation of the
DescribeEngineDefaultParameters
action.
- On failure, responds with
SdkError<DescribeEngineDefaultParametersError>
sourcepub fn describe_event_categories(&self) -> DescribeEventCategories
pub fn describe_event_categories(&self) -> DescribeEventCategories
Constructs a fluent builder for the DescribeEventCategories
operation.
- The fluent builder is configurable:
source_type(impl Into<String>)
/set_source_type(Option<String>)
:The type of source that is generating the events. For RDS Proxy events, specify
db-proxy
.Valid values:
db-instance
|db-cluster
|db-parameter-group
|db-security-group
|db-snapshot
|db-cluster-snapshot
|db-proxy
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter isn’t currently supported.
- On success, responds with
DescribeEventCategoriesOutput
with field(s):event_categories_map_list(Option<Vec<EventCategoriesMap>>)
:A list of
EventCategoriesMap
data types.
- On failure, responds with
SdkError<DescribeEventCategoriesError>
sourcepub fn describe_events(&self) -> DescribeEvents
pub fn describe_events(&self) -> DescribeEvents
Constructs a fluent builder for the DescribeEvents
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
source_identifier(impl Into<String>)
/set_source_identifier(Option<String>)
:The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.
Constraints:
-
If
SourceIdentifier
is supplied,SourceType
must also be provided. -
If the source type is a DB instance, a
DBInstanceIdentifier
value must be supplied. -
If the source type is a DB cluster, a
DBClusterIdentifier
value must be supplied. -
If the source type is a DB parameter group, a
DBParameterGroupName
value must be supplied. -
If the source type is a DB security group, a
DBSecurityGroupName
value must be supplied. -
If the source type is a DB snapshot, a
DBSnapshotIdentifier
value must be supplied. -
If the source type is a DB cluster snapshot, a
DBClusterSnapshotIdentifier
value must be supplied. -
If the source type is an RDS Proxy, a
DBProxyName
value must be supplied. -
Can’t end with a hyphen or contain two consecutive hyphens.
-
source_type(SourceType)
/set_source_type(Option<SourceType>)
:The event source to retrieve events for. If no value is specified, all events are returned.
start_time(DateTime)
/set_start_time(Option<DateTime>)
:The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
end_time(DateTime)
/set_end_time(Option<DateTime>)
:The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
duration(i32)
/set_duration(Option<i32>)
:The number of minutes to retrieve events for.
Default: 60
event_categories(Vec<String>)
/set_event_categories(Option<Vec<String>>)
:A list of event categories that trigger notifications for a event notification subscription.
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter isn’t currently supported.
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On success, responds with
DescribeEventsOutput
with field(s):marker(Option<String>)
:An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.events(Option<Vec<Event>>)
:A list of
Event
instances.
- On failure, responds with
SdkError<DescribeEventsError>
sourcepub fn describe_event_subscriptions(&self) -> DescribeEventSubscriptions
pub fn describe_event_subscriptions(&self) -> DescribeEventSubscriptions
Constructs a fluent builder for the DescribeEventSubscriptions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
subscription_name(impl Into<String>)
/set_subscription_name(Option<String>)
:The name of the RDS event notification subscription you want to describe.
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter isn’t currently supported.
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On success, responds with
DescribeEventSubscriptionsOutput
with field(s):marker(Option<String>)
:An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.event_subscriptions_list(Option<Vec<EventSubscription>>)
:A list of EventSubscriptions data types.
- On failure, responds with
SdkError<DescribeEventSubscriptionsError>
sourcepub fn describe_export_tasks(&self) -> DescribeExportTasks
pub fn describe_export_tasks(&self) -> DescribeExportTasks
Constructs a fluent builder for the DescribeExportTasks
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
export_task_identifier(impl Into<String>)
/set_export_task_identifier(Option<String>)
:The identifier of the snapshot export task to be described.
source_arn(impl Into<String>)
/set_source_arn(Option<String>)
:The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.
Supported filters include the following:
-
export-task-identifier
- An identifier for the snapshot export task. -
s3-bucket
- The Amazon S3 bucket the snapshot is exported to. -
source-arn
- The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3 -
status
- The status of the export task. Must be lowercase. Valid statuses are the following:-
canceled
-
canceling
-
complete
-
failed
-
in_progress
-
starting
-
-
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous
DescribeExportTasks
request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by theMaxRecords
parameter.max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later
DescribeExportTasks
request to retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
- On success, responds with
DescribeExportTasksOutput
with field(s):marker(Option<String>)
:A pagination token that can be used in a later
DescribeExportTasks
request. A marker is used for pagination to identify the location to begin output for the next response ofDescribeExportTasks
.export_tasks(Option<Vec<ExportTask>>)
:Information about an export of a snapshot to Amazon S3.
- On failure, responds with
SdkError<DescribeExportTasksError>
sourcepub fn describe_global_clusters(&self) -> DescribeGlobalClusters
pub fn describe_global_clusters(&self) -> DescribeGlobalClusters
Constructs a fluent builder for the DescribeGlobalClusters
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
global_cluster_identifier(impl Into<String>)
/set_global_cluster_identifier(Option<String>)
:The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn’t case-sensitive.
Constraints:
-
If supplied, must match an existing DBClusterIdentifier.
-
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter isn’t currently supported.
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous
DescribeGlobalClusters
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
- On success, responds with
DescribeGlobalClustersOutput
with field(s):marker(Option<String>)
:An optional pagination token provided by a previous
DescribeGlobalClusters
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.global_clusters(Option<Vec<GlobalCluster>>)
:The list of global clusters returned by this request.
- On failure, responds with
SdkError<DescribeGlobalClustersError>
sourcepub fn describe_option_group_options(&self) -> DescribeOptionGroupOptions
pub fn describe_option_group_options(&self) -> DescribeOptionGroupOptions
Constructs a fluent builder for the DescribeOptionGroupOptions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
engine_name(impl Into<String>)
/set_engine_name(Option<String>)
:A required parameter. Options available for the given engine name are described.
Valid Values:
-
mariadb
-
mysql
-
oracle-ee
-
oracle-ee-cdb
-
oracle-se2
-
oracle-se2-cdb
-
postgres
-
sqlserver-ee
-
sqlserver-se
-
sqlserver-ex
-
sqlserver-web
-
major_engine_version(impl Into<String>)
/set_major_engine_version(Option<String>)
:If specified, filters the results to include only options for the specified major engine version.
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter isn’t currently supported.
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On success, responds with
DescribeOptionGroupOptionsOutput
with field(s):option_group_options(Option<Vec<OptionGroupOption>>)
:List of available option group options.
marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On failure, responds with
SdkError<DescribeOptionGroupOptionsError>
sourcepub fn describe_option_groups(&self) -> DescribeOptionGroups
pub fn describe_option_groups(&self) -> DescribeOptionGroups
Constructs a fluent builder for the DescribeOptionGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
option_group_name(impl Into<String>)
/set_option_group_name(Option<String>)
:The name of the option group to describe. Can’t be supplied together with EngineName or MajorEngineVersion.
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter isn’t currently supported.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
engine_name(impl Into<String>)
/set_engine_name(Option<String>)
:Filters the list of option groups to only include groups associated with a specific database engine.
Valid Values:
-
mariadb
-
mysql
-
oracle-ee
-
oracle-ee-cdb
-
oracle-se2
-
oracle-se2-cdb
-
postgres
-
sqlserver-ee
-
sqlserver-se
-
sqlserver-ex
-
sqlserver-web
-
major_engine_version(impl Into<String>)
/set_major_engine_version(Option<String>)
:Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.
- On success, responds with
DescribeOptionGroupsOutput
with field(s):option_groups_list(Option<Vec<OptionGroup>>)
:List of option groups.
marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On failure, responds with
SdkError<DescribeOptionGroupsError>
sourcepub fn describe_orderable_db_instance_options(
&self
) -> DescribeOrderableDBInstanceOptions
pub fn describe_orderable_db_instance_options(
&self
) -> DescribeOrderableDBInstanceOptions
Constructs a fluent builder for the DescribeOrderableDBInstanceOptions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
engine(impl Into<String>)
/set_engine(Option<String>)
:The name of the engine to retrieve DB instance options for.
Valid Values:
-
aurora
(for MySQL 5.6-compatible Aurora) -
aurora-mysql
(for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora) -
aurora-postgresql
-
mariadb
-
mysql
-
oracle-ee
-
oracle-ee-cdb
-
oracle-se2
-
oracle-se2-cdb
-
postgres
-
sqlserver-ee
-
sqlserver-se
-
sqlserver-ex
-
sqlserver-web
-
engine_version(impl Into<String>)
/set_engine_version(Option<String>)
:The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.
db_instance_class(impl Into<String>)
/set_db_instance_class(Option<String>)
:The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
license_model(impl Into<String>)
/set_license_model(Option<String>)
:The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
RDS Custom supports only the BYOL licensing model.
availability_zone_group(impl Into<String>)
/set_availability_zone_group(Option<String>)
:The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.
Omit this parameter to show the available offerings in the specified Amazon Web Services Region.
This setting doesn’t apply to RDS Custom.
vpc(bool)
/set_vpc(Option<bool>)
:A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.
RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter isn’t currently supported.
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 10000.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On success, responds with
DescribeOrderableDbInstanceOptionsOutput
with field(s):orderable_db_instance_options(Option<Vec<OrderableDbInstanceOption>>)
:An
OrderableDBInstanceOption
structure containing information about orderable options for the DB instance.marker(Option<String>)
:An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On failure, responds with
SdkError<DescribeOrderableDBInstanceOptionsError>
sourcepub fn describe_pending_maintenance_actions(
&self
) -> DescribePendingMaintenanceActions
pub fn describe_pending_maintenance_actions(
&self
) -> DescribePendingMaintenanceActions
Constructs a fluent builder for the DescribePendingMaintenanceActions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
resource_identifier(impl Into<String>)
/set_resource_identifier(Option<String>)
:The ARN of a resource to return pending maintenance actions for.
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:A filter that specifies one or more resources to return pending maintenance actions for.
Supported filters:
-
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes pending maintenance actions for the DB clusters identified by these ARNs. -
db-instance-id
- Accepts DB instance identifiers and DB instance ARNs. The results list only includes pending maintenance actions for the DB instances identified by these ARNs.
-
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous
DescribePendingMaintenanceActions
request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified byMaxRecords
.max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
- On success, responds with
DescribePendingMaintenanceActionsOutput
with field(s):pending_maintenance_actions(Option<Vec<ResourcePendingMaintenanceActions>>)
:A list of the pending maintenance actions for the resource.
marker(Option<String>)
:An optional pagination token provided by a previous
DescribePendingMaintenanceActions
request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified byMaxRecords
.
- On failure, responds with
SdkError<DescribePendingMaintenanceActionsError>
sourcepub fn describe_reserved_db_instances(&self) -> DescribeReservedDBInstances
pub fn describe_reserved_db_instances(&self) -> DescribeReservedDBInstances
Constructs a fluent builder for the DescribeReservedDBInstances
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
reserved_db_instance_id(impl Into<String>)
/set_reserved_db_instance_id(Option<String>)
:The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.
reserved_db_instances_offering_id(impl Into<String>)
/set_reserved_db_instances_offering_id(Option<String>)
:The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.
db_instance_class(impl Into<String>)
/set_db_instance_class(Option<String>)
:The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.
duration(impl Into<String>)
/set_duration(Option<String>)
:The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values:
1 | 3 | 31536000 | 94608000
product_description(impl Into<String>)
/set_product_description(Option<String>)
:The product description filter value. Specify this parameter to show only those reservations matching the specified product description.
offering_type(impl Into<String>)
/set_offering_type(Option<String>)
:The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values:
“Partial Upfront” | “All Upfront” | “No Upfront”
multi_az(bool)
/set_multi_az(Option<bool>)
:A value that indicates whether to show only those reservations that support Multi-AZ.
lease_id(impl Into<String>)
/set_lease_id(Option<String>)
:The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.
Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter isn’t currently supported.
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more than the
MaxRecords
value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On success, responds with
DescribeReservedDbInstancesOutput
with field(s):marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.reserved_db_instances(Option<Vec<ReservedDbInstance>>)
:A list of reserved DB instances.
- On failure, responds with
SdkError<DescribeReservedDBInstancesError>
sourcepub fn describe_reserved_db_instances_offerings(
&self
) -> DescribeReservedDBInstancesOfferings
pub fn describe_reserved_db_instances_offerings(
&self
) -> DescribeReservedDBInstancesOfferings
Constructs a fluent builder for the DescribeReservedDBInstancesOfferings
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
reserved_db_instances_offering_id(impl Into<String>)
/set_reserved_db_instances_offering_id(Option<String>)
:The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.
Example:
438012d3-4052-4cc7-b2e3-8d3372e0e706
db_instance_class(impl Into<String>)
/set_db_instance_class(Option<String>)
:The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
duration(impl Into<String>)
/set_duration(Option<String>)
:Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values:
1 | 3 | 31536000 | 94608000
product_description(impl Into<String>)
/set_product_description(Option<String>)
:Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.
The results show offerings that partially match the filter value.
offering_type(impl Into<String>)
/set_offering_type(Option<String>)
:The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values:
“Partial Upfront” | “All Upfront” | “No Upfront”
multi_az(bool)
/set_multi_az(Option<bool>)
:A value that indicates whether to show only those reservations that support Multi-AZ.
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter isn’t currently supported.
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more than the
MaxRecords
value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On success, responds with
DescribeReservedDbInstancesOfferingsOutput
with field(s):marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.reserved_db_instances_offerings(Option<Vec<ReservedDbInstancesOffering>>)
:A list of reserved DB instance offerings.
- On failure, responds with
SdkError<DescribeReservedDBInstancesOfferingsError>
sourcepub fn describe_source_regions(&self) -> DescribeSourceRegions
pub fn describe_source_regions(&self) -> DescribeSourceRegions
Constructs a fluent builder for the DescribeSourceRegions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
region_name(impl Into<String>)
/set_region_name(Option<String>)
:The source Amazon Web Services Region name. For example,
us-east-1
.Constraints:
-
Must specify a valid Amazon Web Services Region name.
-
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous
DescribeSourceRegions
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter isn’t currently supported.
- On success, responds with
DescribeSourceRegionsOutput
with field(s):marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.source_regions(Option<Vec<SourceRegion>>)
:A list of
SourceRegion
instances that contains each source Amazon Web Services Region that the current Amazon Web Services Region can get a read replica or a DB snapshot from.
- On failure, responds with
SdkError<DescribeSourceRegionsError>
sourcepub fn describe_valid_db_instance_modifications(
&self
) -> DescribeValidDBInstanceModifications
pub fn describe_valid_db_instance_modifications(
&self
) -> DescribeValidDBInstanceModifications
Constructs a fluent builder for the DescribeValidDBInstanceModifications
operation.
- The fluent builder is configurable:
db_instance_identifier(impl Into<String>)
/set_db_instance_identifier(Option<String>)
:The customer identifier or the ARN of your DB instance.
- On success, responds with
DescribeValidDbInstanceModificationsOutput
with field(s):valid_db_instance_modifications_message(Option<ValidDbInstanceModificationsMessage>)
:Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the
DescribeValidDBInstanceModifications
action. You can use this information when you callModifyDBInstance
.
- On failure, responds with
SdkError<DescribeValidDBInstanceModificationsError>
sourcepub fn download_db_log_file_portion(&self) -> DownloadDBLogFilePortion
pub fn download_db_log_file_portion(&self) -> DownloadDBLogFilePortion
Constructs a fluent builder for the DownloadDBLogFilePortion
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
db_instance_identifier(impl Into<String>)
/set_db_instance_identifier(Option<String>)
:The customer-assigned name of the DB instance that contains the log files you want to list.
Constraints:
-
Must match the identifier of an existing DBInstance.
-
log_file_name(impl Into<String>)
/set_log_file_name(Option<String>)
:The name of the log file to be downloaded.
marker(impl Into<String>)
/set_marker(Option<String>)
:The pagination token provided in the previous request or “0”. If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.
number_of_lines(i32)
/set_number_of_lines(i32)
:The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.
If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.
-
If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first.
-
If NumberOfLines is specified and Marker isn’t specified, then the most recent lines from the end of the log file are returned.
-
If Marker is specified as “0”, then the specified number of lines from the beginning of the log file are returned.
-
You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of “0” for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.
-
- On success, responds with
DownloadDbLogFilePortionOutput
with field(s):log_file_data(Option<String>)
:Entries from the specified log file.
marker(Option<String>)
:A pagination token that can be used in a later
DownloadDBLogFilePortion
request.additional_data_pending(bool)
:Boolean value that if true, indicates there is more data to be downloaded.
- On failure, responds with
SdkError<DownloadDBLogFilePortionError>
sourcepub fn failover_db_cluster(&self) -> FailoverDBCluster
pub fn failover_db_cluster(&self) -> FailoverDBCluster
Constructs a fluent builder for the FailoverDBCluster
operation.
- The fluent builder is configurable:
db_cluster_identifier(impl Into<String>)
/set_db_cluster_identifier(Option<String>)
:A DB cluster identifier to force a failover for. This parameter isn’t case-sensitive.
Constraints:
-
Must match the identifier of an existing DBCluster.
-
target_db_instance_identifier(impl Into<String>)
/set_target_db_instance_identifier(Option<String>)
:The name of the DB instance to promote to the primary DB instance.
Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster, for example
mydbcluster-replica1
.This setting isn’t supported for RDS for MySQL Multi-AZ DB clusters.
- On success, responds with
FailoverDbClusterOutput
with field(s):db_cluster(Option<DbCluster>)
:Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,PromoteReadReplicaDBCluster
,RestoreDBClusterFromS3
,RestoreDBClusterFromSnapshot
,RestoreDBClusterToPointInTime
,StartDBCluster
, andStopDBCluster
.For a Multi-AZ DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,RebootDBCluster
,RestoreDBClusterFromSnapshot
, andRestoreDBClusterToPointInTime
.For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
- On failure, responds with
SdkError<FailoverDBClusterError>
sourcepub fn failover_global_cluster(&self) -> FailoverGlobalCluster
pub fn failover_global_cluster(&self) -> FailoverGlobalCluster
Constructs a fluent builder for the FailoverGlobalCluster
operation.
- The fluent builder is configurable:
global_cluster_identifier(impl Into<String>)
/set_global_cluster_identifier(Option<String>)
:Identifier of the Aurora global database (
GlobalCluster
) that should be failed over. The identifier is the unique key assigned by the user when the Aurora global database was created. In other words, it’s the name of the Aurora global database that you want to fail over.Constraints:
-
Must match the identifier of an existing
GlobalCluster
(Aurora global database).
-
target_db_cluster_identifier(impl Into<String>)
/set_target_db_cluster_identifier(Option<String>)
:Identifier of the secondary Aurora DB cluster that you want to promote to primary for the Aurora global database (
GlobalCluster
.) Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services Region.
- On success, responds with
FailoverGlobalClusterOutput
with field(s):global_cluster(Option<GlobalCluster>)
:A data type representing an Aurora global database.
- On failure, responds with
SdkError<FailoverGlobalClusterError>
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_name(impl Into<String>)
/set_resource_name(Option<String>)
:The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter isn’t currently supported.
- On success, responds with
ListTagsForResourceOutput
with field(s):tag_list(Option<Vec<Tag>>)
:List of tags returned by the
ListTagsForResource
operation.
- On failure, responds with
SdkError<ListTagsForResourceError>
sourcepub fn modify_activity_stream(&self) -> ModifyActivityStream
pub fn modify_activity_stream(&self) -> ModifyActivityStream
Constructs a fluent builder for the ModifyActivityStream
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the RDS for Oracle DB instance, for example,
arn:aws:rds:us-east-1:12345667890:instance:my-orcl-db
.audit_policy_state(AuditPolicyState)
/set_audit_policy_state(Option<AuditPolicyState>)
:The audit policy state. When a policy is unlocked, it is read/write. When it is locked, it is read-only. You can edit your audit policy only when the activity stream is unlocked or stopped.
- On success, responds with
ModifyActivityStreamOutput
with field(s):kms_key_id(Option<String>)
:The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.
kinesis_stream_name(Option<String>)
:The name of the Amazon Kinesis data stream to be used for the database activity stream.
status(Option<ActivityStreamStatus>)
:The status of the modification to the database activity stream.
mode(Option<ActivityStreamMode>)
:The mode of the database activity stream.
engine_native_audit_fields_included(Option<bool>)
:Indicates whether engine-native audit fields are included in the database activity stream.
policy_status(Option<ActivityStreamPolicyStatus>)
:The status of the modification to the policy state of the database activity stream.
- On failure, responds with
SdkError<ModifyActivityStreamError>
sourcepub fn modify_certificates(&self) -> ModifyCertificates
pub fn modify_certificates(&self) -> ModifyCertificates
Constructs a fluent builder for the ModifyCertificates
operation.
- The fluent builder is configurable:
certificate_identifier(impl Into<String>)
/set_certificate_identifier(Option<String>)
:The new default certificate identifier to override the current one with.
To determine the valid values, use the
describe-certificates
CLI command or theDescribeCertificates
API operation.remove_customer_override(bool)
/set_remove_customer_override(Option<bool>)
:A value that indicates whether to remove the override for the default certificate. If the override is removed, the default certificate is the system default.
- On success, responds with
ModifyCertificatesOutput
with field(s):certificate(Option<Certificate>)
:A CA certificate for an Amazon Web Services account.
- On failure, responds with
SdkError<ModifyCertificatesError>
sourcepub fn modify_current_db_cluster_capacity(
&self
) -> ModifyCurrentDBClusterCapacity
pub fn modify_current_db_cluster_capacity(
&self
) -> ModifyCurrentDBClusterCapacity
Constructs a fluent builder for the ModifyCurrentDBClusterCapacity
operation.
- The fluent builder is configurable:
db_cluster_identifier(impl Into<String>)
/set_db_cluster_identifier(Option<String>)
:The DB cluster identifier for the cluster being modified. This parameter isn’t case-sensitive.
Constraints:
-
Must match the identifier of an existing DB cluster.
-
capacity(i32)
/set_capacity(Option<i32>)
:The DB cluster capacity.
When you change the capacity of a paused Aurora Serverless v1 DB cluster, it automatically resumes.
Constraints:
-
For Aurora MySQL, valid capacity values are
1
,2
,4
,8
,16
,32
,64
,128
, and256
. -
For Aurora PostgreSQL, valid capacity values are
2
,4
,8
,16
,32
,64
,192
, and384
.
-
seconds_before_timeout(i32)
/set_seconds_before_timeout(Option<i32>)
:The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
Specify a value between 10 and 600 seconds.
timeout_action(impl Into<String>)
/set_timeout_action(Option<String>)
:The action to take when the timeout is reached, either
ForceApplyCapacityChange
orRollbackCapacityChange
.ForceApplyCapacityChange
, the default, sets the capacity to the specified value as soon as possible.RollbackCapacityChange
ignores the capacity change if a scaling point isn’t found in the timeout period.
- On success, responds with
ModifyCurrentDbClusterCapacityOutput
with field(s):db_cluster_identifier(Option<String>)
:A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
pending_capacity(Option<i32>)
:A value that specifies the capacity that the DB cluster scales to next.
current_capacity(Option<i32>)
:The current capacity of the DB cluster.
seconds_before_timeout(Option<i32>)
:The number of seconds before a call to
ModifyCurrentDBClusterCapacity
times out.timeout_action(Option<String>)
:The timeout action of a call to
ModifyCurrentDBClusterCapacity
, eitherForceApplyCapacityChange
orRollbackCapacityChange
.
- On failure, responds with
SdkError<ModifyCurrentDBClusterCapacityError>
sourcepub fn modify_custom_db_engine_version(&self) -> ModifyCustomDBEngineVersion
pub fn modify_custom_db_engine_version(&self) -> ModifyCustomDBEngineVersion
Constructs a fluent builder for the ModifyCustomDBEngineVersion
operation.
- The fluent builder is configurable:
engine(impl Into<String>)
/set_engine(Option<String>)
:The DB engine. The only supported value is
custom-oracle-ee
.engine_version(impl Into<String>)
/set_engine_version(Option<String>)
:The custom engine version (CEV) that you want to modify. This option is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of
Engine
andEngineVersion
is unique per customer per Amazon Web Services Region.description(impl Into<String>)
/set_description(Option<String>)
:An optional description of your CEV.
status(CustomEngineVersionStatus)
/set_status(Option<CustomEngineVersionStatus>)
:The availability status to be assigned to the CEV. Valid values are as follows:
- available
-
You can use this CEV to create a new RDS Custom DB instance.
- inactive
-
You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can’t patch or create new instances with this CEV.
You can change any status to any status. A typical reason to change status is to prevent the accidental use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status of your CEV from
available
toinactive
, and frominactive
back toavailable
. To change the availability status of the CEV, it must not currently be in use by an RDS Custom instance, snapshot, or automated backup.
- On success, responds with
ModifyCustomDbEngineVersionOutput
with field(s):engine(Option<String>)
:The name of the database engine.
engine_version(Option<String>)
:The version number of the database engine.
db_parameter_group_family(Option<String>)
:The name of the DB parameter group family for the database engine.
db_engine_description(Option<String>)
:The description of the database engine.
db_engine_version_description(Option<String>)
:The description of the database engine version.
default_character_set(Option<CharacterSet>)
:The default character set for new instances of this engine version, if the
CharacterSetName
parameter of the CreateDBInstance API isn’t specified.supported_character_sets(Option<Vec<CharacterSet>>)
:A list of the character sets supported by this engine for the
CharacterSetName
parameter of theCreateDBInstance
operation.supported_nchar_character_sets(Option<Vec<CharacterSet>>)
:A list of the character sets supported by the Oracle DB engine for the
NcharCharacterSetName
parameter of theCreateDBInstance
operation.valid_upgrade_target(Option<Vec<UpgradeTarget>>)
:A list of engine versions that this database engine version can be upgraded to.
supported_timezones(Option<Vec<Timezone>>)
:A list of the time zones supported by this engine for the
Timezone
parameter of theCreateDBInstance
action.exportable_log_types(Option<Vec<String>>)
:The types of logs that the database engine has available for export to CloudWatch Logs.
supports_log_exports_to_cloudwatch_logs(bool)
:A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
supports_read_replica(bool)
:Indicates whether the database engine version supports read replicas.
supported_engine_modes(Option<Vec<String>>)
:A list of the supported DB engine modes.
supported_feature_names(Option<Vec<String>>)
:A list of features supported by the DB engine.
The supported features vary by DB engine and DB engine version.
To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:
aws rds describe-db-engine-versions –engine <engine_name> –engine-version <engine_version></engine_version> </engine_name>
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:
aws rds describe-db-engine-versions –engine postgres –engine-version 13.3
The supported features are listed under
SupportedFeatureNames
in the output.status(Option<String>)
:The status of the DB engine version, either
available
ordeprecated
.supports_parallel_query(bool)
:A value that indicates whether you can use Aurora parallel query with a specific DB engine version.
supports_global_databases(bool)
:A value that indicates whether you can use Aurora global databases with a specific DB engine version.
major_engine_version(Option<String>)
:The major engine version of the CEV.
database_installation_files_s3_bucket_name(Option<String>)
:The name of the Amazon S3 bucket that contains your database installation files.
database_installation_files_s3_prefix(Option<String>)
:The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
db_engine_version_arn(Option<String>)
:The ARN of the custom engine version.
kms_key_id(Option<String>)
:The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
create_time(Option<DateTime>)
:The creation time of the DB engine version.
tag_list(Option<Vec<Tag>>)
:A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
supports_babelfish(bool)
:A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
- On failure, responds with
SdkError<ModifyCustomDBEngineVersionError>
sourcepub fn modify_db_cluster(&self) -> ModifyDBCluster
pub fn modify_db_cluster(&self) -> ModifyDBCluster
Constructs a fluent builder for the ModifyDBCluster
operation.
- The fluent builder is configurable:
db_cluster_identifier(impl Into<String>)
/set_db_cluster_identifier(Option<String>)
:The DB cluster identifier for the cluster being modified. This parameter isn’t case-sensitive.
Constraints: This identifier must match the identifier of an existing DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
new_db_cluster_identifier(impl Into<String>)
/set_new_db_cluster_identifier(Option<String>)
:The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.
Constraints:
-
Must contain from 1 to 63 letters, numbers, or hyphens
-
The first character must be a letter
-
Can’t end with a hyphen or contain two consecutive hyphens
Example:
my-cluster2
Valid for: Aurora DB clusters only
-
apply_immediately(bool)
/set_apply_immediately(bool)
:A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the
PreferredMaintenanceWindow
setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window.The
ApplyImmediately
parameter only affects theEnableIAMDatabaseAuthentication
,MasterUserPassword
, andNewDBClusterIdentifier
values. If theApplyImmediately
parameter is disabled, then changes to theEnableIAMDatabaseAuthentication
,MasterUserPassword
, andNewDBClusterIdentifier
values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of theApplyImmediately
parameter.By default, this parameter is disabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
backup_retention_period(i32)
/set_backup_retention_period(Option<i32>)
:The number of days for which automated backups are retained. Specify a minimum value of 1.
Default: 1
Constraints:
-
Must be a value from 1 to 35
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
db_cluster_parameter_group_name(impl Into<String>)
/set_db_cluster_parameter_group_name(Option<String>)
:The name of the DB cluster parameter group to use for the DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
vpc_security_group_ids(Vec<String>)
/set_vpc_security_group_ids(Option<Vec<String>>)
:A list of VPC security groups that the DB cluster will belong to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
port(i32)
/set_port(Option<i32>)
:The port number on which the DB cluster accepts connections.
Constraints: Value must be
1150-65535
Default: The same port as the original DB cluster.
Valid for: Aurora DB clusters only
master_user_password(impl Into<String>)
/set_master_user_password(Option<String>)
:The new password for the master database user. This password can contain any printable ASCII character except “/”, “”“, or “@”.
Constraints: Must contain from 8 to 41 characters.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
option_group_name(impl Into<String>)
/set_option_group_name(Option<String>)
:A value that indicates that the DB cluster should be associated with the specified option group.
DB clusters are associated with a default option group that can’t be modified.
preferred_backup_window(impl Into<String>)
/set_preferred_backup_window(Option<String>)
:The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter.The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Constraints:
-
Must be in the format
hh24:mi-hh24:mi
. -
Must be in Universal Coordinated Time (UTC).
-
Must not conflict with the preferred maintenance window.
-
Must be at least 30 minutes.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
preferred_maintenance_window(impl Into<String>)
/set_preferred_maintenance_window(Option<String>)
:The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format:
ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
enable_iam_database_authentication(bool)
/set_enable_iam_database_authentication(Option<bool>)
:A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn’t enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
backtrack_window(i64)
/set_backtrack_window(Option<i64>)
:The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
-
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora MySQL DB clusters only
-
cloudwatch_logs_export_configuration(CloudwatchLogsExportConfiguration)
/set_cloudwatch_logs_export_configuration(Option<CloudwatchLogsExportConfiguration>)
:The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are
error
,general
, andslowquery
.RDS for PostgreSQL
Possible values are
postgresql
andupgrade
.Aurora MySQL
Possible values are
audit
,error
,general
, andslowquery
.Aurora PostgreSQL
Possible value is
postgresql
.For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
engine_version(impl Into<String>)
/set_engine_version(Option<String>)
:The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless
ApplyImmediately
is enabled.To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:
aws rds describe-db-engine-versions –engine aurora –query “DBEngineVersions[].EngineVersion”
To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:
aws rds describe-db-engine-versions –engine aurora-mysql –query “DBEngineVersions[].EngineVersion”
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions –engine aurora-postgresql –query “DBEngineVersions[].EngineVersion”
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions –engine mysql –query “DBEngineVersions[].EngineVersion”
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions –engine postgres –query “DBEngineVersions[].EngineVersion”
Valid for: Aurora DB clusters and Multi-AZ DB clusters
allow_major_version_upgrade(bool)
/set_allow_major_version_upgrade(bool)
:A value that indicates whether major version upgrades are allowed.
Constraints: You must allow major version upgrades when specifying a value for the
EngineVersion
parameter that is a different major version than the DB cluster’s current version.Valid for: Aurora DB clusters only
db_instance_parameter_group_name(impl Into<String>)
/set_db_instance_parameter_group_name(Option<String>)
:The name of the DB parameter group to apply to all instances of the DB cluster.
When you apply a parameter group using the
DBInstanceParameterGroupName
parameter, the DB cluster isn’t rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.Default: The existing name setting
Constraints:
-
The DB parameter group must be in the same DB parameter group family as this DB cluster.
-
The
DBInstanceParameterGroupName
parameter is valid in combination with theAllowMajorVersionUpgrade
parameter for a major version upgrade only.
Valid for: Aurora DB clusters only
-
domain(impl Into<String>)
/set_domain(Option<String>)
:The Active Directory directory ID to move the DB cluster to. Specify
none
to remove the cluster from its current domain. The domain must be created prior to this operation.For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
domain_iam_role_name(impl Into<String>)
/set_domain_iam_role_name(Option<String>)
:Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
scaling_configuration(ScalingConfiguration)
/set_scaling_configuration(Option<ScalingConfiguration>)
:The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in
serverless
DB engine mode.Valid for: Aurora DB clusters only
deletion_protection(bool)
/set_deletion_protection(Option<bool>)
:A value that indicates whether the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection isn’t enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
enable_http_endpoint(bool)
/set_enable_http_endpoint(Option<bool>)
:A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint is disabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
copy_tags_to_snapshot(bool)
/set_copy_tags_to_snapshot(Option<bool>)
:A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
enable_global_write_forwarding(bool)
/set_enable_global_write_forwarding(Option<bool>)
:A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (
GlobalCluster
). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the
FailoverGlobalCluster
API operation, but it does nothing until then.Valid for: Aurora DB clusters only
db_cluster_instance_class(impl Into<String>)
/set_db_cluster_instance_class(Option<String>)
:The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
allocated_storage(i32)
/set_allocated_storage(Option<i32>)
:The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
Type: Integer
Valid for: Multi-AZ DB clusters only
storage_type(impl Into<String>)
/set_storage_type(Option<String>)
:Specifies the storage type to be associated with the DB cluster.
Valid values:
io1
When specified, a value for the
Iops
parameter is required.Default:
io1
Valid for: Multi-AZ DB clusters only
iops(i32)
/set_iops(Option<i32>)
:The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
Valid for: Multi-AZ DB clusters only
auto_minor_version_upgrade(bool)
/set_auto_minor_version_upgrade(Option<bool>)
:A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
Valid for: Multi-AZ DB clusters only
monitoring_interval(i32)
/set_monitoring_interval(Option<i32>)
:The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If
MonitoringRoleArn
is specified, also setMonitoringInterval
to a value other than 0.Valid Values:
0, 1, 5, 10, 15, 30, 60
Valid for: Multi-AZ DB clusters only
monitoring_role_arn(impl Into<String>)
/set_monitoring_role_arn(Option<String>)
:The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.If
MonitoringInterval
is set to a value other than 0, supply aMonitoringRoleArn
value.Valid for: Multi-AZ DB clusters only
enable_performance_insights(bool)
/set_enable_performance_insights(Option<bool>)
:A value that indicates whether to turn on Performance Insights for the DB cluster.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
performance_insights_kms_key_id(impl Into<String>)
/set_performance_insights_kms_key_id(Option<String>)
:The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don’t specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.Valid for: Multi-AZ DB clusters only
performance_insights_retention_period(i32)
/set_performance_insights_retention_period(Option<i32>)
:The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
-
7
-
month * 31, where month is a number of months from 1-23
-
731
For example, the following values are valid:
-
93 (3 months * 31)
-
341 (11 months * 31)
-
589 (19 months * 31)
-
731
If you specify a retention period such as 94, which isn’t a valid value, RDS issues an error.
Valid for: Multi-AZ DB clusters only
-
serverless_v2_scaling_configuration(ServerlessV2ScalingConfiguration)
/set_serverless_v2_scaling_configuration(Option<ServerlessV2ScalingConfiguration>)
:Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
network_type(impl Into<String>)
/set_network_type(Option<String>)
:The network type of the DB cluster.
Valid values:
-
IPV4
-
DUAL
The network type is determined by the
DBSubnetGroup
specified for the DB cluster. ADBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL
).For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
-
- On success, responds with
ModifyDbClusterOutput
with field(s):db_cluster(Option<DbCluster>)
:Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,PromoteReadReplicaDBCluster
,RestoreDBClusterFromS3
,RestoreDBClusterFromSnapshot
,RestoreDBClusterToPointInTime
,StartDBCluster
, andStopDBCluster
.For a Multi-AZ DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,RebootDBCluster
,RestoreDBClusterFromSnapshot
, andRestoreDBClusterToPointInTime
.For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
- On failure, responds with
SdkError<ModifyDBClusterError>
sourcepub fn modify_db_cluster_endpoint(&self) -> ModifyDBClusterEndpoint
pub fn modify_db_cluster_endpoint(&self) -> ModifyDBClusterEndpoint
Constructs a fluent builder for the ModifyDBClusterEndpoint
operation.
- The fluent builder is configurable:
db_cluster_endpoint_identifier(impl Into<String>)
/set_db_cluster_endpoint_identifier(Option<String>)
:The identifier of the endpoint to modify. This parameter is stored as a lowercase string.
endpoint_type(impl Into<String>)
/set_endpoint_type(Option<String>)
:The type of the endpoint. One of:
READER
,WRITER
,ANY
.static_members(Vec<String>)
/set_static_members(Option<Vec<String>>)
:List of DB instance identifiers that are part of the custom endpoint group.
excluded_members(Vec<String>)
/set_excluded_members(Option<Vec<String>>)
:List of DB instance identifiers that aren’t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
- On success, responds with
ModifyDbClusterEndpointOutput
with field(s):db_cluster_endpoint_identifier(Option<String>)
:The identifier associated with the endpoint. This parameter is stored as a lowercase string.
db_cluster_identifier(Option<String>)
:The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
db_cluster_endpoint_resource_identifier(Option<String>)
:A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
endpoint(Option<String>)
:The DNS address of the endpoint.
status(Option<String>)
:The current status of the endpoint. One of:
creating
,available
,deleting
,inactive
,modifying
. Theinactive
state applies to an endpoint that can’t be used for a certain kind of cluster, such as awriter
endpoint for a read-only secondary cluster in a global database.endpoint_type(Option<String>)
:The type of the endpoint. One of:
READER
,WRITER
,CUSTOM
.custom_endpoint_type(Option<String>)
:The type associated with a custom endpoint. One of:
READER
,WRITER
,ANY
.static_members(Option<Vec<String>>)
:List of DB instance identifiers that are part of the custom endpoint group.
excluded_members(Option<Vec<String>>)
:List of DB instance identifiers that aren’t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
db_cluster_endpoint_arn(Option<String>)
:The Amazon Resource Name (ARN) for the endpoint.
- On failure, responds with
SdkError<ModifyDBClusterEndpointError>
sourcepub fn modify_db_cluster_parameter_group(&self) -> ModifyDBClusterParameterGroup
pub fn modify_db_cluster_parameter_group(&self) -> ModifyDBClusterParameterGroup
Constructs a fluent builder for the ModifyDBClusterParameterGroup
operation.
- The fluent builder is configurable:
db_cluster_parameter_group_name(impl Into<String>)
/set_db_cluster_parameter_group_name(Option<String>)
:The name of the DB cluster parameter group to modify.
parameters(Vec<Parameter>)
/set_parameters(Option<Vec<Parameter>>)
:A list of parameters in the DB cluster parameter group to modify.
Valid Values (for the application method):
immediate | pending-reboot
You can use the
immediate
value with dynamic parameters only. You can use thepending-reboot
value for both dynamic and static parameters.When the application method is
immediate
, changes to dynamic parameters are applied immediately to the DB clusters associated with the parameter group. When the application method ispending-reboot
, changes to dynamic and static parameters are applied after a reboot without failover to the DB clusters associated with the parameter group.
- On success, responds with
ModifyDbClusterParameterGroupOutput
with field(s):db_cluster_parameter_group_name(Option<String>)
:The name of the DB cluster parameter group.
Constraints:
-
Must be 1 to 255 letters or numbers.
-
First character must be a letter
-
Can’t end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
-
- On failure, responds with
SdkError<ModifyDBClusterParameterGroupError>
sourcepub fn modify_db_cluster_snapshot_attribute(
&self
) -> ModifyDBClusterSnapshotAttribute
pub fn modify_db_cluster_snapshot_attribute(
&self
) -> ModifyDBClusterSnapshotAttribute
Constructs a fluent builder for the ModifyDBClusterSnapshotAttribute
operation.
- The fluent builder is configurable:
db_cluster_snapshot_identifier(impl Into<String>)
/set_db_cluster_snapshot_identifier(Option<String>)
:The identifier for the DB cluster snapshot to modify the attributes for.
attribute_name(impl Into<String>)
/set_attribute_name(Option<String>)
:The name of the DB cluster snapshot attribute to modify.
To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this value to
restore
.To view the list of attributes available to modify, use the
DescribeDBClusterSnapshotAttributes
API operation.values_to_add(Vec<String>)
/set_values_to_add(Option<Vec<String>>)
:A list of DB cluster snapshot attributes to add to the attribute specified by
AttributeName
.To authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account IDs, or
all
to make the manual DB cluster snapshot restorable by any Amazon Web Services account. Do not add theall
value for any manual DB cluster snapshots that contain private information that you don’t want available to all Amazon Web Services accounts.values_to_remove(Vec<String>)
/set_values_to_remove(Option<Vec<String>>)
:A list of DB cluster snapshot attributes to remove from the attribute specified by
AttributeName
.To remove authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account identifiers, or
all
to remove authorization for any Amazon Web Services account to copy or restore the DB cluster snapshot. If you specifyall
, an Amazon Web Services account whose account ID is explicitly added to therestore
attribute can still copy or restore a manual DB cluster snapshot.
- On success, responds with
ModifyDbClusterSnapshotAttributeOutput
with field(s):db_cluster_snapshot_attributes_result(Option<DbClusterSnapshotAttributesResult>)
:Contains the results of a successful call to the
DescribeDBClusterSnapshotAttributes
API action.Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot. For more information, see the
ModifyDBClusterSnapshotAttribute
API action.
- On failure, responds with
SdkError<ModifyDBClusterSnapshotAttributeError>
sourcepub fn modify_db_instance(&self) -> ModifyDBInstance
pub fn modify_db_instance(&self) -> ModifyDBInstance
Constructs a fluent builder for the ModifyDBInstance
operation.
- The fluent builder is configurable:
db_instance_identifier(impl Into<String>)
/set_db_instance_identifier(Option<String>)
:The DB instance identifier. This value is stored as a lowercase string.
Constraints:
-
Must match the identifier of an existing DBInstance.
-
allocated_storage(i32)
/set_allocated_storage(Option<i32>)
:The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
For the valid values for allocated storage for each engine, see
CreateDBInstance
.db_instance_class(impl Into<String>)
/set_db_instance_class(Option<String>)
:The new compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and DB instance class support for RDS Custom for SQL Server.
If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless
ApplyImmediately
is enabled for this request.Default: Uses existing setting
db_subnet_group_name(impl Into<String>)
/set_db_subnet_group_name(Option<String>)
:The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn’t in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable
ApplyImmediately
.This parameter doesn’t apply to RDS Custom.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example:
mydbsubnetgroup
db_security_groups(Vec<String>)
/set_db_security_groups(Option<Vec<String>>)
:A list of DB security groups to authorize on this DB instance. Changing this setting doesn’t result in an outage and the change is asynchronously applied as soon as possible.
This setting doesn’t apply to RDS Custom.
Constraints:
-
If supplied, must match existing DBSecurityGroups.
-
vpc_security_group_ids(Vec<String>)
/set_vpc_security_group_ids(Option<Vec<String>>)
:A list of Amazon EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
This setting doesn’t apply to RDS Custom.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see
ModifyDBCluster
.Constraints:
-
If supplied, must match existing VpcSecurityGroupIds.
-
apply_immediately(bool)
/set_apply_immediately(bool)
:A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the
PreferredMaintenanceWindow
setting for the DB instance. By default, this parameter is disabled.If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to
RebootDBInstance
, or the next failure reboot. Review the table of parameters in Modifying a DB Instance in the Amazon RDS User Guide to see the impact of enabling or disablingApplyImmediately
for each modified parameter and to determine when the changes are applied.master_user_password(impl Into<String>)
/set_master_user_password(Option<String>)
:The new password for the master user. The password can include any printable ASCII character except “/”, “”“, or “@”.
Changing this parameter doesn’t result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the
MasterUserPassword
element exists in thePendingModifiedValues
element of the operation response.This setting doesn’t apply to RDS Custom.
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster. For more information, see
ModifyDBCluster
.Default: Uses existing setting
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
Amazon RDS API operations never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
db_parameter_group_name(impl Into<String>)
/set_db_parameter_group_name(Option<String>)
:The name of the DB parameter group to apply to the DB instance.
Changing this setting doesn’t result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn’t rebooted automatically, and the parameter changes aren’t applied during the next maintenance window. However, if you modify dynamic parameters in the newly associated DB parameter group, these changes are applied immediately without a reboot.
This setting doesn’t apply to RDS Custom.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as the DB instance.
backup_retention_period(i32)
/set_backup_retention_period(Option<i32>)
:The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
These changes are applied during the next maintenance window unless the
ApplyImmediately
parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see
ModifyDBCluster
.Default: Uses existing setting
Constraints:
-
It must be a value from 0 to 35. It can’t be set to 0 if the DB instance is a source to read replicas. It can’t be set to 0 for an RDS Custom for Oracle DB instance.
-
It can be specified for a MySQL read replica only if the source is running MySQL 5.6 or later.
-
It can be specified for a PostgreSQL read replica only if the source is running PostgreSQL 9.3.5.
-
preferred_backup_window(impl Into<String>)
/set_preferred_backup_window(Option<String>)
:The daily time range during which automated backups are created if automated backups are enabled, as determined by the
BackupRetentionPeriod
parameter. Changing this parameter doesn’t result in an outage and the change is asynchronously applied as soon as possible. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see
ModifyDBCluster
.Constraints:
-
Must be in the format hh24:mi-hh24:mi
-
Must be in Universal Time Coordinated (UTC)
-
Must not conflict with the preferred maintenance window
-
Must be at least 30 minutes
-
preferred_maintenance_window(impl Into<String>)
/set_preferred_maintenance_window(Option<String>)
:The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn’t result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.
For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
multi_az(bool)
/set_multi_az(Option<bool>)
:A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn’t result in an outage. The change is applied during the next maintenance window unless the
ApplyImmediately
parameter is enabled for this request.This setting doesn’t apply to RDS Custom.
engine_version(impl Into<String>)
/set_engine_version(Option<String>)
:The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the
ApplyImmediately
parameter is enabled for this request.For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
If you specify only a major version, Amazon RDS will update the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see
CreateDBInstance
, or callDescribeDBEngineVersions
.In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the
PATCH_DB_FAILURE
lifecycle.allow_major_version_upgrade(bool)
/set_allow_major_version_upgrade(bool)
:A value that indicates whether major version upgrades are allowed. Changing this parameter doesn’t result in an outage and the change is asynchronously applied as soon as possible.
This setting doesn’t apply to RDS Custom.
Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance’s current version.
auto_minor_version_upgrade(bool)
/set_auto_minor_version_upgrade(Option<bool>)
:A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window. An outage occurs when all the following conditions are met:
-
The automatic upgrade is enabled for the maintenance window.
-
A newer minor version is available.
-
RDS has enabled automatic patching for the engine version.
If any of the preceding conditions isn’t met, RDS applies the change as soon as possible and doesn’t cause an outage.
For an RDS Custom DB instance, set
AutoMinorVersionUpgrade
tofalse
. Otherwise, the operation returns an error.-
license_model(impl Into<String>)
/set_license_model(Option<String>)
:The license model for the DB instance.
This setting doesn’t apply to RDS Custom.
Valid values:
license-included
|bring-your-own-license
|general-public-license
iops(i32)
/set_iops(Option<i32>)
:The new Provisioned IOPS (I/O operations per second) value for the RDS instance.
Changing this setting doesn’t result in an outage and the change is applied during the next maintenance window unless the
ApplyImmediately
parameter is enabled for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Default: Uses existing setting
option_group_name(impl Into<String>)
/set_option_group_name(Option<String>)
:A value that indicates the DB instance should be associated with the specified option group.
Changing this parameter doesn’t result in an outage, with one exception. If the parameter change results in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which new connections are rejected but existing connections aren’t interrupted.
The change is applied during the next maintenance window unless the
ApplyImmediately
parameter is enabled for this request.Permanent options, such as the TDE option for Oracle Advanced Security TDE, can’t be removed from an option group, and that option group can’t be removed from a DB instance after it is associated with a DB instance.
This setting doesn’t apply to RDS Custom.
new_db_instance_identifier(impl Into<String>)
/set_new_db_instance_identifier(Option<String>)
:The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable
ApplyImmediately
, or will occur during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.This setting doesn’t apply to RDS Custom.
Constraints:
-
Must contain from 1 to 63 letters, numbers, or hyphens.
-
The first character must be a letter.
-
Can’t end with a hyphen or contain two consecutive hyphens.
Example:
mydbinstance
-
storage_type(impl Into<String>)
/set_storage_type(Option<String>)
:Specifies the storage type to be associated with the DB instance.
If you specify Provisioned IOPS (
io1
), you must also include a value for theIops
parameter.If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
Valid values:
standard | gp2 | io1
Default:
io1
if theIops
parameter is specified, otherwisegp2
tde_credential_arn(impl Into<String>)
/set_tde_credential_arn(Option<String>)
:The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn’t apply to RDS Custom.
tde_credential_password(impl Into<String>)
/set_tde_credential_password(Option<String>)
:The password for the given ARN from the key store in order to access the device.
This setting doesn’t apply to RDS Custom.
ca_certificate_identifier(impl Into<String>)
/set_ca_certificate_identifier(Option<String>)
:Specifies the certificate to associate with the DB instance.
This setting doesn’t apply to RDS Custom.
domain(impl Into<String>)
/set_domain(Option<String>)
:The Active Directory directory ID to move the DB instance to. Specify
none
to remove the instance from its current domain. You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn’t apply to RDS Custom.
copy_tags_to_snapshot(bool)
/set_copy_tags_to_snapshot(Option<bool>)
:A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see
ModifyDBCluster
.monitoring_interval(i32)
/set_monitoring_interval(Option<i32>)
:The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0, which is the default.
If
MonitoringRoleArn
is specified, setMonitoringInterval
to a value other than 0.This setting doesn’t apply to RDS Custom.
Valid Values:
0, 1, 5, 10, 15, 30, 60
db_port_number(i32)
/set_db_port_number(Option<i32>)
:The port number on which the database accepts connections.
The value of the
DBPortNumber
parameter must not match any of the port values specified for options in the option group for the DB instance.If you change the
DBPortNumber
value, your database restarts regardless of the value of theApplyImmediately
parameter.This setting doesn’t apply to RDS Custom.
MySQL
Default:
3306
Valid values:
1150-65535
MariaDB
Default:
3306
Valid values:
1150-65535
PostgreSQL
Default:
5432
Valid values:
1150-65535
Type: Integer
Oracle
Default:
1521
Valid values:
1150-65535
SQL Server
Default:
1433
Valid values:
1150-65535
except1234
,1434
,3260
,3343
,3389
,47001
, and49152-49156
.Amazon Aurora
Default:
3306
Valid values:
1150-65535
publicly_accessible(bool)
/set_publicly_accessible(Option<bool>)
:A value that indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster’s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster’s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn’t permitted if the security group assigned to the DB cluster doesn’t permit it.
When the DB instance isn’t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
PubliclyAccessible
only applies to DB instances in a VPC. The DB instance must be part of a public subnet andPubliclyAccessible
must be enabled for it to be publicly accessible.Changes to the
PubliclyAccessible
parameter are applied immediately regardless of the value of theApplyImmediately
parameter.monitoring_role_arn(impl Into<String>)
/set_monitoring_role_arn(Option<String>)
:The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.If
MonitoringInterval
is set to a value other than 0, supply aMonitoringRoleArn
value.This setting doesn’t apply to RDS Custom.
domain_iam_role_name(impl Into<String>)
/set_domain_iam_role_name(Option<String>)
:The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn’t apply to RDS Custom.
promotion_tier(i32)
/set_promotion_tier(Option<i32>)
:A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
This setting doesn’t apply to RDS Custom.
Default: 1
Valid Values: 0 - 15
enable_iam_database_authentication(bool)
/set_enable_iam_database_authentication(Option<bool>)
:A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn’t enabled.
This setting doesn’t apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn’t apply to RDS Custom.
enable_performance_insights(bool)
/set_enable_performance_insights(Option<bool>)
:A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
This setting doesn’t apply to RDS Custom.
performance_insights_kms_key_id(impl Into<String>)
/set_performance_insights_kms_key_id(Option<String>)
:The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.This setting doesn’t apply to RDS Custom.
performance_insights_retention_period(i32)
/set_performance_insights_retention_period(Option<i32>)
:The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
-
7
-
month * 31, where month is a number of months from 1-23
-
731
For example, the following values are valid:
-
93 (3 months * 31)
-
341 (11 months * 31)
-
589 (19 months * 31)
-
731
If you specify a retention period such as 94, which isn’t a valid value, RDS issues an error.
This setting doesn’t apply to RDS Custom.
-
cloudwatch_logs_export_configuration(CloudwatchLogsExportConfiguration)
/set_cloudwatch_logs_export_configuration(Option<CloudwatchLogsExportConfiguration>)
:The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.
A change to the
CloudwatchLogsExportConfiguration
parameter is always applied to the DB instance immediately. Therefore, theApplyImmediately
parameter has no effect.This setting doesn’t apply to RDS Custom.
processor_features(Vec<ProcessorFeature>)
/set_processor_features(Option<Vec<ProcessorFeature>>)
:The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn’t apply to RDS Custom.
use_default_processor_features(bool)
/set_use_default_processor_features(Option<bool>)
:A value that indicates whether the DB instance class of the DB instance uses its default processor features.
This setting doesn’t apply to RDS Custom.
deletion_protection(bool)
/set_deletion_protection(Option<bool>)
:A value that indicates whether the DB instance has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection isn’t enabled. For more information, see Deleting a DB Instance.
max_allocated_storage(i32)
/set_max_allocated_storage(Option<i32>)
:The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn’t apply to RDS Custom.
certificate_rotation_restart(bool)
/set_certificate_rotation_restart(Option<bool>)
:A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
Set this parameter only if you are not using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
-
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.
This setting doesn’t apply to RDS Custom.
-
replica_mode(ReplicaMode)
/set_replica_mode(Option<ReplicaMode>)
:A value that sets the open mode of a replica database to either mounted or read-only.
Currently, this parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn’t use Active Data Guard to transmit information to the mounted replica. Because it doesn’t accept user connections, a mounted replica can’t serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
This setting doesn’t apply to RDS Custom.
enable_customer_owned_ip(bool)
/set_enable_customer_owned_ip(Option<bool>)
:A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
aws_backup_recovery_point_arn(impl Into<String>)
/set_aws_backup_recovery_point_arn(Option<String>)
:The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
This setting doesn’t apply to RDS Custom.
automation_mode(AutomationMode)
/set_automation_mode(Option<AutomationMode>)
:The automation mode of the RDS Custom DB instance:
full
orall paused
. Iffull
, the DB instance automates monitoring and instance recovery. Ifall paused
, the instance pauses automation for the duration set byResumeFullAutomationModeMinutes
.resume_full_automation_mode_minutes(i32)
/set_resume_full_automation_mode_minutes(Option<i32>)
:The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is
60
(default). The maximum value is1,440
.network_type(impl Into<String>)
/set_network_type(Option<String>)
:The network type of the DB instance.
Valid values:
-
IPV4
-
DUAL
The network type is determined by the
DBSubnetGroup
specified for the DB instance. ADBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL
).For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
-
- On success, responds with
ModifyDbInstanceOutput
with field(s):db_instance(Option<DbInstance>)
:Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
- On failure, responds with
SdkError<ModifyDBInstanceError>
sourcepub fn modify_db_parameter_group(&self) -> ModifyDBParameterGroup
pub fn modify_db_parameter_group(&self) -> ModifyDBParameterGroup
Constructs a fluent builder for the ModifyDBParameterGroup
operation.
- The fluent builder is configurable:
db_parameter_group_name(impl Into<String>)
/set_db_parameter_group_name(Option<String>)
:The name of the DB parameter group.
Constraints:
-
If supplied, must match the name of an existing
DBParameterGroup
.
-
parameters(Vec<Parameter>)
/set_parameters(Option<Vec<Parameter>>)
:An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.
Valid Values (for the application method):
immediate | pending-reboot
You can use the
immediate
value with dynamic parameters only. You can use thepending-reboot
value for both dynamic and static parameters.When the application method is
immediate
, changes to dynamic parameters are applied immediately to the DB instances associated with the parameter group.When the application method is
pending-reboot
, changes to dynamic and static parameters are applied after a reboot without failover to the DB instances associated with the parameter group.You can’t use
pending-reboot
with dynamic parameters on RDS for SQL Server DB instances. Useimmediate
.For more information on modifying DB parameters, see Working with DB parameter groups in the Amazon RDS User Guide.
- On success, responds with
ModifyDbParameterGroupOutput
with field(s):db_parameter_group_name(Option<String>)
:The name of the DB parameter group.
- On failure, responds with
SdkError<ModifyDBParameterGroupError>
sourcepub fn modify_db_proxy(&self) -> ModifyDBProxy
pub fn modify_db_proxy(&self) -> ModifyDBProxy
Constructs a fluent builder for the ModifyDBProxy
operation.
- The fluent builder is configurable:
db_proxy_name(impl Into<String>)
/set_db_proxy_name(Option<String>)
:The identifier for the
DBProxy
to modify.new_db_proxy_name(impl Into<String>)
/set_new_db_proxy_name(Option<String>)
:The new identifier for the
DBProxy
. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can’t end with a hyphen or contain two consecutive hyphens.auth(Vec<UserAuthConfig>)
/set_auth(Option<Vec<UserAuthConfig>>)
:The new authentication settings for the
DBProxy
.require_tls(bool)
/set_require_tls(Option<bool>)
:Whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn’t use TLS.
idle_client_timeout(i32)
/set_idle_client_timeout(Option<i32>)
:The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.
debug_logging(bool)
/set_debug_logging(Option<bool>)
:Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
security_groups(Vec<String>)
/set_security_groups(Option<Vec<String>>)
:The new list of security groups for the
DBProxy
.
- On success, responds with
ModifyDbProxyOutput
with field(s):db_proxy(Option<DbProxy>)
:The
DBProxy
object representing the new settings for the proxy.
- On failure, responds with
SdkError<ModifyDBProxyError>
sourcepub fn modify_db_proxy_endpoint(&self) -> ModifyDBProxyEndpoint
pub fn modify_db_proxy_endpoint(&self) -> ModifyDBProxyEndpoint
Constructs a fluent builder for the ModifyDBProxyEndpoint
operation.
- The fluent builder is configurable:
db_proxy_endpoint_name(impl Into<String>)
/set_db_proxy_endpoint_name(Option<String>)
:The name of the DB proxy sociated with the DB proxy endpoint that you want to modify.
new_db_proxy_endpoint_name(impl Into<String>)
/set_new_db_proxy_endpoint_name(Option<String>)
:The new identifier for the
DBProxyEndpoint
. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can’t end with a hyphen or contain two consecutive hyphens.vpc_security_group_ids(Vec<String>)
/set_vpc_security_group_ids(Option<Vec<String>>)
:The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint uses a different VPC than the original proxy, you also specify a different set of security group IDs than for the original proxy.
- On success, responds with
ModifyDbProxyEndpointOutput
with field(s):db_proxy_endpoint(Option<DbProxyEndpoint>)
:The
DBProxyEndpoint
object representing the new settings for the DB proxy endpoint.
- On failure, responds with
SdkError<ModifyDBProxyEndpointError>
sourcepub fn modify_db_proxy_target_group(&self) -> ModifyDBProxyTargetGroup
pub fn modify_db_proxy_target_group(&self) -> ModifyDBProxyTargetGroup
Constructs a fluent builder for the ModifyDBProxyTargetGroup
operation.
- The fluent builder is configurable:
target_group_name(impl Into<String>)
/set_target_group_name(Option<String>)
:The name of the target group to modify.
db_proxy_name(impl Into<String>)
/set_db_proxy_name(Option<String>)
:The name of the proxy.
connection_pool_config(ConnectionPoolConfiguration)
/set_connection_pool_config(Option<ConnectionPoolConfiguration>)
:The settings that determine the size and behavior of the connection pool for the target group.
new_name(impl Into<String>)
/set_new_name(Option<String>)
:The new name for the modified
DBProxyTarget
. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can’t end with a hyphen or contain two consecutive hyphens.
- On success, responds with
ModifyDbProxyTargetGroupOutput
with field(s):db_proxy_target_group(Option<DbProxyTargetGroup>)
:The settings of the modified
DBProxyTarget
.
- On failure, responds with
SdkError<ModifyDBProxyTargetGroupError>
sourcepub fn modify_db_snapshot(&self) -> ModifyDBSnapshot
pub fn modify_db_snapshot(&self) -> ModifyDBSnapshot
Constructs a fluent builder for the ModifyDBSnapshot
operation.
- The fluent builder is configurable:
db_snapshot_identifier(impl Into<String>)
/set_db_snapshot_identifier(Option<String>)
:The identifier of the DB snapshot to modify.
engine_version(impl Into<String>)
/set_engine_version(Option<String>)
:The engine version to upgrade the DB snapshot to.
The following are the database engines and engine versions that are available when you upgrade a DB snapshot.
MySQL
-
5.5.46
(supported for 5.1 DB snapshots)
Oracle
-
12.1.0.2.v8
(supported for 12.1.0.1 DB snapshots) -
11.2.0.4.v12
(supported for 11.2.0.2 DB snapshots) -
11.2.0.4.v11
(supported for 11.2.0.3 DB snapshots)
PostgreSQL
For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading the PostgreSQL DB Engine for Amazon RDS.
-
option_group_name(impl Into<String>)
/set_option_group_name(Option<String>)
:The option group to identify with the upgraded DB snapshot.
You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see Option group considerations in the Amazon RDS User Guide.
- On success, responds with
ModifyDbSnapshotOutput
with field(s):db_snapshot(Option<DbSnapshot>)
:Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the
DescribeDBSnapshots
action.
- On failure, responds with
SdkError<ModifyDBSnapshotError>
sourcepub fn modify_db_snapshot_attribute(&self) -> ModifyDBSnapshotAttribute
pub fn modify_db_snapshot_attribute(&self) -> ModifyDBSnapshotAttribute
Constructs a fluent builder for the ModifyDBSnapshotAttribute
operation.
- The fluent builder is configurable:
db_snapshot_identifier(impl Into<String>)
/set_db_snapshot_identifier(Option<String>)
:The identifier for the DB snapshot to modify the attributes for.
attribute_name(impl Into<String>)
/set_attribute_name(Option<String>)
:The name of the DB snapshot attribute to modify.
To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, set this value to
restore
.To view the list of attributes available to modify, use the
DescribeDBSnapshotAttributes
API operation.values_to_add(Vec<String>)
/set_values_to_add(Option<Vec<String>>)
:A list of DB snapshot attributes to add to the attribute specified by
AttributeName
.To authorize other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account IDs, or
all
to make the manual DB snapshot restorable by any Amazon Web Services account. Do not add theall
value for any manual DB snapshots that contain private information that you don’t want available to all Amazon Web Services accounts.values_to_remove(Vec<String>)
/set_values_to_remove(Option<Vec<String>>)
:A list of DB snapshot attributes to remove from the attribute specified by
AttributeName
.To remove authorization for other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account identifiers, or
all
to remove authorization for any Amazon Web Services account to copy or restore the DB snapshot. If you specifyall
, an Amazon Web Services account whose account ID is explicitly added to therestore
attribute can still copy or restore the manual DB snapshot.
- On success, responds with
ModifyDbSnapshotAttributeOutput
with field(s):db_snapshot_attributes_result(Option<DbSnapshotAttributesResult>)
:Contains the results of a successful call to the
DescribeDBSnapshotAttributes
API action.Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB snapshot. For more information, see the
ModifyDBSnapshotAttribute
API action.
- On failure, responds with
SdkError<ModifyDBSnapshotAttributeError>
sourcepub fn modify_db_subnet_group(&self) -> ModifyDBSubnetGroup
pub fn modify_db_subnet_group(&self) -> ModifyDBSubnetGroup
Constructs a fluent builder for the ModifyDBSubnetGroup
operation.
- The fluent builder is configurable:
db_subnet_group_name(impl Into<String>)
/set_db_subnet_group_name(Option<String>)
:The name for the DB subnet group. This value is stored as a lowercase string. You can’t modify the default subnet group.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example:
mydbsubnetgroup
db_subnet_group_description(impl Into<String>)
/set_db_subnet_group_description(Option<String>)
:The description for the DB subnet group.
subnet_ids(Vec<String>)
/set_subnet_ids(Option<Vec<String>>)
:The EC2 subnet IDs for the DB subnet group.
- On success, responds with
ModifyDbSubnetGroupOutput
with field(s):db_subnet_group(Option<DbSubnetGroup>)
:Contains the details of an Amazon RDS DB subnet group.
This data type is used as a response element in the
DescribeDBSubnetGroups
action.
- On failure, responds with
SdkError<ModifyDBSubnetGroupError>
sourcepub fn modify_event_subscription(&self) -> ModifyEventSubscription
pub fn modify_event_subscription(&self) -> ModifyEventSubscription
Constructs a fluent builder for the ModifyEventSubscription
operation.
- The fluent builder is configurable:
subscription_name(impl Into<String>)
/set_subscription_name(Option<String>)
:The name of the RDS event notification subscription.
sns_topic_arn(impl Into<String>)
/set_sns_topic_arn(Option<String>)
:The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
source_type(impl Into<String>)
/set_source_type(Option<String>)
:The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify
db-proxy
. If this value isn’t specified, all events are returned.Valid values:
db-instance
|db-cluster
|db-parameter-group
|db-security-group
|db-snapshot
|db-cluster-snapshot
|db-proxy
event_categories(Vec<String>)
/set_event_categories(Option<Vec<String>>)
:A list of event categories for a source type (
SourceType
) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using theDescribeEventCategories
operation.enabled(bool)
/set_enabled(Option<bool>)
:A value that indicates whether to activate the subscription.
- On success, responds with
ModifyEventSubscriptionOutput
with field(s):event_subscription(Option<EventSubscription>)
:Contains the results of a successful invocation of the
DescribeEventSubscriptions
action.
- On failure, responds with
SdkError<ModifyEventSubscriptionError>
sourcepub fn modify_global_cluster(&self) -> ModifyGlobalCluster
pub fn modify_global_cluster(&self) -> ModifyGlobalCluster
Constructs a fluent builder for the ModifyGlobalCluster
operation.
- The fluent builder is configurable:
global_cluster_identifier(impl Into<String>)
/set_global_cluster_identifier(Option<String>)
:The DB cluster identifier for the global cluster being modified. This parameter isn’t case-sensitive.
Constraints:
-
Must match the identifier of an existing global database cluster.
-
new_global_cluster_identifier(impl Into<String>)
/set_new_global_cluster_identifier(Option<String>)
:The new cluster identifier for the global database cluster when modifying a global database cluster. This value is stored as a lowercase string.
Constraints:
-
Must contain from 1 to 63 letters, numbers, or hyphens
-
The first character must be a letter
-
Can’t end with a hyphen or contain two consecutive hyphens
Example:
my-cluster2
-
deletion_protection(bool)
/set_deletion_protection(Option<bool>)
:Indicates if the global database cluster has deletion protection enabled. The global database cluster can’t be deleted when deletion protection is enabled.
engine_version(impl Into<String>)
/set_engine_version(Option<String>)
:The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless
ApplyImmediately
is enabled.To list all of the available engine versions for
aurora
(for MySQL 5.6-compatible Aurora), use the following command:aws rds describe-db-engine-versions –engine aurora –query ‘[]|[?SupportsGlobalDatabases ==
true
].[EngineVersion]’To list all of the available engine versions for
aurora-mysql
(for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:aws rds describe-db-engine-versions –engine aurora-mysql –query ‘[]|[?SupportsGlobalDatabases ==
true
].[EngineVersion]’To list all of the available engine versions for
aurora-postgresql
, use the following command:aws rds describe-db-engine-versions –engine aurora-postgresql –query ‘*[]|[?SupportsGlobalDatabases ==
true
].[EngineVersion]’allow_major_version_upgrade(bool)
/set_allow_major_version_upgrade(Option<bool>)
:A value that indicates whether major version upgrades are allowed.
Constraints: You must allow major version upgrades when specifying a value for the
EngineVersion
parameter that is a different major version than the DB cluster’s current version.If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version. Apply any custom parameter groups after completing the upgrade.
- On success, responds with
ModifyGlobalClusterOutput
with field(s):global_cluster(Option<GlobalCluster>)
:A data type representing an Aurora global database.
- On failure, responds with
SdkError<ModifyGlobalClusterError>
sourcepub fn modify_option_group(&self) -> ModifyOptionGroup
pub fn modify_option_group(&self) -> ModifyOptionGroup
Constructs a fluent builder for the ModifyOptionGroup
operation.
- The fluent builder is configurable:
option_group_name(impl Into<String>)
/set_option_group_name(Option<String>)
:The name of the option group to be modified.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can’t be removed from an option group, and that option group can’t be removed from a DB instance once it is associated with a DB instance
options_to_include(Vec<OptionConfiguration>)
/set_options_to_include(Option<Vec<OptionConfiguration>>)
:Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.
options_to_remove(Vec<String>)
/set_options_to_remove(Option<Vec<String>>)
:Options in this list are removed from the option group.
apply_immediately(bool)
/set_apply_immediately(bool)
:A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.
- On success, responds with
ModifyOptionGroupOutput
with field(s): - On failure, responds with
SdkError<ModifyOptionGroupError>
sourcepub fn promote_read_replica(&self) -> PromoteReadReplica
pub fn promote_read_replica(&self) -> PromoteReadReplica
Constructs a fluent builder for the PromoteReadReplica
operation.
- The fluent builder is configurable:
db_instance_identifier(impl Into<String>)
/set_db_instance_identifier(Option<String>)
:The DB instance identifier. This value is stored as a lowercase string.
Constraints:
-
Must match the identifier of an existing read replica DB instance.
Example:
mydbinstance
-
backup_retention_period(i32)
/set_backup_retention_period(Option<i32>)
:The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Default: 1
Constraints:
-
Must be a value from 0 to 35.
-
Can’t be set to 0 if the DB instance is a source to read replicas.
-
preferred_backup_window(impl Into<String>)
/set_preferred_backup_window(Option<String>)
:The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter.The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
-
Must be in the format
hh24:mi-hh24:mi
. -
Must be in Universal Coordinated Time (UTC).
-
Must not conflict with the preferred maintenance window.
-
Must be at least 30 minutes.
-
- On success, responds with
PromoteReadReplicaOutput
with field(s):db_instance(Option<DbInstance>)
:Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
- On failure, responds with
SdkError<PromoteReadReplicaError>
sourcepub fn promote_read_replica_db_cluster(&self) -> PromoteReadReplicaDBCluster
pub fn promote_read_replica_db_cluster(&self) -> PromoteReadReplicaDBCluster
Constructs a fluent builder for the PromoteReadReplicaDBCluster
operation.
- The fluent builder is configurable:
db_cluster_identifier(impl Into<String>)
/set_db_cluster_identifier(Option<String>)
:The identifier of the DB cluster read replica to promote. This parameter isn’t case-sensitive.
Constraints:
-
Must match the identifier of an existing DB cluster read replica.
Example:
my-cluster-replica1
-
- On success, responds with
PromoteReadReplicaDbClusterOutput
with field(s):db_cluster(Option<DbCluster>)
:Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,PromoteReadReplicaDBCluster
,RestoreDBClusterFromS3
,RestoreDBClusterFromSnapshot
,RestoreDBClusterToPointInTime
,StartDBCluster
, andStopDBCluster
.For a Multi-AZ DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,RebootDBCluster
,RestoreDBClusterFromSnapshot
, andRestoreDBClusterToPointInTime
.For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
- On failure, responds with
SdkError<PromoteReadReplicaDBClusterError>
sourcepub fn purchase_reserved_db_instances_offering(
&self
) -> PurchaseReservedDBInstancesOffering
pub fn purchase_reserved_db_instances_offering(
&self
) -> PurchaseReservedDBInstancesOffering
Constructs a fluent builder for the PurchaseReservedDBInstancesOffering
operation.
- The fluent builder is configurable:
reserved_db_instances_offering_id(impl Into<String>)
/set_reserved_db_instances_offering_id(Option<String>)
:The ID of the Reserved DB instance offering to purchase.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
reserved_db_instance_id(impl Into<String>)
/set_reserved_db_instance_id(Option<String>)
:Customer-specified identifier to track this reservation.
Example: myreservationID
db_instance_count(i32)
/set_db_instance_count(Option<i32>)
:The number of instances to reserve.
Default:
1
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
- On success, responds with
PurchaseReservedDbInstancesOfferingOutput
with field(s):reserved_db_instance(Option<ReservedDbInstance>)
:This data type is used as a response element in the
DescribeReservedDBInstances
andPurchaseReservedDBInstancesOffering
actions.
- On failure, responds with
SdkError<PurchaseReservedDBInstancesOfferingError>
sourcepub fn reboot_db_cluster(&self) -> RebootDBCluster
pub fn reboot_db_cluster(&self) -> RebootDBCluster
Constructs a fluent builder for the RebootDBCluster
operation.
- The fluent builder is configurable:
db_cluster_identifier(impl Into<String>)
/set_db_cluster_identifier(Option<String>)
:The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
-
Must match the identifier of an existing DBCluster.
-
- On success, responds with
RebootDbClusterOutput
with field(s):db_cluster(Option<DbCluster>)
:Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,PromoteReadReplicaDBCluster
,RestoreDBClusterFromS3
,RestoreDBClusterFromSnapshot
,RestoreDBClusterToPointInTime
,StartDBCluster
, andStopDBCluster
.For a Multi-AZ DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,RebootDBCluster
,RestoreDBClusterFromSnapshot
, andRestoreDBClusterToPointInTime
.For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
- On failure, responds with
SdkError<RebootDBClusterError>
sourcepub fn reboot_db_instance(&self) -> RebootDBInstance
pub fn reboot_db_instance(&self) -> RebootDBInstance
Constructs a fluent builder for the RebootDBInstance
operation.
- The fluent builder is configurable:
db_instance_identifier(impl Into<String>)
/set_db_instance_identifier(Option<String>)
:The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
-
Must match the identifier of an existing DBInstance.
-
force_failover(bool)
/set_force_failover(Option<bool>)
:A value that indicates whether the reboot is conducted through a Multi-AZ failover.
Constraint: You can’t enable force failover if the instance isn’t configured for Multi-AZ.
- On success, responds with
RebootDbInstanceOutput
with field(s):db_instance(Option<DbInstance>)
:Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
- On failure, responds with
SdkError<RebootDBInstanceError>
sourcepub fn register_db_proxy_targets(&self) -> RegisterDBProxyTargets
pub fn register_db_proxy_targets(&self) -> RegisterDBProxyTargets
Constructs a fluent builder for the RegisterDBProxyTargets
operation.
- The fluent builder is configurable:
db_proxy_name(impl Into<String>)
/set_db_proxy_name(Option<String>)
:The identifier of the
DBProxy
that is associated with theDBProxyTargetGroup
.target_group_name(impl Into<String>)
/set_target_group_name(Option<String>)
:The identifier of the
DBProxyTargetGroup
.db_instance_identifiers(Vec<String>)
/set_db_instance_identifiers(Option<Vec<String>>)
:One or more DB instance identifiers.
db_cluster_identifiers(Vec<String>)
/set_db_cluster_identifiers(Option<Vec<String>>)
:One or more DB cluster identifiers.
- On success, responds with
RegisterDbProxyTargetsOutput
with field(s):db_proxy_targets(Option<Vec<DbProxyTarget>>)
:One or more
DBProxyTarget
objects that are created when you register targets with a target group.
- On failure, responds with
SdkError<RegisterDBProxyTargetsError>
sourcepub fn remove_from_global_cluster(&self) -> RemoveFromGlobalCluster
pub fn remove_from_global_cluster(&self) -> RemoveFromGlobalCluster
Constructs a fluent builder for the RemoveFromGlobalCluster
operation.
- The fluent builder is configurable:
global_cluster_identifier(impl Into<String>)
/set_global_cluster_identifier(Option<String>)
:The cluster identifier to detach from the Aurora global database cluster.
db_cluster_identifier(impl Into<String>)
/set_db_cluster_identifier(Option<String>)
:The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.
- On success, responds with
RemoveFromGlobalClusterOutput
with field(s):global_cluster(Option<GlobalCluster>)
:A data type representing an Aurora global database.
- On failure, responds with
SdkError<RemoveFromGlobalClusterError>
sourcepub fn remove_role_from_db_cluster(&self) -> RemoveRoleFromDBCluster
pub fn remove_role_from_db_cluster(&self) -> RemoveRoleFromDBCluster
Constructs a fluent builder for the RemoveRoleFromDBCluster
operation.
- The fluent builder is configurable:
db_cluster_identifier(impl Into<String>)
/set_db_cluster_identifier(Option<String>)
:The name of the DB cluster to disassociate the IAM role from.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example
arn:aws:iam::123456789012:role/AuroraAccessRole
.feature_name(impl Into<String>)
/set_feature_name(Option<String>)
:The name of the feature for the DB cluster that the IAM role is to be disassociated from. For information about supported feature names, see
DBEngineVersion
.
- On success, responds with
RemoveRoleFromDbClusterOutput
- On failure, responds with
SdkError<RemoveRoleFromDBClusterError>
sourcepub fn remove_role_from_db_instance(&self) -> RemoveRoleFromDBInstance
pub fn remove_role_from_db_instance(&self) -> RemoveRoleFromDBInstance
Constructs a fluent builder for the RemoveRoleFromDBInstance
operation.
- The fluent builder is configurable:
db_instance_identifier(impl Into<String>)
/set_db_instance_identifier(Option<String>)
:The name of the DB instance to disassociate the IAM role from.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance, for example,
arn:aws:iam::123456789012:role/AccessRole
.feature_name(impl Into<String>)
/set_feature_name(Option<String>)
:The name of the feature for the DB instance that the IAM role is to be disassociated from. For information about supported feature names, see
DBEngineVersion
.
- On success, responds with
RemoveRoleFromDbInstanceOutput
- On failure, responds with
SdkError<RemoveRoleFromDBInstanceError>
sourcepub fn remove_source_identifier_from_subscription(
&self
) -> RemoveSourceIdentifierFromSubscription
pub fn remove_source_identifier_from_subscription(
&self
) -> RemoveSourceIdentifierFromSubscription
Constructs a fluent builder for the RemoveSourceIdentifierFromSubscription
operation.
- The fluent builder is configurable:
subscription_name(impl Into<String>)
/set_subscription_name(Option<String>)
:The name of the RDS event notification subscription you want to remove a source identifier from.
source_identifier(impl Into<String>)
/set_source_identifier(Option<String>)
:The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.
- On success, responds with
RemoveSourceIdentifierFromSubscriptionOutput
with field(s):event_subscription(Option<EventSubscription>)
:Contains the results of a successful invocation of the
DescribeEventSubscriptions
action.
- On failure, responds with
SdkError<RemoveSourceIdentifierFromSubscriptionError>
Constructs a fluent builder for the RemoveTagsFromResource
operation.
- The fluent builder is configurable:
resource_name(impl Into<String>)
/set_resource_name(Option<String>)
:The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:The tag key (name) of the tag to be removed.
- On success, responds with
RemoveTagsFromResourceOutput
- On failure, responds with
SdkError<RemoveTagsFromResourceError>
sourcepub fn reset_db_cluster_parameter_group(&self) -> ResetDBClusterParameterGroup
pub fn reset_db_cluster_parameter_group(&self) -> ResetDBClusterParameterGroup
Constructs a fluent builder for the ResetDBClusterParameterGroup
operation.
- The fluent builder is configurable:
db_cluster_parameter_group_name(impl Into<String>)
/set_db_cluster_parameter_group_name(Option<String>)
:The name of the DB cluster parameter group to reset.
reset_all_parameters(bool)
/set_reset_all_parameters(bool)
:A value that indicates whether to reset all parameters in the DB cluster parameter group to their default values. You can’t use this parameter if there is a list of parameter names specified for the
Parameters
parameter.parameters(Vec<Parameter>)
/set_parameters(Option<Vec<Parameter>>)
:A list of parameter names in the DB cluster parameter group to reset to the default values. You can’t use this parameter if the
ResetAllParameters
parameter is enabled.
- On success, responds with
ResetDbClusterParameterGroupOutput
with field(s):db_cluster_parameter_group_name(Option<String>)
:The name of the DB cluster parameter group.
Constraints:
-
Must be 1 to 255 letters or numbers.
-
First character must be a letter
-
Can’t end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
-
- On failure, responds with
SdkError<ResetDBClusterParameterGroupError>
sourcepub fn reset_db_parameter_group(&self) -> ResetDBParameterGroup
pub fn reset_db_parameter_group(&self) -> ResetDBParameterGroup
Constructs a fluent builder for the ResetDBParameterGroup
operation.
- The fluent builder is configurable:
db_parameter_group_name(impl Into<String>)
/set_db_parameter_group_name(Option<String>)
:The name of the DB parameter group.
Constraints:
-
Must match the name of an existing
DBParameterGroup
.
-
reset_all_parameters(bool)
/set_reset_all_parameters(bool)
:A value that indicates whether to reset all parameters in the DB parameter group to default values. By default, all parameters in the DB parameter group are reset to default values.
parameters(Vec<Parameter>)
/set_parameters(Option<Vec<Parameter>>)
:To reset the entire DB parameter group, specify the
DBParameterGroup
name andResetAllParameters
parameters. To reset specific parameters, provide a list of the following:ParameterName
andApplyMethod
. A maximum of 20 parameters can be modified in a single request.MySQL
Valid Values (for Apply method):
immediate
|pending-reboot
You can use the immediate value with dynamic parameters only. You can use the
pending-reboot
value for both dynamic and static parameters, and changes are applied when DB instance reboots.MariaDB
Valid Values (for Apply method):
immediate
|pending-reboot
You can use the immediate value with dynamic parameters only. You can use the
pending-reboot
value for both dynamic and static parameters, and changes are applied when DB instance reboots.Oracle
Valid Values (for Apply method):
pending-reboot
- On success, responds with
ResetDbParameterGroupOutput
with field(s):db_parameter_group_name(Option<String>)
:The name of the DB parameter group.
- On failure, responds with
SdkError<ResetDBParameterGroupError>
sourcepub fn restore_db_cluster_from_s3(&self) -> RestoreDBClusterFromS3
pub fn restore_db_cluster_from_s3(&self) -> RestoreDBClusterFromS3
Constructs a fluent builder for the RestoreDBClusterFromS3
operation.
- The fluent builder is configurable:
availability_zones(Vec<String>)
/set_availability_zones(Option<Vec<String>>)
:A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
backup_retention_period(i32)
/set_backup_retention_period(Option<i32>)
:The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
-
Must be a value from 1 to 35
-
character_set_name(impl Into<String>)
/set_character_set_name(Option<String>)
:A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:The database name for the restored DB cluster.
db_cluster_identifier(impl Into<String>)
/set_db_cluster_identifier(Option<String>)
:The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn’t case-sensitive.
Constraints:
-
Must contain from 1 to 63 letters, numbers, or hyphens.
-
First character must be a letter.
-
Can’t end with a hyphen or contain two consecutive hyphens.
Example:
my-cluster1
-
db_cluster_parameter_group_name(impl Into<String>)
/set_db_cluster_parameter_group_name(Option<String>)
:The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted,
default.aurora5.6
is used.Constraints:
-
If supplied, must match the name of an existing DBClusterParameterGroup.
-
vpc_security_group_ids(Vec<String>)
/set_vpc_security_group_ids(Option<Vec<String>>)
:A list of EC2 VPC security groups to associate with the restored DB cluster.
db_subnet_group_name(impl Into<String>)
/set_db_subnet_group_name(Option<String>)
:A DB subnet group to associate with the restored DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example:
mydbsubnetgroup
engine(impl Into<String>)
/set_engine(Option<String>)
:The name of the database engine to be used for this DB cluster.
Valid Values:
aurora
(for MySQL 5.6-compatible Aurora) andaurora-mysql
(for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)engine_version(impl Into<String>)
/set_engine_version(Option<String>)
:The version number of the database engine to use.
To list all of the available engine versions for
aurora
(for MySQL 5.6-compatible Aurora), use the following command:aws rds describe-db-engine-versions –engine aurora –query “DBEngineVersions[].EngineVersion”
To list all of the available engine versions for
aurora-mysql
(for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:aws rds describe-db-engine-versions –engine aurora-mysql –query “DBEngineVersions[].EngineVersion”
Aurora MySQL
Example:
5.6.10a
,5.6.mysql_aurora.1.19.2
,5.7.mysql_aurora.2.07.1
,8.0.mysql_aurora.3.02.0
port(i32)
/set_port(Option<i32>)
:The port number on which the instances in the restored DB cluster accept connections.
Default:
3306
master_username(impl Into<String>)
/set_master_username(Option<String>)
:The name of the master user for the restored DB cluster.
Constraints:
-
Must be 1 to 16 letters or numbers.
-
First character must be a letter.
-
Can’t be a reserved word for the chosen database engine.
-
master_user_password(impl Into<String>)
/set_master_user_password(Option<String>)
:The password for the master database user. This password can contain any printable ASCII character except “/”, “”“, or “@”.
Constraints: Must contain from 8 to 41 characters.
option_group_name(impl Into<String>)
/set_option_group_name(Option<String>)
:A value that indicates that the restored DB cluster should be associated with the specified option group.
Permanent options can’t be removed from an option group. An option group can’t be removed from a DB cluster once it is associated with a DB cluster.
preferred_backup_window(impl Into<String>)
/set_preferred_backup_window(Option<String>)
:The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod
parameter.The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Constraints:
-
Must be in the format
hh24:mi-hh24:mi
. -
Must be in Universal Coordinated Time (UTC).
-
Must not conflict with the preferred maintenance window.
-
Must be at least 30 minutes.
-
preferred_maintenance_window(impl Into<String>)
/set_preferred_maintenance_window(Option<String>)
:The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format:
ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
storage_encrypted(bool)
/set_storage_encrypted(Option<bool>)
:A value that indicates whether the restored DB cluster is encrypted.
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the
KmsKeyId
parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.enable_iam_database_authentication(bool)
/set_enable_iam_database_authentication(Option<bool>)
:A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn’t enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
source_engine(impl Into<String>)
/set_source_engine(Option<String>)
:The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
Valid values:
mysql
source_engine_version(impl Into<String>)
/set_source_engine_version(Option<String>)
:The version of the database that the backup files were created from.
MySQL versions 5.5, 5.6, and 5.7 are supported.
Example:
5.6.40
,5.7.28
s3_bucket_name(impl Into<String>)
/set_s3_bucket_name(Option<String>)
:The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
s3_prefix(impl Into<String>)
/set_s3_prefix(Option<String>)
:The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.
s3_ingestion_role_arn(impl Into<String>)
/set_s3_ingestion_role_arn(Option<String>)
:The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
backtrack_window(i64)
/set_backtrack_window(Option<i64>)
:The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
-
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
-
enable_cloudwatch_logs_exports(Vec<String>)
/set_enable_cloudwatch_logs_exports(Option<Vec<String>>)
:The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.
Aurora MySQL
Possible values are
audit
,error
,general
, andslowquery
.Aurora PostgreSQL
Possible value is
postgresql
.For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
deletion_protection(bool)
/set_deletion_protection(Option<bool>)
:A value that indicates whether the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection isn’t enabled.
copy_tags_to_snapshot(bool)
/set_copy_tags_to_snapshot(Option<bool>)
:A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
domain(impl Into<String>)
/set_domain(Option<String>)
:Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
domain_iam_role_name(impl Into<String>)
/set_domain_iam_role_name(Option<String>)
:Specify the name of the IAM role to be used when making API calls to the Directory Service.
serverless_v2_scaling_configuration(ServerlessV2ScalingConfiguration)
/set_serverless_v2_scaling_configuration(Option<ServerlessV2ScalingConfiguration>)
:Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
network_type(impl Into<String>)
/set_network_type(Option<String>)
:The network type of the DB cluster.
Valid values:
-
IPV4
-
DUAL
The network type is determined by the
DBSubnetGroup
specified for the DB cluster. ADBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL
).For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
-
- On success, responds with
RestoreDbClusterFromS3Output
with field(s):db_cluster(Option<DbCluster>)
:Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,PromoteReadReplicaDBCluster
,RestoreDBClusterFromS3
,RestoreDBClusterFromSnapshot
,RestoreDBClusterToPointInTime
,StartDBCluster
, andStopDBCluster
.For a Multi-AZ DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,RebootDBCluster
,RestoreDBClusterFromSnapshot
, andRestoreDBClusterToPointInTime
.For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
- On failure, responds with
SdkError<RestoreDBClusterFromS3Error>
sourcepub fn restore_db_cluster_from_snapshot(&self) -> RestoreDBClusterFromSnapshot
pub fn restore_db_cluster_from_snapshot(&self) -> RestoreDBClusterFromSnapshot
Constructs a fluent builder for the RestoreDBClusterFromSnapshot
operation.
- The fluent builder is configurable:
availability_zones(Vec<String>)
/set_availability_zones(Option<Vec<String>>)
:Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
Valid for: Aurora DB clusters only
db_cluster_identifier(impl Into<String>)
/set_db_cluster_identifier(Option<String>)
:The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn’t case-sensitive.
Constraints:
-
Must contain from 1 to 63 letters, numbers, or hyphens
-
First character must be a letter
-
Can’t end with a hyphen or contain two consecutive hyphens
Example:
my-snapshot-id
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
snapshot_identifier(impl Into<String>)
/set_snapshot_identifier(Option<String>)
:The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
-
Must match the identifier of an existing Snapshot.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
engine(impl Into<String>)
/set_engine(Option<String>)
:The database engine to use for the new DB cluster.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid for: Aurora DB clusters and Multi-AZ DB clusters
engine_version(impl Into<String>)
/set_engine_version(Option<String>)
:The version of the database engine to use for the new DB cluster.
To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:
aws rds describe-db-engine-versions –engine aurora –query “DBEngineVersions[].EngineVersion”
To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:
aws rds describe-db-engine-versions –engine aurora-mysql –query “DBEngineVersions[].EngineVersion”
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions –engine aurora-postgresql –query “DBEngineVersions[].EngineVersion”
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions –engine mysql –query “DBEngineVersions[].EngineVersion”
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions –engine postgres –query “DBEngineVersions[].EngineVersion”
Aurora MySQL
See MySQL on Amazon RDS Versions in the Amazon Aurora User Guide.
Aurora PostgreSQL
See Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.
MySQL
See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
PostgreSQL
See Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
port(i32)
/set_port(Option<i32>)
:The port number on which the new DB cluster accepts connections.
Constraints: This value must be
1150-65535
Default: The same port as the original DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
db_subnet_group_name(impl Into<String>)
/set_db_subnet_group_name(Option<String>)
:The name of the DB subnet group to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DB subnet group.
Example:
mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
database_name(impl Into<String>)
/set_database_name(Option<String>)
:The database name for the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
option_group_name(impl Into<String>)
/set_option_group_name(Option<String>)
:The name of the option group to use for the restored DB cluster.
DB clusters are associated with a default option group that can’t be modified.
vpc_security_group_ids(Vec<String>)
/set_vpc_security_group_ids(Option<Vec<String>>)
:A list of VPC security groups that the new DB cluster will belong to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tags to be assigned to the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
When you don’t specify a value for the
KmsKeyId
parameter, then the following occurs:-
If the DB snapshot or DB cluster snapshot in
SnapshotIdentifier
is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot. -
If the DB snapshot or DB cluster snapshot in
SnapshotIdentifier
isn’t encrypted, then the restored DB cluster isn’t encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
enable_iam_database_authentication(bool)
/set_enable_iam_database_authentication(Option<bool>)
:A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn’t enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
backtrack_window(i64)
/set_backtrack_window(Option<i64>)
:The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
-
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora DB clusters only
-
enable_cloudwatch_logs_exports(Vec<String>)
/set_enable_cloudwatch_logs_exports(Option<Vec<String>>)
:The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are
error
,general
, andslowquery
.RDS for PostgreSQL
Possible values are
postgresql
andupgrade
.Aurora MySQL
Possible values are
audit
,error
,general
, andslowquery
.Aurora PostgreSQL
Possible value is
postgresql
.For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
engine_mode(impl Into<String>)
/set_engine_mode(Option<String>)
:The DB engine mode of the DB cluster, either
provisioned
,serverless
,parallelquery
,global
, ormultimaster
.For more information, see CreateDBCluster.
Valid for: Aurora DB clusters only
scaling_configuration(ScalingConfiguration)
/set_scaling_configuration(Option<ScalingConfiguration>)
:For DB clusters in
serverless
DB engine mode, the scaling properties of the DB cluster.Valid for: Aurora DB clusters only
db_cluster_parameter_group_name(impl Into<String>)
/set_db_cluster_parameter_group_name(Option<String>)
:The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
-
If supplied, must match the name of an existing default DB cluster parameter group.
-
Must be 1 to 255 letters, numbers, or hyphens.
-
First character must be a letter.
-
Can’t end with a hyphen or contain two consecutive hyphens.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
deletion_protection(bool)
/set_deletion_protection(Option<bool>)
:A value that indicates whether the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection isn’t enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
copy_tags_to_snapshot(bool)
/set_copy_tags_to_snapshot(Option<bool>)
:A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
domain(impl Into<String>)
/set_domain(Option<String>)
:Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
Valid for: Aurora DB clusters only
domain_iam_role_name(impl Into<String>)
/set_domain_iam_role_name(Option<String>)
:Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
db_cluster_instance_class(impl Into<String>)
/set_db_cluster_instance_class(Option<String>)
:The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
storage_type(impl Into<String>)
/set_storage_type(Option<String>)
:Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.
Valid values:
io1
When specified, a value for the
Iops
parameter is required.Default:
io1
Valid for: Aurora DB clusters and Multi-AZ DB clusters
iops(i32)
/set_iops(Option<i32>)
:The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
publicly_accessible(bool)
/set_publicly_accessible(Option<bool>)
:A value that indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster’s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster’s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn’t permit it.
When the DB cluster isn’t publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether
DBSubnetGroupName
is specified.If
DBSubnetGroupName
isn’t specified, andPubliclyAccessible
isn’t specified, the following applies:-
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
-
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If
DBSubnetGroupName
is specified, andPubliclyAccessible
isn’t specified, the following applies:-
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
-
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
serverless_v2_scaling_configuration(ServerlessV2ScalingConfiguration)
/set_serverless_v2_scaling_configuration(Option<ServerlessV2ScalingConfiguration>)
:Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
network_type(impl Into<String>)
/set_network_type(Option<String>)
:The network type of the DB cluster.
Valid values:
-
IPV4
-
DUAL
The network type is determined by the
DBSubnetGroup
specified for the DB cluster. ADBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL
).For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
-
- On success, responds with
RestoreDbClusterFromSnapshotOutput
with field(s):db_cluster(Option<DbCluster>)
:Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,PromoteReadReplicaDBCluster
,RestoreDBClusterFromS3
,RestoreDBClusterFromSnapshot
,RestoreDBClusterToPointInTime
,StartDBCluster
, andStopDBCluster
.For a Multi-AZ DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,RebootDBCluster
,RestoreDBClusterFromSnapshot
, andRestoreDBClusterToPointInTime
.For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
- On failure, responds with
SdkError<RestoreDBClusterFromSnapshotError>
sourcepub fn restore_db_cluster_to_point_in_time(
&self
) -> RestoreDBClusterToPointInTime
pub fn restore_db_cluster_to_point_in_time(
&self
) -> RestoreDBClusterToPointInTime
Constructs a fluent builder for the RestoreDBClusterToPointInTime
operation.
- The fluent builder is configurable:
db_cluster_identifier(impl Into<String>)
/set_db_cluster_identifier(Option<String>)
:The name of the new DB cluster to be created.
Constraints:
-
Must contain from 1 to 63 letters, numbers, or hyphens
-
First character must be a letter
-
Can’t end with a hyphen or contain two consecutive hyphens
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
restore_type(impl Into<String>)
/set_restore_type(Option<String>)
:The type of restore to be performed. You can specify one of the following values:
-
full-copy
- The new DB cluster is restored as a full copy of the source DB cluster. -
copy-on-write
- The new DB cluster is restored as a clone of the source DB cluster.
Constraints: You can’t specify
copy-on-write
if the engine version of the source DB cluster is earlier than 1.11.If you don’t specify a
RestoreType
value, then the new DB cluster is restored as a full copy of the source DB cluster.Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
source_db_cluster_identifier(impl Into<String>)
/set_source_db_cluster_identifier(Option<String>)
:The identifier of the source DB cluster from which to restore.
Constraints:
-
Must match the identifier of an existing DBCluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
restore_to_time(DateTime)
/set_restore_to_time(Option<DateTime>)
:The date and time to restore the DB cluster to.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
-
Must be before the latest restorable time for the DB instance
-
Must be specified if
UseLatestRestorableTime
parameter isn’t provided -
Can’t be specified if the
UseLatestRestorableTime
parameter is enabled -
Can’t be specified if the
RestoreType
parameter iscopy-on-write
Example:
2015-03-07T23:45:00Z
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
use_latest_restorable_time(bool)
/set_use_latest_restorable_time(bool)
:A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn’t restored to the latest restorable backup time.
Constraints: Can’t be specified if
RestoreToTime
parameter is provided.Valid for: Aurora DB clusters and Multi-AZ DB clusters
port(i32)
/set_port(Option<i32>)
:The port number on which the new DB cluster accepts connections.
Constraints: A value from
1150-65535
.Default: The default port for the engine.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
db_subnet_group_name(impl Into<String>)
/set_db_subnet_group_name(Option<String>)
:The DB subnet group name to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example:
mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
option_group_name(impl Into<String>)
/set_option_group_name(Option<String>)
:The name of the option group for the new DB cluster.
DB clusters are associated with a default option group that can’t be modified.
vpc_security_group_ids(Vec<String>)
/set_vpc_security_group_ids(Option<Vec<String>>)
:A list of VPC security groups that the new DB cluster belongs to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the
KmsKeyId
parameter.If you don’t specify a value for the
KmsKeyId
parameter, then the following occurs:-
If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
-
If the DB cluster isn’t encrypted, then the restored DB cluster isn’t encrypted.
If
DBClusterIdentifier
refers to a DB cluster that isn’t encrypted, then the restore request is rejected.Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
enable_iam_database_authentication(bool)
/set_enable_iam_database_authentication(Option<bool>)
:A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn’t enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
backtrack_window(i64)
/set_backtrack_window(Option<i64>)
:The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
-
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora MySQL DB clusters only
-
enable_cloudwatch_logs_exports(Vec<String>)
/set_enable_cloudwatch_logs_exports(Option<Vec<String>>)
:The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are
error
,general
, andslowquery
.RDS for PostgreSQL
Possible values are
postgresql
andupgrade
.Aurora MySQL
Possible values are
audit
,error
,general
, andslowquery
.Aurora PostgreSQL
Possible value is
postgresql
.For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
db_cluster_parameter_group_name(impl Into<String>)
/set_db_cluster_parameter_group_name(Option<String>)
:The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
-
If supplied, must match the name of an existing DB cluster parameter group.
-
Must be 1 to 255 letters, numbers, or hyphens.
-
First character must be a letter.
-
Can’t end with a hyphen or contain two consecutive hyphens.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
deletion_protection(bool)
/set_deletion_protection(Option<bool>)
:A value that indicates whether the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection isn’t enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
copy_tags_to_snapshot(bool)
/set_copy_tags_to_snapshot(Option<bool>)
:A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
domain(impl Into<String>)
/set_domain(Option<String>)
:Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
domain_iam_role_name(impl Into<String>)
/set_domain_iam_role_name(Option<String>)
:Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
scaling_configuration(ScalingConfiguration)
/set_scaling_configuration(Option<ScalingConfiguration>)
:For DB clusters in
serverless
DB engine mode, the scaling properties of the DB cluster.Valid for: Aurora DB clusters only
engine_mode(impl Into<String>)
/set_engine_mode(Option<String>)
:The engine mode of the new cluster. Specify
provisioned
orserverless
, depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or an encrypted provisioned cluster.Valid for: Aurora DB clusters only
db_cluster_instance_class(impl Into<String>)
/set_db_cluster_instance_class(Option<String>)
:The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
storage_type(impl Into<String>)
/set_storage_type(Option<String>)
:Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.
Valid values:
io1
When specified, a value for the
Iops
parameter is required.Default:
io1
Valid for: Multi-AZ DB clusters only
publicly_accessible(bool)
/set_publicly_accessible(Option<bool>)
:A value that indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster’s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster’s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn’t permit it.
When the DB cluster isn’t publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether
DBSubnetGroupName
is specified.If
DBSubnetGroupName
isn’t specified, andPubliclyAccessible
isn’t specified, the following applies:-
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
-
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If
DBSubnetGroupName
is specified, andPubliclyAccessible
isn’t specified, the following applies:-
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
-
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Multi-AZ DB clusters only
-
iops(i32)
/set_iops(Option<i32>)
:The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid
Iops
values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide.Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Multi-AZ DB clusters only
serverless_v2_scaling_configuration(ServerlessV2ScalingConfiguration)
/set_serverless_v2_scaling_configuration(Option<ServerlessV2ScalingConfiguration>)
:Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
network_type(impl Into<String>)
/set_network_type(Option<String>)
:The network type of the DB cluster.
Valid values:
-
IPV4
-
DUAL
The network type is determined by the
DBSubnetGroup
specified for the DB cluster. ADBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL
).For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
-
- On success, responds with
RestoreDbClusterToPointInTimeOutput
with field(s):db_cluster(Option<DbCluster>)
:Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,PromoteReadReplicaDBCluster
,RestoreDBClusterFromS3
,RestoreDBClusterFromSnapshot
,RestoreDBClusterToPointInTime
,StartDBCluster
, andStopDBCluster
.For a Multi-AZ DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,RebootDBCluster
,RestoreDBClusterFromSnapshot
, andRestoreDBClusterToPointInTime
.For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
- On failure, responds with
SdkError<RestoreDBClusterToPointInTimeError>
sourcepub fn restore_db_instance_from_db_snapshot(
&self
) -> RestoreDBInstanceFromDBSnapshot
pub fn restore_db_instance_from_db_snapshot(
&self
) -> RestoreDBInstanceFromDBSnapshot
Constructs a fluent builder for the RestoreDBInstanceFromDBSnapshot
operation.
- The fluent builder is configurable:
db_instance_identifier(impl Into<String>)
/set_db_instance_identifier(Option<String>)
:Name of the DB instance to create from the DB snapshot. This parameter isn’t case-sensitive.
Constraints:
-
Must contain from 1 to 63 numbers, letters, or hyphens
-
First character must be a letter
-
Can’t end with a hyphen or contain two consecutive hyphens
Example:
my-snapshot-id
-
db_snapshot_identifier(impl Into<String>)
/set_db_snapshot_identifier(Option<String>)
:The identifier for the DB snapshot to restore from.
Constraints:
-
Must match the identifier of an existing DBSnapshot.
-
If you are restoring from a shared manual DB snapshot, the
DBSnapshotIdentifier
must be the ARN of the shared DB snapshot.
-
db_instance_class(impl Into<String>)
/set_db_instance_class(Option<String>)
:The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
port(i32)
/set_port(Option<i32>)
:The port number on which the database accepts connections.
Default: The same port as the original DB instance
Constraints: Value must be
1150-65535
availability_zone(impl Into<String>)
/set_availability_zone(Option<String>)
:The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone.
Constraint: You can’t specify the
AvailabilityZone
parameter if the DB instance is a Multi-AZ deployment.Example:
us-east-1a
db_subnet_group_name(impl Into<String>)
/set_db_subnet_group_name(Option<String>)
:The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example:
mydbsubnetgroup
multi_az(bool)
/set_multi_az(Option<bool>)
:A value that indicates whether the DB instance is a Multi-AZ deployment.
This setting doesn’t apply to RDS Custom.
Constraint: You can’t specify the
AvailabilityZone
parameter if the DB instance is a Multi-AZ deployment.publicly_accessible(bool)
/set_publicly_accessible(Option<bool>)
:A value that indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance’s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance’s VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn’t permit it.
When the DB instance isn’t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see
CreateDBInstance
.auto_minor_version_upgrade(bool)
/set_auto_minor_version_upgrade(Option<bool>)
:A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
If you restore an RDS Custom DB instance, you must disable this parameter.
license_model(impl Into<String>)
/set_license_model(Option<String>)
:License model information for the restored DB instance.
This setting doesn’t apply to RDS Custom.
Default: Same as source.
Valid values:
license-included
|bring-your-own-license
|general-public-license
db_name(impl Into<String>)
/set_db_name(Option<String>)
:The database name for the restored DB instance.
This parameter doesn’t apply to the MySQL, PostgreSQL, or MariaDB engines. It also doesn’t apply to RDS Custom DB instances.
engine(impl Into<String>)
/set_engine(Option<String>)
:The database engine to use for the new instance.
This setting doesn’t apply to RDS Custom.
Default: The same as source
Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
Valid Values:
-
mariadb
-
mysql
-
oracle-ee
-
oracle-ee-cdb
-
oracle-se2
-
oracle-se2-cdb
-
postgres
-
sqlserver-ee
-
sqlserver-se
-
sqlserver-ex
-
sqlserver-web
-
iops(i32)
/set_iops(Option<i32>)
:Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn’t specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.
The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.
Constraints: Must be an integer greater than 1000.
option_group_name(impl Into<String>)
/set_option_group_name(Option<String>)
:The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can’t be removed from an option group, and that option group can’t be removed from a DB instance after it is associated with a DB instance.
This setting doesn’t apply to RDS Custom.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
storage_type(impl Into<String>)
/set_storage_type(Option<String>)
:Specifies the storage type to be associated with the DB instance.
Valid values:
standard | gp2 | io1
If you specify
io1
, you must also include a value for theIops
parameter.Default:
io1
if theIops
parameter is specified, otherwisegp2
tde_credential_arn(impl Into<String>)
/set_tde_credential_arn(Option<String>)
:The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn’t apply to RDS Custom.
tde_credential_password(impl Into<String>)
/set_tde_credential_password(Option<String>)
:The password for the given ARN from the key store in order to access the device.
This setting doesn’t apply to RDS Custom.
vpc_security_group_ids(Vec<String>)
/set_vpc_security_group_ids(Option<Vec<String>>)
:A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group’s VPC.
domain(impl Into<String>)
/set_domain(Option<String>)
:Specify the Active Directory directory ID to restore the DB instance in. The domain/ must be created prior to this operation. Currently, you can create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn’t apply to RDS Custom.
copy_tags_to_snapshot(bool)
/set_copy_tags_to_snapshot(Option<bool>)
:A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.
In most cases, tags aren’t copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.
For more information, see Copying tags to DB instance snapshots in the Amazon RDS User Guide.
domain_iam_role_name(impl Into<String>)
/set_domain_iam_role_name(Option<String>)
:Specify the name of the IAM role to be used when making API calls to the Directory Service.
This setting doesn’t apply to RDS Custom.
enable_iam_database_authentication(bool)
/set_enable_iam_database_authentication(Option<bool>)
:A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn’t apply to RDS Custom.
enable_cloudwatch_logs_exports(Vec<String>)
/set_enable_cloudwatch_logs_exports(Option<Vec<String>>)
:The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn’t apply to RDS Custom.
processor_features(Vec<ProcessorFeature>)
/set_processor_features(Option<Vec<ProcessorFeature>>)
:The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn’t apply to RDS Custom.
use_default_processor_features(bool)
/set_use_default_processor_features(Option<bool>)
:A value that indicates whether the DB instance class of the DB instance uses its default processor features.
This setting doesn’t apply to RDS Custom.
db_parameter_group_name(impl Into<String>)
/set_db_parameter_group_name(Option<String>)
:The name of the DB parameter group to associate with this DB instance.
If you don’t specify a value for
DBParameterGroupName
, then RDS uses the defaultDBParameterGroup
for the specified DB engine.This setting doesn’t apply to RDS Custom.
Constraints:
-
If supplied, must match the name of an existing DBParameterGroup.
-
Must be 1 to 255 letters, numbers, or hyphens.
-
First character must be a letter.
-
Can’t end with a hyphen or contain two consecutive hyphens.
-
deletion_protection(bool)
/set_deletion_protection(Option<bool>)
:A value that indicates whether the DB instance has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection isn’t enabled. For more information, see Deleting a DB Instance.
enable_customer_owned_ip(bool)
/set_enable_customer_owned_ip(Option<bool>)
:A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
This setting doesn’t apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
custom_iam_instance_profile(impl Into<String>)
/set_custom_iam_instance_profile(Option<String>)
:The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
-
The profile must exist in your account.
-
The profile must have an IAM role that Amazon EC2 has permissions to assume.
-
The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom
.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom.
-
backup_target(impl Into<String>)
/set_backup_target(Option<String>)
:Specifies where automated backups and manual snapshots are stored for the restored DB instance.
Possible values are
outposts
(Amazon Web Services Outposts) andregion
(Amazon Web Services Region). The default isregion
.For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
network_type(impl Into<String>)
/set_network_type(Option<String>)
:The network type of the DB instance.
Valid values:
-
IPV4
-
DUAL
The network type is determined by the
DBSubnetGroup
specified for the DB instance. ADBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL
).For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
-
- On success, responds with
RestoreDbInstanceFromDbSnapshotOutput
with field(s):db_instance(Option<DbInstance>)
:Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
- On failure, responds with
SdkError<RestoreDBInstanceFromDBSnapshotError>
sourcepub fn restore_db_instance_from_s3(&self) -> RestoreDBInstanceFromS3
pub fn restore_db_instance_from_s3(&self) -> RestoreDBInstanceFromS3
Constructs a fluent builder for the RestoreDBInstanceFromS3
operation.
- The fluent builder is configurable:
db_name(impl Into<String>)
/set_db_name(Option<String>)
:The name of the database to create when the DB instance is created. Follow the naming rules specified in
CreateDBInstance
.db_instance_identifier(impl Into<String>)
/set_db_instance_identifier(Option<String>)
:The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
-
Must contain from 1 to 63 letters, numbers, or hyphens.
-
First character must be a letter.
-
Can’t end with a hyphen or contain two consecutive hyphens.
Example:
mydbinstance
-
allocated_storage(i32)
/set_allocated_storage(Option<i32>)
:The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation rules specified in
CreateDBInstance
.Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth.
db_instance_class(impl Into<String>)
/set_db_instance_class(Option<String>)
:The compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Importing from Amazon S3 isn’t supported on the db.t2.micro DB instance class.
engine(impl Into<String>)
/set_engine(Option<String>)
:The name of the database engine to be used for this instance.
Valid Values:
mysql
master_username(impl Into<String>)
/set_master_username(Option<String>)
:The name for the master user.
Constraints:
-
Must be 1 to 16 letters or numbers.
-
First character must be a letter.
-
Can’t be a reserved word for the chosen database engine.
-
master_user_password(impl Into<String>)
/set_master_user_password(Option<String>)
:The password for the master user. The password can include any printable ASCII character except “/”, “”“, or “@”.
Constraints: Must contain from 8 to 41 characters.
db_security_groups(Vec<String>)
/set_db_security_groups(Option<Vec<String>>)
:A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
vpc_security_group_ids(Vec<String>)
/set_vpc_security_group_ids(Option<Vec<String>>)
:A list of VPC security groups to associate with this DB instance.
availability_zone(impl Into<String>)
/set_availability_zone(Option<String>)
:The Availability Zone that the DB instance is created in. For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.
Default: A random, system-chosen Availability Zone in the endpoint’s Amazon Web Services Region.
Example:
us-east-1d
Constraint: The
AvailabilityZone
parameter can’t be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.db_subnet_group_name(impl Into<String>)
/set_db_subnet_group_name(Option<String>)
:A DB subnet group to associate with this DB instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example:
mydbsubnetgroup
preferred_maintenance_window(impl Into<String>)
/set_preferred_maintenance_window(Option<String>)
:The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Constraints:
-
Must be in the format
ddd:hh24:mi-ddd:hh24:mi
. -
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
-
Must be in Universal Coordinated Time (UTC).
-
Must not conflict with the preferred backup window.
-
Must be at least 30 minutes.
-
db_parameter_group_name(impl Into<String>)
/set_db_parameter_group_name(Option<String>)
:The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for
DBParameterGroupName
, then the defaultDBParameterGroup
for the specified DB engine is used.backup_retention_period(i32)
/set_backup_retention_period(Option<i32>)
:The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see
CreateDBInstance
.preferred_backup_window(impl Into<String>)
/set_preferred_backup_window(Option<String>)
:The time range each day during which automated backups are created if automated backups are enabled. For more information, see Backup window in the Amazon RDS User Guide.
Constraints:
-
Must be in the format
hh24:mi-hh24:mi
. -
Must be in Universal Coordinated Time (UTC).
-
Must not conflict with the preferred maintenance window.
-
Must be at least 30 minutes.
-
port(i32)
/set_port(Option<i32>)
:The port number on which the database accepts connections.
Type: Integer
Valid Values:
1150
-65535
Default:
3306
multi_az(bool)
/set_multi_az(Option<bool>)
:A value that indicates whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you can’t set the
AvailabilityZone
parameter.engine_version(impl Into<String>)
/set_engine_version(Option<String>)
:The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see
CreateDBInstance
, or callDescribeDBEngineVersions
.auto_minor_version_upgrade(bool)
/set_auto_minor_version_upgrade(Option<bool>)
:A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.
license_model(impl Into<String>)
/set_license_model(Option<String>)
:The license model for this DB instance. Use
general-public-license
.iops(i32)
/set_iops(Option<i32>)
:The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.
option_group_name(impl Into<String>)
/set_option_group_name(Option<String>)
:The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.
publicly_accessible(bool)
/set_publicly_accessible(Option<bool>)
:A value that indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance’s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance’s VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn’t permit it.
When the DB instance isn’t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see
CreateDBInstance
.tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
storage_type(impl Into<String>)
/set_storage_type(Option<String>)
:Specifies the storage type to be associated with the DB instance.
Valid values:
standard
|gp2
|io1
If you specify
io1
, you must also include a value for theIops
parameter.Default:
io1
if theIops
parameter is specified; otherwisegp2
storage_encrypted(bool)
/set_storage_encrypted(Option<bool>)
:A value that indicates whether the new DB instance is encrypted or not.
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:The Amazon Web Services KMS key identifier for an encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the
StorageEncrypted
parameter is enabled, and you do not specify a value for theKmsKeyId
parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.copy_tags_to_snapshot(bool)
/set_copy_tags_to_snapshot(Option<bool>)
:A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
monitoring_interval(i32)
/set_monitoring_interval(Option<i32>)
:The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.
If
MonitoringRoleArn
is specified, then you must also setMonitoringInterval
to a value other than 0.Valid Values: 0, 1, 5, 10, 15, 30, 60
Default:
0
monitoring_role_arn(impl Into<String>)
/set_monitoring_role_arn(Option<String>)
:The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.If
MonitoringInterval
is set to a value other than 0, then you must supply aMonitoringRoleArn
value.enable_iam_database_authentication(bool)
/set_enable_iam_database_authentication(Option<bool>)
:A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn’t enabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
source_engine(impl Into<String>)
/set_source_engine(Option<String>)
:The name of the engine of your source database.
Valid Values:
mysql
source_engine_version(impl Into<String>)
/set_source_engine_version(Option<String>)
:The version of the database that the backup files were created from.
MySQL versions 5.6 and 5.7 are supported.
Example:
5.6.40
s3_bucket_name(impl Into<String>)
/set_s3_bucket_name(Option<String>)
:The name of your Amazon S3 bucket that contains your database backup file.
s3_prefix(impl Into<String>)
/set_s3_prefix(Option<String>)
:The prefix of your Amazon S3 bucket.
s3_ingestion_role_arn(impl Into<String>)
/set_s3_ingestion_role_arn(Option<String>)
:An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.
enable_performance_insights(bool)
/set_enable_performance_insights(Option<bool>)
:A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
performance_insights_kms_key_id(impl Into<String>)
/set_performance_insights_kms_key_id(Option<String>)
:The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.performance_insights_retention_period(i32)
/set_performance_insights_retention_period(Option<i32>)
:The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
-
7
-
month * 31, where month is a number of months from 1-23
-
731
For example, the following values are valid:
-
93 (3 months * 31)
-
341 (11 months * 31)
-
589 (19 months * 31)
-
731
If you specify a retention period such as 94, which isn’t a valid value, RDS issues an error.
-
enable_cloudwatch_logs_exports(Vec<String>)
/set_enable_cloudwatch_logs_exports(Option<Vec<String>>)
:The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
processor_features(Vec<ProcessorFeature>)
/set_processor_features(Option<Vec<ProcessorFeature>>)
:The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
use_default_processor_features(bool)
/set_use_default_processor_features(Option<bool>)
:A value that indicates whether the DB instance class of the DB instance uses its default processor features.
deletion_protection(bool)
/set_deletion_protection(Option<bool>)
:A value that indicates whether the DB instance has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection isn’t enabled. For more information, see Deleting a DB Instance.
max_allocated_storage(i32)
/set_max_allocated_storage(Option<i32>)
:The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
network_type(impl Into<String>)
/set_network_type(Option<String>)
:The network type of the DB instance.
Valid values:
-
IPV4
-
DUAL
The network type is determined by the
DBSubnetGroup
specified for the DB instance. ADBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL
).For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
-
- On success, responds with
RestoreDbInstanceFromS3Output
with field(s):db_instance(Option<DbInstance>)
:Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
- On failure, responds with
SdkError<RestoreDBInstanceFromS3Error>
sourcepub fn restore_db_instance_to_point_in_time(
&self
) -> RestoreDBInstanceToPointInTime
pub fn restore_db_instance_to_point_in_time(
&self
) -> RestoreDBInstanceToPointInTime
Constructs a fluent builder for the RestoreDBInstanceToPointInTime
operation.
- The fluent builder is configurable:
source_db_instance_identifier(impl Into<String>)
/set_source_db_instance_identifier(Option<String>)
:The identifier of the source DB instance from which to restore.
Constraints:
-
Must match the identifier of an existing DB instance.
-
target_db_instance_identifier(impl Into<String>)
/set_target_db_instance_identifier(Option<String>)
:The name of the new DB instance to be created.
Constraints:
-
Must contain from 1 to 63 letters, numbers, or hyphens
-
First character must be a letter
-
Can’t end with a hyphen or contain two consecutive hyphens
-
restore_time(DateTime)
/set_restore_time(Option<DateTime>)
:The date and time to restore from.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
-
Must be before the latest restorable time for the DB instance
-
Can’t be specified if the
UseLatestRestorableTime
parameter is enabled
Example:
2009-09-07T23:45:00Z
-
use_latest_restorable_time(bool)
/set_use_latest_restorable_time(bool)
:A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn’t restored from the latest backup time.
Constraints: Can’t be specified if the
RestoreTime
parameter is provided.db_instance_class(impl Into<String>)
/set_db_instance_class(Option<String>)
:The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
port(i32)
/set_port(Option<i32>)
:The port number on which the database accepts connections.
Constraints: Value must be
1150-65535
Default: The same port as the original DB instance.
availability_zone(impl Into<String>)
/set_availability_zone(Option<String>)
:The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone.
Constraint: You can’t specify the
AvailabilityZone
parameter if the DB instance is a Multi-AZ deployment.Example:
us-east-1a
db_subnet_group_name(impl Into<String>)
/set_db_subnet_group_name(Option<String>)
:The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example:
mydbsubnetgroup
multi_az(bool)
/set_multi_az(Option<bool>)
:A value that indicates whether the DB instance is a Multi-AZ deployment.
This setting doesn’t apply to RDS Custom.
Constraint: You can’t specify the
AvailabilityZone
parameter if the DB instance is a Multi-AZ deployment.publicly_accessible(bool)
/set_publicly_accessible(Option<bool>)
:A value that indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster’s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster’s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn’t permitted if the security group assigned to the DB cluster doesn’t permit it.
When the DB instance isn’t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see
CreateDBInstance
.auto_minor_version_upgrade(bool)
/set_auto_minor_version_upgrade(Option<bool>)
:A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
This setting doesn’t apply to RDS Custom.
license_model(impl Into<String>)
/set_license_model(Option<String>)
:License model information for the restored DB instance.
This setting doesn’t apply to RDS Custom.
Default: Same as source.
Valid values:
license-included
|bring-your-own-license
|general-public-license
db_name(impl Into<String>)
/set_db_name(Option<String>)
:The database name for the restored DB instance.
This parameter isn’t supported for the MySQL or MariaDB engines. It also doesn’t apply to RDS Custom.
engine(impl Into<String>)
/set_engine(Option<String>)
:The database engine to use for the new instance.
This setting doesn’t apply to RDS Custom.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values:
-
mariadb
-
mysql
-
oracle-ee
-
oracle-ee-cdb
-
oracle-se2
-
oracle-se2-cdb
-
postgres
-
sqlserver-ee
-
sqlserver-se
-
sqlserver-ex
-
sqlserver-web
-
iops(i32)
/set_iops(Option<i32>)
:The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine isn’t supported.
option_group_name(impl Into<String>)
/set_option_group_name(Option<String>)
:The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can’t be removed from an option group, and that option group can’t be removed from a DB instance after it is associated with a DB instance
This setting doesn’t apply to RDS Custom.
copy_tags_to_snapshot(bool)
/set_copy_tags_to_snapshot(Option<bool>)
:A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
storage_type(impl Into<String>)
/set_storage_type(Option<String>)
:Specifies the storage type to be associated with the DB instance.
Valid values:
standard | gp2 | io1
If you specify
io1
, you must also include a value for theIops
parameter.Default:
io1
if theIops
parameter is specified, otherwisegp2
tde_credential_arn(impl Into<String>)
/set_tde_credential_arn(Option<String>)
:The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn’t apply to RDS Custom.
tde_credential_password(impl Into<String>)
/set_tde_credential_password(Option<String>)
:The password for the given ARN from the key store in order to access the device.
This setting doesn’t apply to RDS Custom.
vpc_security_group_ids(Vec<String>)
/set_vpc_security_group_ids(Option<Vec<String>>)
:A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group’s VPC.
domain(impl Into<String>)
/set_domain(Option<String>)
:Specify the Active Directory directory ID to restore the DB instance in. Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
This setting doesn’t apply to RDS Custom.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
domain_iam_role_name(impl Into<String>)
/set_domain_iam_role_name(Option<String>)
:Specify the name of the IAM role to be used when making API calls to the Directory Service.
This setting doesn’t apply to RDS Custom.
enable_iam_database_authentication(bool)
/set_enable_iam_database_authentication(Option<bool>)
:A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn’t enabled.
This setting doesn’t apply to RDS Custom.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
enable_cloudwatch_logs_exports(Vec<String>)
/set_enable_cloudwatch_logs_exports(Option<Vec<String>>)
:The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn’t apply to RDS Custom.
processor_features(Vec<ProcessorFeature>)
/set_processor_features(Option<Vec<ProcessorFeature>>)
:The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn’t apply to RDS Custom.
use_default_processor_features(bool)
/set_use_default_processor_features(Option<bool>)
:A value that indicates whether the DB instance class of the DB instance uses its default processor features.
This setting doesn’t apply to RDS Custom.
db_parameter_group_name(impl Into<String>)
/set_db_parameter_group_name(Option<String>)
:The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for
DBParameterGroupName
, then the defaultDBParameterGroup
for the specified DB engine is used.This setting doesn’t apply to RDS Custom.
Constraints:
-
If supplied, must match the name of an existing DBParameterGroup.
-
Must be 1 to 255 letters, numbers, or hyphens.
-
First character must be a letter.
-
Can’t end with a hyphen or contain two consecutive hyphens.
-
deletion_protection(bool)
/set_deletion_protection(Option<bool>)
:A value that indicates whether the DB instance has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection isn’t enabled. For more information, see Deleting a DB Instance.
source_dbi_resource_id(impl Into<String>)
/set_source_dbi_resource_id(Option<String>)
:The resource ID of the source DB instance from which to restore.
max_allocated_storage(i32)
/set_max_allocated_storage(Option<i32>)
:The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn’t apply to RDS Custom.
source_db_instance_automated_backups_arn(impl Into<String>)
/set_source_db_instance_automated_backups_arn(Option<String>)
:The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,
arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.This setting doesn’t apply to RDS Custom.
enable_customer_owned_ip(bool)
/set_enable_customer_owned_ip(Option<bool>)
:A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
This setting doesn’t apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
custom_iam_instance_profile(impl Into<String>)
/set_custom_iam_instance_profile(Option<String>)
:The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
-
The profile must exist in your account.
-
The profile must have an IAM role that Amazon EC2 has permissions to assume.
-
The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom
.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom.
-
backup_target(impl Into<String>)
/set_backup_target(Option<String>)
:Specifies where automated backups and manual snapshots are stored for the restored DB instance.
Possible values are
outposts
(Amazon Web Services Outposts) andregion
(Amazon Web Services Region). The default isregion
.For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
network_type(impl Into<String>)
/set_network_type(Option<String>)
:The network type of the DB instance.
Valid values:
-
IPV4
-
DUAL
The network type is determined by the
DBSubnetGroup
specified for the DB instance. ADBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL
).For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
-
- On success, responds with
RestoreDbInstanceToPointInTimeOutput
with field(s):db_instance(Option<DbInstance>)
:Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
- On failure, responds with
SdkError<RestoreDBInstanceToPointInTimeError>
sourcepub fn revoke_db_security_group_ingress(&self) -> RevokeDBSecurityGroupIngress
pub fn revoke_db_security_group_ingress(&self) -> RevokeDBSecurityGroupIngress
Constructs a fluent builder for the RevokeDBSecurityGroupIngress
operation.
- The fluent builder is configurable:
db_security_group_name(impl Into<String>)
/set_db_security_group_name(Option<String>)
:The name of the DB security group to revoke ingress from.
cidrip(impl Into<String>)
/set_cidrip(Option<String>)
:The IP range to revoke access from. Must be a valid CIDR range. If
CIDRIP
is specified,EC2SecurityGroupName
,EC2SecurityGroupId
andEC2SecurityGroupOwnerId
can’t be provided.ec2_security_group_name(impl Into<String>)
/set_ec2_security_group_name(Option<String>)
:The name of the EC2 security group to revoke access from. For VPC DB security groups,
EC2SecurityGroupId
must be provided. Otherwise, EC2SecurityGroupOwnerId and eitherEC2SecurityGroupName
orEC2SecurityGroupId
must be provided.ec2_security_group_id(impl Into<String>)
/set_ec2_security_group_id(Option<String>)
:The id of the EC2 security group to revoke access from. For VPC DB security groups,
EC2SecurityGroupId
must be provided. Otherwise, EC2SecurityGroupOwnerId and eitherEC2SecurityGroupName
orEC2SecurityGroupId
must be provided.ec2_security_group_owner_id(impl Into<String>)
/set_ec2_security_group_owner_id(Option<String>)
:The Amazon Web Services account number of the owner of the EC2 security group specified in the
EC2SecurityGroupName
parameter. The Amazon Web Services access key ID isn’t an acceptable value. For VPC DB security groups,EC2SecurityGroupId
must be provided. Otherwise, EC2SecurityGroupOwnerId and eitherEC2SecurityGroupName
orEC2SecurityGroupId
must be provided.
- On success, responds with
RevokeDbSecurityGroupIngressOutput
with field(s):db_security_group(Option<DbSecurityGroup>)
:Contains the details for an Amazon RDS DB security group.
This data type is used as a response element in the
DescribeDBSecurityGroups
action.
- On failure, responds with
SdkError<RevokeDBSecurityGroupIngressError>
sourcepub fn start_activity_stream(&self) -> StartActivityStream
pub fn start_activity_stream(&self) -> StartActivityStream
Constructs a fluent builder for the StartActivityStream
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the DB cluster, for example,
arn:aws:rds:us-east-1:12345667890:cluster:das-cluster
.mode(ActivityStreamMode)
/set_mode(Option<ActivityStreamMode>)
:Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
apply_immediately(bool)
/set_apply_immediately(Option<bool>)
:Specifies whether or not the database activity stream is to start as soon as possible, regardless of the maintenance window for the database.
engine_native_audit_fields_included(bool)
/set_engine_native_audit_fields_included(Option<bool>)
:Specifies whether the database activity stream includes engine-native audit fields. This option only applies to an Oracle DB instance. By default, no engine-native audit fields are included.
- On success, responds with
StartActivityStreamOutput
with field(s):kms_key_id(Option<String>)
:The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.
kinesis_stream_name(Option<String>)
:The name of the Amazon Kinesis data stream to be used for the database activity stream.
status(Option<ActivityStreamStatus>)
:The status of the database activity stream.
mode(Option<ActivityStreamMode>)
:The mode of the database activity stream.
apply_immediately(bool)
:Indicates whether or not the database activity stream will start as soon as possible, regardless of the maintenance window for the database.
engine_native_audit_fields_included(Option<bool>)
:Indicates whether engine-native audit fields are included in the database activity stream.
- On failure, responds with
SdkError<StartActivityStreamError>
sourcepub fn start_db_cluster(&self) -> StartDBCluster
pub fn start_db_cluster(&self) -> StartDBCluster
Constructs a fluent builder for the StartDBCluster
operation.
- The fluent builder is configurable:
db_cluster_identifier(impl Into<String>)
/set_db_cluster_identifier(Option<String>)
:The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as a lowercase string.
- On success, responds with
StartDbClusterOutput
with field(s):db_cluster(Option<DbCluster>)
:Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,PromoteReadReplicaDBCluster
,RestoreDBClusterFromS3
,RestoreDBClusterFromSnapshot
,RestoreDBClusterToPointInTime
,StartDBCluster
, andStopDBCluster
.For a Multi-AZ DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,RebootDBCluster
,RestoreDBClusterFromSnapshot
, andRestoreDBClusterToPointInTime
.For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
- On failure, responds with
SdkError<StartDBClusterError>
sourcepub fn start_db_instance(&self) -> StartDBInstance
pub fn start_db_instance(&self) -> StartDBInstance
Constructs a fluent builder for the StartDBInstance
operation.
- The fluent builder is configurable:
db_instance_identifier(impl Into<String>)
/set_db_instance_identifier(Option<String>)
:The user-supplied instance identifier.
- On success, responds with
StartDbInstanceOutput
with field(s):db_instance(Option<DbInstance>)
:Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
- On failure, responds with
SdkError<StartDBInstanceError>
sourcepub fn start_db_instance_automated_backups_replication(
&self
) -> StartDBInstanceAutomatedBackupsReplication
pub fn start_db_instance_automated_backups_replication(
&self
) -> StartDBInstanceAutomatedBackupsReplication
Constructs a fluent builder for the StartDBInstanceAutomatedBackupsReplication
operation.
- The fluent builder is configurable:
source_db_instance_arn(impl Into<String>)
/set_source_db_instance_arn(Option<String>)
:The Amazon Resource Name (ARN) of the source DB instance for the replicated automated backups, for example,
arn:aws:rds:us-west-2:123456789012:db:mydatabase
.backup_retention_period(i32)
/set_backup_retention_period(Option<i32>)
:The retention period for the replicated automated backups.
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:The Amazon Web Services KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination Amazon Web Services Region, for example,
arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE
.pre_signed_url(impl Into<String>)
/set_pre_signed_url(Option<String>)
:In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request for the
StartDBInstanceAutomatedBackupsReplication
operation to call in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for theStartDBInstanceAutomatedBackupsReplication
API operation that can run in the Amazon Web Services Region that contains the source DB instance.This setting applies only to Amazon Web Services GovCloud (US) Regions. It’s ignored in other Amazon Web Services Regions.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify
SourceRegion
(or–source-region
for the CLI) instead of specifyingPreSignedUrl
manually. SpecifyingSourceRegion
autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
- On success, responds with
StartDbInstanceAutomatedBackupsReplicationOutput
with field(s):db_instance_automated_backup(Option<DbInstanceAutomatedBackup>)
:An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.
- On failure, responds with
SdkError<StartDBInstanceAutomatedBackupsReplicationError>
sourcepub fn start_export_task(&self) -> StartExportTask
pub fn start_export_task(&self) -> StartExportTask
Constructs a fluent builder for the StartExportTask
operation.
- The fluent builder is configurable:
export_task_identifier(impl Into<String>)
/set_export_task_identifier(Option<String>)
:A unique identifier for the snapshot export task. This ID isn’t an identifier for the Amazon S3 bucket where the snapshot is to be exported to.
source_arn(impl Into<String>)
/set_source_arn(Option<String>)
:The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3.
s3_bucket_name(impl Into<String>)
/set_s3_bucket_name(Option<String>)
:The name of the Amazon S3 bucket to export the snapshot to.
iam_role_arn(impl Into<String>)
/set_iam_role_arn(Option<String>)
:The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot.
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:The ID of the Amazon Web Services KMS key to use to encrypt the snapshot exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to execute the following operations. These can be set in the Amazon Web Services KMS key policy:
-
GrantOperation.Encrypt
-
GrantOperation.Decrypt
-
GrantOperation.GenerateDataKey
-
GrantOperation.GenerateDataKeyWithoutPlaintext
-
GrantOperation.ReEncryptFrom
-
GrantOperation.ReEncryptTo
-
GrantOperation.CreateGrant
-
GrantOperation.DescribeKey
-
GrantOperation.RetireGrant
-
s3_prefix(impl Into<String>)
/set_s3_prefix(Option<String>)
:The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
export_only(Vec<String>)
/set_export_only(Option<Vec<String>>)
:The data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are the following:
-
database
- Export all the data from a specified database. -
database.table
table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL. -
database.schema
schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. -
database.schema.table
table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
-
- On success, responds with
StartExportTaskOutput
with field(s):export_task_identifier(Option<String>)
:A unique identifier for the snapshot export task. This ID isn’t an identifier for the Amazon S3 bucket where the snapshot is exported to.
source_arn(Option<String>)
:The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
export_only(Option<Vec<String>>)
:The data exported from the snapshot. Valid values are the following:
-
database
- Export all the data from a specified database. -
database.table
table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL. -
database.schema
schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. -
database.schema.table
table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
-
snapshot_time(Option<DateTime>)
:The time that the snapshot was created.
task_start_time(Option<DateTime>)
:The time that the snapshot export task started.
task_end_time(Option<DateTime>)
:The time that the snapshot export task completed.
s3_bucket(Option<String>)
:The Amazon S3 bucket that the snapshot is exported to.
s3_prefix(Option<String>)
:The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
iam_role_arn(Option<String>)
:The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
kms_key_id(Option<String>)
:The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot when it’s exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key.
status(Option<String>)
:The progress status of the export task.
percent_progress(i32)
:The progress of the snapshot export task as a percentage.
total_extracted_data_in_gb(i32)
:The total amount of data exported, in gigabytes.
failure_cause(Option<String>)
:The reason the export failed, if it failed.
warning_message(Option<String>)
:A warning about the snapshot export task.
- On failure, responds with
SdkError<StartExportTaskError>
sourcepub fn stop_activity_stream(&self) -> StopActivityStream
pub fn stop_activity_stream(&self) -> StopActivityStream
Constructs a fluent builder for the StopActivityStream
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the DB cluster for the database activity stream. For example,
arn:aws:rds:us-east-1:12345667890:cluster:das-cluster
.apply_immediately(bool)
/set_apply_immediately(Option<bool>)
:Specifies whether or not the database activity stream is to stop as soon as possible, regardless of the maintenance window for the database.
- On success, responds with
StopActivityStreamOutput
with field(s):kms_key_id(Option<String>)
:The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
kinesis_stream_name(Option<String>)
:The name of the Amazon Kinesis data stream used for the database activity stream.
status(Option<ActivityStreamStatus>)
:The status of the database activity stream.
- On failure, responds with
SdkError<StopActivityStreamError>
sourcepub fn stop_db_cluster(&self) -> StopDBCluster
pub fn stop_db_cluster(&self) -> StopDBCluster
Constructs a fluent builder for the StopDBCluster
operation.
- The fluent builder is configurable:
db_cluster_identifier(impl Into<String>)
/set_db_cluster_identifier(Option<String>)
:The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as a lowercase string.
- On success, responds with
StopDbClusterOutput
with field(s):db_cluster(Option<DbCluster>)
:Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,PromoteReadReplicaDBCluster
,RestoreDBClusterFromS3
,RestoreDBClusterFromSnapshot
,RestoreDBClusterToPointInTime
,StartDBCluster
, andStopDBCluster
.For a Multi-AZ DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,RebootDBCluster
,RestoreDBClusterFromSnapshot
, andRestoreDBClusterToPointInTime
.For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
- On failure, responds with
SdkError<StopDBClusterError>
sourcepub fn stop_db_instance(&self) -> StopDBInstance
pub fn stop_db_instance(&self) -> StopDBInstance
Constructs a fluent builder for the StopDBInstance
operation.
- The fluent builder is configurable:
db_instance_identifier(impl Into<String>)
/set_db_instance_identifier(Option<String>)
:The user-supplied instance identifier.
db_snapshot_identifier(impl Into<String>)
/set_db_snapshot_identifier(Option<String>)
:The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.
- On success, responds with
StopDbInstanceOutput
with field(s):db_instance(Option<DbInstance>)
:Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
- On failure, responds with
SdkError<StopDBInstanceError>
sourcepub fn stop_db_instance_automated_backups_replication(
&self
) -> StopDBInstanceAutomatedBackupsReplication
pub fn stop_db_instance_automated_backups_replication(
&self
) -> StopDBInstanceAutomatedBackupsReplication
Constructs a fluent builder for the StopDBInstanceAutomatedBackupsReplication
operation.
- The fluent builder is configurable:
source_db_instance_arn(impl Into<String>)
/set_source_db_instance_arn(Option<String>)
:The Amazon Resource Name (ARN) of the source DB instance for which to stop replicating automated backups, for example,
arn:aws:rds:us-west-2:123456789012:db:mydatabase
.
- On success, responds with
StopDbInstanceAutomatedBackupsReplicationOutput
with field(s):db_instance_automated_backup(Option<DbInstanceAutomatedBackup>)
:An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.
- On failure, responds with
SdkError<StopDBInstanceAutomatedBackupsReplicationError>
sourcepub fn switchover_read_replica(&self) -> SwitchoverReadReplica
pub fn switchover_read_replica(&self) -> SwitchoverReadReplica
Constructs a fluent builder for the SwitchoverReadReplica
operation.
- The fluent builder is configurable:
db_instance_identifier(impl Into<String>)
/set_db_instance_identifier(Option<String>)
:The DB instance identifier of the current standby database. This value is stored as a lowercase string.
Constraints:
-
Must match the identifier of an existing Oracle read replica DB instance.
-
- On success, responds with
SwitchoverReadReplicaOutput
with field(s):db_instance(Option<DbInstance>)
:Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
- On failure, responds with
SdkError<SwitchoverReadReplicaError>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more