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

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the AddRoleToDBCluster operation.

Constructs a fluent builder for the AddRoleToDBInstance operation.

Constructs a fluent builder for the AddSourceIdentifierToSubscription operation.

Constructs a fluent builder for the AddTagsToResource operation.

Constructs a fluent builder for the ApplyPendingMaintenanceAction operation.

Constructs a fluent builder for the AuthorizeDBSecurityGroupIngress operation.

Constructs a fluent builder for the BacktrackDBCluster operation.

Constructs a fluent builder for the CancelExportTask operation.

Constructs a fluent builder for the CopyDBClusterParameterGroup operation.

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 for KmsKeyId, 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>):

      The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don’t specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.

      The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values:

      • KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.

      • DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.

      • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

      To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (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 specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source 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):
  • On failure, responds with SdkError<CopyDBClusterSnapshotError>

Constructs a fluent builder for the CopyDBParameterGroup operation.

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, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.

      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>):

      The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source Amazon Web Services Region that contains the source DB snapshot to copy.

      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 CopyDBSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB snapshot to be copied. 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 the CopyDBSnapshot action 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 action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.

      • KmsKeyId - The Amazon Web Services 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 the CopyDBSnapshot action that is called in the destination Amazon Web Services Region, and the action 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 your SourceDBSnapshotIdentifier 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 specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source 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>

Constructs a fluent builder for the CopyOptionGroup operation.

Constructs a fluent builder for the CreateCustomAvailabilityZone operation.

Constructs a fluent builder for the CreateCustomDBEngineVersion operation.

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 and ReplicationSourceIdentifier 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>):

      A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source Amazon Web Services Region where the DB cluster is replicated from. Specify PreSignedUrl only when you are performing cross-Region replication from an encrypted DB cluster.

      The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster to be copied.

      The pre-signed URL request must contain the following parameter values:

      • KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the CreateDBCluster action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.

      • DestinationRegion - The name of the Amazon Web Services Region that 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 your ReplicationSourceIdentifier 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 specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source 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. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

      Aurora MySQL

      Possible values are audit, error, general, and slowquery.

      Aurora PostgreSQL

      Possible value is postgresql.

      Valid for: Aurora DB clusters only

    • engine_mode(impl Into<String>) / set_engine_mode(Option<String>):

      The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

      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, and global 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.

      For Aurora PostgreSQL, the global engine mode isn’t required, and both the parallelquery and the multimaster 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 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 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 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 only

    • 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, and PubliclyAccessible isn’t specified, the following applies:

      • If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

      • If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

      If DBSubnetGroupName is specified, and PubliclyAccessible isn’t specified, the following applies:

      • If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

      • If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

      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 set MonitoringInterval 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 a MonitoringRoleArn 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 amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

      Valid for: Multi-AZ 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, and StopDBCluster.

      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, and RestoreDBClusterToPointInTime.

      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.

      The Multi-AZ DB clusters feature is in preview and is subject to change.

  • On failure, responds with SdkError<CreateDBClusterError>

Constructs a fluent builder for the CreateDBClusterEndpoint operation.

Constructs a fluent builder for the CreateDBClusterParameterGroup operation.

Constructs a fluent builder for the CreateDBClusterSnapshot operation.

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 value ORCL is used. You can’t specify the string NULL, or any other reserved word, for DBName.

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

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

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

      Not applicable. Availability Zones are managed by the DB cluster.

      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.

      If you’re creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in.

      For more information about RDS on VMware, see the RDS on VMware User Guide.

    • 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 or 35 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 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-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.

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

      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 is 19.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 to false.

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

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

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

    • 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, and PubliclyAccessible isn’t specified, the following applies:

      • If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB 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, and PubliclyAccessible isn’t specified, the following applies:

      • If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB 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 the Iops parameter.

      Default: io1 if the Iops parameter is specified, otherwise gp2

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

    • 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 to false, 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 the KmsKeyId 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.

    • 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 set MonitoringInterval 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 a MonitoringRoleArn 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.

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

      This setting doesn’t apply to RDS Custom or Amazon Aurora. In Aurora, mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.

      For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

    • 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 Relational Database Service 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 amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

      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 Relational Database Service 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, and slowquery.

      Microsoft SQL Server

      Possible values are agent and error.

      MySQL

      Possible values are audit, error, general, and slowquery.

      Oracle

      Possible values are alert, audit, listener, trace, and oemagent.

      PostgreSQL

      Possible values are postgresql and upgrade.

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

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

    • 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 Relational Database Service 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) and region (Amazon Web Services Region). The default is region.

      For more information, see Working with Amazon RDS on Amazon Web Services Outposts 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, and StopDBInstance.

  • On failure, responds with SdkError<CreateDBInstanceError>

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 the DBParameterGroup of source DB instance for a same Region read replica, or the default DBParameterGroup for the specified DB engine for a cross-Region read replica.

      Specifying a parameter group for this operation is only supported for 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 the Iops parameter.

      Default: io1 if the Iops parameter is specified, otherwise gp2

    • 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 set MonitoringInterval 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 a MonitoringRoleArn 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>):

      The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source Amazon Web Services Region that contains the source DB instance.

      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 action that can be executed 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 the CreateDBInstanceReadReplica action 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 action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.

      • KmsKeyId - The Amazon Web Services 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 the CreateDBInstanceReadReplica action that is called in the destination Amazon Web Services Region, and the action 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 your SourceDBInstanceIdentifier 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 specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.

      SourceRegion isn’t supported for SQL Server, because SQL Server on Amazon RDS 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 amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

      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 Relational Database Service User Guide.

      This setting is required for RDS Custom.

  • 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, and StopDBInstance.

  • On failure, responds with SdkError<CreateDBInstanceReadReplicaError>

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):
  • On failure, responds with SdkError<CreateDBParameterGroupError>

