restoreFromClusterSnapshot method

Future<RestoreFromClusterSnapshotResult> restoreFromClusterSnapshot({ required String clusterIdentifier, required String snapshotIdentifier, String? additionalInfo, bool? allowVersionUpgrade, int? automatedSnapshotRetentionPeriod, String? availabilityZone, bool? availabilityZoneRelocation, String? clusterParameterGroupName, List<String>? clusterSecurityGroups, String? clusterSubnetGroupName, String? elasticIp, bool? enhancedVpcRouting, String? hsmClientCertificateIdentifier, String? hsmConfigurationIdentifier, List<String>? iamRoles, String? kmsKeyId, String? maintenanceTrackName, int? manualSnapshotRetentionPeriod, String? nodeType, int? numberOfNodes, String? ownerAccount, int? port, String? preferredMaintenanceWindow, bool? publiclyAccessible, String? snapshotClusterIdentifier, String? snapshotScheduleIdentifier, List<String>? vpcSecurityGroupIds, })

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.

May throw AccessToSnapshotDeniedFault. May throw ClusterAlreadyExistsFault. May throw ClusterSnapshotNotFoundFault. May throw ClusterQuotaExceededFault. May throw InsufficientClusterCapacityFault. May throw InvalidClusterSnapshotStateFault. May throw InvalidRestoreFault. May throw NumberOfNodesQuotaExceededFault. May throw NumberOfNodesPerClusterLimitExceededFault. May throw InvalidVPCNetworkStateFault. May throw InvalidClusterSubnetGroupStateFault. May throw InvalidSubnet. May throw ClusterSubnetGroupNotFoundFault. May throw UnauthorizedOperation. May throw HsmClientCertificateNotFoundFault. May throw HsmConfigurationNotFoundFault. May throw InvalidElasticIpFault. May throw ClusterParameterGroupNotFoundFault. May throw ClusterSecurityGroupNotFoundFault. May throw LimitExceededFault. May throw DependentServiceRequestThrottlingFault. May throw InvalidClusterTrackFault. May throw SnapshotScheduleNotFoundFault. May throw TagLimitExceededFault. May throw InvalidTagFault.

Parameter 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 AWS account.

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

Example: my-snapshot-id

Parameter additionalInfo : Reserved.

Parameter 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

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

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

Constraints: Must be a value from 0 to 35.

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

Default: A random, system-chosen Availability Zone.

Example: us-east-2a

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

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

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

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

Parameter elasticIp : The elastic IP (EIP) address for the cluster.

Parameter 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

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

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

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

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

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

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

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

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

Parameter numberOfNodes : The number of nodes specified when provisioning the restored cluster.

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

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

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

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

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

Parameter snapshotScheduleIdentifier : A unique identifier for the snapshot schedule.

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

Implementation

