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

Class: Aws::Redshift::Types::RestoreFromClusterSnapshotMessage

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

Overview

Note:

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

{
  cluster_identifier: "String", # required
  snapshot_identifier: "String", # required
  snapshot_cluster_identifier: "String",
  port: 1,
  availability_zone: "String",
  allow_version_upgrade: false,
  cluster_subnet_group_name: "String",
  publicly_accessible: false,
  owner_account: "String",
  hsm_client_certificate_identifier: "String",
  hsm_configuration_identifier: "String",
  elastic_ip: "String",
  cluster_parameter_group_name: "String",
  cluster_security_groups: ["String"],
  vpc_security_group_ids: ["String"],
  preferred_maintenance_window: "String",
  automated_snapshot_retention_period: 1,
  manual_snapshot_retention_period: 1,
  kms_key_id: "String",
  node_type: "String",
  enhanced_vpc_routing: false,
  additional_info: "String",
  iam_roles: ["String"],
  maintenance_track_name: "String",
  snapshot_schedule_identifier: "String",
  number_of_nodes: 1,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#additional_info ⇒ String

Reserved.

Returns:

  • (String) —

    Reserved.

#allow_version_upgrade ⇒ Boolean

If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

Default: true

Returns:

  • (Boolean) —

    If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

#automated_snapshot_retention_period ⇒ Integer

The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.

Default: The value selected for the cluster from which the snapshot was taken.

Constraints: Must be a value from 0 to 35.

Returns:

  • (Integer) —

    The number of days that automated snapshots are retained.

#availability_zone ⇒ String

The Amazon EC2 Availability Zone in which to restore the cluster.

Default: A random, system-chosen Availability Zone.

Example: us-east-2a

Returns:

  • (String) —

    The Amazon EC2 Availability Zone in which to restore the cluster.

#cluster_identifier ⇒ String

The identifier of the cluster that will be created from restoring the snapshot.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • Alphabetic characters must be lowercase.

  • First character must be a letter.

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

  • Must be unique for all clusters within an AWS account.

Returns:

  • (String) —

    The identifier of the cluster that will be created from restoring the snapshot.

#cluster_parameter_group_name ⇒ String

The name of the parameter group to be associated with this cluster.

Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups.

Constraints:

  • Must be 1 to 255 alphanumeric characters or hyphens.

  • First character must be a letter.

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

Returns:

  • (String) —

    The name of the parameter group to be associated with this cluster.

#cluster_security_groups ⇒ Array<String>

A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

Cluster security groups only apply to clusters outside of VPCs.

Returns:

  • (Array<String>) —

    A list of security groups to be associated with this cluster.

#cluster_subnet_group_name ⇒ String

The name of the subnet group where you want to cluster restored.

A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.

Returns:

  • (String) —

    The name of the subnet group where you want to cluster restored.

#elastic_ip ⇒ String

The elastic IP (EIP) address for the cluster.

Returns:

  • (String) —

    The elastic IP (EIP) address for the cluster.

#enhanced_vpc_routing ⇒ Boolean

An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

If this option is true, enhanced VPC routing is enabled.

Default: false

Returns:

  • (Boolean) —

    An option that specifies whether to create the cluster with enhanced VPC routing enabled.

#hsm_client_certificate_identifier ⇒ String

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

Returns:

  • (String) —

    Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

#hsm_configuration_identifier ⇒ String

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

Returns:

  • (String) —

    Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

#iam_roles ⇒ Array<String>

A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.

A cluster can have up to 10 IAM roles associated at any time.

Returns:

  • (Array<String>) —

    A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.

#kms_key_id ⇒ String

The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster that you restore from a shared snapshot.

Returns:

  • (String) —

    The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster that you restore from a shared snapshot.

#maintenance_track_name ⇒ String

The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the MaintenanceTrack value from the cluster. The snapshot might be on a different track than the cluster that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source cluster are on different tracks.

Returns:

  • (String) —

    The name of the maintenance track for the restored cluster.

#manual_snapshot_retention_period ⇒ Integer

The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn\'t change the retention period of existing snapshots.

The value must be either -1 or an integer between 1 and 3,653.

Returns:

  • (Integer) —

    The default number of days to retain a manual snapshot.

#node_type ⇒ String

The node type that the restored cluster will be provisioned with.

Default: The node type of the cluster from which the snapshot was taken. You can modify this if you are using any DS node type. In that case, you can choose to restore into another DS node type of the same size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or ds1.xlarge into ds2.xlarge. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc1.large instance type into another dc1.large instance type or dc2.large instance type. You can\'t restore dc1.8xlarge to dc2.8xlarge. First restore to a dc1.8xlarge cluster, then resize to a dc2.8large cluster. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide.

Returns:

  • (String) —

    The node type that the restored cluster will be provisioned with.

#number_of_nodes ⇒ Integer

The number of nodes specified when provisioning the restored cluster.

Returns:

  • (Integer) —

    The number of nodes specified when provisioning the restored cluster.

#owner_account ⇒ String

The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.

Returns:

  • (String) —

    The AWS customer account used to create or copy the snapshot.

#port ⇒ Integer

The port number on which the cluster accepts connections.

Default: The same port as the original cluster.

Constraints: Must be between 1115 and 65535.

Returns:

  • (Integer) —

    The port number on which the cluster accepts connections.

#preferred_maintenance_window ⇒ String

The weekly time range (in UTC) during which automated cluster maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi

Default: The value selected for the cluster from which the snapshot was taken. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Minimum 30-minute window.

Returns:

  • (String) —

    The weekly time range (in UTC) during which automated cluster maintenance can occur.

#publicly_accessible ⇒ Boolean

If true, the cluster can be accessed from a public network.

Returns:

  • (Boolean) —

    If true, the cluster can be accessed from a public network.

#snapshot_cluster_identifier ⇒ String

The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

Returns:

  • (String) —

    The name of the cluster the source snapshot was created from.

#snapshot_identifier ⇒ String

The name of the snapshot from which to create the new cluster. This parameter isn\'t case sensitive.

Example: my-snapshot-id

Returns:

  • (String) —

    The name of the snapshot from which to create the new cluster.

#snapshot_schedule_identifier ⇒ String

A unique identifier for the snapshot schedule.

Returns:

  • (String) —

    A unique identifier for the snapshot schedule.

#vpc_security_group_ids ⇒ Array<String>

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Default: The default VPC security group is associated with the cluster.

VPC security groups only apply to clusters in VPCs.

Returns:

  • (Array<String>) —

    A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.