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

Inherits:

Struct

Object
Struct
Aws::Redshift::Types::RestoreFromClusterSnapshotMessage

show all

Defined in:: gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#additional_info ⇒ 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.
#aqua_configuration_status ⇒ String
This parameter is retired.
#automated_snapshot_retention_period ⇒ Integer
The number of days that automated snapshots are retained.
#availability_zone ⇒ String
The Amazon EC2 Availability Zone in which to restore the cluster.
#availability_zone_relocation ⇒ Boolean
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is restored.
#cluster_identifier ⇒ 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.
#cluster_security_groups ⇒ 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.
#default_iam_role_arn ⇒ String
The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last modified while it was restored from a snapshot.
#elastic_ip ⇒ String
The Elastic IP (EIP) address for the cluster.
#encrypted ⇒ Boolean
Enables support for restoring an unencrypted snapshot to a cluster encrypted with Key Management Service (KMS) and a customer managed key.
#enhanced_vpc_routing ⇒ 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.
#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.
#iam_roles ⇒ Array<String>
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
#ip_address_type ⇒ String
The IP address type for the cluster.
#kms_key_id ⇒ String
The Key Management Service (KMS) key ID of the encryption key that encrypts data in the cluster restored from a shared snapshot.
#maintenance_track_name ⇒ String
The name of the maintenance track for the restored cluster.
#manage_master_password ⇒ Boolean
If true, Amazon Redshift uses Secrets Manager to manage the restored cluster's admin credentials.
#manual_snapshot_retention_period ⇒ Integer
The default number of days to retain a manual snapshot.
#master_password_secret_kms_key_id ⇒ String
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
#multi_az ⇒ Boolean
If true, the snapshot will be restored to a cluster deployed in two Availability Zones.
#node_type ⇒ 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.
#owner_account ⇒ String
The Amazon Web Services account used to create or copy the snapshot.
#port ⇒ 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.
#publicly_accessible ⇒ Boolean
If true, the cluster can be accessed from a public network.
#reserved_node_id ⇒ String
The identifier of the target reserved node offering.
#snapshot_arn ⇒ String
The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster.
#snapshot_cluster_identifier ⇒ 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.
#snapshot_schedule_identifier ⇒ String
A unique identifier for the snapshot schedule.
#target_reserved_node_offering_id ⇒ String
The identifier of the target reserved node offering.
#vpc_security_group_ids ⇒ Array<String>
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Instance Attribute Details

#additional_info ⇒ `String`

Reserved.

Returns:

(String)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

#aqua_configuration_status ⇒ `String`

This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

Returns:

(String)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

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

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.

Returns:

(Integer)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone_relocation ⇒ `Boolean`

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is restored.

Returns:

(Boolean)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

#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 Amazon Web Services account.

Returns:

(String)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

#default_iam_role_arn ⇒ `String`

The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last modified while it was restored from a snapshot.

Returns:

(String)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

#elastic_ip ⇒ `String`

The Elastic IP (EIP) address for the cluster. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on.

Returns:

(String)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

#encrypted ⇒ `Boolean`

Enables support for restoring an unencrypted snapshot to a cluster encrypted with Key Management Service (KMS) and a customer managed key.

Returns:

(Boolean)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

#iam_roles ⇒ `Array<String>`

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.

The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.

Returns:

(Array<String>)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

#ip_address_type ⇒ `String`

The IP address type for the cluster. Possible values are ipv4 and dualstack.

Returns:

(String)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ `String`

The Key Management Service (KMS) key ID of the encryption key that encrypts data in the cluster restored from a shared snapshot. You can also provide the key ID when you restore from an unencrypted snapshot to an encrypted cluster in the same account. Additionally, you can specify a new KMS key ID when you restore from an encrypted snapshot in the same account in order to change it. In that case, the restored cluster is encrypted with the new KMS key ID.

Returns:

(String)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

#manage_master_password ⇒ `Boolean`

If true, Amazon Redshift uses Secrets Manager to manage the restored cluster's admin credentials. If ManageMasterPassword is false or not set, Amazon Redshift uses the admin credentials the cluster had at the time the snapshot was taken.

Returns:

(Boolean)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

#master_password_secret_kms_key_id ⇒ `String`

The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. You can only use this parameter if ManageMasterPassword is true.

Returns:

(String)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

#multi_az ⇒ `Boolean`

If true, the snapshot will be restored to a cluster deployed in two Availability Zones.

Returns:

(Boolean)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

#node_type ⇒ `String`

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

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 dc2.large node type into another dc2 type. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide.

Returns:

(String)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_nodes ⇒ `Integer`

The number of nodes specified when provisioning the restored cluster.

Returns:

(Integer)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

#owner_account ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ `Integer`

The port number on which the cluster accepts connections.

Default: The same port as the original cluster.

Valid values: For clusters with DC2 nodes, must be within the range 1150-65535. For clusters with ra3 nodes, must be within the ranges 5431-5455 or 8191-8215.

Returns:

(Integer)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_accessible ⇒ `Boolean`

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

Default: false

Returns:

(Boolean)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

#reserved_node_id ⇒ `String`

The identifier of the target reserved node offering.

Returns:

(String)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_arn ⇒ `String`

The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster. You must specify this parameter or snapshotIdentifier, but not both.

Returns:

(String)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_identifier ⇒ `String`

The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. You must specify this parameter or snapshotArn, but not both.

Example: my-snapshot-id

Returns:

(String)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_schedule_identifier ⇒ `String`

A unique identifier for the snapshot schedule.

Returns:

(String)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

#target_reserved_node_offering_id ⇒ `String`

The identifier of the target reserved node offering.

Returns:

(String)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 10849

class RestoreFromClusterSnapshotMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :snapshot_cluster_identifier,
  :port,
  :availability_zone,
  :allow_version_upgrade,
  :cluster_subnet_group_name,
  :publicly_accessible,
  :owner_account,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :cluster_parameter_group_name,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :kms_key_id,
  :node_type,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :number_of_nodes,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :reserved_node_id,
  :target_reserved_node_offering_id,
  :encrypted,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#additional_info ⇒ String

#allow_version_upgrade ⇒ Boolean

#aqua_configuration_status ⇒ String

#automated_snapshot_retention_period ⇒ Integer

#availability_zone ⇒ String

#availability_zone_relocation ⇒ Boolean

#cluster_identifier ⇒ String

#cluster_parameter_group_name ⇒ String

#cluster_security_groups ⇒ Array<String>

#cluster_subnet_group_name ⇒ String

#default_iam_role_arn ⇒ String

#elastic_ip ⇒ String

#encrypted ⇒ Boolean

#enhanced_vpc_routing ⇒ Boolean

#hsm_client_certificate_identifier ⇒ String

#hsm_configuration_identifier ⇒ String

#iam_roles ⇒ Array<String>

#ip_address_type ⇒ String

#kms_key_id ⇒ String

#maintenance_track_name ⇒ String

#manage_master_password ⇒ Boolean

#manual_snapshot_retention_period ⇒ Integer

#master_password_secret_kms_key_id ⇒ String

#multi_az ⇒ Boolean

#node_type ⇒ String

#number_of_nodes ⇒ Integer

#owner_account ⇒ String

#port ⇒ Integer

#preferred_maintenance_window ⇒ String

#publicly_accessible ⇒ Boolean

#reserved_node_id ⇒ String

#snapshot_arn ⇒ String

#snapshot_cluster_identifier ⇒ String

#snapshot_identifier ⇒ String

#snapshot_schedule_identifier ⇒ String

#target_reserved_node_offering_id ⇒ String

#vpc_security_group_ids ⇒ Array<String>

#additional_info ⇒ `String`

#allow_version_upgrade ⇒ `Boolean`

#aqua_configuration_status ⇒ `String`

#automated_snapshot_retention_period ⇒ `Integer`

#availability_zone ⇒ `String`

#availability_zone_relocation ⇒ `Boolean`

#cluster_identifier ⇒ `String`

#cluster_parameter_group_name ⇒ `String`

#cluster_security_groups ⇒ `Array<String>`

#cluster_subnet_group_name ⇒ `String`

#default_iam_role_arn ⇒ `String`

#elastic_ip ⇒ `String`

#encrypted ⇒ `Boolean`

#enhanced_vpc_routing ⇒ `Boolean`

#hsm_client_certificate_identifier ⇒ `String`

#hsm_configuration_identifier ⇒ `String`

#iam_roles ⇒ `Array<String>`

#ip_address_type ⇒ `String`

#kms_key_id ⇒ `String`

#maintenance_track_name ⇒ `String`

#manage_master_password ⇒ `Boolean`

#manual_snapshot_retention_period ⇒ `Integer`

#master_password_secret_kms_key_id ⇒ `String`

#multi_az ⇒ `Boolean`

#node_type ⇒ `String`

#number_of_nodes ⇒ `Integer`

#owner_account ⇒ `String`

#port ⇒ `Integer`

#preferred_maintenance_window ⇒ `String`

#publicly_accessible ⇒ `Boolean`

#reserved_node_id ⇒ `String`

#snapshot_arn ⇒ `String`

#snapshot_cluster_identifier ⇒ `String`

#snapshot_identifier ⇒ `String`

#snapshot_schedule_identifier ⇒ `String`

#target_reserved_node_offering_id ⇒ `String`

#vpc_security_group_ids ⇒ `Array<String>`