modifyCluster method

Future<ModifyClusterResult> modifyCluster({

required String clusterIdentifier,
bool? allowVersionUpgrade,
int? automatedSnapshotRetentionPeriod,
String? availabilityZone,
bool? availabilityZoneRelocation,
String? clusterParameterGroupName,
List<String>? clusterSecurityGroups,
String? clusterType,
String? clusterVersion,
String? elasticIp,
bool? encrypted,
bool? enhancedVpcRouting,
bool? extraComputeForAutomaticOptimization,
String? hsmClientCertificateIdentifier,
String? hsmConfigurationIdentifier,
String? ipAddressType,
String? kmsKeyId,
String? maintenanceTrackName,
bool? manageMasterPassword,
int? manualSnapshotRetentionPeriod,
String? masterPasswordSecretKmsKeyId,
String? masterUserPassword,
bool? multiAZ,
String? newClusterIdentifier,
String? nodeType,
int? numberOfNodes,
int? port,
String? preferredMaintenanceWindow,
bool? publiclyAccessible,
List<String>? vpcSecurityGroupIds,

})

Modifies the settings for a cluster.

You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change.

You can add another security or parameter group, or change the admin user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a subnet group for a provisioned cluster is in an account with VPC BPA turned on, the following capabilities are blocked:

Creating a public cluster
Restoring a public cluster
Modifying a private cluster to be public
Adding a subnet with VPC BPA turned on to the subnet group when there's at least one public cluster within the group

For more information about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.

May throw ClusterAlreadyExistsFault. May throw ClusterNotFoundFault. May throw ClusterParameterGroupNotFoundFault. May throw ClusterSecurityGroupNotFoundFault. May throw CustomCnameAssociationFault. May throw DependentServiceRequestThrottlingFault. May throw HsmClientCertificateNotFoundFault. May throw HsmConfigurationNotFoundFault. May throw InsufficientClusterCapacityFault. May throw InvalidClusterSecurityGroupStateFault. May throw InvalidClusterStateFault. May throw InvalidClusterTrackFault. May throw InvalidElasticIpFault. May throw InvalidRetentionPeriodFault. May throw Ipv6CidrBlockNotFoundFault. May throw LimitExceededFault. May throw NumberOfNodesPerClusterLimitExceededFault. May throw NumberOfNodesQuotaExceededFault. May throw TableLimitExceededFault. May throw UnauthorizedOperation. May throw UnsupportedOperationFault. May throw UnsupportedOptionFault.

Parameter clusterIdentifier : The unique identifier of the cluster to be modified.

Example: examplecluster

Parameter allowVersionUpgrade : If true, major version upgrades will be applied automatically to the cluster during the maintenance window.

Default: false

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.

If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted.

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

Default: Uses existing setting.

Constraints: Must be a value from 0 to 35.

Parameter availabilityZone : The option to initiate relocation for an Amazon Redshift cluster to the target Availability Zone.

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

Parameter clusterParameterGroupName : The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use RebootCluster.

Default: Uses existing setting.

Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.

Parameter clusterSecurityGroups : A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible.

Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster.

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 clusterType : The new cluster type.

When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request.

Valid Values: multi-node | single-node

Parameter clusterVersion : The new version number of the Amazon Redshift engine to upgrade to.

For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Example: 1.0

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

Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.

Parameter encrypted : Indicates whether the cluster is encrypted. If the value is encrypted (true) and you provide a value for the KmsKeyId parameter, we encrypt the cluster with the provided KmsKeyId. If you don't provide a KmsKeyId, we encrypt with the default key.

If the value is not encrypted (false), then the cluster is decrypted.

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 extraComputeForAutomaticOptimization : If true, allocates additional compute resources for running automatic optimization operations.

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 ipAddressType : The IP address types that the cluster supports. Possible values are ipv4 and dualstack.

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

Parameter maintenanceTrackName : The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied.

Parameter manageMasterPassword : If true, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password.

Parameter manualSnapshotRetentionPeriod : The default for number of days that a newly created manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. This value doesn't retroactively change the retention periods of existing manual snapshots.

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

The default value is -1.

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

Parameter masterUserPassword : The new password for the cluster admin user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

You can't use MasterUserPassword if ManageMasterPassword is true. Default: Uses existing setting.

Constraints:

Must be between 8 and 64 characters in length.
Must contain at least one uppercase letter.
Must contain at least one lowercase letter.
Must contain one number.
Can be any printable ASCII character (ASCII code 33-126) except ' (single quote), " (double quote), \, /, or @.

Parameter multiAZ : If true and the cluster is currently only deployed in a single Availability Zone, the cluster will be modified to be deployed in two Availability Zones.

Parameter newClusterIdentifier : The new identifier for the cluster.

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.

Example: examplecluster

Parameter nodeType : The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter.

For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

Parameter numberOfNodes : The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter.

For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

Valid Values: Integer greater than 0.

Parameter port : The option to change the port of an Amazon Redshift cluster.

Valid Values:

