pub struct Builder { /* private fields */ }
Expand description

A builder for AwsRdsDbInstanceDetails.

Implementations§

Appends an item to associated_roles.

To override the contents of this collection use set_associated_roles.

The IAM roles associated with the DB instance.

The IAM roles associated with the DB instance.

The identifier of the CA certificate for this DB instance.

The identifier of the CA certificate for this DB instance.

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

Contains the name of the compute and memory capacity class of the DB instance.

Contains the name of the compute and memory capacity class of the DB instance.

Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in CloudTrail log entries whenever the KMS key for the DB instance is accessed.

The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in CloudTrail log entries whenever the KMS key for the DB instance is accessed.

The meaning of this parameter differs according to the database engine you use.

MySQL, MariaDB, SQL Server, PostgreSQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

The meaning of this parameter differs according to the database engine you use.

MySQL, MariaDB, SQL Server, PostgreSQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

Indicates whether the DB instance has deletion protection enabled.

When deletion protection is enabled, the database cannot be deleted.

Indicates whether the DB instance has deletion protection enabled.

When deletion protection is enabled, the database cannot be deleted.

Specifies the connection endpoint.

Specifies the connection endpoint.

Provides the name of the database engine to use for this DB instance.

Provides the name of the database engine to use for this DB instance.

Indicates the database engine version.

Indicates the database engine version.

True if mapping of IAM accounts to database accounts is enabled, and otherwise false.

IAM database authentication can be enabled for the following database engines.

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

  • Aurora 5.6 or higher

True if mapping of IAM accounts to database accounts is enabled, and otherwise false.

IAM database authentication can be enabled for the following database engines.

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

  • Aurora 5.6 or higher

Indicates when the DB instance was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Indicates when the DB instance was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

If StorageEncrypted is true, the KMS key identifier for the encrypted DB instance.

If StorageEncrypted is true, the KMS key identifier for the encrypted DB instance.

Specifies the accessibility options for the DB instance.

A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address.

A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Specifies the accessibility options for the DB instance.

A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address.

A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Specifies whether the DB instance is encrypted.

Specifies whether the DB instance is encrypted.

The ARN from the key store with which the instance is associated for TDE encryption.

The ARN from the key store with which the instance is associated for TDE encryption.

Appends an item to vpc_security_groups.

To override the contents of this collection use set_vpc_security_groups.

A list of VPC security groups that the DB instance belongs to.

A list of VPC security groups that the DB instance belongs to.

Whether the DB instance is a multiple Availability Zone deployment.

Whether the DB instance is a multiple Availability Zone deployment.

The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.

The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.

The current status of the DB instance.

The current status of the DB instance.

The master user name of the DB instance.

The master user name of the DB instance.

The amount of storage (in gigabytes) to initially allocate for the DB instance.

The amount of storage (in gigabytes) to initially allocate for the DB instance.

The range of time each day when automated backups are created, if automated backups are enabled.

Uses the format HH:MM-HH:MM. For example, 04:52-05:22.

The range of time each day when automated backups are created, if automated backups are enabled.

Uses the format HH:MM-HH:MM. For example, 04:52-05:22.

The number of days for which to retain automated backups.

The number of days for which to retain automated backups.

Appends an item to db_security_groups.

To override the contents of this collection use set_db_security_groups.

A list of the DB security groups to assign to the DB instance.

A list of the DB security groups to assign to the DB instance.

Appends an item to db_parameter_groups.

To override the contents of this collection use set_db_parameter_groups.

A list of the DB parameter groups to assign to the DB instance.

A list of the DB parameter groups to assign to the DB instance.

The Availability Zone where the DB instance will be created.

The Availability Zone where the DB instance will be created.

Information about the subnet group that is associated with the DB instance.

Information about the subnet group that is associated with the DB instance.

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Uses the format :HH:MM- :HH:MM .

For the day values, use mon|tue|wed|thu|fri|sat|sun.

For example, sun:09:32-sun:10:02.

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Uses the format :HH:MM- :HH:MM .

For the day values, use mon|tue|wed|thu|fri|sat|sun.

For example, sun:09:32-sun:10:02.

Changes to the DB instance that are currently pending.

Changes to the DB instance that are currently pending.

Specifies the latest time to which a database can be restored with point-in-time restore.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Specifies the latest time to which a database can be restored with point-in-time restore.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Indicates whether minor version patches are applied automatically.

Indicates whether minor version patches are applied automatically.

If this DB instance is a read replica, contains the identifier of the source DB instance.

If this DB instance is a read replica, contains the identifier of the source DB instance.

Appends an item to read_replica_db_instance_identifiers.

To override the contents of this collection use set_read_replica_db_instance_identifiers.

List of identifiers of the read replicas associated with this DB instance.

List of identifiers of the read replicas associated with this DB instance.

Appends an item to read_replica_db_cluster_identifiers.

To override the contents of this collection use set_read_replica_db_cluster_identifiers.

List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.

List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.

License model information for this DB instance.

License model information for this DB instance.

Specifies the provisioned IOPS (I/O operations per second) for this DB instance.

Specifies the provisioned IOPS (I/O operations per second) for this DB instance.

Appends an item to option_group_memberships.

To override the contents of this collection use set_option_group_memberships.

The list of option group memberships for this DB instance.

The list of option group memberships for this DB instance.

The name of the character set that this DB instance is associated with.

The name of the character set that this DB instance is associated with.

For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.

For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.

Appends an item to status_infos.

To override the contents of this collection use set_status_infos.

The status of a read replica. If the instance isn't a read replica, this is empty.

The status of a read replica. If the instance isn't a read replica, this is empty.

The storage type for the DB instance.

The storage type for the DB instance.

Appends an item to domain_memberships.

To override the contents of this collection use set_domain_memberships.

The Active Directory domain membership records associated with the DB instance.

The Active Directory domain membership records associated with the DB instance.

Whether to copy resource tags to snapshots of the DB instance.

Whether to copy resource tags to snapshots of the DB instance.

The interval, in seconds, between points when enhanced monitoring metrics are collected for the DB instance.

The interval, in seconds, between points when enhanced monitoring metrics are collected for the DB instance.

The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.

The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.

The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.

The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.

The time zone of the DB instance.

The time zone of the DB instance.

Indicates whether Performance Insights is enabled for the DB instance.

Indicates whether Performance Insights is enabled for the DB instance.

The identifier of the KMS key used to encrypt the Performance Insights data.

The identifier of the KMS key used to encrypt the Performance Insights data.

The number of days to retain Performance Insights data.

The number of days to retain Performance Insights data.

Appends an item to enabled_cloud_watch_logs_exports.

To override the contents of this collection use set_enabled_cloud_watch_logs_exports.

A list of log types that this DB instance is configured to export to CloudWatch Logs.

A list of log types that this DB instance is configured to export to CloudWatch Logs.

Appends an item to processor_features.

To override the contents of this collection use set_processor_features.

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Specifies the connection endpoint.

Specifies the connection endpoint.

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

Consumes the builder and constructs a AwsRdsDbInstanceDetails.

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
Returns the “default value” for a type. Read more
This method tests for self and other values to be equal, and is used by ==.
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

Should always be Self
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
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