Constructs a fluent builder for the CreateDBProxy operation.

Constructs a fluent builder for the CreateDBProxyEndpoint operation.

Constructs a fluent builder for the CreateDBSecurityGroup operation.

Constructs a fluent builder for the CreateDBSnapshot operation.

Constructs a fluent builder for the CreateDBSubnetGroup operation.

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, 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 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 the DescribeEventCategories 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):
  • On failure, responds with SdkError<CreateEventSubscriptionError>

Constructs a fluent builder for the CreateGlobalCluster operation.

Constructs a fluent builder for the CreateOptionGroup operation.

Constructs a fluent builder for the DeleteCustomAvailabilityZone operation.

Constructs a fluent builder for the DeleteCustomDBEngineVersion operation.

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 if SkipFinalSnapshot 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, and StopDBCluster.

      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, and RestoreDBClusterToPointInTime.

      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.

      The Multi-AZ DB clusters feature is in preview and is subject to change.

  • On failure, responds with SdkError<DeleteDBClusterError>

Constructs a fluent builder for the DeleteDBClusterEndpoint operation.

Constructs a fluent builder for the DeleteDBClusterParameterGroup operation.

Constructs a fluent builder for the DeleteDBClusterSnapshot operation.

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, or incompatible-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 new DBSnapshot created when the SkipFinalSnapshot 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, and StopDBInstance.

  • On failure, responds with SdkError<DeleteDBInstanceError>

Constructs a fluent builder for the DeleteDBInstanceAutomatedBackup operation.

Constructs a fluent builder for the DeleteDBParameterGroup operation.

Constructs a fluent builder for the DeleteDBProxy operation.

Constructs a fluent builder for the DeleteDBProxyEndpoint operation.

Constructs a fluent builder for the DeleteDBSecurityGroup operation.

Constructs a fluent builder for the DeleteDBSnapshot operation.

Constructs a fluent builder for the DeleteDBSubnetGroup operation.

Constructs a fluent builder for the DeleteEventSubscription operation.

Constructs a fluent builder for the DeleteGlobalCluster operation.

Constructs a fluent builder for the DeleteInstallationMedia operation.

Constructs a fluent builder for the DeleteOptionGroup operation.

Constructs a fluent builder for the DeregisterDBProxyTargets operation.

Constructs a fluent builder for the DescribeAccountAttributes operation.

Constructs a fluent builder for the DescribeCertificates operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribeCustomAvailabilityZones operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribeDBClusterBacktracks operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribeDBClusterEndpoints operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribeDBClusterParameterGroups operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribeDBClusterParameters operation. This operation supports pagination; See into_paginator().

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 by MaxRecords.

    • 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):
  • On failure, responds with SdkError<DescribeDBClustersError>

Constructs a fluent builder for the DescribeDBClusterSnapshotAttributes operation.

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 the IncludeShared parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic parameter.

      The IncludeShared and IncludePublic parameters don’t apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn’t apply when SnapshotType is set to shared. The IncludeShared parameter doesn’t apply when SnapshotType is set to public.

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

    • 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):
  • On failure, responds with SdkError<DescribeDBClusterSnapshotsError>

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 for CreateDBInstance, 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 to true, 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 for CreateDBInstance, 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 to true, 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):
  • On failure, responds with SdkError<DescribeDBEngineVersionsError>

Constructs a fluent builder for the DescribeDBInstanceAutomatedBackups operation. This operation supports pagination; See into_paginator().

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 by MaxRecords.

  • On success, responds with DescribeDbInstancesOutput with field(s):
  • On failure, responds with SdkError<DescribeDBInstancesError>