For clusters with RG or RA3 nodes - Select a port within the ranges 5431-5455 or 8191-8215. (If you have an existing cluster with RG or RA3 nodes, it isn't required that you change the port to these ranges.)
For clusters with dc2 nodes - Select a port within the range 1150-65535.

Parameter preferredMaintenanceWindow : The weekly time range (in UTC) during which system maintenance can occur, if necessary. If system maintenance is necessary during the window, it may result in an outage.

This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied.

Default: Uses existing setting.

Format: ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00.

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

Constraints: Must be at least 30 minutes.

Parameter publiclyAccessible : If true, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.

Default: false

Parameter vpcSecurityGroupIds : A list of virtual private cloud (VPC) security groups to be associated with the cluster. This change is asynchronously applied as soon as possible.

Implementation

Future<ModifyClusterResult> modifyCluster({
  required String clusterIdentifier,
  bool? allowVersionUpgrade,
  int? automatedSnapshotRetentionPeriod,
  String? availabilityZone,
  bool? availabilityZoneRelocation,
  String? clusterParameterGroupName,
  List<String>? clusterSecurityGroups,
  String? clusterType,
  String? clusterVersion,
  String? elasticIp,
  bool? encrypted,
  bool? enhancedVpcRouting,
  bool? extraComputeForAutomaticOptimization,
  String? hsmClientCertificateIdentifier,
  String? hsmConfigurationIdentifier,
  String? ipAddressType,
  String? kmsKeyId,
  String? maintenanceTrackName,
  bool? manageMasterPassword,
  int? manualSnapshotRetentionPeriod,
  String? masterPasswordSecretKmsKeyId,
  String? masterUserPassword,
  bool? multiAZ,
  String? newClusterIdentifier,
  String? nodeType,
  int? numberOfNodes,
  int? port,
  String? preferredMaintenanceWindow,
  bool? publiclyAccessible,
  List<String>? vpcSecurityGroupIds,
}) async {
  final $request = <String, String>{
    'ClusterIdentifier': clusterIdentifier,
    if (allowVersionUpgrade != null)
      'AllowVersionUpgrade': allowVersionUpgrade.toString(),
    if (automatedSnapshotRetentionPeriod != null)
      'AutomatedSnapshotRetentionPeriod':
          automatedSnapshotRetentionPeriod.toString(),
    if (availabilityZone != null) 'AvailabilityZone': availabilityZone,
    if (availabilityZoneRelocation != null)
      'AvailabilityZoneRelocation': availabilityZoneRelocation.toString(),
    if (clusterParameterGroupName != null)
      'ClusterParameterGroupName': clusterParameterGroupName,
    if (clusterSecurityGroups != null)
      if (clusterSecurityGroups.isEmpty)
        'ClusterSecurityGroups': ''
      else
        for (var i1 = 0; i1 < clusterSecurityGroups.length; i1++)
          'ClusterSecurityGroups.ClusterSecurityGroupName.${i1 + 1}':
              clusterSecurityGroups[i1],
    if (clusterType != null) 'ClusterType': clusterType,
    if (clusterVersion != null) 'ClusterVersion': clusterVersion,
    if (elasticIp != null) 'ElasticIp': elasticIp,
    if (encrypted != null) 'Encrypted': encrypted.toString(),
    if (enhancedVpcRouting != null)
      'EnhancedVpcRouting': enhancedVpcRouting.toString(),
    if (extraComputeForAutomaticOptimization != null)
      'ExtraComputeForAutomaticOptimization':
          extraComputeForAutomaticOptimization.toString(),
    if (hsmClientCertificateIdentifier != null)
      'HsmClientCertificateIdentifier': hsmClientCertificateIdentifier,
    if (hsmConfigurationIdentifier != null)
      'HsmConfigurationIdentifier': hsmConfigurationIdentifier,
    if (ipAddressType != null) 'IpAddressType': ipAddressType,
    if (kmsKeyId != null) 'KmsKeyId': kmsKeyId,
    if (maintenanceTrackName != null)
      'MaintenanceTrackName': maintenanceTrackName,
    if (manageMasterPassword != null)
      'ManageMasterPassword': manageMasterPassword.toString(),
    if (manualSnapshotRetentionPeriod != null)
      'ManualSnapshotRetentionPeriod':
          manualSnapshotRetentionPeriod.toString(),
    if (masterPasswordSecretKmsKeyId != null)
      'MasterPasswordSecretKmsKeyId': masterPasswordSecretKmsKeyId,
    if (masterUserPassword != null) 'MasterUserPassword': masterUserPassword,
    if (multiAZ != null) 'MultiAZ': multiAZ.toString(),
    if (newClusterIdentifier != null)
      'NewClusterIdentifier': newClusterIdentifier,
    if (nodeType != null) 'NodeType': nodeType,
    if (numberOfNodes != null) 'NumberOfNodes': numberOfNodes.toString(),
    if (port != null) 'Port': port.toString(),
    if (preferredMaintenanceWindow != null)
      'PreferredMaintenanceWindow': preferredMaintenanceWindow,
    if (publiclyAccessible != null)
      'PubliclyAccessible': publiclyAccessible.toString(),
    if (vpcSecurityGroupIds != null)
      if (vpcSecurityGroupIds.isEmpty)
        'VpcSecurityGroupIds': ''
      else
        for (var i1 = 0; i1 < vpcSecurityGroupIds.length; i1++)
          'VpcSecurityGroupIds.VpcSecurityGroupId.${i1 + 1}':
              vpcSecurityGroupIds[i1],
  };
  final $result = await _protocol.send(
    $request,
    action: 'ModifyCluster',
    version: '2012-12-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    resultWrapper: 'ModifyClusterResult',
  );
  return ModifyClusterResult.fromXml($result);
}

modifyCluster method

Implementation

Redshift class