AWS SDK for C++  1.8.60
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::Redshift::Model::ModifyClusterRequest Class Reference

#include <ModifyClusterRequest.h>

+ Inheritance diagram for Aws::Redshift::Model::ModifyClusterRequest:

Public Member Functions

 ModifyClusterRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetClusterIdentifier () const
 
bool ClusterIdentifierHasBeenSet () const
 
void SetClusterIdentifier (const Aws::String &value)
 
void SetClusterIdentifier (Aws::String &&value)
 
void SetClusterIdentifier (const char *value)
 
ModifyClusterRequestWithClusterIdentifier (const Aws::String &value)
 
ModifyClusterRequestWithClusterIdentifier (Aws::String &&value)
 
ModifyClusterRequestWithClusterIdentifier (const char *value)
 
const Aws::StringGetClusterType () const
 
bool ClusterTypeHasBeenSet () const
 
void SetClusterType (const Aws::String &value)
 
void SetClusterType (Aws::String &&value)
 
void SetClusterType (const char *value)
 
ModifyClusterRequestWithClusterType (const Aws::String &value)
 
ModifyClusterRequestWithClusterType (Aws::String &&value)
 
ModifyClusterRequestWithClusterType (const char *value)
 
const Aws::StringGetNodeType () const
 
bool NodeTypeHasBeenSet () const
 
void SetNodeType (const Aws::String &value)
 
void SetNodeType (Aws::String &&value)
 
void SetNodeType (const char *value)
 
ModifyClusterRequestWithNodeType (const Aws::String &value)
 
ModifyClusterRequestWithNodeType (Aws::String &&value)
 
ModifyClusterRequestWithNodeType (const char *value)
 
int GetNumberOfNodes () const
 
bool NumberOfNodesHasBeenSet () const
 
void SetNumberOfNodes (int value)
 
ModifyClusterRequestWithNumberOfNodes (int value)
 
const Aws::Vector< Aws::String > & GetClusterSecurityGroups () const
 
bool ClusterSecurityGroupsHasBeenSet () const
 
void SetClusterSecurityGroups (const Aws::Vector< Aws::String > &value)
 
void SetClusterSecurityGroups (Aws::Vector< Aws::String > &&value)
 
ModifyClusterRequestWithClusterSecurityGroups (const Aws::Vector< Aws::String > &value)
 
ModifyClusterRequestWithClusterSecurityGroups (Aws::Vector< Aws::String > &&value)
 
ModifyClusterRequestAddClusterSecurityGroups (const Aws::String &value)
 
ModifyClusterRequestAddClusterSecurityGroups (Aws::String &&value)
 
ModifyClusterRequestAddClusterSecurityGroups (const char *value)
 
const Aws::Vector< Aws::String > & GetVpcSecurityGroupIds () const
 
bool VpcSecurityGroupIdsHasBeenSet () const
 
void SetVpcSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
void SetVpcSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
ModifyClusterRequestWithVpcSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
ModifyClusterRequestWithVpcSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
ModifyClusterRequestAddVpcSecurityGroupIds (const Aws::String &value)
 
ModifyClusterRequestAddVpcSecurityGroupIds (Aws::String &&value)
 
ModifyClusterRequestAddVpcSecurityGroupIds (const char *value)
 
const Aws::StringGetMasterUserPassword () const
 
bool MasterUserPasswordHasBeenSet () const
 
void SetMasterUserPassword (const Aws::String &value)
 
void SetMasterUserPassword (Aws::String &&value)
 
void SetMasterUserPassword (const char *value)
 
ModifyClusterRequestWithMasterUserPassword (const Aws::String &value)
 
ModifyClusterRequestWithMasterUserPassword (Aws::String &&value)
 
ModifyClusterRequestWithMasterUserPassword (const char *value)
 
const Aws::StringGetClusterParameterGroupName () const
 
bool ClusterParameterGroupNameHasBeenSet () const
 
void SetClusterParameterGroupName (const Aws::String &value)
 
void SetClusterParameterGroupName (Aws::String &&value)
 
void SetClusterParameterGroupName (const char *value)
 
ModifyClusterRequestWithClusterParameterGroupName (const Aws::String &value)
 
ModifyClusterRequestWithClusterParameterGroupName (Aws::String &&value)
 
ModifyClusterRequestWithClusterParameterGroupName (const char *value)
 
int GetAutomatedSnapshotRetentionPeriod () const
 
bool AutomatedSnapshotRetentionPeriodHasBeenSet () const
 
void SetAutomatedSnapshotRetentionPeriod (int value)
 
ModifyClusterRequestWithAutomatedSnapshotRetentionPeriod (int value)
 
int GetManualSnapshotRetentionPeriod () const
 
bool ManualSnapshotRetentionPeriodHasBeenSet () const
 
void SetManualSnapshotRetentionPeriod (int value)
 
ModifyClusterRequestWithManualSnapshotRetentionPeriod (int value)
 
const Aws::StringGetPreferredMaintenanceWindow () const
 
bool PreferredMaintenanceWindowHasBeenSet () const
 
void SetPreferredMaintenanceWindow (const Aws::String &value)
 
void SetPreferredMaintenanceWindow (Aws::String &&value)
 
void SetPreferredMaintenanceWindow (const char *value)
 
ModifyClusterRequestWithPreferredMaintenanceWindow (const Aws::String &value)
 