Constructs a fluent builder for the DescribeDBLogFiles operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribeDBParameterGroups operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribeDBParameters operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribeDBProxies operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribeDBProxyEndpoints operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribeDBProxyTargetGroups operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribeDBProxyTargets operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribeDBSecurityGroups operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribeDBSnapshotAttributes operation.

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 can’t be used in conjunction with DBSnapshotIdentifier. 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 parameter can’t be used in conjunction with DBInstanceIdentifier. 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 the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.

      The IncludeShared and IncludePublic parameters don’t apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn’t apply when SnapshotType is set to shared. The IncludeShared parameter doesn’t apply when SnapshotType is set to public.

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

    • 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):
  • On failure, responds with SdkError<DescribeDBSnapshotsError>

Constructs a fluent builder for the DescribeDBSubnetGroups operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribeEngineDefaultClusterParameters operation.

Constructs a fluent builder for the DescribeEngineDefaultParameters operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribeEventCategories operation.

Constructs a fluent builder for the DescribeEvents operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribeEventSubscriptions operation. This operation supports pagination; See into_paginator().

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 the MaxRecords 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 of DescribeExportTasks.

    • export_tasks(Option<Vec<ExportTask>>):

      Information about an export of a snapshot to Amazon S3.

  • On failure, responds with SdkError<DescribeExportTasksError>

Constructs a fluent builder for the DescribeGlobalClusters operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribeInstallationMedia operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribeOptionGroupOptions operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribeOptionGroups operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribeOrderableDBInstanceOptions operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribePendingMaintenanceActions operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribeReservedDBInstances operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribeReservedDBInstancesOfferings operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribeSourceRegions operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribeValidDBInstanceModifications operation.

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):
  • On failure, responds with SdkError<DownloadDBLogFilePortionError>

Constructs a fluent builder for the FailoverDBCluster operation.

  • The fluent builder is configurable:
  • 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, and StopDBCluster.

      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, and RestoreDBClusterToPointInTime.

      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.

      The Multi-AZ DB clusters feature is in preview and is subject to change.

  • On failure, responds with SdkError<FailoverDBClusterError>

Constructs a fluent builder for the FailoverGlobalCluster operation.

Constructs a fluent builder for the ImportInstallationMedia operation.

Constructs a fluent builder for the ListTagsForResource operation.

Constructs a fluent builder for the ModifyCertificates operation.

Constructs a fluent builder for the ModifyCurrentDBClusterCapacity operation.

Constructs a fluent builder for the ModifyCustomDBEngineVersion operation.

Constructs a fluent builder for the ModifyDBCluster operation.

  • The fluent builder is configurable:
  • 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, and StopDBCluster.

      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, and RestoreDBClusterToPointInTime.

      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.

      The Multi-AZ DB clusters feature is in preview and is subject to change.

  • On failure, responds with SdkError<ModifyDBClusterError>

Constructs a fluent builder for the ModifyDBClusterEndpoint operation.

Constructs a fluent builder for the ModifyDBClusterParameterGroup operation.

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

    • 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 the all value for any manual DB cluster snapshots that contain private information that you don’t want available to all Amazon Web Services accounts.

    • 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 specify all, an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot.

  • On success, responds with ModifyDbClusterSnapshotAttributeOutput with field(s):
  • On failure, responds with SdkError<ModifyDBClusterSnapshotAttributeError>

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.

      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.

      This setting doesn’t apply to RDS Custom for Oracle.

      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 disabling ApplyImmediately 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 the PendingModifiedValues 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 actions 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 or 35 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 call DescribeDBEngineVersions.

      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 to false. 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 the Iops 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 the Iops parameter is specified, otherwise gp2

    • 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, set MonitoringInterval 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 the ApplyImmediately 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 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-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 and PubliclyAccessible must be enabled for it to be publicly accessible.

      Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately 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 a MonitoringRoleArn 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 Relational Database Service 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 amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

      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, the ApplyImmediately 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:

      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 or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by ResumeFullAutomationModeMinutes.

    • 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 is 1,440.

  • 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, and StopDBInstance.

  • On failure, responds with SdkError<ModifyDBInstanceError>

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 the pending-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. Use immediate.

      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):
  • On failure, responds with SdkError<ModifyDBParameterGroupError>

Constructs a fluent builder for the ModifyDBProxy operation.

Constructs a fluent builder for the ModifyDBProxyEndpoint operation.

Constructs a fluent builder for the ModifyDBProxyTargetGroup operation.

Constructs a fluent builder for the ModifyDBSnapshot operation.

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

    • 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 the all 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 specify all, an Amazon Web Services account whose account ID is explicitly added to the restore 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>

Constructs a fluent builder for the ModifyDBSubnetGroup operation.

