You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::RDS::Types::RestoreDBClusterFromS3Message

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing RestoreDBClusterFromS3Message as input to an Aws::Client method, you can use a vanilla Hash:

{
  availability_zones: ["String"],
  backup_retention_period: 1,
  character_set_name: "String",
  database_name: "String",
  db_cluster_identifier: "String", # required
  db_cluster_parameter_group_name: "String",
  vpc_security_group_ids: ["String"],
  db_subnet_group_name: "String",
  engine: "String", # required
  engine_version: "String",
  port: 1,
  master_username: "String", # required
  master_user_password: "String", # required
  option_group_name: "String",
  preferred_backup_window: "String",
  preferred_maintenance_window: "String",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  storage_encrypted: false,
  kms_key_id: "String",
  enable_iam_database_authentication: false,
  source_engine: "String", # required
  source_engine_version: "String", # required
  s3_bucket_name: "String", # required
  s3_prefix: "String",
  s3_ingestion_role_arn: "String", # required
  backtrack_window: 1,
  enable_cloudwatch_logs_exports: ["String"],
  deletion_protection: false,
  copy_tags_to_snapshot: false,
  domain: "String",
  domain_iam_role_name: "String",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zones ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#backtrack_window ⇒ Integer

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

^

Returns:

  • (Integer) —

    The target backtrack window, in seconds.

#backup_retention_period ⇒ Integer

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

^

Returns:

  • (Integer) —

    The number of days for which automated backups of the restored DB cluster are retained.

#character_set_name ⇒ String

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

Returns:

  • (String) —

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

#copy_tags_to_snapshot ⇒ Boolean

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.

Returns:

  • (Boolean) —

    A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster.

#database_name ⇒ String

The database name for the restored DB cluster.

Returns:

  • (String) —

    The database name for the restored DB cluster.

#db_cluster_identifier ⇒ String

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

Returns:

  • (String) —

    The name of the DB cluster to create from the source data in the Amazon S3 bucket.

#db_cluster_parameter_group_name ⇒ String

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.

^

Returns:

  • (String) —

    The name of the DB cluster parameter group to associate with the restored DB cluster.

#db_subnet_group_name ⇒ String

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

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

Example: mySubnetgroup

Returns:

  • (String) —

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

#deletion_protection ⇒ Boolean

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

Returns:

  • (Boolean) —

    A value that indicates whether the DB cluster has deletion protection enabled.

#domain ⇒ String

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.

Returns:

  • (String) —

    Specify the Active Directory directory ID to restore the DB cluster in.

#domain_iam_role_name ⇒ String

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

Returns:

  • (String) —

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

#enable_cloudwatch_logs_exports ⇒ Array<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. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

Returns:

  • (Array<String>) —

    The list of logs that the restored DB cluster is to export to CloudWatch Logs.

#enable_iam_database_authentication ⇒ Boolean

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

Returns:

  • (Boolean) —

    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.

#engine ⇒ String

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

Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

Returns:

  • (String) —

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

#engine_version ⇒ String

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 Aurora), use the following command:

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

To list all of the available engine versions for aurora-postgresql, use the following command:

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

Aurora MySQL

Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5

Aurora PostgreSQL

Example: 9.6.3, 10.7

Returns:

  • (String) —

    The version number of the database engine to use.

#kms_key_id ⇒ String

The AWS KMS key identifier for an encrypted DB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key.

If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

Returns:

  • (String) —

    The AWS KMS key identifier for an encrypted DB cluster.

#master_user_password ⇒ String

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.

Returns:

  • (String) —

    The password for the master database user.

#master_username ⇒ String

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.

Returns:

  • (String) —

    The name of the master user for the restored DB cluster.

#option_group_name ⇒ String

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.

Returns:

  • (String) —

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

#port ⇒ Integer

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

Default: 3306

Returns:

  • (Integer) —

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

#preferred_backup_window ⇒ String

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 AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance 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.

Returns:

  • (String) —

    The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

#preferred_maintenance_window ⇒ String

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

Returns:

  • (String) —

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

#s3_bucket_name ⇒ String

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

Returns:

  • (String) —

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

#s3_ingestion_role_arn ⇒ String

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.

#s3_prefix ⇒ String

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.

Returns:

  • (String) —

    The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster.

#source_engine ⇒ String

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

Valid values: mysql

Returns:

  • (String) —

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

#source_engine_version ⇒ String

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

Returns:

  • (String) —

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

#storage_encrypted ⇒ Boolean

A value that indicates whether the restored DB cluster is encrypted.

Returns:

  • (Boolean) —

    A value that indicates whether the restored DB cluster is encrypted.

#tags ⇒ Array<Types::Tag>

A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

Returns:

#vpc_security_group_ids ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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