Struct aws_sdk_rds::input::RestoreDbClusterFromS3Input
source · [−]#[non_exhaustive]pub struct RestoreDbClusterFromS3Input { /* private fields */ }Implementations
sourceimpl RestoreDbClusterFromS3Input
impl RestoreDbClusterFromS3Input
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<RestoreDBClusterFromS3, AwsResponseRetryClassifier>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<RestoreDBClusterFromS3, AwsResponseRetryClassifier>, BuildError>
Consumes the builder and constructs an Operation<RestoreDBClusterFromS3>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture RestoreDbClusterFromS3Input.
sourceimpl RestoreDbClusterFromS3Input
impl RestoreDbClusterFromS3Input
sourcepub fn availability_zones(&self) -> Option<&[String]>
pub fn availability_zones(&self) -> Option<&[String]>
A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
sourcepub fn backup_retention_period(&self) -> Option<i32>
pub fn backup_retention_period(&self) -> Option<i32>
The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
-
Must be a value from 1 to 35
sourcepub fn character_set_name(&self) -> Option<&str>
pub fn character_set_name(&self) -> Option<&str>
A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
sourcepub fn database_name(&self) -> Option<&str>
pub fn database_name(&self) -> Option<&str>
The database name for the restored DB cluster.
sourcepub fn db_cluster_identifier(&self) -> Option<&str>
pub fn db_cluster_identifier(&self) -> Option<&str>
The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.
Constraints:
-
Must contain from 1 to 63 letters, numbers, or hyphens.
-
First character must be a letter.
-
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
sourcepub fn db_cluster_parameter_group_name(&self) -> Option<&str>
pub fn db_cluster_parameter_group_name(&self) -> Option<&str>
The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, default.aurora5.6 is used.
Constraints:
-
If supplied, must match the name of an existing DBClusterParameterGroup.
sourcepub fn vpc_security_group_ids(&self) -> Option<&[String]>
pub fn vpc_security_group_ids(&self) -> Option<&[String]>
A list of EC2 VPC security groups to associate with the restored DB cluster.
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 the restored DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
sourcepub fn engine(&self) -> Option<&str>
pub fn engine(&self) -> Option<&str>
The name of the database engine to be used for this DB cluster.
Valid Values: aurora (for MySQL 5.6-compatible Aurora) and aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
sourcepub fn engine_version(&self) -> Option<&str>
pub fn engine_version(&self) -> Option<&str>
The version number of the database engine to use.
To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.mysql_aurora.2.07.1, 8.0.mysql_aurora.3.02.0
sourcepub fn port(&self) -> Option<i32>
pub fn port(&self) -> Option<i32>
The port number on which the instances in the restored DB cluster accept connections.
Default: 3306
sourcepub fn master_username(&self) -> Option<&str>
pub fn master_username(&self) -> Option<&str>
The name of the master user for the restored DB cluster.
Constraints:
-
Must be 1 to 16 letters or numbers.
-
First character must be a letter.
-
Can't be a reserved word for the chosen database engine.
sourcepub fn master_user_password(&self) -> Option<&str>
pub fn master_user_password(&self) -> Option<&str>
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.
sourcepub fn option_group_name(&self) -> Option<&str>
pub fn option_group_name(&self) -> Option<&str>
A value that indicates that the restored DB cluster should be associated with the specified option group.
Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.
sourcepub fn preferred_backup_window(&self) -> Option<&str>
pub fn preferred_backup_window(&self) -> Option<&str>
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.
sourcepub fn preferred_maintenance_window(&self) -> Option<&str>
pub fn preferred_maintenance_window(&self) -> Option<&str>
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
sourcepub fn storage_encrypted(&self) -> Option<bool>
pub fn storage_encrypted(&self) -> Option<bool>
A value that indicates whether the restored DB cluster is encrypted.
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 cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
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, see IAM Database Authentication in the Amazon Aurora User Guide.
sourcepub fn source_engine(&self) -> Option<&str>
pub fn source_engine(&self) -> Option<&str>
The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
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.5, 5.6, and 5.7 are supported.
Example: 5.6.40, 5.7.28
sourcepub fn s3_bucket_name(&self) -> Option<&str>
pub fn s3_bucket_name(&self) -> Option<&str>
The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
sourcepub fn s3_prefix(&self) -> Option<&str>
pub fn s3_prefix(&self) -> Option<&str>
The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.
sourcepub fn s3_ingestion_role_arn(&self) -> Option<&str>
pub fn s3_ingestion_role_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
sourcepub fn backtrack_window(&self) -> Option<i64>
pub fn backtrack_window(&self) -> 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).
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 cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.
Aurora MySQL
Possible values are audit, error, general, and slowquery.
Aurora PostgreSQL
Possible value is postgresql.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
sourcepub fn deletion_protection(&self) -> Option<bool>
pub fn deletion_protection(&self) -> 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.
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.
sourcepub fn domain(&self) -> Option<&str>
pub fn domain(&self) -> Option<&str>
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.
sourcepub fn domain_iam_role_name(&self) -> Option<&str>
pub fn domain_iam_role_name(&self) -> Option<&str>
Specify the name of the IAM role to be used when making API calls to the Directory Service.
sourcepub fn serverless_v2_scaling_configuration(
&self
) -> Option<&ServerlessV2ScalingConfiguration>
pub fn serverless_v2_scaling_configuration(
&self
) -> Option<&ServerlessV2ScalingConfiguration>
Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
sourcepub fn network_type(&self) -> Option<&str>
pub fn network_type(&self) -> Option<&str>
The network type of the DB cluster.
Valid values:
-
IPV4 -
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. 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 Aurora User Guide.
Trait Implementations
sourceimpl Clone for RestoreDbClusterFromS3Input
impl Clone for RestoreDbClusterFromS3Input
sourcefn clone(&self) -> RestoreDbClusterFromS3Input
fn clone(&self) -> RestoreDbClusterFromS3Input
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more