Constructs a fluent builder for the ModifyEventSubscription operation.

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):
  • On failure, responds with SdkError<ModifyGlobalClusterError>

Constructs a fluent builder for the ModifyOptionGroup operation.

Constructs a fluent builder for the PromoteReadReplica operation.

  • The fluent builder is configurable:
  • 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, and StopDBInstance.

  • On failure, responds with SdkError<PromoteReadReplicaError>

Constructs a fluent builder for the PromoteReadReplicaDBCluster operation.

  • The fluent builder is configurable:
  • 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, and StopDBCluster.

      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, and RestoreDBClusterToPointInTime.

      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.

      The Multi-AZ DB clusters feature is in preview and is subject to change.

  • On failure, responds with SdkError<PromoteReadReplicaDBClusterError>

Constructs a fluent builder for the PurchaseReservedDBInstancesOffering operation.

Constructs a fluent builder for the RebootDBCluster operation.

  • The fluent builder is configurable:
  • 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, and StopDBCluster.

      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, and RestoreDBClusterToPointInTime.

      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.

      The Multi-AZ DB clusters feature is in preview and is subject to change.

  • On failure, responds with SdkError<RebootDBClusterError>

Constructs a fluent builder for the RebootDBInstance operation.

Constructs a fluent builder for the RegisterDBProxyTargets operation.

Constructs a fluent builder for the RemoveFromGlobalCluster operation.

Constructs a fluent builder for the RemoveRoleFromDBCluster operation.

Constructs a fluent builder for the RemoveRoleFromDBInstance operation.

Constructs a fluent builder for the RemoveSourceIdentifierFromSubscription operation.

Constructs a fluent builder for the RemoveTagsFromResource operation.

Constructs a fluent builder for the ResetDBClusterParameterGroup operation.

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 and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. 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):
  • On failure, responds with SdkError<ResetDBParameterGroupError>

Constructs a fluent builder for the RestoreDBClusterFromS3 operation.

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.

      For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

      Valid for: Aurora DB clusters only

    • engine_mode(impl Into<String>) / set_engine_mode(Option<String>):

      The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

      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 only

    • 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, and PubliclyAccessible isn’t specified, the following applies:

      • If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

      • If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

      If DBSubnetGroupName is specified, and PubliclyAccessible isn’t specified, the following applies:

      • If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

      • If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

  • 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, and StopDBCluster.

      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, and RestoreDBClusterToPointInTime.

      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.

      The Multi-AZ DB clusters feature is in preview and is subject to change.

  • On failure, responds with SdkError<RestoreDBClusterFromSnapshotError>

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 is copy-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.

      For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

      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 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 only

    • 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 or serverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless cluster. To create a clone that is an Aurora Serverless cluster, the original cluster must be an Aurora Serverless 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, and PubliclyAccessible isn’t specified, the following applies:

      • If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

      • If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

      If DBSubnetGroupName is specified, and PubliclyAccessible isn’t specified, the following applies:

      • If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

      • If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

      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

  • 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, and StopDBCluster.

      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, and RestoreDBClusterToPointInTime.

      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.

      The Multi-AZ DB clusters feature is in preview and is subject to change.

  • On failure, responds with SdkError<RestoreDBClusterToPointInTimeError>

Constructs a fluent builder for the RestoreDBInstanceFromDBSnapshot operation.

Constructs a fluent builder for the RestoreDBInstanceFromS3 operation.

Constructs a fluent builder for the RestoreDBInstanceToPointInTime operation.

Constructs a fluent builder for the RevokeDBSecurityGroupIngress operation.

Constructs a fluent builder for the StartActivityStream operation.

Constructs a fluent builder for the StartDBCluster operation.

  • The fluent builder is configurable:
  • 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, and StopDBCluster.

      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, and RestoreDBClusterToPointInTime.

      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.

      The Multi-AZ DB clusters feature is in preview and is subject to change.

  • On failure, responds with SdkError<StartDBClusterError>

Constructs a fluent builder for the StartDBInstance operation.

Constructs a fluent builder for the StartDBInstanceAutomatedBackupsReplication operation.

Constructs a fluent builder for the StartExportTask operation.

Constructs a fluent builder for the StopActivityStream operation.

Constructs a fluent builder for the StopDBCluster operation.

  • The fluent builder is configurable:
  • 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, and StopDBCluster.

      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, and RestoreDBClusterToPointInTime.

      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.

      The Multi-AZ DB clusters feature is in preview and is subject to change.

  • On failure, responds with SdkError<StopDBClusterError>

Constructs a fluent builder for the StopDBInstance operation.

Constructs a fluent builder for the StopDBInstanceAutomatedBackupsReplication operation.

Creates a client with the given service config and connector override.

Creates a new client from a shared config.

Creates a new client from the service Config.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Performs the conversion.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more