Struct aws_sdk_rds::input::RestoreDbInstanceFromS3Input
source · [−]#[non_exhaustive]pub struct RestoreDbInstanceFromS3Input { /* private fields */ }Implementations
sourceimpl RestoreDbInstanceFromS3Input
impl RestoreDbInstanceFromS3Input
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<RestoreDBInstanceFromS3, AwsResponseRetryClassifier>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<RestoreDBInstanceFromS3, AwsResponseRetryClassifier>, BuildError>
Consumes the builder and constructs an Operation<RestoreDBInstanceFromS3>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture RestoreDbInstanceFromS3Input.
sourceimpl RestoreDbInstanceFromS3Input
impl RestoreDbInstanceFromS3Input
sourcepub fn db_name(&self) -> Option<&str>
pub fn db_name(&self) -> Option<&str>
The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance.
sourcepub fn db_instance_identifier(&self) -> Option<&str>
pub fn db_instance_identifier(&self) -> Option<&str>
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
sourcepub fn allocated_storage(&self) -> Option<i32>
pub fn allocated_storage(&self) -> Option<i32>
The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.
Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth.
sourcepub fn db_instance_class(&self) -> Option<&str>
pub fn db_instance_class(&self) -> Option<&str>
The compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.
sourcepub fn engine(&self) -> Option<&str>
pub fn engine(&self) -> Option<&str>
The name of the database engine to be used for this instance.
Valid Values: mysql
sourcepub fn master_username(&self) -> Option<&str>
pub fn master_username(&self) -> Option<&str>
The name for the master user.
Constraints:
-
Must be 1 to 16 letters or numbers.
-
First character must be a letter.
-
Can't be a reserved word for the chosen database engine.
sourcepub fn master_user_password(&self) -> Option<&str>
pub fn master_user_password(&self) -> Option<&str>
The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
sourcepub fn db_security_groups(&self) -> Option<&[String]>
pub fn db_security_groups(&self) -> Option<&[String]>
A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
sourcepub fn vpc_security_group_ids(&self) -> Option<&[String]>
pub fn vpc_security_group_ids(&self) -> Option<&[String]>
A list of VPC security groups to associate with this DB instance.
sourcepub fn availability_zone(&self) -> Option<&str>
pub fn availability_zone(&self) -> Option<&str>
The Availability Zone that the DB instance is created in. For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Example: us-east-1d
Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
sourcepub fn db_subnet_group_name(&self) -> Option<&str>
pub fn db_subnet_group_name(&self) -> Option<&str>
A DB subnet group to associate with this DB instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
sourcepub fn preferred_maintenance_window(&self) -> Option<&str>
pub fn preferred_maintenance_window(&self) -> Option<&str>
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Constraints:
-
Must be in the format
ddd:hh24:mi-ddd:hh24:mi. -
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
-
Must be in Universal Coordinated Time (UTC).
-
Must not conflict with the preferred backup window.
-
Must be at least 30 minutes.
sourcepub fn db_parameter_group_name(&self) -> Option<&str>
pub fn db_parameter_group_name(&self) -> Option<&str>
The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.
sourcepub fn backup_retention_period(&self) -> Option<i32>
pub fn backup_retention_period(&self) -> Option<i32>
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see CreateDBInstance.
sourcepub fn preferred_backup_window(&self) -> Option<&str>
pub fn preferred_backup_window(&self) -> Option<&str>
The time range each day during which automated backups are created if automated backups are enabled. For more information, see Backup window in the Amazon RDS User Guide.
Constraints:
-
Must be in the format
hh24:mi-hh24:mi. -
Must be in Universal Coordinated Time (UTC).
-
Must not conflict with the preferred maintenance window.
-
Must be at least 30 minutes.
sourcepub fn port(&self) -> Option<i32>
pub fn port(&self) -> Option<i32>
The port number on which the database accepts connections.
Type: Integer
Valid Values: 1150-65535
Default: 3306
sourcepub fn multi_az(&self) -> Option<bool>
pub fn multi_az(&self) -> Option<bool>
A value that indicates whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.
sourcepub fn engine_version(&self) -> Option<&str>
pub fn engine_version(&self) -> Option<&str>
The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.
sourcepub fn auto_minor_version_upgrade(&self) -> Option<bool>
pub fn auto_minor_version_upgrade(&self) -> Option<bool>
A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.
sourcepub fn license_model(&self) -> Option<&str>
pub fn license_model(&self) -> Option<&str>
The license model for this DB instance. Use general-public-license.
sourcepub fn iops(&self) -> Option<i32>
pub fn iops(&self) -> Option<i32>
The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.
sourcepub fn option_group_name(&self) -> Option<&str>
pub fn option_group_name(&self) -> Option<&str>
The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.
sourcepub fn publicly_accessible(&self) -> Option<bool>
pub fn publicly_accessible(&self) -> Option<bool>
A value that indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
sourcepub fn storage_type(&self) -> Option<&str>
pub fn storage_type(&self) -> Option<&str>
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
sourcepub fn storage_encrypted(&self) -> Option<bool>
pub fn storage_encrypted(&self) -> Option<bool>
A value that indicates whether the new DB instance is encrypted or not.
sourcepub fn kms_key_id(&self) -> Option<&str>
pub fn kms_key_id(&self) -> Option<&str>
The Amazon Web Services KMS key identifier for an encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
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.
sourcepub fn monitoring_interval(&self) -> Option<i32>
pub fn monitoring_interval(&self) -> Option<i32>
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Default: 0
sourcepub fn monitoring_role_arn(&self) -> Option<&str>
pub fn monitoring_role_arn(&self) -> Option<&str>
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.
sourcepub fn enable_iam_database_authentication(&self) -> Option<bool>
pub fn enable_iam_database_authentication(&self) -> 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.
sourcepub fn source_engine(&self) -> Option<&str>
pub fn source_engine(&self) -> Option<&str>
The name of the engine of your source database.
Valid Values: mysql
sourcepub fn source_engine_version(&self) -> Option<&str>
pub fn source_engine_version(&self) -> Option<&str>
The version of the database that the backup files were created from.
MySQL versions 5.6 and 5.7 are supported.
Example: 5.6.40
sourcepub fn s3_bucket_name(&self) -> Option<&str>
pub fn s3_bucket_name(&self) -> Option<&str>
The name of your Amazon S3 bucket that contains your database backup file.
sourcepub fn s3_ingestion_role_arn(&self) -> Option<&str>
pub fn s3_ingestion_role_arn(&self) -> Option<&str>
An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.
sourcepub fn enable_performance_insights(&self) -> Option<bool>
pub fn enable_performance_insights(&self) -> Option<bool>
A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
sourcepub fn performance_insights_kms_key_id(&self) -> Option<&str>
pub fn performance_insights_kms_key_id(&self) -> Option<&str>
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.
sourcepub fn performance_insights_retention_period(&self) -> Option<i32>
pub fn performance_insights_retention_period(&self) -> Option<i32>
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
-
7
-
month * 31, where month is a number of months from 1-23
-
731
For example, the following values are valid:
-
93 (3 months * 31)
-
341 (11 months * 31)
-
589 (19 months * 31)
-
731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
sourcepub fn enable_cloudwatch_logs_exports(&self) -> Option<&[String]>
pub fn enable_cloudwatch_logs_exports(&self) -> Option<&[String]>
The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
sourcepub fn processor_features(&self) -> Option<&[ProcessorFeature]>
pub fn processor_features(&self) -> Option<&[ProcessorFeature]>
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
sourcepub fn use_default_processor_features(&self) -> Option<bool>
pub fn use_default_processor_features(&self) -> Option<bool>
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
sourcepub fn deletion_protection(&self) -> Option<bool>
pub fn deletion_protection(&self) -> 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.
sourcepub fn max_allocated_storage(&self) -> Option<i32>
pub fn max_allocated_storage(&self) -> 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.
sourcepub fn network_type(&self) -> Option<&str>
pub fn network_type(&self) -> Option<&str>
The network type of the DB instance.
Valid values:
-
IPV4 -
DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Trait Implementations
sourceimpl Clone for RestoreDbInstanceFromS3Input
impl Clone for RestoreDbInstanceFromS3Input
sourcefn clone(&self) -> RestoreDbInstanceFromS3Input
fn clone(&self) -> RestoreDbInstanceFromS3Input
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more