ModifyClusterRequestWithPreferredMaintenanceWindow (Aws::String &&value)
 
ModifyClusterRequestWithPreferredMaintenanceWindow (const char *value)
 
const Aws::StringGetClusterVersion () const
 
bool ClusterVersionHasBeenSet () const
 
void SetClusterVersion (const Aws::String &value)
 
void SetClusterVersion (Aws::String &&value)
 
void SetClusterVersion (const char *value)
 
ModifyClusterRequestWithClusterVersion (const Aws::String &value)
 
ModifyClusterRequestWithClusterVersion (Aws::String &&value)
 
ModifyClusterRequestWithClusterVersion (const char *value)
 
bool GetAllowVersionUpgrade () const
 
bool AllowVersionUpgradeHasBeenSet () const
 
void SetAllowVersionUpgrade (bool value)
 
ModifyClusterRequestWithAllowVersionUpgrade (bool value)
 
const Aws::StringGetHsmClientCertificateIdentifier () const
 
bool HsmClientCertificateIdentifierHasBeenSet () const
 
void SetHsmClientCertificateIdentifier (const Aws::String &value)
 
void SetHsmClientCertificateIdentifier (Aws::String &&value)
 
void SetHsmClientCertificateIdentifier (const char *value)
 
ModifyClusterRequestWithHsmClientCertificateIdentifier (const Aws::String &value)
 
ModifyClusterRequestWithHsmClientCertificateIdentifier (Aws::String &&value)
 
ModifyClusterRequestWithHsmClientCertificateIdentifier (const char *value)
 
const Aws::StringGetHsmConfigurationIdentifier () const
 
bool HsmConfigurationIdentifierHasBeenSet () const
 
void SetHsmConfigurationIdentifier (const Aws::String &value)
 
void SetHsmConfigurationIdentifier (Aws::String &&value)
 
void SetHsmConfigurationIdentifier (const char *value)
 
ModifyClusterRequestWithHsmConfigurationIdentifier (const Aws::String &value)
 
ModifyClusterRequestWithHsmConfigurationIdentifier (Aws::String &&value)
 
ModifyClusterRequestWithHsmConfigurationIdentifier (const char *value)
 
const Aws::StringGetNewClusterIdentifier () const
 
bool NewClusterIdentifierHasBeenSet () const
 
void SetNewClusterIdentifier (const Aws::String &value)
 
void SetNewClusterIdentifier (Aws::String &&value)
 
void SetNewClusterIdentifier (const char *value)
 
ModifyClusterRequestWithNewClusterIdentifier (const Aws::String &value)
 
ModifyClusterRequestWithNewClusterIdentifier (Aws::String &&value)
 
ModifyClusterRequestWithNewClusterIdentifier (const char *value)
 
bool GetPubliclyAccessible () const
 
bool PubliclyAccessibleHasBeenSet () const
 
void SetPubliclyAccessible (bool value)
 
ModifyClusterRequestWithPubliclyAccessible (bool value)
 
const Aws::StringGetElasticIp () const
 
bool ElasticIpHasBeenSet () const
 
void SetElasticIp (const Aws::String &value)
 
void SetElasticIp (Aws::String &&value)
 
void SetElasticIp (const char *value)
 
ModifyClusterRequestWithElasticIp (const Aws::String &value)
 
ModifyClusterRequestWithElasticIp (Aws::String &&value)
 
ModifyClusterRequestWithElasticIp (const char *value)
 
bool GetEnhancedVpcRouting () const
 
bool EnhancedVpcRoutingHasBeenSet () const
 
void SetEnhancedVpcRouting (bool value)
 
ModifyClusterRequestWithEnhancedVpcRouting (bool value)
 
const Aws::StringGetMaintenanceTrackName () const
 
bool MaintenanceTrackNameHasBeenSet () const
 
void SetMaintenanceTrackName (const Aws::String &value)
 
void SetMaintenanceTrackName (Aws::String &&value)
 
void SetMaintenanceTrackName (const char *value)
 
ModifyClusterRequestWithMaintenanceTrackName (const Aws::String &value)
 
ModifyClusterRequestWithMaintenanceTrackName (Aws::String &&value)
 
ModifyClusterRequestWithMaintenanceTrackName (const char *value)
 
bool GetEncrypted () const
 
bool EncryptedHasBeenSet () const
 
void SetEncrypted (bool value)
 
ModifyClusterRequestWithEncrypted (bool value)
 
const Aws::StringGetKmsKeyId () const
 
bool KmsKeyIdHasBeenSet () const
 
void SetKmsKeyId (const Aws::String &value)
 
void SetKmsKeyId (Aws::String &&value)
 
void SetKmsKeyId (const char *value)
 
ModifyClusterRequestWithKmsKeyId (const Aws::String &value)
 
ModifyClusterRequestWithKmsKeyId (Aws::String &&value)
 
ModifyClusterRequestWithKmsKeyId (const char *value)
 
- Public Member Functions inherited from Aws::Redshift::RedshiftRequest
virtual ~RedshiftRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::Redshift::RedshiftRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

See Also:

AWS API Reference

Definition at line 25 of file ModifyClusterRequest.h.

Constructor & Destructor Documentation

◆ ModifyClusterRequest()

Aws::Redshift::Model::ModifyClusterRequest::ModifyClusterRequest ( )

Member Function Documentation

