Skip to content

RDS  >  Operations  >  restore_db_cluster_from_s3

restore_db_cluster_from_s3

Operation

restore_db_cluster_from_s3 async

restore_db_cluster_from_s3(request: RestoreDBClusterFromS3Input | RestoreDBClusterFromS3InputDict, /, *, plugins: list[Plugin] | None = None) -> RestoreDBClusterFromS3Output
restore_db_cluster_from_s3(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[RestoreDBClusterFromS3InputDict]) -> RestoreDBClusterFromS3Output

Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide.

Note

This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromS3 operation has completed and the DB cluster is available.

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

Note

This operation only applies to Aurora DB clusters. The source DB engine must be MySQL.

You can use the AssociatedRoles parameter to associate one or more Amazon Web Services Identity and Access Management (IAM) roles with the Aurora DB cluster when you restore it from Amazon S3.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
RestoreDBClusterFromS3Output

An instance of RestoreDBClusterFromS3Output.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

RestoreDBClusterFromS3Input dataclass

Bases: _SerdeShape

Dataclass for RestoreDBClusterFromS3Input structure.

Attributes
associated_roles class-attribute instance-attribute
associated_roles: list[DBClusterAssociatedRole] | None = ...

A list of Amazon Web Services Identity and Access Management (IAM) roles to associate with the DB cluster when it's restored from Amazon S3. Each role grants the DB cluster permission to access other Amazon Web Services on your behalf. For each role, specify a role ARN and, optionally, the feature name (such as s3Import, s3Export, or Lambda).

availability_zones class-attribute instance-attribute
availability_zones: list[str] | None = ...

A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

backtrack_window class-attribute instance-attribute
backtrack_window: int | None = ...

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Note

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).
backup_retention_period class-attribute instance-attribute
backup_retention_period: int | None = ...

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
character_set_name class-attribute instance-attribute
character_set_name: str | None = ...

A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

copy_tags_to_snapshot class-attribute instance-attribute
copy_tags_to_snapshot: bool | None = ...

Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

database_name class-attribute instance-attribute
database_name: str | None = ...

The database name for the restored DB cluster.

db_cluster_identifier class-attribute instance-attribute
db_cluster_identifier: str | None = ...

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

db_cluster_parameter_group_name class-attribute instance-attribute
db_cluster_parameter_group_name: str | None = ...

The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, the default parameter group for the engine version is used.

Constraints:

  • If supplied, must match the name of an existing DBClusterParameterGroup.
db_subnet_group_name class-attribute instance-attribute
db_subnet_group_name: str | None = ...

A DB subnet group to associate with the restored DB cluster.

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

Example: mydbsubnetgroup

deletion_protection class-attribute instance-attribute
deletion_protection: bool | None = ...

Specifies whether to enable deletion protection for the DB cluster. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.

domain class-attribute instance-attribute
domain: str | None = ...

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.

domain_iam_role_name class-attribute instance-attribute
domain_iam_role_name: str | None = ...

Specify the name of the IAM role to be used when making API calls to the Directory Service.

enable_cloudwatch_logs_exports class-attribute instance-attribute
enable_cloudwatch_logs_exports: list[str] | None = ...

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, instance, slowquery, and iam-db-auth-error.

Aurora PostgreSQL

Possible value are instance, postgresql, and iam-db-auth-error.

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

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

enable_iam_database_authentication class-attribute instance-attribute
enable_iam_database_authentication: bool | None = ...

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, see IAM Database Authentication in the Amazon Aurora User Guide.

engine class-attribute instance-attribute
engine: str | None = ...

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

Valid Values: aurora-mysql (for Aurora MySQL)

engine_lifecycle_support class-attribute instance-attribute
engine_lifecycle_support: str | None = ...

The lifecycle type for this DB cluster.

Note

By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster 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 cluster 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 cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

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

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

Default: open-source-rds-extended-support

engine_version class-attribute instance-attribute
engine_version: str | None = ...

The version number of the database engine to use.

To list all of the available engine versions for aurora-mysql (Aurora MySQL), use the following command:

aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

Aurora MySQL

