aws_sdk_rds::operation::restore_db_instance_from_s3

Struct RestoreDbInstanceFromS3Input

#[non_exhaustive]
pub struct RestoreDbInstanceFromS3Input {Show 52 fields
    pub db_name: Option<String>,
    pub db_instance_identifier: Option<String>,
    pub allocated_storage: Option<i32>,
    pub db_instance_class: Option<String>,
    pub engine: Option<String>,
    pub master_username: Option<String>,
    pub master_user_password: Option<String>,
    pub db_security_groups: Option<Vec<String>>,
    pub vpc_security_group_ids: Option<Vec<String>>,
    pub availability_zone: Option<String>,
    pub db_subnet_group_name: Option<String>,
    pub preferred_maintenance_window: Option<String>,
    pub db_parameter_group_name: Option<String>,
    pub backup_retention_period: Option<i32>,
    pub preferred_backup_window: Option<String>,
    pub port: Option<i32>,
    pub multi_az: Option<bool>,
    pub engine_version: Option<String>,
    pub auto_minor_version_upgrade: Option<bool>,
    pub license_model: Option<String>,
    pub iops: Option<i32>,
    pub storage_throughput: Option<i32>,
    pub option_group_name: Option<String>,
    pub publicly_accessible: Option<bool>,
    pub tags: Option<Vec<Tag>>,
    pub storage_type: Option<String>,
    pub storage_encrypted: Option<bool>,
    pub kms_key_id: Option<String>,
    pub copy_tags_to_snapshot: Option<bool>,
    pub monitoring_interval: Option<i32>,
    pub monitoring_role_arn: Option<String>,
    pub enable_iam_database_authentication: Option<bool>,
    pub source_engine: Option<String>,
    pub source_engine_version: Option<String>,
    pub s3_bucket_name: Option<String>,
    pub s3_prefix: Option<String>,
    pub s3_ingestion_role_arn: Option<String>,
    pub database_insights_mode: Option<DatabaseInsightsMode>,
    pub enable_performance_insights: Option<bool>,
    pub performance_insights_kms_key_id: Option<String>,
    pub performance_insights_retention_period: Option<i32>,
    pub enable_cloudwatch_logs_exports: Option<Vec<String>>,
    pub processor_features: Option<Vec<ProcessorFeature>>,
    pub use_default_processor_features: Option<bool>,
    pub deletion_protection: Option<bool>,
    pub max_allocated_storage: Option<i32>,
    pub network_type: Option<String>,
    pub manage_master_user_password: Option<bool>,
    pub master_user_secret_kms_key_id: Option<String>,
    pub dedicated_log_volume: Option<bool>,
    pub ca_certificate_identifier: Option<String>,
    pub engine_lifecycle_support: Option<String>,
}

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

§db_name: Option<String>

The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance.

§db_instance_identifier: 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: Option<i32>

The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.

This setting isn't valid for RDS for SQL Server.

Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.

§db_instance_class: Option<String>

The compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.

§engine: Option<String>

The name of the database engine to be used for this instance.

Valid Values: mysql

§master_username: Option<String>

The name for the master user.

Constraints:

Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.

§master_user_password: Option<String>

The password for the master user.

Constraints:

Can't be specified if ManageMasterUserPassword is turned on.
Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character.

Length Constraints:

RDS for Db2 - Must contain from 8 to 128 characters.
RDS for MariaDB - Must contain from 8 to 41 characters.
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
RDS for MySQL - Must contain from 8 to 41 characters.
RDS for Oracle - Must contain from 8 to 30 characters.
RDS for PostgreSQL - Must contain from 8 to 128 characters.

§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: Option<Vec<String>>

A list of VPC security groups to associate with this DB instance.

§availability_zone: Option<String>

The Availability Zone that the DB instance is created in. For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.

§db_subnet_group_name: Option<String>

A DB subnet group to associate with this DB instance.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mydbsubnetgroup

§preferred_maintenance_window: Option<String>

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.

Constraints:

Must be in the format ddd:hh24:mi-ddd:hh24:mi.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.

§db_parameter_group_name: Option<String>

The name of the DB parameter group to associate with this DB instance.

If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.

§backup_retention_period: Option<i32>

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see CreateDBInstance.

§preferred_backup_window: Option<String>

