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

Class: Aws::RDS::Types::RestoreDBInstanceFromS3Message

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

Overview

Note:

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

{
  db_name: "String",
  db_instance_identifier: "String", # required
  allocated_storage: 1,
  db_instance_class: "String", # required
  engine: "String", # required
  master_username: "String",
  master_user_password: "String",
  db_security_groups: ["String"],
  vpc_security_group_ids: ["String"],
  availability_zone: "String",
  db_subnet_group_name: "String",
  preferred_maintenance_window: "String",
  db_parameter_group_name: "String",
  backup_retention_period: 1,
  preferred_backup_window: "String",
  port: 1,
  multi_az: false,
  engine_version: "String",
  auto_minor_version_upgrade: false,
  license_model: "String",
  iops: 1,
  option_group_name: "String",
  publicly_accessible: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  storage_type: "String",
  storage_encrypted: false,
  kms_key_id: "String",
  copy_tags_to_snapshot: false,
  monitoring_interval: 1,
  monitoring_role_arn: "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
  enable_performance_insights: false,
  performance_insights_kms_key_id: "String",
  performance_insights_retention_period: 1,
  enable_cloudwatch_logs_exports: ["String"],
  processor_features: [
    {
      name: "String",
      value: "String",
    },
  ],
  use_default_processor_features: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_storageInteger

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.

Returns:

  • (Integer)

    The amount of storage (in gigabytes) to allocate initially for the DB instance.

#auto_minor_version_upgradeBoolean

True to indicate that minor engine upgrades are applied automatically to the DB instance during the maintenance window, and otherwise false.

Default: true

Returns:

  • (Boolean)

    True to indicate that minor engine upgrades are applied automatically to the DB instance during the maintenance window, and otherwise false.

#availability_zoneString

The Availability Zone that the DB instance is created in. For information about AWS Regions and Availability Zones, see Regions and Availability Zones.

Default: A random, system-chosen Availability Zone in the endpoint\'s AWS Region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter can\'t be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint.

Returns:

  • (String)

    The Availability Zone that the DB instance is created in.

#backup_retention_periodInteger

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

Returns:

  • (Integer)

    The number of days for which automated backups are retained.

#copy_tags_to_snapshotBoolean

True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false.

Default: false.

Returns:

  • (Boolean)

    True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false.

#db_instance_classString

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS 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 is not supported on the db.t2.micro DB instance class.

Returns:

  • (String)

    The compute and memory capacity of the DB instance, for example, db.m4.large.

#db_instance_identifierString

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.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

Returns:

  • (String)

    The DB instance identifier.

#db_nameString

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

Returns:

  • (String)

    The name of the database to create when the DB instance is created.

#db_parameter_group_nameString

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

Returns:

  • (String)

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

#db_security_groupsArray<String>

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

Default: The default DB security group for the database engine.

Returns:

  • (Array<String>)

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

#db_subnet_group_nameString

A DB subnet group to associate with this DB instance.

Returns:

  • (String)

    A DB subnet group to associate with this DB instance.

#enable_cloudwatch_logs_exportsArray<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 Relational Database Service User Guide.

Returns:

  • (Array<String>)

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

#enable_iam_database_authenticationBoolean

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

Returns:

  • (Boolean)

    True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

#enable_performance_insightsBoolean

True to enable Performance Insights for the DB instance, and otherwise false.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

Returns:

  • (Boolean)

    True to enable Performance Insights for the DB instance, and otherwise false.

#engineString

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

Valid Values: mysql

Returns:

  • (String)

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

#engine_versionString

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.

Returns:

  • (String)

    The version number of the database engine to use.

#iopsInteger

The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid Iops values, see see Amazon RDS Provisioned IOPS Storage to Improve Performance.

Returns:

  • (Integer)

    The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance.

#kms_key_idString

The AWS KMS key identifier for an encrypted DB instance.

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

If the StorageEncrypted parameter is true, 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 instance.

#license_modelString

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

Returns:

  • (String)

    The license model for this DB instance.

#master_user_passwordString

The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

Constraints: Must contain from 8 to 41 characters.

Returns:

  • (String)

    The password for the master user.

#master_usernameString

The name for the master user.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

  • Cannot be a reserved word for the chosen database engine.

Returns:

  • (String)

    The name for the master user.

#monitoring_intervalInteger

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

Returns:

  • (Integer)

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

#monitoring_role_arnString

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.

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

Returns:

  • (String)

    The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.

#multi_azBoolean

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

Returns:

  • (Boolean)

    Specifies whether the DB instance is a Multi-AZ deployment.

#option_group_nameString

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.

Returns:

  • (String)

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

#performance_insights_kms_key_idString

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key.

Returns:

  • (String)

    The AWS KMS key identifier for encryption of Performance Insights data.

#performance_insights_retention_periodInteger

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

Returns:

  • (Integer)

    The amount of time, in days, to retain Performance Insights data.

#portInteger

The port number on which the database accepts connections.

Type: Integer

Valid Values: 1150-65535

Default: 3306

Returns:

  • (Integer)

    The port number on which the database accepts connections.

#preferred_backup_windowString

The time range each day during which automated backups are created if automated backups are enabled. For more information, see The Backup Window.

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 time range each day during which automated backups are created if automated backups are enabled.

#preferred_maintenance_windowString

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

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.

Returns:

  • (String)

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

#processor_featuresArray<Types::ProcessorFeature>

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

Returns:

  • (Array<Types::ProcessorFeature>)

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

#publicly_accessibleBoolean

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

Returns:

  • (Boolean)

    Specifies the accessibility options for the DB instance.

#s3_bucket_nameString

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

Returns:

  • (String)

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

#s3_ingestion_role_arnString

An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.

Returns:

  • (String)

    An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.

#s3_prefixString

The prefix of your Amazon S3 bucket.

Returns:

  • (String)

    The prefix of your Amazon S3 bucket.

#source_engineString

The name of the engine of your source database.

Valid Values: mysql

Returns:

  • (String)

    The name of the engine of your source database.

#source_engine_versionString

The engine version of your source database.

Valid Values: 5.6

Returns:

  • (String)

    The engine version of your source database.

#storage_encryptedBoolean

Specifies whether the new DB instance is encrypted or not.

Returns:

  • (Boolean)

    Specifies whether the new DB instance is encrypted or not.

#storage_typeString

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 standard

Returns:

  • (String)

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

#tagsArray<Types::Tag>

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

Returns:

  • (Array<Types::Tag>)

    A list of tags to associate with this DB instance.

#use_default_processor_featuresBoolean

A value that specifies that the DB instance class of the DB instance uses its default processor features.

Returns:

  • (Boolean)

    A value that specifies that the DB instance class of the DB instance uses its default processor features.

#vpc_security_group_idsArray<String>

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

Returns:

  • (Array<String>)

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