Examples: 5.7.mysql_aurora.2.12.0, 8.0.mysql_aurora.3.04.0

kms_key_id class-attribute instance-attribute
kms_key_id: str | None = ...

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.

manage_master_user_password class-attribute instance-attribute
manage_master_user_password: bool | None = ...

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 and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.

Constraints:

  • Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
master_user_password class-attribute instance-attribute
master_user_password: str | None = ...

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.

  • Can't be specified if ManageMasterUserPassword is turned on.

master_user_secret_kms_key_id class-attribute instance-attribute
master_user_secret_kms_key_id: str | None = ...

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

master_username class-attribute instance-attribute
master_username: str | None = ...

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.

network_type class-attribute instance-attribute
network_type: str | None = ...

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.

option_group_name class-attribute instance-attribute
option_group_name: str | None = ...

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.

port class-attribute instance-attribute
port: int | None = ...

The port number on which the instances in the restored DB cluster accept connections.

Default: 3306

preferred_backup_window class-attribute instance-attribute
preferred_backup_window: str | None = ...

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.

preferred_maintenance_window class-attribute instance-attribute
preferred_maintenance_window: str | None = ...

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.

s3_bucket_name class-attribute instance-attribute
s3_bucket_name: str | None = ...

The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

s3_ingestion_role_arn class-attribute instance-attribute
s3_ingestion_role_arn: str | None = ...

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.

s3_prefix class-attribute instance-attribute
s3_prefix: str | None = ...

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.

serverless_v2_scaling_configuration class-attribute instance-attribute
serverless_v2_scaling_configuration: ServerlessV2ScalingConfiguration | None = ...

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.

source_engine class-attribute instance-attribute
source_engine: str | None = ...

The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.

Valid Values: mysql

source_engine_version class-attribute instance-attribute
source_engine_version: str | None = ...

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

MySQL versions 5.7 and 8.0 are supported.

Example: 5.7.40, 8.0.28

storage_encrypted class-attribute instance-attribute
storage_encrypted: bool | None = ...

Specifies whether the restored DB cluster is encrypted.

storage_type class-attribute instance-attribute
storage_type: str | None = ...

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

Valid Values: aurora, aurora-iopt1

Default: aurora

Valid for: Aurora DB clusters only

tag_specifications class-attribute instance-attribute
tag_specifications: list[TagSpecification] | None = ...

Tags to assign to resources associated with the DB cluster.

Valid Values:

  • cluster-auto-backup - The DB cluster's automated backup.
tags class-attribute instance-attribute
tags: list[Tag] | None = ...

A list of tags.

For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

vpc_security_group_ids class-attribute instance-attribute
vpc_security_group_ids: list[str] | None = ...

A list of EC2 VPC security groups to associate with the restored DB cluster.

Dictionaries

RestoreDBClusterFromS3InputDict

Bases: TypedDict

Dictionary form of RestoreDBClusterFromS3Input.

Attributes
associated_roles instance-attribute

A list of Amazon Web Services Identity and Access Management (IAM) roles to associate with the DB cluster when it's restored from Amazon S3. Each role grants the DB cluster permission to access other Amazon Web Services on your behalf. For each role, specify a role ARN and, optionally, the feature name (such as s3Import, s3Export, or Lambda).

availability_zones instance-attribute
availability_zones: Sequence[str] | None

A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

backtrack_window instance-attribute
backtrack_window: int | None

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Note

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).
backup_retention_period instance-attribute
backup_retention_period: int | None

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
character_set_name instance-attribute
character_set_name: str | None

A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

copy_tags_to_snapshot instance-attribute
copy_tags_to_snapshot: bool | None

Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

database_name instance-attribute
database_name: str | None

The database name for the restored DB cluster.