The time range each day during which automated backups are created if automated backups are enabled. For more information, see Backup window in the Amazon RDS User Guide.

Constraints:

Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.

§port: Option<i32>

The port number on which the database accepts connections.

Type: Integer

Valid Values: 1150-65535

Default: 3306

§multi_az: Option<bool>

Specifies whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.

§engine_version: Option<String>

The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

§auto_minor_version_upgrade: Option<bool>

Specifies whether to automatically apply minor engine upgrades to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.

For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

§license_model: Option<String>

The license model for this DB instance. Use general-public-license.

§iops: Option<i32>

The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.

§storage_throughput: Option<i32>

Specifies the storage throughput value for the DB instance.

This setting doesn't apply to RDS Custom or Amazon Aurora.

§option_group_name: Option<String>

The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.

§publicly_accessible: Option<bool>

Specifies whether the DB instance is publicly accessible.

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

§tags: Option<Vec<Tag>>

A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

§storage_type: Option<String>

Specifies the storage type to be associated with the DB instance.

Valid Values: gp2 | gp3 | io1 | io2 | standard

If you specify io1, io2, or gp3, you must also include a value for the Iops parameter.

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

§storage_encrypted: Option<bool>

Specifies whether the new DB instance is encrypted or not.

§kms_key_id: Option<String>

The Amazon Web Services KMS key identifier for an encrypted DB instance.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

If the StorageEncrypted parameter is enabled, and you do not specify a value for 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.

§copy_tags_to_snapshot: Option<bool>

Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

§monitoring_interval: Option<i32>

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

Default: 0

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

§enable_iam_database_authentication: Option<bool>

Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

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

§source_engine: Option<String>

The name of the engine of your source database.

Valid Values: mysql

§source_engine_version: Option<String>

The version of the database that the backup files were created from.

MySQL versions 5.6 and 5.7 are supported.

Example: 5.6.40

§s3_bucket_name: Option<String>

The name of your Amazon S3 bucket that contains your database backup file.

§s3_prefix: Option<String>

The prefix of your Amazon S3 bucket.

§s3_ingestion_role_arn: Option<String>

An Amazon Web Services Identity and Access Management (IAM) role with a trust policy and a permissions policy that allows Amazon RDS to access your Amazon S3 bucket. For information about this role, see Creating an IAM role manually in the Amazon RDS User Guide.

§database_insights_mode: Option<DatabaseInsightsMode>

Specifies the mode of Database Insights to enable for the DB instance.

Aurora DB instances inherit this value from the DB cluster, so you can't change this value.

§enable_performance_insights: Option<bool>

Specifies whether to enable Performance Insights for the DB instance.

For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

§performance_insights_kms_key_id: Option<String>

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

§performance_insights_retention_period: Option<i32>

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

7
month * 31, where month is a number of months from 1-23
731

For example, the following values are valid:

93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

§enable_cloudwatch_logs_exports: Option<Vec<String>>

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

§processor_features: Option<Vec<ProcessorFeature>>

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

§use_default_processor_features: Option<bool>

Specifies whether the DB instance class of the DB instance uses its default processor features.

§deletion_protection: Option<bool>

Specifies whether to enable deletion protection for the DB instance. 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: Option<i32>

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.

§network_type: Option<String>

The network type of the DB instance.

Valid Values:

IPV4
DUAL

The network type is determined by the DBSubnetGroup specified for the DB instance. 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.

§manage_master_user_password: Option<bool>

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.

Constraints:

Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.

§master_user_secret_kms_key_id: Option<String>

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the 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 you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed 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.

§dedicated_log_volume: Option<bool>

Specifies whether to enable a dedicated log volume (DLV) for the DB instance.

§ca_certificate_identifier: Option<String>

The CA certificate identifier to use for the DB instance's server certificate.

This setting doesn't apply to RDS Custom DB instances.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

§engine_lifecycle_support: Option<String>

The life cycle type for this DB instance.

By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.

You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support Amazon RDS in the Amazon RDS User Guide.

This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled

Default: open-source-rds-extended-support

Struct RestoreDbInstanceFromS3Input Copy item path

Fields (Non-exhaustive)§

Implementations§

impl RestoreDbInstanceFromS3Input

pub fn db_name(&self) -> Option<&str>