◆ AddClusterSecurityGroups() [1/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::AddClusterSecurityGroups ( const Aws::String value)
inline

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

Definition at line 402 of file ModifyClusterRequest.h.

◆ AddClusterSecurityGroups() [2/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::AddClusterSecurityGroups ( Aws::String &&  value)
inline

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

Definition at line 413 of file ModifyClusterRequest.h.

◆ AddClusterSecurityGroups() [3/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::AddClusterSecurityGroups ( const char *  value)
inline

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

Definition at line 424 of file ModifyClusterRequest.h.

◆ AddVpcSecurityGroupIds() [1/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::AddVpcSecurityGroupIds ( const Aws::String value)
inline

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

Definition at line 467 of file ModifyClusterRequest.h.

◆ AddVpcSecurityGroupIds() [2/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::AddVpcSecurityGroupIds ( Aws::String &&  value)
inline

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

Definition at line 473 of file ModifyClusterRequest.h.

◆ AddVpcSecurityGroupIds() [3/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::AddVpcSecurityGroupIds ( const char *  value)
inline

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

Definition at line 479 of file ModifyClusterRequest.h.

◆ AllowVersionUpgradeHasBeenSet()

bool Aws::Redshift::Model::ModifyClusterRequest::AllowVersionUpgradeHasBeenSet ( ) const
inline

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

Default: false

Definition at line 988 of file ModifyClusterRequest.h.

◆ AutomatedSnapshotRetentionPeriodHasBeenSet()

bool Aws::Redshift::Model::ModifyClusterRequest::AutomatedSnapshotRetentionPeriodHasBeenSet ( ) const
inline

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.

Default: Uses existing setting.

Constraints: Must be a value from 0 to 35.

Definition at line 704 of file ModifyClusterRequest.h.

◆ ClusterIdentifierHasBeenSet()

bool Aws::Redshift::Model::ModifyClusterRequest::ClusterIdentifierHasBeenSet ( ) const
inline

The unique identifier of the cluster to be modified.

Example: examplecluster

Definition at line 53 of file ModifyClusterRequest.h.

◆ ClusterParameterGroupNameHasBeenSet()

bool Aws::Redshift::Model::ModifyClusterRequest::ClusterParameterGroupNameHasBeenSet ( ) const
inline

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.

Definition at line 627 of file ModifyClusterRequest.h.

◆ ClusterSecurityGroupsHasBeenSet()

bool Aws::Redshift::Model::ModifyClusterRequest::ClusterSecurityGroupsHasBeenSet ( ) const
inline

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

Definition at line 347 of file ModifyClusterRequest.h.

◆ ClusterTypeHasBeenSet()

bool Aws::Redshift::Model::ModifyClusterRequest::ClusterTypeHasBeenSet ( ) const
inline

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

Definition at line 112 of file ModifyClusterRequest.h.

◆ ClusterVersionHasBeenSet()

bool Aws::Redshift::Model::ModifyClusterRequest::ClusterVersionHasBeenSet ( ) const
inline

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

Definition at line 895 of file ModifyClusterRequest.h.

◆ DumpBodyToUrl()

void Aws::Redshift::Model::ModifyClusterRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ ElasticIpHasBeenSet()

bool Aws::Redshift::Model::ModifyClusterRequest::ElasticIpHasBeenSet ( ) const
inline

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.

Definition at line 1227 of file ModifyClusterRequest.h.

◆ EncryptedHasBeenSet()

bool Aws::Redshift::Model::ModifyClusterRequest::EncryptedHasBeenSet ( ) const
inline

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.

Definition at line 1432 of file ModifyClusterRequest.h.

◆ EnhancedVpcRoutingHasBeenSet()

bool Aws::Redshift::Model::ModifyClusterRequest::EnhancedVpcRoutingHasBeenSet ( ) const
inline

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

Definition at line 1310 of file ModifyClusterRequest.h.

◆ GetAllowVersionUpgrade()

bool Aws::Redshift::Model::ModifyClusterRequest::GetAllowVersionUpgrade ( ) const
inline

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

Default: false

Definition at line 981 of file ModifyClusterRequest.h.

◆ GetAutomatedSnapshotRetentionPeriod()

int Aws::Redshift::Model::ModifyClusterRequest::GetAutomatedSnapshotRetentionPeriod ( ) const
inline

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.

Default: Uses existing setting.

Constraints: Must be a value from 0 to 35.

Definition at line 693 of file ModifyClusterRequest.h.

◆ GetClusterIdentifier()

const Aws::String& Aws::Redshift::Model::ModifyClusterRequest::GetClusterIdentifier ( ) const
inline

The unique identifier of the cluster to be modified.

Example: examplecluster

Definition at line 47 of file ModifyClusterRequest.h.

◆ GetClusterParameterGroupName()

const Aws::String& Aws::Redshift::Model::ModifyClusterRequest::GetClusterParameterGroupName ( ) const
inline

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.

Definition at line 618 of file ModifyClusterRequest.h.

◆ GetClusterSecurityGroups()

const Aws::Vector<Aws::String>& Aws::Redshift::Model::ModifyClusterRequest::GetClusterSecurityGroups ( ) const
inline

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

Definition at line 336 of file ModifyClusterRequest.h.

◆ GetClusterType()

const Aws::String& Aws::Redshift::Model::ModifyClusterRequest::GetClusterType ( ) const
inline

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

Definition at line 101 of file ModifyClusterRequest.h.

◆ GetClusterVersion()

const Aws::String& Aws::Redshift::Model::ModifyClusterRequest::GetClusterVersion ( ) const
inline

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

Definition at line 882 of file ModifyClusterRequest.h.

◆ GetElasticIp()

const Aws::String& Aws::Redshift::Model::ModifyClusterRequest::GetElasticIp ( ) const
inline

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.

Definition at line 1217 of file ModifyClusterRequest.h.

◆ GetEncrypted()

bool Aws::Redshift::Model::ModifyClusterRequest::GetEncrypted ( ) const
inline

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.

Definition at line 1423 of file ModifyClusterRequest.h.

◆ GetEnhancedVpcRouting()

bool Aws::Redshift::Model::ModifyClusterRequest::GetEnhancedVpcRouting ( ) const
inline

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

Definition at line 1299 of file ModifyClusterRequest.h.

◆ GetHsmClientCertificateIdentifier()

const Aws::String& Aws::Redshift::Model::ModifyClusterRequest::GetHsmClientCertificateIdentifier ( ) const
inline

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

Definition at line 1009 of file ModifyClusterRequest.h.

◆ GetHsmConfigurationIdentifier()

const Aws::String& Aws::Redshift::Model::ModifyClusterRequest::GetHsmConfigurationIdentifier ( ) const
inline

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.

Definition at line 1058 of file ModifyClusterRequest.h.

◆ GetKmsKeyId()

const Aws::String& Aws::Redshift::Model::ModifyClusterRequest::GetKmsKeyId ( ) const
inline

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

Definition at line 1457 of file ModifyClusterRequest.h.

◆ GetMaintenanceTrackName()

const Aws::String& Aws::Redshift::Model::ModifyClusterRequest::GetMaintenanceTrackName ( ) const
inline

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.

Definition at line 1343 of file ModifyClusterRequest.h.

◆ GetManualSnapshotRetentionPeriod()

int Aws::Redshift::Model::ModifyClusterRequest::GetManualSnapshotRetentionPeriod ( ) const
inline

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.

Definition at line 736 of file ModifyClusterRequest.h.

◆ GetMasterUserPassword()

const Aws::String& Aws::Redshift::Model::ModifyClusterRequest::GetMasterUserPassword ( ) const
inline

The new password for the cluster master 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.

Operations never return the password, so this operation provides a way to regain access to the master 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 to 126) except ' (single quote), " (double quote), \, /, @, or space.

Definition at line 496 of file ModifyClusterRequest.h.

◆ GetNewClusterIdentifier()

const Aws::String& Aws::Redshift::Model::ModifyClusterRequest::GetNewClusterIdentifier ( ) const
inline

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

Example: examplecluster

Definition at line 1111 of file ModifyClusterRequest.h.

◆ GetNodeType()

const Aws::String& Aws::Redshift::Model::ModifyClusterRequest::GetNodeType ( ) const
inline

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: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge

Definition at line 192 of file ModifyClusterRequest.h.

◆ GetNumberOfNodes()

int Aws::Redshift::Model::ModifyClusterRequest::GetNumberOfNodes ( ) const
inline

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.

Definition at line 294 of file ModifyClusterRequest.h.

◆ GetPreferredMaintenanceWindow()

const Aws::String& Aws::Redshift::Model::ModifyClusterRequest::GetPreferredMaintenanceWindow ( ) const
inline

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.

Definition at line 777 of file ModifyClusterRequest.h.

◆ GetPubliclyAccessible()

bool Aws::Redshift::Model::ModifyClusterRequest::GetPubliclyAccessible ( ) const
inline

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

Definition at line 1188 of file ModifyClusterRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Redshift::Model::ModifyClusterRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file ModifyClusterRequest.h.

◆ GetVpcSecurityGroupIds()

const Aws::Vector<Aws::String>& Aws::Redshift::Model::ModifyClusterRequest::GetVpcSecurityGroupIds ( ) const
inline

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

Definition at line 431 of file ModifyClusterRequest.h.

◆ HsmClientCertificateIdentifierHasBeenSet()

bool Aws::Redshift::Model::ModifyClusterRequest::HsmClientCertificateIdentifierHasBeenSet ( ) const
inline

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

Definition at line 1015 of file ModifyClusterRequest.h.

◆ HsmConfigurationIdentifierHasBeenSet()

bool Aws::Redshift::Model::ModifyClusterRequest::HsmConfigurationIdentifierHasBeenSet ( ) const
inline

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.

Definition at line 1064 of file ModifyClusterRequest.h.

◆ KmsKeyIdHasBeenSet()

bool Aws::Redshift::Model::ModifyClusterRequest::KmsKeyIdHasBeenSet ( ) const
inline

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

Definition at line 1463 of file ModifyClusterRequest.h.

◆ MaintenanceTrackNameHasBeenSet()

bool Aws::Redshift::Model::ModifyClusterRequest::MaintenanceTrackNameHasBeenSet ( ) const
inline

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.

Definition at line 1353 of file ModifyClusterRequest.h.

◆ ManualSnapshotRetentionPeriodHasBeenSet()

bool Aws::Redshift::Model::ModifyClusterRequest::ManualSnapshotRetentionPeriodHasBeenSet ( ) const
inline

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.

Definition at line 745 of file ModifyClusterRequest.h.

◆ MasterUserPasswordHasBeenSet()

bool Aws::Redshift::Model::ModifyClusterRequest::MasterUserPasswordHasBeenSet ( ) const
inline

The new password for the cluster master 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.

Operations never return the password, so this operation provides a way to regain access to the master 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 to 126) except ' (single quote), " (double quote), \, /, @, or space.

Definition at line 512 of file ModifyClusterRequest.h.

◆ NewClusterIdentifierHasBeenSet()

bool Aws::Redshift::Model::ModifyClusterRequest::NewClusterIdentifierHasBeenSet ( ) const
inline

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

Example: examplecluster

Definition at line 1121 of file ModifyClusterRequest.h.

◆ NodeTypeHasBeenSet()

bool Aws::Redshift::Model::ModifyClusterRequest::NodeTypeHasBeenSet ( ) const
inline

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: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge

Definition at line 205 of file ModifyClusterRequest.h.

◆ NumberOfNodesHasBeenSet()

bool Aws::Redshift::Model::ModifyClusterRequest::NumberOfNodesHasBeenSet ( ) const
inline

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.

Definition at line 304 of file ModifyClusterRequest.h.

◆ PreferredMaintenanceWindowHasBeenSet()

bool Aws::Redshift::Model::ModifyClusterRequest::PreferredMaintenanceWindowHasBeenSet ( ) const
inline

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.

Definition at line 790 of file ModifyClusterRequest.h.

◆ PubliclyAccessibleHasBeenSet()

bool Aws::Redshift::Model::ModifyClusterRequest::PubliclyAccessibleHasBeenSet ( ) const
inline

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

Definition at line 1194 of file ModifyClusterRequest.h.

◆ SerializePayload()

Aws::String Aws::Redshift::Model::ModifyClusterRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAllowVersionUpgrade()

void Aws::Redshift::Model::ModifyClusterRequest::SetAllowVersionUpgrade ( bool  value)
inline

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

Default: false

Definition at line 995 of file ModifyClusterRequest.h.

◆ SetAutomatedSnapshotRetentionPeriod()

void Aws::Redshift::Model::ModifyClusterRequest::SetAutomatedSnapshotRetentionPeriod ( int  value)
inline

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.

Default: Uses existing setting.

Constraints: Must be a value from 0 to 35.

Definition at line 715 of file ModifyClusterRequest.h.

◆ SetClusterIdentifier() [1/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetClusterIdentifier ( const Aws::String value)
inline

The unique identifier of the cluster to be modified.

Example: examplecluster

Definition at line 59 of file ModifyClusterRequest.h.

◆ SetClusterIdentifier() [2/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetClusterIdentifier ( Aws::String &&  value)
inline

The unique identifier of the cluster to be modified.

Example: examplecluster

Definition at line 65 of file ModifyClusterRequest.h.

◆ SetClusterIdentifier() [3/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetClusterIdentifier ( const char *  value)
inline

The unique identifier of the cluster to be modified.

Example: examplecluster

Definition at line 71 of file ModifyClusterRequest.h.

◆ SetClusterParameterGroupName() [1/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetClusterParameterGroupName ( const Aws::String value)
inline

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.

Definition at line 636 of file ModifyClusterRequest.h.

◆ SetClusterParameterGroupName() [2/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetClusterParameterGroupName ( Aws::String &&  value)
inline

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.

Definition at line 645 of file ModifyClusterRequest.h.

◆ SetClusterParameterGroupName() [3/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetClusterParameterGroupName ( const char *  value)
inline

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.

Definition at line 654 of file ModifyClusterRequest.h.

◆ SetClusterSecurityGroups() [1/2]

void Aws::Redshift::Model::ModifyClusterRequest::SetClusterSecurityGroups ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 358 of file ModifyClusterRequest.h.

◆ SetClusterSecurityGroups() [2/2]

void Aws::Redshift::Model::ModifyClusterRequest::SetClusterSecurityGroups ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 369 of file ModifyClusterRequest.h.

◆ SetClusterType() [1/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetClusterType ( const Aws::String value)
inline

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

Definition at line 123 of file ModifyClusterRequest.h.

◆ SetClusterType() [2/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetClusterType ( Aws::String &&  value)
inline

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

Definition at line 134 of file ModifyClusterRequest.h.

◆ SetClusterType() [3/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetClusterType ( const char *  value)
inline

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

Definition at line 145 of file ModifyClusterRequest.h.

◆ SetClusterVersion() [1/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetClusterVersion ( const Aws::String value)
inline

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

Definition at line 908 of file ModifyClusterRequest.h.

◆ SetClusterVersion() [2/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetClusterVersion ( Aws::String &&  value)
inline

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

Definition at line 921 of file ModifyClusterRequest.h.

◆ SetClusterVersion() [3/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetClusterVersion ( const char *  value)
inline

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

Definition at line 934 of file ModifyClusterRequest.h.

◆ SetElasticIp() [1/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetElasticIp ( const Aws::String value)
inline

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.

Definition at line 1237 of file ModifyClusterRequest.h.

◆ SetElasticIp() [2/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetElasticIp ( Aws::String &&  value)
inline

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.

Definition at line 1247 of file ModifyClusterRequest.h.

◆ SetElasticIp() [3/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetElasticIp ( const char *  value)
inline

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.

Definition at line 1257 of file ModifyClusterRequest.h.

◆ SetEncrypted()

void Aws::Redshift::Model::ModifyClusterRequest::SetEncrypted ( bool  value)
inline

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.

Definition at line 1441 of file ModifyClusterRequest.h.

◆ SetEnhancedVpcRouting()

void Aws::Redshift::Model::ModifyClusterRequest::SetEnhancedVpcRouting ( bool  value)
inline

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

Definition at line 1321 of file ModifyClusterRequest.h.

◆ SetHsmClientCertificateIdentifier() [1/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetHsmClientCertificateIdentifier ( const Aws::String value)
inline

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

Definition at line 1021 of file ModifyClusterRequest.h.

◆ SetHsmClientCertificateIdentifier() [2/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetHsmClientCertificateIdentifier ( Aws::String &&  value)
inline

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

Definition at line 1027 of file ModifyClusterRequest.h.

◆ SetHsmClientCertificateIdentifier() [3/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetHsmClientCertificateIdentifier ( const char *  value)
inline

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

Definition at line 1033 of file ModifyClusterRequest.h.

◆ SetHsmConfigurationIdentifier() [1/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetHsmConfigurationIdentifier ( const Aws::String value)
inline

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.

Definition at line 1070 of file ModifyClusterRequest.h.

◆ SetHsmConfigurationIdentifier() [2/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetHsmConfigurationIdentifier ( Aws::String &&  value)
inline

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.

Definition at line 1076 of file ModifyClusterRequest.h.

◆ SetHsmConfigurationIdentifier() [3/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetHsmConfigurationIdentifier ( const char *  value)
inline

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.

Definition at line 1082 of file ModifyClusterRequest.h.

◆ SetKmsKeyId() [1/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetKmsKeyId ( const Aws::String value)
inline

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

Definition at line 1469 of file ModifyClusterRequest.h.

◆ SetKmsKeyId() [2/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetKmsKeyId ( Aws::String &&  value)
inline

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

Definition at line 1475 of file ModifyClusterRequest.h.

◆ SetKmsKeyId() [3/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetKmsKeyId ( const char *  value)
inline

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

Definition at line 1481 of file ModifyClusterRequest.h.

◆ SetMaintenanceTrackName() [1/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetMaintenanceTrackName ( const Aws::String value)
inline

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.

Definition at line 1363 of file ModifyClusterRequest.h.

◆ SetMaintenanceTrackName() [2/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetMaintenanceTrackName ( Aws::String &&  value)
inline

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.

Definition at line 1373 of file ModifyClusterRequest.h.

◆ SetMaintenanceTrackName() [3/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetMaintenanceTrackName ( const char *  value)
inline

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.

Definition at line 1383 of file ModifyClusterRequest.h.

◆ SetManualSnapshotRetentionPeriod()

void Aws::Redshift::Model::ModifyClusterRequest::SetManualSnapshotRetentionPeriod ( int  value)
inline

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.

Definition at line 754 of file ModifyClusterRequest.h.

◆ SetMasterUserPassword() [1/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetMasterUserPassword ( const Aws::String value)
inline

The new password for the cluster master 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.

Operations never return the password, so this operation provides a way to regain access to the master 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 to 126) except ' (single quote), " (double quote), \, /, @, or space.

Definition at line 528 of file ModifyClusterRequest.h.

◆ SetMasterUserPassword() [2/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetMasterUserPassword ( Aws::String &&  value)
inline

The new password for the cluster master 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.

Operations never return the password, so this operation provides a way to regain access to the master 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 to 126) except ' (single quote), " (double quote), \, /, @, or space.

Definition at line 544 of file ModifyClusterRequest.h.

◆ SetMasterUserPassword() [3/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetMasterUserPassword ( const char *  value)
inline

The new password for the cluster master 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.

Operations never return the password, so this operation provides a way to regain access to the master 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 to 126) except ' (single quote), " (double quote), \, /, @, or space.

Definition at line 560 of file ModifyClusterRequest.h.

◆ SetNewClusterIdentifier() [1/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetNewClusterIdentifier ( const Aws::String value)
inline

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

Example: examplecluster

Definition at line 1131 of file ModifyClusterRequest.h.

◆ SetNewClusterIdentifier() [2/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetNewClusterIdentifier ( Aws::String &&  value)
inline

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

Example: examplecluster

Definition at line 1141 of file ModifyClusterRequest.h.

◆ SetNewClusterIdentifier() [3/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetNewClusterIdentifier ( const char *  value)
inline

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

Example: examplecluster

Definition at line 1151 of file ModifyClusterRequest.h.

◆ SetNodeType() [1/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetNodeType ( const Aws::String value)
inline

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: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge

Definition at line 218 of file ModifyClusterRequest.h.

◆ SetNodeType() [2/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetNodeType ( Aws::String &&  value)
inline

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: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge

Definition at line 231 of file ModifyClusterRequest.h.

◆ SetNodeType() [3/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetNodeType ( const char *  value)
inline

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: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge

Definition at line 244 of file ModifyClusterRequest.h.

◆ SetNumberOfNodes()

void Aws::Redshift::Model::ModifyClusterRequest::SetNumberOfNodes ( int  value)
inline

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.

Definition at line 314 of file ModifyClusterRequest.h.

◆ SetPreferredMaintenanceWindow() [1/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetPreferredMaintenanceWindow ( const Aws::String value)
inline

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.

Definition at line 803 of file ModifyClusterRequest.h.

◆ SetPreferredMaintenanceWindow() [2/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetPreferredMaintenanceWindow ( Aws::String &&  value)
inline

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.

Definition at line 816 of file ModifyClusterRequest.h.

◆ SetPreferredMaintenanceWindow() [3/3]

void Aws::Redshift::Model::ModifyClusterRequest::SetPreferredMaintenanceWindow ( const char *  value)
inline

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.

Definition at line 829 of file ModifyClusterRequest.h.

◆ SetPubliclyAccessible()

void Aws::Redshift::Model::ModifyClusterRequest::SetPubliclyAccessible ( bool  value)
inline

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

Definition at line 1200 of file ModifyClusterRequest.h.

◆ SetVpcSecurityGroupIds() [1/2]

void Aws::Redshift::Model::ModifyClusterRequest::SetVpcSecurityGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 443 of file ModifyClusterRequest.h.

◆ SetVpcSecurityGroupIds() [2/2]

void Aws::Redshift::Model::ModifyClusterRequest::SetVpcSecurityGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 449 of file ModifyClusterRequest.h.

◆ VpcSecurityGroupIdsHasBeenSet()

bool Aws::Redshift::Model::ModifyClusterRequest::VpcSecurityGroupIdsHasBeenSet ( ) const
inline

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

Definition at line 437 of file ModifyClusterRequest.h.

◆ WithAllowVersionUpgrade()

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithAllowVersionUpgrade ( bool  value)
inline

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

Default: false

Definition at line 1002 of file ModifyClusterRequest.h.

◆ WithAutomatedSnapshotRetentionPeriod()

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithAutomatedSnapshotRetentionPeriod ( int  value)
inline

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.

Default: Uses existing setting.

Constraints: Must be a value from 0 to 35.

Definition at line 726 of file ModifyClusterRequest.h.

◆ WithClusterIdentifier() [1/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithClusterIdentifier ( const Aws::String value)
inline

The unique identifier of the cluster to be modified.

Example: examplecluster

Definition at line 77 of file ModifyClusterRequest.h.

◆ WithClusterIdentifier() [2/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithClusterIdentifier ( Aws::String &&  value)
inline

The unique identifier of the cluster to be modified.

Example: examplecluster

Definition at line 83 of file ModifyClusterRequest.h.

◆ WithClusterIdentifier() [3/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithClusterIdentifier ( const char *  value)
inline

The unique identifier of the cluster to be modified.

Example: examplecluster

Definition at line 89 of file ModifyClusterRequest.h.

◆ WithClusterParameterGroupName() [1/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithClusterParameterGroupName ( const Aws::String value)
inline

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.

Definition at line 663 of file ModifyClusterRequest.h.

◆ WithClusterParameterGroupName() [2/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithClusterParameterGroupName ( Aws::String &&  value)
inline

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.

Definition at line 672 of file ModifyClusterRequest.h.

◆ WithClusterParameterGroupName() [3/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithClusterParameterGroupName ( const char *  value)
inline

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.

Definition at line 681 of file ModifyClusterRequest.h.

◆ WithClusterSecurityGroups() [1/2]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithClusterSecurityGroups ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 380 of file ModifyClusterRequest.h.

◆ WithClusterSecurityGroups() [2/2]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithClusterSecurityGroups ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 391 of file ModifyClusterRequest.h.

◆ WithClusterType() [1/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithClusterType ( const Aws::String value)
inline

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

Definition at line 156 of file ModifyClusterRequest.h.

◆ WithClusterType() [2/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithClusterType ( Aws::String &&  value)
inline

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

Definition at line 167 of file ModifyClusterRequest.h.

◆ WithClusterType() [3/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithClusterType ( const char *  value)
inline

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

Definition at line 178 of file ModifyClusterRequest.h.

◆ WithClusterVersion() [1/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithClusterVersion ( const Aws::String value)
inline

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

Definition at line 947 of file ModifyClusterRequest.h.

◆ WithClusterVersion() [2/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithClusterVersion ( Aws::String &&  value)
inline

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

Definition at line 960 of file ModifyClusterRequest.h.

◆ WithClusterVersion() [3/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithClusterVersion ( const char *  value)
inline

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

Definition at line 973 of file ModifyClusterRequest.h.

◆ WithElasticIp() [1/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithElasticIp ( const Aws::String value)
inline

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.

Definition at line 1267 of file ModifyClusterRequest.h.

◆ WithElasticIp() [2/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithElasticIp ( Aws::String &&  value)
inline

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.

Definition at line 1277 of file ModifyClusterRequest.h.

◆ WithElasticIp() [3/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithElasticIp ( const char *  value)
inline

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.

Definition at line 1287 of file ModifyClusterRequest.h.

◆ WithEncrypted()

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithEncrypted ( bool  value)
inline

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.

Definition at line 1450 of file ModifyClusterRequest.h.

◆ WithEnhancedVpcRouting()

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithEnhancedVpcRouting ( bool  value)
inline

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

Definition at line 1332 of file ModifyClusterRequest.h.

◆ WithHsmClientCertificateIdentifier() [1/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithHsmClientCertificateIdentifier ( const Aws::String value)
inline

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

Definition at line 1039 of file ModifyClusterRequest.h.

◆ WithHsmClientCertificateIdentifier() [2/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithHsmClientCertificateIdentifier ( Aws::String &&  value)
inline

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

Definition at line 1045 of file ModifyClusterRequest.h.

◆ WithHsmClientCertificateIdentifier() [3/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithHsmClientCertificateIdentifier ( const char *  value)
inline

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

Definition at line 1051 of file ModifyClusterRequest.h.

◆ WithHsmConfigurationIdentifier() [1/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithHsmConfigurationIdentifier ( const Aws::String value)
inline

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.

Definition at line 1088 of file ModifyClusterRequest.h.

◆ WithHsmConfigurationIdentifier() [2/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithHsmConfigurationIdentifier ( Aws::String &&  value)
inline

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.

Definition at line 1094 of file ModifyClusterRequest.h.

◆ WithHsmConfigurationIdentifier() [3/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithHsmConfigurationIdentifier ( const char *  value)
inline

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.

Definition at line 1100 of file ModifyClusterRequest.h.

◆ WithKmsKeyId() [1/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithKmsKeyId ( const Aws::String value)
inline

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

Definition at line 1487 of file ModifyClusterRequest.h.

◆ WithKmsKeyId() [2/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithKmsKeyId ( Aws::String &&  value)
inline

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

Definition at line 1493 of file ModifyClusterRequest.h.

◆ WithKmsKeyId() [3/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithKmsKeyId ( const char *  value)
inline

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

Definition at line 1499 of file ModifyClusterRequest.h.

◆ WithMaintenanceTrackName() [1/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithMaintenanceTrackName ( const Aws::String value)
inline

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.

Definition at line 1393 of file ModifyClusterRequest.h.

◆ WithMaintenanceTrackName() [2/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithMaintenanceTrackName ( Aws::String &&  value)
inline

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.

Definition at line 1403 of file ModifyClusterRequest.h.

◆ WithMaintenanceTrackName() [3/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithMaintenanceTrackName ( const char *  value)
inline

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.

Definition at line 1413 of file ModifyClusterRequest.h.

◆ WithManualSnapshotRetentionPeriod()

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithManualSnapshotRetentionPeriod ( int  value)
inline

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.

Definition at line 763 of file ModifyClusterRequest.h.

◆ WithMasterUserPassword() [1/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithMasterUserPassword ( const Aws::String value)
inline

The new password for the cluster master 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.

Operations never return the password, so this operation provides a way to regain access to the master 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 to 126) except ' (single quote), " (double quote), \, /, @, or space.

Definition at line 576 of file ModifyClusterRequest.h.

◆ WithMasterUserPassword() [2/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithMasterUserPassword ( Aws::String &&  value)
inline

The new password for the cluster master 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.

Operations never return the password, so this operation provides a way to regain access to the master 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 to 126) except ' (single quote), " (double quote), \, /, @, or space.

Definition at line 592 of file ModifyClusterRequest.h.

◆ WithMasterUserPassword() [3/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithMasterUserPassword ( const char *  value)
inline

The new password for the cluster master 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.

Operations never return the password, so this operation provides a way to regain access to the master 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 to 126) except ' (single quote), " (double quote), \, /, @, or space.

Definition at line 608 of file ModifyClusterRequest.h.

◆ WithNewClusterIdentifier() [1/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithNewClusterIdentifier ( const Aws::String value)
inline

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

Example: examplecluster

Definition at line 1161 of file ModifyClusterRequest.h.

◆ WithNewClusterIdentifier() [2/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithNewClusterIdentifier ( Aws::String &&  value)
inline

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

Example: examplecluster

Definition at line 1171 of file ModifyClusterRequest.h.

◆ WithNewClusterIdentifier() [3/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithNewClusterIdentifier ( const char *  value)
inline

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

Example: examplecluster

Definition at line 1181 of file ModifyClusterRequest.h.

◆ WithNodeType() [1/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithNodeType ( const Aws::String value)
inline

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: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge

Definition at line 257 of file ModifyClusterRequest.h.

◆ WithNodeType() [2/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithNodeType ( Aws::String &&  value)
inline

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: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge

Definition at line 270 of file ModifyClusterRequest.h.

◆ WithNodeType() [3/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithNodeType ( const char *  value)
inline

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: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge

Definition at line 283 of file ModifyClusterRequest.h.

◆ WithNumberOfNodes()

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithNumberOfNodes ( int  value)
inline

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.

Definition at line 324 of file ModifyClusterRequest.h.

◆ WithPreferredMaintenanceWindow() [1/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithPreferredMaintenanceWindow ( const Aws::String value)
inline

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.

Definition at line 842 of file ModifyClusterRequest.h.

◆ WithPreferredMaintenanceWindow() [2/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithPreferredMaintenanceWindow ( Aws::String &&  value)
inline

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.

Definition at line 855 of file ModifyClusterRequest.h.

◆ WithPreferredMaintenanceWindow() [3/3]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithPreferredMaintenanceWindow ( const char *  value)
inline

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.

Definition at line 868 of file ModifyClusterRequest.h.

◆ WithPubliclyAccessible()

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithPubliclyAccessible ( bool  value)
inline

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

Definition at line 1206 of file ModifyClusterRequest.h.

◆ WithVpcSecurityGroupIds() [1/2]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithVpcSecurityGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 455 of file ModifyClusterRequest.h.

◆ WithVpcSecurityGroupIds() [2/2]

ModifyClusterRequest& Aws::Redshift::Model::ModifyClusterRequest::WithVpcSecurityGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 461 of file ModifyClusterRequest.h.


The documentation for this class was generated from the following file: