Amazonka.Redshift.RestoreFromClusterSnapshot

Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the ModifyCluster API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore.

If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

Creating a Request

data RestoreFromClusterSnapshot

See: newRestoreFromClusterSnapshot smart constructor.

Constructors

RestoreFromClusterSnapshot'

Fields

• additionalInfo :: Maybe Text

  Reserved.

• allowVersionUpgrade :: Maybe Bool

  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

• aquaConfigurationStatus :: Maybe AquaConfigurationStatus

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

• automatedSnapshotRetentionPeriod :: Maybe Int

  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.

• availabilityZone :: Maybe Text

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

  Default: A random, system-chosen Availability Zone.

  Example: us-east-2a

• availabilityZoneRelocation :: Maybe Bool

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

• clusterParameterGroupName :: Maybe Text

  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.
• clusterSecurityGroups :: Maybe [Text]

  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.

• clusterSubnetGroupName :: Maybe Text

  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.

• defaultIamRoleArn :: Maybe Text

  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.

• elasticIp :: Maybe Text

  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.

• encrypted :: Maybe Bool

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

• enhancedVpcRouting :: Maybe Bool

  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

• hsmClientCertificateIdentifier :: Maybe Text

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

• hsmConfigurationIdentifier :: Maybe Text

  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.

• iamRoles :: Maybe [Text]

  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.

• kmsKeyId :: Maybe Text

  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.

• maintenanceTrackName :: Maybe Text

  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.

• manualSnapshotRetentionPeriod :: Maybe Int

  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.

• nodeType :: Maybe Text

  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.

• numberOfNodes :: Maybe Int

  The number of nodes specified when provisioning the restored cluster.

• ownerAccount :: Maybe Text

  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.

• port :: Maybe Int

  The port number on which the cluster accepts connections.

  Default: The same port as the original cluster.

  Constraints: Must be between 1115 and 65535.

• preferredMaintenanceWindow :: Maybe Text

  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.

• publiclyAccessible :: Maybe Bool

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

• reservedNodeId :: Maybe Text

  The identifier of the target reserved node offering.

• snapshotArn :: Maybe Text

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

• snapshotClusterIdentifier :: Maybe Text

  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.

• snapshotIdentifier :: Maybe Text

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

  Example: my-snapshot-id

• snapshotScheduleIdentifier :: Maybe Text

  A unique identifier for the snapshot schedule.

• targetReservedNodeOfferingId :: Maybe Text

  The identifier of the target reserved node offering.

• vpcSecurityGroupIds :: Maybe [Text]

  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.

• clusterIdentifier :: Text

  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.

Instances

ToHeaders RestoreFromClusterSnapshot

Defined in Amazonka.Redshift.RestoreFromClusterSnapshot

Methods

toHeaders :: RestoreFromClusterSnapshot -> [Header]

ToPath RestoreFromClusterSnapshot

Defined in Amazonka.Redshift.RestoreFromClusterSnapshot

Methods

toPath :: RestoreFromClusterSnapshot -> ByteString

ToQuery RestoreFromClusterSnapshot

Defined in Amazonka.Redshift.RestoreFromClusterSnapshot

Methods

toQuery :: RestoreFromClusterSnapshot -> QueryString

AWSRequest RestoreFromClusterSnapshot

Defined in Amazonka.Redshift.RestoreFromClusterSnapshot

Associated Types

type AWSResponse RestoreFromClusterSnapshot

Methods

request :: (Service -> Service) -> RestoreFromClusterSnapshot -> Request RestoreFromClusterSnapshot

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RestoreFromClusterSnapshot -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RestoreFromClusterSnapshot)))

Generic RestoreFromClusterSnapshot

Defined in Amazonka.Redshift.RestoreFromClusterSnapshot

Associated Types

type Rep RestoreFromClusterSnapshot :: Type -> Type

Methods

from :: RestoreFromClusterSnapshot -> Rep RestoreFromClusterSnapshot x

to :: Rep RestoreFromClusterSnapshot x -> RestoreFromClusterSnapshot

Read RestoreFromClusterSnapshot

Defined in Amazonka.Redshift.RestoreFromClusterSnapshot

Methods

readsPrec :: Int -> ReadS RestoreFromClusterSnapshot

readList :: ReadS [RestoreFromClusterSnapshot]

readPrec :: ReadPrec RestoreFromClusterSnapshot

readListPrec :: ReadPrec [RestoreFromClusterSnapshot]

Show RestoreFromClusterSnapshot

Defined in Amazonka.Redshift.RestoreFromClusterSnapshot

Methods

showsPrec :: Int -> RestoreFromClusterSnapshot -> ShowS

show :: RestoreFromClusterSnapshot -> String

showList :: [RestoreFromClusterSnapshot] -> ShowS