db_cluster_identifier instance-attribute
db_cluster_identifier: Required[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

db_cluster_parameter_group_name instance-attribute
db_cluster_parameter_group_name: str | None

The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, the default parameter group for the engine version is used.

Constraints:

  • If supplied, must match the name of an existing DBClusterParameterGroup.
db_subnet_group_name instance-attribute
db_subnet_group_name: str | None

A DB subnet group to associate with the restored DB cluster.

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

Example: mydbsubnetgroup

deletion_protection instance-attribute
deletion_protection: bool | None

Specifies whether to enable deletion protection for the DB cluster. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.

domain instance-attribute
domain: str | None

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.

domain_iam_role_name instance-attribute
domain_iam_role_name: str | None

Specify the name of the IAM role to be used when making API calls to the Directory Service.

enable_cloudwatch_logs_exports instance-attribute
enable_cloudwatch_logs_exports: Sequence[str] | None

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, instance, slowquery, and iam-db-auth-error.

Aurora PostgreSQL

Possible value are instance, postgresql, and iam-db-auth-error.

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

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

enable_iam_database_authentication instance-attribute
enable_iam_database_authentication: bool | None

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, see IAM Database Authentication in the Amazon Aurora User Guide.

engine instance-attribute
engine: Required[str]

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

Valid Values: aurora-mysql (for Aurora MySQL)

engine_lifecycle_support instance-attribute
engine_lifecycle_support: str | None

The lifecycle type for this DB cluster.

Note

By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster 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 cluster 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 cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

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

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

Default: open-source-rds-extended-support

engine_version instance-attribute
engine_version: str | None

The version number of the database engine to use.

To list all of the available engine versions for aurora-mysql (Aurora MySQL), use the following command:

aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

Aurora MySQL

Examples: 5.7.mysql_aurora.2.12.0, 8.0.mysql_aurora.3.04.0

kms_key_id instance-attribute
kms_key_id: str | None

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.

manage_master_user_password instance-attribute
manage_master_user_password: bool | None

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 and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.

Constraints:

  • Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
master_user_password instance-attribute
master_user_password: str | None

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.

  • Can't be specified if ManageMasterUserPassword is turned on.

master_user_secret_kms_key_id instance-attribute
master_user_secret_kms_key_id: str | None

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

master_username instance-attribute
master_username: Required[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.

network_type instance-attribute
network_type: str | None

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.

option_group_name instance-attribute
option_group_name: str | None

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.

port instance-attribute
port: int | None

The port number on which the instances in the restored DB cluster accept connections.

Default: 3306

preferred_backup_window instance-attribute
preferred_backup_window: str | None

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.

preferred_maintenance_window instance-attribute
preferred_maintenance_window: str | None

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.

s3_bucket_name instance-attribute
s3_bucket_name: Required[str]

The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

s3_ingestion_role_arn instance-attribute
s3_ingestion_role_arn: Required[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.

s3_prefix instance-attribute
s3_prefix: str | None

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.

serverless_v2_scaling_configuration instance-attribute
serverless_v2_scaling_configuration: ServerlessV2ScalingConfiguration | ServerlessV2ScalingConfigurationDict | None

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.

source_engine instance-attribute
source_engine: Required[str]

The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.

Valid Values: mysql

source_engine_version instance-attribute
source_engine_version: Required[str]

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

MySQL versions 5.7 and 8.0 are supported.

Example: 5.7.40, 8.0.28

storage_encrypted instance-attribute
storage_encrypted: bool | None

Specifies whether the restored DB cluster is encrypted.

storage_type instance-attribute
storage_type: str | None

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

Valid Values: aurora, aurora-iopt1

Default: aurora

Valid for: Aurora DB clusters only

tag_specifications instance-attribute
tag_specifications: Sequence[TagSpecification | TagSpecificationDict] | None

Tags to assign to resources associated with the DB cluster.

Valid Values:

  • cluster-auto-backup - The DB cluster's automated backup.
tags instance-attribute
tags: Sequence[Tag | TagDict] | None

A list of tags.

For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

vpc_security_group_ids instance-attribute
vpc_security_group_ids: Sequence[str] | None

A list of EC2 VPC security groups to associate with the restored DB cluster.

Output

RestoreDBClusterFromS3Output dataclass

Bases: _SerdeShape

Dataclass for RestoreDBClusterFromS3Output structure.

Attributes

db_cluster class-attribute instance-attribute
db_cluster: DBCluster | None = ...

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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.