class Aws::Redshift::Types::RestoreFromClusterSnapshotMessage

@note When making an API call, you may pass RestoreFromClusterSnapshotMessage

data as a 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,
      availability_zone_relocation: false,
      aqua_configuration_status: "enabled", # accepts enabled, disabled, auto
    }

@!attribute [rw] cluster_identifier

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 Amazon Web Services
  account.
@return [String]

@!attribute [rw] snapshot_identifier

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

Example: `my-snapshot-id`
@return [String]

@!attribute [rw] snapshot_cluster_identifier

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.
@return [String]

@!attribute [rw] port

The port number on which the cluster accepts connections.

Default: The same port as the original cluster.

Constraints: Must be between `1115` and `65535`.
@return [Integer]

@!attribute [rw] availability_zone

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

Default: A random, system-chosen Availability Zone.

Example: `us-east-2a`
@return [String]

@!attribute [rw] allow_version_upgrade

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`
@return [Boolean]

@!attribute [rw] cluster_subnet_group_name

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.
@return [String]

@!attribute [rw] publicly_accessible

If `true`, the cluster can be accessed from a public network.
@return [Boolean]

@!attribute [rw] owner_account

The Amazon Web Services 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.
@return [String]

@!attribute [rw] hsm_client_certificate_identifier

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

@!attribute [rw] hsm_configuration_identifier

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.
@return [String]

@!attribute [rw] elastic_ip

The elastic IP (EIP) address for the cluster.
@return [String]

@!attribute [rw] cluster_parameter_group_name

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][1].

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.

[1]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html
@return [String]

@!attribute [rw] cluster_security_groups

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.
@return [Array<String>]

@!attribute [rw] vpc_security_group_ids

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.
@return [Array<String>]

@!attribute [rw] preferred_maintenance_window

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][1] in Amazon Redshift Cluster
Management Guide.

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

Constraints: Minimum 30-minute window.

[1]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows
@return [String]

@!attribute [rw] automated_snapshot_retention_period

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.

You can't disable automated snapshots for RA3 node types. Set the
automated retention period from 1-35 days.

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

Constraints: Must be a value from 0 to 35.
@return [Integer]

@!attribute [rw] manual_snapshot_retention_period

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.
@return [Integer]

@!attribute [rw] kms_key_id

The 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.
@return [String]

@!attribute [rw] node_type

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][1] in
the *Amazon Redshift Cluster Management Guide*.

[1]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-about-clusters-and-nodes
@return [String]

@!attribute [rw] enhanced_vpc_routing

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][1] in the Amazon Redshift Cluster Management
Guide.

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

Default: false

[1]: https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html
@return [Boolean]

@!attribute [rw] additional_info

Reserved.
@return [String]

@!attribute [rw] iam_roles

A list of Identity and Access Management (IAM) roles that can be
used by the cluster to access other Amazon Web Services 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.
@return [Array<String>]

@!attribute [rw] maintenance_track_name

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.
@return [String]

@!attribute [rw] snapshot_schedule_identifier

A unique identifier for the snapshot schedule.
@return [String]

@!attribute [rw] number_of_nodes

The number of nodes specified when provisioning the restored
cluster.
@return [Integer]

@!attribute [rw] availability_zone_relocation

The option to enable relocation for an Amazon Redshift cluster
between Availability Zones after the cluster is restored.
@return [Boolean]

@!attribute [rw] aqua_configuration_status

The value represents how the cluster is configured to use AQUA
(Advanced Query Accelerator) after the cluster is restored. Possible
values include the following.

* enabled - Use AQUA if it is available for the current Amazon Web
  Services Region and Amazon Redshift node type.

* disabled - Don't use AQUA.

* auto - Amazon Redshift determines whether to use AQUA.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/RestoreFromClusterSnapshotMessage AWS API Documentation

Constants

SENSITIVE