NFData RestoreFromClusterSnapshot

Defined in Amazonka.Redshift.RestoreFromClusterSnapshot

Methods

rnf :: RestoreFromClusterSnapshot -> ()

Eq RestoreFromClusterSnapshot

Defined in Amazonka.Redshift.RestoreFromClusterSnapshot

Methods

(==) :: RestoreFromClusterSnapshot -> RestoreFromClusterSnapshot -> Bool

(/=) :: RestoreFromClusterSnapshot -> RestoreFromClusterSnapshot -> Bool

Hashable RestoreFromClusterSnapshot

Defined in Amazonka.Redshift.RestoreFromClusterSnapshot

Methods

hashWithSalt :: Int -> RestoreFromClusterSnapshot -> Int

hash :: RestoreFromClusterSnapshot -> Int

type AWSResponse RestoreFromClusterSnapshot

Defined in Amazonka.Redshift.RestoreFromClusterSnapshot

type AWSResponse RestoreFromClusterSnapshot = RestoreFromClusterSnapshotResponse

type Rep RestoreFromClusterSnapshot

Defined in Amazonka.Redshift.RestoreFromClusterSnapshot

type Rep RestoreFromClusterSnapshot = D1 ('MetaData "RestoreFromClusterSnapshot" "Amazonka.Redshift.RestoreFromClusterSnapshot" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "RestoreFromClusterSnapshot'" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "additionalInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "allowVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "aquaConfigurationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AquaConfigurationStatus)) :*: S1 ('MetaSel ('Just "automatedSnapshotRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "availabilityZoneRelocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "clusterParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "clusterSecurityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :*: (((S1 ('MetaSel ('Just "clusterSubnetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "defaultIamRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "elasticIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "encrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "enhancedVpcRouting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "hsmClientCertificateIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "hsmConfigurationIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "iamRoles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))) :*: ((((S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maintenanceTrackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "manualSnapshotRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "nodeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "numberOfNodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "ownerAccount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "publiclyAccessible") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "reservedNodeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "snapshotArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "snapshotClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "snapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "snapshotScheduleIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "targetReservedNodeOfferingId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "vpcSecurityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "clusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))))

newRestoreFromClusterSnapshot

Arguments

:: Text

RestoreFromClusterSnapshot

-> RestoreFromClusterSnapshot

Create a value of RestoreFromClusterSnapshot with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:additionalInfo:RestoreFromClusterSnapshot', restoreFromClusterSnapshot_additionalInfo - Reserved.

RestoreFromClusterSnapshot, restoreFromClusterSnapshot_allowVersionUpgrade - 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

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

RestoreFromClusterSnapshot, restoreFromClusterSnapshot_automatedSnapshotRetentionPeriod - 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.

RestoreFromClusterSnapshot, restoreFromClusterSnapshot_availabilityZone - The Amazon EC2 Availability Zone in which to restore the cluster.

Default: A random, system-chosen Availability Zone.

Example: us-east-2a

$sel:availabilityZoneRelocation:RestoreFromClusterSnapshot', restoreFromClusterSnapshot_availabilityZoneRelocation - The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is restored.

$sel:clusterParameterGroupName:RestoreFromClusterSnapshot', restoreFromClusterSnapshot_clusterParameterGroupName - 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.

RestoreFromClusterSnapshot, restoreFromClusterSnapshot_clusterSecurityGroups - 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.

RestoreFromClusterSnapshot, restoreFromClusterSnapshot_clusterSubnetGroupName - 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.

RestoreFromClusterSnapshot, restoreFromClusterSnapshot_defaultIamRoleArn - 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.

RestoreFromClusterSnapshot, restoreFromClusterSnapshot_elasticIp - 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.

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

RestoreFromClusterSnapshot, restoreFromClusterSnapshot_enhancedVpcRouting - 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

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

RestoreFromClusterSnapshot, restoreFromClusterSnapshot_hsmConfigurationIdentifier - 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.

RestoreFromClusterSnapshot, restoreFromClusterSnapshot_iamRoles - 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.

RestoreFromClusterSnapshot, restoreFromClusterSnapshot_kmsKeyId - 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.

RestoreFromClusterSnapshot, restoreFromClusterSnapshot_maintenanceTrackName - 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.

RestoreFromClusterSnapshot, restoreFromClusterSnapshot_manualSnapshotRetentionPeriod - 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.

RestoreFromClusterSnapshot, restoreFromClusterSnapshot_nodeType - 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.

RestoreFromClusterSnapshot, restoreFromClusterSnapshot_numberOfNodes - The number of nodes specified when provisioning the restored cluster.

RestoreFromClusterSnapshot, restoreFromClusterSnapshot_ownerAccount - 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.

RestoreFromClusterSnapshot, restoreFromClusterSnapshot_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.

RestoreFromClusterSnapshot, restoreFromClusterSnapshot_preferredMaintenanceWindow - 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.

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

RestoreFromClusterSnapshot, restoreFromClusterSnapshot_reservedNodeId - The identifier of the target reserved node offering.

$sel:snapshotArn:RestoreFromClusterSnapshot', restoreFromClusterSnapshot_snapshotArn - The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster. You can specify this parameter or snapshotIdentifier, but not both.

RestoreFromClusterSnapshot, restoreFromClusterSnapshot_snapshotClusterIdentifier - 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.

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

Example: my-snapshot-id

RestoreFromClusterSnapshot, restoreFromClusterSnapshot_snapshotScheduleIdentifier - A unique identifier for the snapshot schedule.

RestoreFromClusterSnapshot, restoreFromClusterSnapshot_targetReservedNodeOfferingId - The identifier of the target reserved node offering.

$sel:vpcSecurityGroupIds:RestoreFromClusterSnapshot', restoreFromClusterSnapshot_vpcSecurityGroupIds - 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.

RestoreFromClusterSnapshot, restoreFromClusterSnapshot_clusterIdentifier - 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.

Request Lenses

restoreFromClusterSnapshot_additionalInfo :: Lens' RestoreFromClusterSnapshot (Maybe Text)

Reserved.

restoreFromClusterSnapshot_allowVersionUpgrade :: Lens' RestoreFromClusterSnapshot (Maybe Bool)

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

restoreFromClusterSnapshot_aquaConfigurationStatus :: Lens' RestoreFromClusterSnapshot (Maybe AquaConfigurationStatus)

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

restoreFromClusterSnapshot_automatedSnapshotRetentionPeriod :: Lens' RestoreFromClusterSnapshot (Maybe Int)

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.

restoreFromClusterSnapshot_availabilityZone :: Lens' RestoreFromClusterSnapshot (Maybe Text)

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

Default: A random, system-chosen Availability Zone.

Example: us-east-2a

restoreFromClusterSnapshot_availabilityZoneRelocation :: Lens' RestoreFromClusterSnapshot (Maybe Bool)

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

restoreFromClusterSnapshot_clusterParameterGroupName :: Lens' RestoreFromClusterSnapshot (Maybe Text)

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.

restoreFromClusterSnapshot_clusterSecurityGroups :: Lens' RestoreFromClusterSnapshot (Maybe [Text])

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.

restoreFromClusterSnapshot_clusterSubnetGroupName :: Lens' RestoreFromClusterSnapshot (Maybe Text)

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.

restoreFromClusterSnapshot_defaultIamRoleArn :: Lens' RestoreFromClusterSnapshot (Maybe Text)

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.

restoreFromClusterSnapshot_elasticIp :: Lens' RestoreFromClusterSnapshot (Maybe Text)

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.

restoreFromClusterSnapshot_encrypted :: Lens' RestoreFromClusterSnapshot (Maybe Bool)

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

restoreFromClusterSnapshot_enhancedVpcRouting :: Lens' RestoreFromClusterSnapshot (Maybe Bool)

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

restoreFromClusterSnapshot_hsmClientCertificateIdentifier :: Lens' RestoreFromClusterSnapshot (Maybe Text)

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

restoreFromClusterSnapshot_hsmConfigurationIdentifier :: Lens' RestoreFromClusterSnapshot (Maybe Text)

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.

restoreFromClusterSnapshot_iamRoles :: Lens' RestoreFromClusterSnapshot (Maybe [Text])

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.

restoreFromClusterSnapshot_kmsKeyId :: Lens' RestoreFromClusterSnapshot (Maybe Text)

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.

restoreFromClusterSnapshot_maintenanceTrackName :: Lens' RestoreFromClusterSnapshot (Maybe Text)

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.

restoreFromClusterSnapshot_manualSnapshotRetentionPeriod :: Lens' RestoreFromClusterSnapshot (Maybe Int)

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.

restoreFromClusterSnapshot_nodeType :: Lens' RestoreFromClusterSnapshot (Maybe Text)

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.

restoreFromClusterSnapshot_numberOfNodes :: Lens' RestoreFromClusterSnapshot (Maybe Int)

The number of nodes specified when provisioning the restored cluster.

restoreFromClusterSnapshot_ownerAccount :: Lens' RestoreFromClusterSnapshot (Maybe Text)

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.

restoreFromClusterSnapshot_port :: Lens' RestoreFromClusterSnapshot (Maybe Int)

The port number on which the cluster accepts connections.

Default: The same port as the original cluster.

Constraints: Must be between 1115 and 65535.

restoreFromClusterSnapshot_preferredMaintenanceWindow :: Lens' RestoreFromClusterSnapshot (Maybe Text)

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.

restoreFromClusterSnapshot_publiclyAccessible :: Lens' RestoreFromClusterSnapshot (Maybe Bool)

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

restoreFromClusterSnapshot_reservedNodeId :: Lens' RestoreFromClusterSnapshot (Maybe Text)

The identifier of the target reserved node offering.

restoreFromClusterSnapshot_snapshotArn :: Lens' RestoreFromClusterSnapshot (Maybe Text)

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

restoreFromClusterSnapshot_snapshotClusterIdentifier :: Lens' RestoreFromClusterSnapshot (Maybe Text)

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.

restoreFromClusterSnapshot_snapshotIdentifier :: Lens' RestoreFromClusterSnapshot (Maybe Text)

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

Example: my-snapshot-id

restoreFromClusterSnapshot_snapshotScheduleIdentifier :: Lens' RestoreFromClusterSnapshot (Maybe Text)

A unique identifier for the snapshot schedule.

restoreFromClusterSnapshot_targetReservedNodeOfferingId :: Lens' RestoreFromClusterSnapshot (Maybe Text)

The identifier of the target reserved node offering.

restoreFromClusterSnapshot_vpcSecurityGroupIds :: Lens' RestoreFromClusterSnapshot (Maybe [Text])

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.

restoreFromClusterSnapshot_clusterIdentifier :: Lens' RestoreFromClusterSnapshot Text

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.

Destructuring the Response

data RestoreFromClusterSnapshotResponse

See: newRestoreFromClusterSnapshotResponse smart constructor.

Constructors

RestoreFromClusterSnapshotResponse'

Fields

• cluster :: Maybe Cluster
• httpStatus :: Int

  The response's http status code.

Instances

Generic RestoreFromClusterSnapshotResponse

Defined in Amazonka.Redshift.RestoreFromClusterSnapshot

Associated Types

type Rep RestoreFromClusterSnapshotResponse :: Type -> Type

Methods

from :: RestoreFromClusterSnapshotResponse -> Rep RestoreFromClusterSnapshotResponse x

to :: Rep RestoreFromClusterSnapshotResponse x -> RestoreFromClusterSnapshotResponse

Read RestoreFromClusterSnapshotResponse

Defined in Amazonka.Redshift.RestoreFromClusterSnapshot

Methods

readsPrec :: Int -> ReadS RestoreFromClusterSnapshotResponse

readList :: ReadS [RestoreFromClusterSnapshotResponse]

readPrec :: ReadPrec RestoreFromClusterSnapshotResponse

readListPrec :: ReadPrec [RestoreFromClusterSnapshotResponse]

Show RestoreFromClusterSnapshotResponse

Defined in Amazonka.Redshift.RestoreFromClusterSnapshot

Methods

showsPrec :: Int -> RestoreFromClusterSnapshotResponse -> ShowS

show :: RestoreFromClusterSnapshotResponse -> String

showList :: [RestoreFromClusterSnapshotResponse] -> ShowS

NFData RestoreFromClusterSnapshotResponse

Defined in Amazonka.Redshift.RestoreFromClusterSnapshot

Methods

rnf :: RestoreFromClusterSnapshotResponse -> ()

Eq RestoreFromClusterSnapshotResponse

Defined in Amazonka.Redshift.RestoreFromClusterSnapshot

Methods

(==) :: RestoreFromClusterSnapshotResponse -> RestoreFromClusterSnapshotResponse -> Bool

(/=) :: RestoreFromClusterSnapshotResponse -> RestoreFromClusterSnapshotResponse -> Bool

type Rep RestoreFromClusterSnapshotResponse

Defined in Amazonka.Redshift.RestoreFromClusterSnapshot

type Rep RestoreFromClusterSnapshotResponse = D1 ('MetaData "RestoreFromClusterSnapshotResponse" "Amazonka.Redshift.RestoreFromClusterSnapshot" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "RestoreFromClusterSnapshotResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Cluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRestoreFromClusterSnapshotResponse

Arguments

:: Int

$sel:httpStatus:RestoreFromClusterSnapshotResponse'

-> RestoreFromClusterSnapshotResponse

Create a value of RestoreFromClusterSnapshotResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cluster:RestoreFromClusterSnapshotResponse', restoreFromClusterSnapshotResponse_cluster - Undocumented member.

$sel:httpStatus:RestoreFromClusterSnapshotResponse', restoreFromClusterSnapshotResponse_httpStatus - The response's http status code.

Response Lenses

restoreFromClusterSnapshotResponse_cluster :: Lens' RestoreFromClusterSnapshotResponse (Maybe Cluster)

Undocumented member.

restoreFromClusterSnapshotResponse_httpStatus :: Lens' RestoreFromClusterSnapshotResponse Int

The response's http status code.