AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Redshift ModifyCluster API operation.

Syntax

Edit-RSCluster
-ClusterIdentifier <String>
-AllowVersionUpgrade <Boolean>
-AutomatedSnapshotRetentionPeriod <Int32>
-AvailabilityZone <String>
-AvailabilityZoneRelocation <Boolean>
-ClusterParameterGroupName <String>
-ClusterSecurityGroup <String[]>
-ClusterType <String>
-ClusterVersion <String>
-ElasticIp <String>
-Encrypted <Boolean>
-EnhancedVpcRouting <Boolean>
-HsmClientCertificateIdentifier <String>
-HsmConfigurationIdentifier <String>
-IpAddressType <String>
-KmsKeyId <String>
-MaintenanceTrackName <String>
-ManageMasterPassword <Boolean>
-ManualSnapshotRetentionPeriod <Int32>
-MasterPasswordSecretKmsKeyId <String>
-MasterUserPassword <String>
-MultiAZ <Boolean>
-NewClusterIdentifier <String>
-NodeType <String>
-NumberOfNodes <Int32>
-Port <Int32>
-PreferredMaintenanceWindow <String>
-PubliclyAccessible <Boolean>
-VpcSecurityGroupId <String[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonRedshiftConfig>

Description

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.

Parameters

-AllowVersionUpgrade <Boolean>
If true, major version upgrades will be applied automatically to the cluster during the maintenance window. Default: false
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutomatedSnapshotRetentionPeriod <Int32>
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 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AvailabilityZone <String>
The option to initiate relocation for an Amazon Redshift cluster to the target Availability Zone.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AvailabilityZoneRelocation <Boolean>
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonRedshiftConfig>
Amazon.PowerShell.Cmdlets.RS.AmazonRedshiftClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClusterIdentifier <String>
The unique identifier of the cluster to be modified.Example: examplecluster
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ClusterParameterGroupName <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClusterSecurityGroup <String[]>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesClusterSecurityGroups
-ClusterType <String>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClusterVersion <String>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ElasticIp <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Encrypted <Boolean>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnhancedVpcRouting <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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-HsmClientCertificateIdentifier <String>
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-HsmConfigurationIdentifier <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IpAddressType <String>
The IP address types that the cluster supports. Possible values are ipv4 and dualstack.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KmsKeyId <String>
The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaintenanceTrackName <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManageMasterPassword <Boolean>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManualSnapshotRetentionPeriod <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MasterPasswordSecretKmsKeyId <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MasterUserPassword <String>
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.Operations never return the password, so this operation provides a way to regain access to the admin user account for a cluster if the password is lost.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 @.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MultiAZ <Boolean>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NewClusterIdentifier <String>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NodeType <String>
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.Valid Values: dc2.large | dc2.8xlarge | ra3.xlplus | ra3.4xlarge | ra3.16xlarge
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NumberOfNodes <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ClusterIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^ClusterIdentifier' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Port <Int32>
The option to change the port of an Amazon Redshift cluster.Valid Values:
  • For clusters with ra3 nodes - Select a port within the ranges 5431-5455 or 8191-8215. (If you have an existing cluster with 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PreferredMaintenanceWindow <String>
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 | SunConstraints: Must be at least 30 minutes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PubliclyAccessible <Boolean>
If true, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Cluster'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Redshift.Model.ModifyClusterResponse). Specifying the name of a property of type Amazon.Redshift.Model.ModifyClusterResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VpcSecurityGroupId <String[]>
A list of virtual private cloud (VPC) security groups to be associated with the cluster. This change is asynchronously applied as soon as possible.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVpcSecurityGroupIds

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.Redshift.Model.Cluster or Amazon.Redshift.Model.ModifyClusterResponse
This cmdlet returns an Amazon.Redshift.Model.Cluster object. The service call response (type Amazon.Redshift.Model.ModifyClusterResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z