Future<RestoreFromClusterSnapshotResult> restoreFromClusterSnapshot({
  required String clusterIdentifier,
  required String snapshotIdentifier,
  String? additionalInfo,
  bool? allowVersionUpgrade,
  int? automatedSnapshotRetentionPeriod,
  String? availabilityZone,
  bool? availabilityZoneRelocation,
  String? clusterParameterGroupName,
  List<String>? clusterSecurityGroups,
  String? clusterSubnetGroupName,
  String? elasticIp,
  bool? enhancedVpcRouting,
  String? hsmClientCertificateIdentifier,
  String? hsmConfigurationIdentifier,
  List<String>? iamRoles,
  String? kmsKeyId,
  String? maintenanceTrackName,
  int? manualSnapshotRetentionPeriod,
  String? nodeType,
  int? numberOfNodes,
  String? ownerAccount,
  int? port,
  String? preferredMaintenanceWindow,
  bool? publiclyAccessible,
  String? snapshotClusterIdentifier,
  String? snapshotScheduleIdentifier,
  List<String>? vpcSecurityGroupIds,
}) async {
  ArgumentError.checkNotNull(clusterIdentifier, 'clusterIdentifier');
  _s.validateStringLength(
    'clusterIdentifier',
    clusterIdentifier,
    0,
    2147483647,
    isRequired: true,
  );
  ArgumentError.checkNotNull(snapshotIdentifier, 'snapshotIdentifier');
  _s.validateStringLength(
    'snapshotIdentifier',
    snapshotIdentifier,
    0,
    2147483647,
    isRequired: true,
  );
  _s.validateStringLength(
    'additionalInfo',
    additionalInfo,
    0,
    2147483647,
  );
  _s.validateStringLength(
    'availabilityZone',
    availabilityZone,
    0,
    2147483647,
  );
  _s.validateStringLength(
    'clusterParameterGroupName',
    clusterParameterGroupName,
    0,
    2147483647,
  );
  _s.validateStringLength(
    'clusterSubnetGroupName',
    clusterSubnetGroupName,
    0,
    2147483647,
  );
  _s.validateStringLength(
    'elasticIp',
    elasticIp,
    0,
    2147483647,
  );
  _s.validateStringLength(
    'hsmClientCertificateIdentifier',
    hsmClientCertificateIdentifier,
    0,
    2147483647,
  );
  _s.validateStringLength(
    'hsmConfigurationIdentifier',
    hsmConfigurationIdentifier,
    0,
    2147483647,
  );
  _s.validateStringLength(
    'kmsKeyId',
    kmsKeyId,
    0,
    2147483647,
  );
  _s.validateStringLength(
    'maintenanceTrackName',
    maintenanceTrackName,
    0,
    2147483647,
  );
  _s.validateStringLength(
    'nodeType',
    nodeType,
    0,
    2147483647,
  );
  _s.validateStringLength(
    'ownerAccount',
    ownerAccount,
    0,
    2147483647,
  );
  _s.validateStringLength(
    'preferredMaintenanceWindow',
    preferredMaintenanceWindow,
    0,
    2147483647,
  );
  _s.validateStringLength(
    'snapshotClusterIdentifier',
    snapshotClusterIdentifier,
    0,
    2147483647,
  );
  _s.validateStringLength(
    'snapshotScheduleIdentifier',
    snapshotScheduleIdentifier,
    0,
    2147483647,
  );
  final $request = <String, dynamic>{};
  $request['ClusterIdentifier'] = clusterIdentifier;
  $request['SnapshotIdentifier'] = snapshotIdentifier;
  additionalInfo?.also((arg) => $request['AdditionalInfo'] = arg);
  allowVersionUpgrade?.also((arg) => $request['AllowVersionUpgrade'] = arg);
  automatedSnapshotRetentionPeriod
      ?.also((arg) => $request['AutomatedSnapshotRetentionPeriod'] = arg);
  availabilityZone?.also((arg) => $request['AvailabilityZone'] = arg);
  availabilityZoneRelocation
      ?.also((arg) => $request['AvailabilityZoneRelocation'] = arg);
  clusterParameterGroupName
      ?.also((arg) => $request['ClusterParameterGroupName'] = arg);
  clusterSecurityGroups
      ?.also((arg) => $request['ClusterSecurityGroups'] = arg);
  clusterSubnetGroupName
      ?.also((arg) => $request['ClusterSubnetGroupName'] = arg);
  elasticIp?.also((arg) => $request['ElasticIp'] = arg);
  enhancedVpcRouting?.also((arg) => $request['EnhancedVpcRouting'] = arg);
  hsmClientCertificateIdentifier
      ?.also((arg) => $request['HsmClientCertificateIdentifier'] = arg);
  hsmConfigurationIdentifier
      ?.also((arg) => $request['HsmConfigurationIdentifier'] = arg);
  iamRoles?.also((arg) => $request['IamRoles'] = arg);
  kmsKeyId?.also((arg) => $request['KmsKeyId'] = arg);
  maintenanceTrackName?.also((arg) => $request['MaintenanceTrackName'] = arg);
  manualSnapshotRetentionPeriod
      ?.also((arg) => $request['ManualSnapshotRetentionPeriod'] = arg);
  nodeType?.also((arg) => $request['NodeType'] = arg);
  numberOfNodes?.also((arg) => $request['NumberOfNodes'] = arg);
  ownerAccount?.also((arg) => $request['OwnerAccount'] = arg);
  port?.also((arg) => $request['Port'] = arg);
  preferredMaintenanceWindow
      ?.also((arg) => $request['PreferredMaintenanceWindow'] = arg);
  publiclyAccessible?.also((arg) => $request['PubliclyAccessible'] = arg);
  snapshotClusterIdentifier
      ?.also((arg) => $request['SnapshotClusterIdentifier'] = arg);
  snapshotScheduleIdentifier
      ?.also((arg) => $request['SnapshotScheduleIdentifier'] = arg);
  vpcSecurityGroupIds?.also((arg) => $request['VpcSecurityGroupIds'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'RestoreFromClusterSnapshot',
    version: '2012-12-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['RestoreFromClusterSnapshotMessage'],
    shapes: shapes,
    resultWrapper: 'RestoreFromClusterSnapshotResult',
  );
  return RestoreFromClusterSnapshotResult.fromXml($result);
}