pub fn db_instance_identifier(&self) -> Option<&str>

pub fn allocated_storage(&self) -> Option<i32>

pub fn db_instance_class(&self) -> Option<&str>

pub fn engine(&self) -> Option<&str>

pub fn master_username(&self) -> Option<&str>

pub fn master_user_password(&self) -> Option<&str>

pub fn db_security_groups(&self) -> &[String]

pub fn vpc_security_group_ids(&self) -> &[String]

pub fn availability_zone(&self) -> Option<&str>

pub fn db_subnet_group_name(&self) -> Option<&str>

pub fn preferred_maintenance_window(&self) -> Option<&str>

pub fn db_parameter_group_name(&self) -> Option<&str>

pub fn backup_retention_period(&self) -> Option<i32>

pub fn preferred_backup_window(&self) -> Option<&str>

pub fn port(&self) -> Option<i32>

pub fn multi_az(&self) -> Option<bool>

pub fn engine_version(&self) -> Option<&str>

pub fn auto_minor_version_upgrade(&self) -> Option<bool>

pub fn license_model(&self) -> Option<&str>

pub fn iops(&self) -> Option<i32>

pub fn storage_throughput(&self) -> Option<i32>

pub fn option_group_name(&self) -> Option<&str>

pub fn publicly_accessible(&self) -> Option<bool>

pub fn tags(&self) -> &[Tag]

pub fn storage_type(&self) -> Option<&str>

pub fn storage_encrypted(&self) -> Option<bool>

pub fn kms_key_id(&self) -> Option<&str>

pub fn copy_tags_to_snapshot(&self) -> Option<bool>

pub fn monitoring_interval(&self) -> Option<i32>

pub fn monitoring_role_arn(&self) -> Option<&str>

pub fn enable_iam_database_authentication(&self) -> Option<bool>

pub fn source_engine(&self) -> Option<&str>

pub fn source_engine_version(&self) -> Option<&str>

pub fn s3_bucket_name(&self) -> Option<&str>

pub fn s3_prefix(&self) -> Option<&str>

pub fn s3_ingestion_role_arn(&self) -> Option<&str>

pub fn database_insights_mode(&self) -> Option<&DatabaseInsightsMode>

pub fn enable_performance_insights(&self) -> Option<bool>

pub fn performance_insights_kms_key_id(&self) -> Option<&str>

pub fn performance_insights_retention_period(&self) -> Option<i32>

pub fn enable_cloudwatch_logs_exports(&self) -> &[String]

pub fn processor_features(&self) -> &[ProcessorFeature]

pub fn use_default_processor_features(&self) -> Option<bool>

pub fn deletion_protection(&self) -> Option<bool>

pub fn max_allocated_storage(&self) -> Option<i32>

pub fn network_type(&self) -> Option<&str>

pub fn manage_master_user_password(&self) -> Option<bool>

pub fn master_user_secret_kms_key_id(&self) -> Option<&str>

pub fn dedicated_log_volume(&self) -> Option<bool>

pub fn ca_certificate_identifier(&self) -> Option<&str>

pub fn engine_lifecycle_support(&self) -> Option<&str>

impl RestoreDbInstanceFromS3Input

pub fn builder() -> RestoreDbInstanceFromS3InputBuilder

Trait Implementations§

impl Clone for RestoreDbInstanceFromS3Input

fn clone(&self) -> RestoreDbInstanceFromS3Input

fn clone_from(&mut self, source: &Self)

impl Debug for RestoreDbInstanceFromS3Input

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl PartialEq for RestoreDbInstanceFromS3Input

fn eq(&self, other: &RestoreDbInstanceFromS3Input) -> bool

fn ne(&self, other: &Rhs) -> bool

impl StructuralPartialEq for RestoreDbInstanceFromS3Input

Auto Trait Implementations§

impl Freeze for RestoreDbInstanceFromS3Input

impl RefUnwindSafe for RestoreDbInstanceFromS3Input

impl Send for RestoreDbInstanceFromS3Input

impl Sync for RestoreDbInstanceFromS3Input

impl Unpin for RestoreDbInstanceFromS3Input

impl UnwindSafe for RestoreDbInstanceFromS3Input

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

Struct RestoreDbInstanceFromS3Input

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

impl<T> Paint for T
where T: ?Sized,