Skip to content

Commit

Permalink
📝 Adds more information to the docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
daschaa committed Jul 11, 2022
1 parent 3107af9 commit 727b824
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions packages/@aws-cdk/aws-redshift/lib/cluster.ts
Original file line number Diff line number Diff line change
Expand Up @@ -324,8 +324,13 @@ export interface ClusterProps {
readonly publiclyAccessible?: boolean

/**
* A boolean value indicating whether the resize operation is using the classic resize process.
* If you don't provide this parameter or set the value to false, the resize type is elastic.
* If this flag is set, the cluster resizing type will be set to classic.
* When resizing a cluster, classic resizing will always provision a new cluster and transfer the data there.
*
* Classic resize takes more time to complete, but it can be useful in cases where the change in node count or
* the node type to migrate to doesn't fall within the bounds for elastic resize.
*
* @see https://docs.aws.amazon.com/redshift/latest/mgmt/managing-cluster-operations.html#elastic-resize
*
* @default - Elastic resize type
*/
Expand Down

0 comments on commit 727b824

Please sign in to comment.