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

#include <CreateClusterRequest.h>

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

Public Member Functions

 CreateClusterRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetDBName () const
 
bool DBNameHasBeenSet () const
 
void SetDBName (const Aws::String &value)
 
void SetDBName (Aws::String &&value)
 
void SetDBName (const char *value)
 
CreateClusterRequestWithDBName (const Aws::String &value)
 
CreateClusterRequestWithDBName (Aws::String &&value)
 
CreateClusterRequestWithDBName (const char *value)
 
const Aws::StringGetClusterIdentifier () const
 
bool ClusterIdentifierHasBeenSet () const
 
void SetClusterIdentifier (const Aws::String &value)
 
void SetClusterIdentifier (Aws::String &&value)
 
void SetClusterIdentifier (const char *value)
 
CreateClusterRequestWithClusterIdentifier (const Aws::String &value)
 
CreateClusterRequestWithClusterIdentifier (Aws::String &&value)
 
CreateClusterRequestWithClusterIdentifier (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)
 
CreateClusterRequestWithClusterType (const Aws::String &value)
 
CreateClusterRequestWithClusterType (Aws::String &&value)
 
CreateClusterRequestWithClusterType (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)
 
CreateClusterRequestWithNodeType (const Aws::String &value)
 
CreateClusterRequestWithNodeType (Aws::String &&value)
 
CreateClusterRequestWithNodeType (const char *value)
 
const Aws::StringGetMasterUsername () const
 
bool MasterUsernameHasBeenSet () const
 
void SetMasterUsername (const Aws::String &value)
 
void SetMasterUsername (Aws::String &&value)
 
void SetMasterUsername (const char *value)
 
CreateClusterRequestWithMasterUsername (const Aws::String &value)
 
CreateClusterRequestWithMasterUsername (Aws::String &&value)
 
CreateClusterRequestWithMasterUsername (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)
 
CreateClusterRequestWithMasterUserPassword (const Aws::String &value)
 
CreateClusterRequestWithMasterUserPassword (Aws::String &&value)
 
CreateClusterRequestWithMasterUserPassword (const char *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)
 
CreateClusterRequestWithClusterSecurityGroups (const Aws::Vector< Aws::String > &value)
 
CreateClusterRequestWithClusterSecurityGroups (Aws::Vector< Aws::String > &&value)
 
CreateClusterRequestAddClusterSecurityGroups (const Aws::String &value)
 
CreateClusterRequestAddClusterSecurityGroups (Aws::String &&value)
 
CreateClusterRequestAddClusterSecurityGroups (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)
 
CreateClusterRequestWithVpcSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
CreateClusterRequestWithVpcSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
CreateClusterRequestAddVpcSecurityGroupIds (const Aws::String &value)
 
CreateClusterRequestAddVpcSecurityGroupIds (Aws::String &&value)
 
CreateClusterRequestAddVpcSecurityGroupIds (const char *value)
 
const Aws::StringGetClusterSubnetGroupName () const
 
bool ClusterSubnetGroupNameHasBeenSet () const
 
void SetClusterSubnetGroupName (const Aws::String &value)
 
void SetClusterSubnetGroupName (Aws::String &&value)
 
void SetClusterSubnetGroupName (const char *value)
 
CreateClusterRequestWithClusterSubnetGroupName (const Aws::String &value)
 
CreateClusterRequestWithClusterSubnetGroupName (Aws::String &&value)
 
CreateClusterRequestWithClusterSubnetGroupName (const char *value)
 
const Aws::StringGetAvailabilityZone () const
 
bool AvailabilityZoneHasBeenSet () const
 
void SetAvailabilityZone (const Aws::String &value)
 
void SetAvailabilityZone (Aws::String &&value)
 
void SetAvailabilityZone (const char *value)
 
CreateClusterRequestWithAvailabilityZone (const Aws::String &value)
 
CreateClusterRequestWithAvailabilityZone (Aws::String &&value)
 
CreateClusterRequestWithAvailabilityZone (const char *value)
 
const Aws::StringGetPreferredMaintenanceWindow () const
 
bool PreferredMaintenanceWindowHasBeenSet () const
 
void SetPreferredMaintenanceWindow (const Aws::String &value)
 
void SetPreferredMaintenanceWindow (Aws::String &&value)
 
void SetPreferredMaintenanceWindow (const char *value)
 
CreateClusterRequestWithPreferredMaintenanceWindow (const Aws::String &value)
 
CreateClusterRequestWithPreferredMaintenanceWindow (Aws::String &&value)
 
CreateClusterRequestWithPreferredMaintenanceWindow (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)
 
CreateClusterRequestWithClusterParameterGroupName (const Aws::String &value)
 
CreateClusterRequestWithClusterParameterGroupName (Aws::String &&value)
 
CreateClusterRequestWithClusterParameterGroupName (const char *value)
 
int GetAutomatedSnapshotRetentionPeriod () const
 
bool AutomatedSnapshotRetentionPeriodHasBeenSet () const
 
void SetAutomatedSnapshotRetentionPeriod (int value)
 
CreateClusterRequestWithAutomatedSnapshotRetentionPeriod (int value)
 
int GetManualSnapshotRetentionPeriod () const
 
bool ManualSnapshotRetentionPeriodHasBeenSet () const
 
void SetManualSnapshotRetentionPeriod (int value)
 
CreateClusterRequestWithManualSnapshotRetentionPeriod (int value)
 
int GetPort () const
 
bool PortHasBeenSet () const
 
void SetPort (int value)
 
CreateClusterRequestWithPort (int value)
 
const Aws::StringGetClusterVersion () const
 
bool ClusterVersionHasBeenSet () const
 
void SetClusterVersion (const Aws::String &value)
 
void SetClusterVersion (Aws::String &&value)
 
void SetClusterVersion (const char *value)
 
CreateClusterRequestWithClusterVersion (const Aws::String &value)
 
CreateClusterRequestWithClusterVersion (Aws::String &&value)
 
CreateClusterRequestWithClusterVersion (const char *value)
 
bool GetAllowVersionUpgrade () const
 
bool AllowVersionUpgradeHasBeenSet () const
 
void SetAllowVersionUpgrade (bool value)
 
CreateClusterRequestWithAllowVersionUpgrade (bool value)
 
int GetNumberOfNodes () const
 
bool NumberOfNodesHasBeenSet () const
 
void SetNumberOfNodes (int value)
 
CreateClusterRequestWithNumberOfNodes (int value)
 
bool GetPubliclyAccessible () const
 
bool PubliclyAccessibleHasBeenSet () const
 
void SetPubliclyAccessible (bool value)
 
CreateClusterRequestWithPubliclyAccessible (bool value)
 
bool GetEncrypted () const
 
bool EncryptedHasBeenSet () const
 
void SetEncrypted (bool value)
 
CreateClusterRequestWithEncrypted (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)
 
CreateClusterRequestWithHsmClientCertificateIdentifier (const Aws::String &value)
 
CreateClusterRequestWithHsmClientCertificateIdentifier (Aws::String &&value)
 
CreateClusterRequestWithHsmClientCertificateIdentifier (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)
 
CreateClusterRequestWithHsmConfigurationIdentifier (const Aws::String &value)
 
CreateClusterRequestWithHsmConfigurationIdentifier (Aws::String &&value)
 
CreateClusterRequestWithHsmConfigurationIdentifier (const char *value)
 
const Aws::StringGetElasticIp () const
 
bool ElasticIpHasBeenSet () const
 
void SetElasticIp (const Aws::String &value)
 
void SetElasticIp (Aws::String &&value)
 
void SetElasticIp (const char *value)
 
CreateClusterRequestWithElasticIp (const Aws::String &value)
 
CreateClusterRequestWithElasticIp (Aws::String &&value)
 
CreateClusterRequestWithElasticIp (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateClusterRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateClusterRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateClusterRequestAddTags (const Tag &value)
 
CreateClusterRequestAddTags (Tag &&value)
 
const Aws::StringGetKmsKeyId () const
 
bool KmsKeyIdHasBeenSet () const
 
void SetKmsKeyId (const Aws::String &value)
 
void SetKmsKeyId (Aws::String &&value)
 
void SetKmsKeyId (const char *value)
 
CreateClusterRequestWithKmsKeyId (const Aws::String &value)
 
CreateClusterRequestWithKmsKeyId (Aws::String &&value)
 
CreateClusterRequestWithKmsKeyId (const char *value)
 
bool GetEnhancedVpcRouting () const
 
bool EnhancedVpcRoutingHasBeenSet () const
 
void SetEnhancedVpcRouting (bool value)
 
CreateClusterRequestWithEnhancedVpcRouting (bool value)
 
const Aws::StringGetAdditionalInfo () const
 
bool AdditionalInfoHasBeenSet () const
 
void SetAdditionalInfo (const Aws::String &value)
 
void SetAdditionalInfo (Aws::String &&value)
 
void SetAdditionalInfo (const char *value)
 
CreateClusterRequestWithAdditionalInfo (const Aws::String &value)
 
CreateClusterRequestWithAdditionalInfo (Aws::String &&value)
 
CreateClusterRequestWithAdditionalInfo (const char *value)
 
const Aws::Vector< Aws::String > & GetIamRoles () const
 
bool IamRolesHasBeenSet () const
 
void SetIamRoles (const Aws::Vector< Aws::String > &value)
 
void SetIamRoles (Aws::Vector< Aws::String > &&value)
 
CreateClusterRequestWithIamRoles (const Aws::Vector< Aws::String > &value)
 
CreateClusterRequestWithIamRoles (Aws::Vector< Aws::String > &&value)
 
CreateClusterRequestAddIamRoles (const Aws::String &value)
 
CreateClusterRequestAddIamRoles (Aws::String &&value)
 
CreateClusterRequestAddIamRoles (const char *value)
 
const Aws::StringGetMaintenanceTrackName () const
 
bool MaintenanceTrackNameHasBeenSet () const
 
void SetMaintenanceTrackName (const Aws::String &value)
 
void SetMaintenanceTrackName (Aws::String &&value)
 
void SetMaintenanceTrackName (const char *value)
 
CreateClusterRequestWithMaintenanceTrackName (const Aws::String &value)
 
CreateClusterRequestWithMaintenanceTrackName (Aws::String &&value)
 
CreateClusterRequestWithMaintenanceTrackName (const char *value)
 
const Aws::StringGetSnapshotScheduleIdentifier () const
 
bool SnapshotScheduleIdentifierHasBeenSet () const
 
void SetSnapshotScheduleIdentifier (const Aws::String &value)
 
void SetSnapshotScheduleIdentifier (Aws::String &&value)
 
void SetSnapshotScheduleIdentifier (const char *value)
 
CreateClusterRequestWithSnapshotScheduleIdentifier (const Aws::String &value)
 
CreateClusterRequestWithSnapshotScheduleIdentifier (Aws::String &&value)
 
CreateClusterRequestWithSnapshotScheduleIdentifier (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 26 of file CreateClusterRequest.h.

Constructor & Destructor Documentation

◆ CreateClusterRequest()

Aws::Redshift::Model::CreateClusterRequest::CreateClusterRequest ( )

Member Function Documentation

◆ AddClusterSecurityGroups() [1/3]

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

A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

Definition at line 666 of file CreateClusterRequest.h.

◆ AddClusterSecurityGroups() [2/3]

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

A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

Definition at line 672 of file CreateClusterRequest.h.

◆ AddClusterSecurityGroups() [3/3]

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

A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

Definition at line 678 of file CreateClusterRequest.h.

◆ AddIamRoles() [1/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::AddIamRoles ( const Aws::String value)
inline

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

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

Definition at line 1829 of file CreateClusterRequest.h.

◆ AddIamRoles() [2/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::AddIamRoles ( Aws::String &&  value)
inline

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

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

Definition at line 1838 of file CreateClusterRequest.h.

◆ AddIamRoles() [3/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::AddIamRoles ( const char *  value)
inline

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

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

Definition at line 1847 of file CreateClusterRequest.h.

◆ AdditionalInfoHasBeenSet()

bool Aws::Redshift::Model::CreateClusterRequest::AdditionalInfoHasBeenSet ( ) const
inline

Reserved.

Definition at line 1735 of file CreateClusterRequest.h.

◆ AddTags() [1/2]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::AddTags ( const Tag value)
inline

A list of tag instances.

Definition at line 1625 of file CreateClusterRequest.h.

◆ AddTags() [2/2]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::AddTags ( Tag &&  value)
inline

A list of tag instances.

Definition at line 1630 of file CreateClusterRequest.h.

◆ AddVpcSecurityGroupIds() [1/3]

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

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Default: The default VPC security group is associated with the cluster.

Definition at line 728 of file CreateClusterRequest.h.

◆ AddVpcSecurityGroupIds() [2/3]

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

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Default: The default VPC security group is associated with the cluster.

Definition at line 735 of file CreateClusterRequest.h.

◆ AddVpcSecurityGroupIds() [3/3]

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

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Default: The default VPC security group is associated with the cluster.

Definition at line 742 of file CreateClusterRequest.h.

◆ AllowVersionUpgradeHasBeenSet()

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

If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.

Default: true

Definition at line 1291 of file CreateClusterRequest.h.

◆ AutomatedSnapshotRetentionPeriodHasBeenSet()

bool Aws::Redshift::Model::CreateClusterRequest::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.

Default: 1

Constraints: Must be a value from 0 to 35.

Definition at line 1117 of file CreateClusterRequest.h.

◆ AvailabilityZoneHasBeenSet()

bool Aws::Redshift::Model::CreateClusterRequest::AvailabilityZoneHasBeenSet ( ) const
inline

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.

Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.

Example: us-east-2d

Constraint: The specified Availability Zone must be in the same region as the current endpoint.

Definition at line 824 of file CreateClusterRequest.h.

◆ ClusterIdentifierHasBeenSet()

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

A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.

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: myexamplecluster

Definition at line 197 of file CreateClusterRequest.h.

◆ ClusterParameterGroupNameHasBeenSet()

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

The name of the parameter group to be associated with this cluster.

Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups

Constraints:

  • Must be 1 to 255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 1026 of file CreateClusterRequest.h.

◆ ClusterSecurityGroupsHasBeenSet()

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

A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

Definition at line 636 of file CreateClusterRequest.h.

◆ ClusterSubnetGroupNameHasBeenSet()

bool Aws::Redshift::Model::CreateClusterRequest::ClusterSubnetGroupNameHasBeenSet ( ) const
inline

The name of a cluster subnet group to be associated with this cluster.

If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

Definition at line 757 of file CreateClusterRequest.h.

◆ ClusterTypeHasBeenSet()

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

The type of the cluster. When cluster type is specified as

  • single-node, the NumberOfNodes parameter is not required.

  • multi-node, the NumberOfNodes parameter is required.

Valid Values: multi-node | single-node

Default: multi-node

Definition at line 294 of file CreateClusterRequest.h.

◆ ClusterVersionHasBeenSet()

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

The version of the Amazon Redshift engine software that you want to deploy on the cluster.

The version selected runs on all the nodes in the cluster.

Constraints: Only version 1.0 is currently available.

Example: 1.0

Definition at line 1222 of file CreateClusterRequest.h.

◆ DBNameHasBeenSet()

bool Aws::Redshift::Model::CreateClusterRequest::DBNameHasBeenSet ( ) const
inline

The name of the first database to be created when the cluster is created.

To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.

Default: dev

Constraints:

  • Must contain 1 to 64 alphanumeric characters.

  • Must contain only lowercase letters.

  • Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Definition at line 74 of file CreateClusterRequest.h.

◆ DumpBodyToUrl()

void Aws::Redshift::Model::CreateClusterRequest::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::CreateClusterRequest::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 1529 of file CreateClusterRequest.h.

◆ EncryptedHasBeenSet()

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

If true, the data in the cluster is encrypted at rest.

Default: false

Definition at line 1398 of file CreateClusterRequest.h.

◆ EnhancedVpcRoutingHasBeenSet()

bool Aws::Redshift::Model::CreateClusterRequest::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 1702 of file CreateClusterRequest.h.

◆ GetAdditionalInfo()

const Aws::String& Aws::Redshift::Model::CreateClusterRequest::GetAdditionalInfo ( ) const
inline

Reserved.

Definition at line 1730 of file CreateClusterRequest.h.

◆ GetAllowVersionUpgrade()

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

If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.

Default: true

Definition at line 1281 of file CreateClusterRequest.h.

◆ GetAutomatedSnapshotRetentionPeriod()

int Aws::Redshift::Model::CreateClusterRequest::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.

Default: 1

Constraints: Must be a value from 0 to 35.

Definition at line 1108 of file CreateClusterRequest.h.

◆ GetAvailabilityZone()

const Aws::String& Aws::Redshift::Model::CreateClusterRequest::GetAvailabilityZone ( ) const
inline

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.

Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.

Example: us-east-2d

Constraint: The specified Availability Zone must be in the same region as the current endpoint.

Definition at line 812 of file CreateClusterRequest.h.

◆ GetClusterIdentifier()

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

A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.

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: myexamplecluster

Definition at line 184 of file CreateClusterRequest.h.

◆ GetClusterParameterGroupName()

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

The name of the parameter group to be associated with this cluster.

Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups

Constraints:

  • Must be 1 to 255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 1014 of file CreateClusterRequest.h.

◆ GetClusterSecurityGroups()

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

A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

Definition at line 630 of file CreateClusterRequest.h.

◆ GetClusterSubnetGroupName()

const Aws::String& Aws::Redshift::Model::CreateClusterRequest::GetClusterSubnetGroupName ( ) const
inline

The name of a cluster subnet group to be associated with this cluster.

If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

Definition at line 750 of file CreateClusterRequest.h.

◆ GetClusterType()

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

The type of the cluster. When cluster type is specified as

  • single-node, the NumberOfNodes parameter is not required.

  • multi-node, the NumberOfNodes parameter is required.

Valid Values: multi-node | single-node

Default: multi-node

Definition at line 285 of file CreateClusterRequest.h.

◆ GetClusterVersion()

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

The version of the Amazon Redshift engine software that you want to deploy on the cluster.

The version selected runs on all the nodes in the cluster.

Constraints: Only version 1.0 is currently available.

Example: 1.0

Definition at line 1214 of file CreateClusterRequest.h.

◆ GetDBName()

const Aws::String& Aws::Redshift::Model::CreateClusterRequest::GetDBName ( ) const
inline

The name of the first database to be created when the cluster is created.

To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.

Default: dev

Constraints:

  • Must contain 1 to 64 alphanumeric characters.

  • Must contain only lowercase letters.

  • Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Definition at line 58 of file CreateClusterRequest.h.

◆ GetElasticIp()

const Aws::String& Aws::Redshift::Model::CreateClusterRequest::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 1519 of file CreateClusterRequest.h.

◆ GetEncrypted()

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

If true, the data in the cluster is encrypted at rest.

Default: false

Definition at line 1392 of file CreateClusterRequest.h.

◆ GetEnhancedVpcRouting()

bool Aws::Redshift::Model::CreateClusterRequest::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 1691 of file CreateClusterRequest.h.

◆ GetHsmClientCertificateIdentifier()

const Aws::String& Aws::Redshift::Model::CreateClusterRequest::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 1417 of file CreateClusterRequest.h.

◆ GetHsmConfigurationIdentifier()

const Aws::String& Aws::Redshift::Model::CreateClusterRequest::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 1466 of file CreateClusterRequest.h.

◆ GetIamRoles()

const Aws::Vector<Aws::String>& Aws::Redshift::Model::CreateClusterRequest::GetIamRoles ( ) const
inline

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

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

Definition at line 1775 of file CreateClusterRequest.h.

◆ GetKmsKeyId()

const Aws::String& Aws::Redshift::Model::CreateClusterRequest::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 1637 of file CreateClusterRequest.h.

◆ GetMaintenanceTrackName()

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

An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current track.

Definition at line 1855 of file CreateClusterRequest.h.

◆ GetManualSnapshotRetentionPeriod()

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

The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

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

Definition at line 1144 of file CreateClusterRequest.h.

◆ GetMasterUsername()

const Aws::String& Aws::Redshift::Model::CreateClusterRequest::GetMasterUsername ( ) const
inline

The user name associated with the master user account for the cluster that is being created.

Constraints:

  • Must be 1 - 128 alphanumeric characters. The user name can't be PUBLIC.

  • First character must be a letter.

  • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Definition at line 457 of file CreateClusterRequest.h.

◆ GetMasterUserPassword()

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

The password associated with the master user account for the cluster that is being created.

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 546 of file CreateClusterRequest.h.

◆ GetNodeType()

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

The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters 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 361 of file CreateClusterRequest.h.

◆ GetNumberOfNodes()

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

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.

If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.

Default: 1

Constraints: Value must be at least 1 and no more than 100.

Definition at line 1325 of file CreateClusterRequest.h.

◆ GetPort()

int Aws::Redshift::Model::CreateClusterRequest::GetPort ( ) const
inline

The port number on which the cluster accepts incoming connections.

The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.

Default: 5439

Valid Values: 1150-65535

Definition at line 1178 of file CreateClusterRequest.h.

◆ GetPreferredMaintenanceWindow()

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

The weekly time range (in UTC) during which automated cluster maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

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

Constraints: Minimum 30-minute window.

Definition at line 910 of file CreateClusterRequest.h.

◆ GetPubliclyAccessible()

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

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

Definition at line 1370 of file CreateClusterRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file CreateClusterRequest.h.

◆ GetSnapshotScheduleIdentifier()

const Aws::String& Aws::Redshift::Model::CreateClusterRequest::GetSnapshotScheduleIdentifier ( ) const
inline

A unique identifier for the snapshot schedule.

Definition at line 1910 of file CreateClusterRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::Redshift::Model::CreateClusterRequest::GetTags ( ) const
inline

A list of tag instances.

Definition at line 1595 of file CreateClusterRequest.h.

◆ GetVpcSecurityGroupIds()

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

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Default: The default VPC security group is associated with the cluster.

Definition at line 686 of file CreateClusterRequest.h.

◆ HsmClientCertificateIdentifierHasBeenSet()

bool Aws::Redshift::Model::CreateClusterRequest::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 1423 of file CreateClusterRequest.h.

◆ HsmConfigurationIdentifierHasBeenSet()

bool Aws::Redshift::Model::CreateClusterRequest::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 1472 of file CreateClusterRequest.h.

◆ IamRolesHasBeenSet()

bool Aws::Redshift::Model::CreateClusterRequest::IamRolesHasBeenSet ( ) const
inline

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

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

Definition at line 1784 of file CreateClusterRequest.h.

◆ KmsKeyIdHasBeenSet()

bool Aws::Redshift::Model::CreateClusterRequest::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 1643 of file CreateClusterRequest.h.

◆ MaintenanceTrackNameHasBeenSet()

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

An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current track.

Definition at line 1862 of file CreateClusterRequest.h.

◆ ManualSnapshotRetentionPeriodHasBeenSet()

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

The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

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

Definition at line 1152 of file CreateClusterRequest.h.

◆ MasterUsernameHasBeenSet()

bool Aws::Redshift::Model::CreateClusterRequest::MasterUsernameHasBeenSet ( ) const
inline

The user name associated with the master user account for the cluster that is being created.

Constraints:

  • Must be 1 - 128 alphanumeric characters. The user name can't be PUBLIC.

  • First character must be a letter.

  • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Definition at line 468 of file CreateClusterRequest.h.

◆ MasterUserPasswordHasBeenSet()

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

The password associated with the master user account for the cluster that is being created.

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 557 of file CreateClusterRequest.h.

◆ NodeTypeHasBeenSet()

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

The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters 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 373 of file CreateClusterRequest.h.

◆ NumberOfNodesHasBeenSet()

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

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.

If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.

Default: 1

Constraints: Value must be at least 1 and no more than 100.

Definition at line 1338 of file CreateClusterRequest.h.

◆ PortHasBeenSet()

bool Aws::Redshift::Model::CreateClusterRequest::PortHasBeenSet ( ) const
inline

The port number on which the cluster accepts incoming connections.

The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.

Default: 5439

Valid Values: 1150-65535

Definition at line 1187 of file CreateClusterRequest.h.

◆ PreferredMaintenanceWindowHasBeenSet()

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

The weekly time range (in UTC) during which automated cluster maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

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

Constraints: Minimum 30-minute window.

Definition at line 923 of file CreateClusterRequest.h.

◆ PubliclyAccessibleHasBeenSet()

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

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

Definition at line 1375 of file CreateClusterRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAdditionalInfo() [1/3]

void Aws::Redshift::Model::CreateClusterRequest::SetAdditionalInfo ( const Aws::String value)
inline

Reserved.

Definition at line 1740 of file CreateClusterRequest.h.

◆ SetAdditionalInfo() [2/3]

void Aws::Redshift::Model::CreateClusterRequest::SetAdditionalInfo ( Aws::String &&  value)
inline

Reserved.

Definition at line 1745 of file CreateClusterRequest.h.

◆ SetAdditionalInfo() [3/3]

void Aws::Redshift::Model::CreateClusterRequest::SetAdditionalInfo ( const char *  value)
inline

Reserved.

Definition at line 1750 of file CreateClusterRequest.h.

◆ SetAllowVersionUpgrade()

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

If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.

Default: true

Definition at line 1301 of file CreateClusterRequest.h.

◆ SetAutomatedSnapshotRetentionPeriod()

void Aws::Redshift::Model::CreateClusterRequest::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.

Default: 1

Constraints: Must be a value from 0 to 35.

Definition at line 1126 of file CreateClusterRequest.h.

◆ SetAvailabilityZone() [1/3]

void Aws::Redshift::Model::CreateClusterRequest::SetAvailabilityZone ( const Aws::String value)
inline

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.

Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.

Example: us-east-2d

Constraint: The specified Availability Zone must be in the same region as the current endpoint.

Definition at line 836 of file CreateClusterRequest.h.

◆ SetAvailabilityZone() [2/3]

void Aws::Redshift::Model::CreateClusterRequest::SetAvailabilityZone ( Aws::String &&  value)
inline

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.

Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.

Example: us-east-2d

Constraint: The specified Availability Zone must be in the same region as the current endpoint.

Definition at line 848 of file CreateClusterRequest.h.

◆ SetAvailabilityZone() [3/3]

void Aws::Redshift::Model::CreateClusterRequest::SetAvailabilityZone ( const char *  value)
inline

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.

Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.

Example: us-east-2d

Constraint: The specified Availability Zone must be in the same region as the current endpoint.

Definition at line 860 of file CreateClusterRequest.h.

◆ SetClusterIdentifier() [1/3]

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

A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.

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: myexamplecluster

Definition at line 210 of file CreateClusterRequest.h.

◆ SetClusterIdentifier() [2/3]

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

A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.

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: myexamplecluster

Definition at line 223 of file CreateClusterRequest.h.

◆ SetClusterIdentifier() [3/3]

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

A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.

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: myexamplecluster

Definition at line 236 of file CreateClusterRequest.h.

◆ SetClusterParameterGroupName() [1/3]

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

The name of the parameter group to be associated with this cluster.

Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups

Constraints:

  • Must be 1 to 255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 1038 of file CreateClusterRequest.h.

◆ SetClusterParameterGroupName() [2/3]

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

The name of the parameter group to be associated with this cluster.

Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups

Constraints:

  • Must be 1 to 255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 1050 of file CreateClusterRequest.h.

◆ SetClusterParameterGroupName() [3/3]

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

The name of the parameter group to be associated with this cluster.

Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups

Constraints:

  • Must be 1 to 255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 1062 of file CreateClusterRequest.h.

◆ SetClusterSecurityGroups() [1/2]

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

A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

Definition at line 642 of file CreateClusterRequest.h.

◆ SetClusterSecurityGroups() [2/2]

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

A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

Definition at line 648 of file CreateClusterRequest.h.

◆ SetClusterSubnetGroupName() [1/3]

void Aws::Redshift::Model::CreateClusterRequest::SetClusterSubnetGroupName ( const Aws::String value)
inline

The name of a cluster subnet group to be associated with this cluster.

If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

Definition at line 764 of file CreateClusterRequest.h.

◆ SetClusterSubnetGroupName() [2/3]

void Aws::Redshift::Model::CreateClusterRequest::SetClusterSubnetGroupName ( Aws::String &&  value)
inline

The name of a cluster subnet group to be associated with this cluster.

If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

Definition at line 771 of file CreateClusterRequest.h.

◆ SetClusterSubnetGroupName() [3/3]

void Aws::Redshift::Model::CreateClusterRequest::SetClusterSubnetGroupName ( const char *  value)
inline

The name of a cluster subnet group to be associated with this cluster.

If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

Definition at line 778 of file CreateClusterRequest.h.

◆ SetClusterType() [1/3]

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

The type of the cluster. When cluster type is specified as

  • single-node, the NumberOfNodes parameter is not required.

  • multi-node, the NumberOfNodes parameter is required.

Valid Values: multi-node | single-node

Default: multi-node

Definition at line 303 of file CreateClusterRequest.h.

◆ SetClusterType() [2/3]

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

The type of the cluster. When cluster type is specified as

  • single-node, the NumberOfNodes parameter is not required.

  • multi-node, the NumberOfNodes parameter is required.

Valid Values: multi-node | single-node

Default: multi-node

Definition at line 312 of file CreateClusterRequest.h.

◆ SetClusterType() [3/3]

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

The type of the cluster. When cluster type is specified as

  • single-node, the NumberOfNodes parameter is not required.

  • multi-node, the NumberOfNodes parameter is required.

Valid Values: multi-node | single-node

Default: multi-node

Definition at line 321 of file CreateClusterRequest.h.

◆ SetClusterVersion() [1/3]

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

The version of the Amazon Redshift engine software that you want to deploy on the cluster.

The version selected runs on all the nodes in the cluster.

Constraints: Only version 1.0 is currently available.

Example: 1.0

Definition at line 1230 of file CreateClusterRequest.h.

◆ SetClusterVersion() [2/3]

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

The version of the Amazon Redshift engine software that you want to deploy on the cluster.

The version selected runs on all the nodes in the cluster.

Constraints: Only version 1.0 is currently available.

Example: 1.0

Definition at line 1238 of file CreateClusterRequest.h.

◆ SetClusterVersion() [3/3]

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

The version of the Amazon Redshift engine software that you want to deploy on the cluster.

The version selected runs on all the nodes in the cluster.

Constraints: Only version 1.0 is currently available.

Example: 1.0

Definition at line 1246 of file CreateClusterRequest.h.

◆ SetDBName() [1/3]

void Aws::Redshift::Model::CreateClusterRequest::SetDBName ( const Aws::String value)
inline

The name of the first database to be created when the cluster is created.

To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.

Default: dev

Constraints:

  • Must contain 1 to 64 alphanumeric characters.

  • Must contain only lowercase letters.

  • Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Definition at line 90 of file CreateClusterRequest.h.

◆ SetDBName() [2/3]

void Aws::Redshift::Model::CreateClusterRequest::SetDBName ( Aws::String &&  value)
inline

The name of the first database to be created when the cluster is created.

To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.

Default: dev

Constraints:

  • Must contain 1 to 64 alphanumeric characters.

  • Must contain only lowercase letters.

  • Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Definition at line 106 of file CreateClusterRequest.h.

◆ SetDBName() [3/3]

void Aws::Redshift::Model::CreateClusterRequest::SetDBName ( const char *  value)
inline

The name of the first database to be created when the cluster is created.

To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.

Default: dev

Constraints:

  • Must contain 1 to 64 alphanumeric characters.

  • Must contain only lowercase letters.

  • Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Definition at line 122 of file CreateClusterRequest.h.

◆ SetElasticIp() [1/3]

void Aws::Redshift::Model::CreateClusterRequest::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 1539 of file CreateClusterRequest.h.

◆ SetElasticIp() [2/3]

void Aws::Redshift::Model::CreateClusterRequest::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 1549 of file CreateClusterRequest.h.

◆ SetElasticIp() [3/3]

void Aws::Redshift::Model::CreateClusterRequest::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 1559 of file CreateClusterRequest.h.

◆ SetEncrypted()

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

If true, the data in the cluster is encrypted at rest.

Default: false

Definition at line 1404 of file CreateClusterRequest.h.

◆ SetEnhancedVpcRouting()

void Aws::Redshift::Model::CreateClusterRequest::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 1713 of file CreateClusterRequest.h.

◆ SetHsmClientCertificateIdentifier() [1/3]

void Aws::Redshift::Model::CreateClusterRequest::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 1429 of file CreateClusterRequest.h.

◆ SetHsmClientCertificateIdentifier() [2/3]

void Aws::Redshift::Model::CreateClusterRequest::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 1435 of file CreateClusterRequest.h.

◆ SetHsmClientCertificateIdentifier() [3/3]

void Aws::Redshift::Model::CreateClusterRequest::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 1441 of file CreateClusterRequest.h.

◆ SetHsmConfigurationIdentifier() [1/3]

void Aws::Redshift::Model::CreateClusterRequest::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 1478 of file CreateClusterRequest.h.

◆ SetHsmConfigurationIdentifier() [2/3]

void Aws::Redshift::Model::CreateClusterRequest::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 1484 of file CreateClusterRequest.h.

◆ SetHsmConfigurationIdentifier() [3/3]

void Aws::Redshift::Model::CreateClusterRequest::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 1490 of file CreateClusterRequest.h.

◆ SetIamRoles() [1/2]

void Aws::Redshift::Model::CreateClusterRequest::SetIamRoles ( const Aws::Vector< Aws::String > &  value)
inline

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

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

Definition at line 1793 of file CreateClusterRequest.h.

◆ SetIamRoles() [2/2]

void Aws::Redshift::Model::CreateClusterRequest::SetIamRoles ( Aws::Vector< Aws::String > &&  value)
inline

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

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

Definition at line 1802 of file CreateClusterRequest.h.

◆ SetKmsKeyId() [1/3]

void Aws::Redshift::Model::CreateClusterRequest::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 1649 of file CreateClusterRequest.h.

◆ SetKmsKeyId() [2/3]

void Aws::Redshift::Model::CreateClusterRequest::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 1655 of file CreateClusterRequest.h.

◆ SetKmsKeyId() [3/3]

void Aws::Redshift::Model::CreateClusterRequest::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 1661 of file CreateClusterRequest.h.

◆ SetMaintenanceTrackName() [1/3]

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

An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current track.

Definition at line 1869 of file CreateClusterRequest.h.

◆ SetMaintenanceTrackName() [2/3]

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

An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current track.

Definition at line 1876 of file CreateClusterRequest.h.

◆ SetMaintenanceTrackName() [3/3]

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

An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current track.

Definition at line 1883 of file CreateClusterRequest.h.

◆ SetManualSnapshotRetentionPeriod()

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

The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

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

Definition at line 1160 of file CreateClusterRequest.h.

◆ SetMasterUsername() [1/3]

void Aws::Redshift::Model::CreateClusterRequest::SetMasterUsername ( const Aws::String value)
inline

The user name associated with the master user account for the cluster that is being created.

Constraints:

  • Must be 1 - 128 alphanumeric characters. The user name can't be PUBLIC.

  • First character must be a letter.

  • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Definition at line 479 of file CreateClusterRequest.h.

◆ SetMasterUsername() [2/3]

void Aws::Redshift::Model::CreateClusterRequest::SetMasterUsername ( Aws::String &&  value)
inline

The user name associated with the master user account for the cluster that is being created.

Constraints:

  • Must be 1 - 128 alphanumeric characters. The user name can't be PUBLIC.

  • First character must be a letter.

  • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Definition at line 490 of file CreateClusterRequest.h.

◆ SetMasterUsername() [3/3]

void Aws::Redshift::Model::CreateClusterRequest::SetMasterUsername ( const char *  value)
inline

The user name associated with the master user account for the cluster that is being created.

Constraints:

  • Must be 1 - 128 alphanumeric characters. The user name can't be PUBLIC.

  • First character must be a letter.

  • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Definition at line 501 of file CreateClusterRequest.h.

◆ SetMasterUserPassword() [1/3]

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

The password associated with the master user account for the cluster that is being created.

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 568 of file CreateClusterRequest.h.

◆ SetMasterUserPassword() [2/3]

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

The password associated with the master user account for the cluster that is being created.

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 579 of file CreateClusterRequest.h.

◆ SetMasterUserPassword() [3/3]

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

The password associated with the master user account for the cluster that is being created.

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 590 of file CreateClusterRequest.h.

◆ SetNodeType() [1/3]

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

The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters 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 385 of file CreateClusterRequest.h.

◆ SetNodeType() [2/3]

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

The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters 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 397 of file CreateClusterRequest.h.

◆ SetNodeType() [3/3]

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

The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters 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 409 of file CreateClusterRequest.h.

◆ SetNumberOfNodes()

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

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.

If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.

Default: 1

Constraints: Value must be at least 1 and no more than 100.

Definition at line 1351 of file CreateClusterRequest.h.

◆ SetPort()

void Aws::Redshift::Model::CreateClusterRequest::SetPort ( int  value)
inline

The port number on which the cluster accepts incoming connections.

The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.

Default: 5439

Valid Values: 1150-65535

Definition at line 1196 of file CreateClusterRequest.h.

◆ SetPreferredMaintenanceWindow() [1/3]

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

The weekly time range (in UTC) during which automated cluster maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

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

Constraints: Minimum 30-minute window.

Definition at line 936 of file CreateClusterRequest.h.

◆ SetPreferredMaintenanceWindow() [2/3]

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

The weekly time range (in UTC) during which automated cluster maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

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

Constraints: Minimum 30-minute window.

Definition at line 949 of file CreateClusterRequest.h.

◆ SetPreferredMaintenanceWindow() [3/3]

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

The weekly time range (in UTC) during which automated cluster maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

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

Constraints: Minimum 30-minute window.

Definition at line 962 of file CreateClusterRequest.h.

◆ SetPubliclyAccessible()

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

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

Definition at line 1380 of file CreateClusterRequest.h.

◆ SetSnapshotScheduleIdentifier() [1/3]

void Aws::Redshift::Model::CreateClusterRequest::SetSnapshotScheduleIdentifier ( const Aws::String value)
inline

A unique identifier for the snapshot schedule.

Definition at line 1920 of file CreateClusterRequest.h.

◆ SetSnapshotScheduleIdentifier() [2/3]

void Aws::Redshift::Model::CreateClusterRequest::SetSnapshotScheduleIdentifier ( Aws::String &&  value)
inline

A unique identifier for the snapshot schedule.

Definition at line 1925 of file CreateClusterRequest.h.

◆ SetSnapshotScheduleIdentifier() [3/3]

void Aws::Redshift::Model::CreateClusterRequest::SetSnapshotScheduleIdentifier ( const char *  value)
inline

A unique identifier for the snapshot schedule.

Definition at line 1930 of file CreateClusterRequest.h.

◆ SetTags() [1/2]

void Aws::Redshift::Model::CreateClusterRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

A list of tag instances.

Definition at line 1605 of file CreateClusterRequest.h.

◆ SetTags() [2/2]

void Aws::Redshift::Model::CreateClusterRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

A list of tag instances.

Definition at line 1610 of file CreateClusterRequest.h.

◆ SetVpcSecurityGroupIds() [1/2]

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

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Default: The default VPC security group is associated with the cluster.

Definition at line 700 of file CreateClusterRequest.h.

◆ SetVpcSecurityGroupIds() [2/2]

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

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Default: The default VPC security group is associated with the cluster.

Definition at line 707 of file CreateClusterRequest.h.

◆ SnapshotScheduleIdentifierHasBeenSet()

bool Aws::Redshift::Model::CreateClusterRequest::SnapshotScheduleIdentifierHasBeenSet ( ) const
inline

A unique identifier for the snapshot schedule.

Definition at line 1915 of file CreateClusterRequest.h.

◆ TagsHasBeenSet()

bool Aws::Redshift::Model::CreateClusterRequest::TagsHasBeenSet ( ) const
inline

A list of tag instances.

Definition at line 1600 of file CreateClusterRequest.h.

◆ VpcSecurityGroupIdsHasBeenSet()

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

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Default: The default VPC security group is associated with the cluster.

Definition at line 693 of file CreateClusterRequest.h.

◆ WithAdditionalInfo() [1/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::WithAdditionalInfo ( const Aws::String value)
inline

Reserved.

Definition at line 1755 of file CreateClusterRequest.h.

◆ WithAdditionalInfo() [2/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::WithAdditionalInfo ( Aws::String &&  value)
inline

Reserved.

Definition at line 1760 of file CreateClusterRequest.h.

◆ WithAdditionalInfo() [3/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::WithAdditionalInfo ( const char *  value)
inline

Reserved.

Definition at line 1765 of file CreateClusterRequest.h.

◆ WithAllowVersionUpgrade()

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

If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.

Default: true

Definition at line 1311 of file CreateClusterRequest.h.

◆ WithAutomatedSnapshotRetentionPeriod()

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::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.

Default: 1

Constraints: Must be a value from 0 to 35.

Definition at line 1135 of file CreateClusterRequest.h.

◆ WithAvailabilityZone() [1/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::WithAvailabilityZone ( const Aws::String value)
inline

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.

Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.

Example: us-east-2d

Constraint: The specified Availability Zone must be in the same region as the current endpoint.

Definition at line 872 of file CreateClusterRequest.h.

◆ WithAvailabilityZone() [2/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::WithAvailabilityZone ( Aws::String &&  value)
inline

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.

Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.

Example: us-east-2d

Constraint: The specified Availability Zone must be in the same region as the current endpoint.

Definition at line 884 of file CreateClusterRequest.h.

◆ WithAvailabilityZone() [3/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::WithAvailabilityZone ( const char *  value)
inline

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.

Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.

Example: us-east-2d

Constraint: The specified Availability Zone must be in the same region as the current endpoint.

Definition at line 896 of file CreateClusterRequest.h.

◆ WithClusterIdentifier() [1/3]

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

A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.

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: myexamplecluster

Definition at line 249 of file CreateClusterRequest.h.

◆ WithClusterIdentifier() [2/3]

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

A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.

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: myexamplecluster

Definition at line 262 of file CreateClusterRequest.h.

◆ WithClusterIdentifier() [3/3]

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

A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.

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: myexamplecluster

Definition at line 275 of file CreateClusterRequest.h.

◆ WithClusterParameterGroupName() [1/3]

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

The name of the parameter group to be associated with this cluster.

Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups

Constraints:

  • Must be 1 to 255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 1074 of file CreateClusterRequest.h.

◆ WithClusterParameterGroupName() [2/3]

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

The name of the parameter group to be associated with this cluster.

Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups

Constraints:

  • Must be 1 to 255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 1086 of file CreateClusterRequest.h.

◆ WithClusterParameterGroupName() [3/3]

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

The name of the parameter group to be associated with this cluster.

Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups

Constraints:

  • Must be 1 to 255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 1098 of file CreateClusterRequest.h.

◆ WithClusterSecurityGroups() [1/2]

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

A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

Definition at line 654 of file CreateClusterRequest.h.

◆ WithClusterSecurityGroups() [2/2]

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

A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

Definition at line 660 of file CreateClusterRequest.h.

◆ WithClusterSubnetGroupName() [1/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::WithClusterSubnetGroupName ( const Aws::String value)
inline

The name of a cluster subnet group to be associated with this cluster.

If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

Definition at line 785 of file CreateClusterRequest.h.

◆ WithClusterSubnetGroupName() [2/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::WithClusterSubnetGroupName ( Aws::String &&  value)
inline

The name of a cluster subnet group to be associated with this cluster.

If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

Definition at line 792 of file CreateClusterRequest.h.

◆ WithClusterSubnetGroupName() [3/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::WithClusterSubnetGroupName ( const char *  value)
inline

The name of a cluster subnet group to be associated with this cluster.

If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

Definition at line 799 of file CreateClusterRequest.h.

◆ WithClusterType() [1/3]

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

The type of the cluster. When cluster type is specified as

  • single-node, the NumberOfNodes parameter is not required.

  • multi-node, the NumberOfNodes parameter is required.

Valid Values: multi-node | single-node

Default: multi-node

Definition at line 330 of file CreateClusterRequest.h.

◆ WithClusterType() [2/3]

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

The type of the cluster. When cluster type is specified as

  • single-node, the NumberOfNodes parameter is not required.

  • multi-node, the NumberOfNodes parameter is required.

Valid Values: multi-node | single-node

Default: multi-node

Definition at line 339 of file CreateClusterRequest.h.

◆ WithClusterType() [3/3]

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

The type of the cluster. When cluster type is specified as

  • single-node, the NumberOfNodes parameter is not required.

  • multi-node, the NumberOfNodes parameter is required.

Valid Values: multi-node | single-node

Default: multi-node

Definition at line 348 of file CreateClusterRequest.h.

◆ WithClusterVersion() [1/3]

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

The version of the Amazon Redshift engine software that you want to deploy on the cluster.

The version selected runs on all the nodes in the cluster.

Constraints: Only version 1.0 is currently available.

Example: 1.0

Definition at line 1254 of file CreateClusterRequest.h.

◆ WithClusterVersion() [2/3]

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

The version of the Amazon Redshift engine software that you want to deploy on the cluster.

The version selected runs on all the nodes in the cluster.

Constraints: Only version 1.0 is currently available.

Example: 1.0

Definition at line 1262 of file CreateClusterRequest.h.

◆ WithClusterVersion() [3/3]

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

The version of the Amazon Redshift engine software that you want to deploy on the cluster.

The version selected runs on all the nodes in the cluster.

Constraints: Only version 1.0 is currently available.

Example: 1.0

Definition at line 1270 of file CreateClusterRequest.h.

◆ WithDBName() [1/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::WithDBName ( const Aws::String value)
inline

The name of the first database to be created when the cluster is created.

To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.

Default: dev

Constraints:

  • Must contain 1 to 64 alphanumeric characters.

  • Must contain only lowercase letters.

  • Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Definition at line 138 of file CreateClusterRequest.h.

◆ WithDBName() [2/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::WithDBName ( Aws::String &&  value)
inline

The name of the first database to be created when the cluster is created.

To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.

Default: dev

Constraints:

  • Must contain 1 to 64 alphanumeric characters.

  • Must contain only lowercase letters.

  • Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Definition at line 154 of file CreateClusterRequest.h.

◆ WithDBName() [3/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::WithDBName ( const char *  value)
inline

The name of the first database to be created when the cluster is created.

To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.

Default: dev

Constraints:

  • Must contain 1 to 64 alphanumeric characters.

  • Must contain only lowercase letters.

  • Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Definition at line 170 of file CreateClusterRequest.h.

◆ WithElasticIp() [1/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::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 1569 of file CreateClusterRequest.h.

◆ WithElasticIp() [2/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::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 1579 of file CreateClusterRequest.h.

◆ WithElasticIp() [3/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::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 1589 of file CreateClusterRequest.h.

◆ WithEncrypted()

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

If true, the data in the cluster is encrypted at rest.

Default: false

Definition at line 1410 of file CreateClusterRequest.h.

◆ WithEnhancedVpcRouting()

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::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 1724 of file CreateClusterRequest.h.

◆ WithHsmClientCertificateIdentifier() [1/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::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 1447 of file CreateClusterRequest.h.

◆ WithHsmClientCertificateIdentifier() [2/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::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 1453 of file CreateClusterRequest.h.

◆ WithHsmClientCertificateIdentifier() [3/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::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 1459 of file CreateClusterRequest.h.

◆ WithHsmConfigurationIdentifier() [1/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::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 1496 of file CreateClusterRequest.h.

◆ WithHsmConfigurationIdentifier() [2/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::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 1502 of file CreateClusterRequest.h.

◆ WithHsmConfigurationIdentifier() [3/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::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 1508 of file CreateClusterRequest.h.

◆ WithIamRoles() [1/2]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::WithIamRoles ( const Aws::Vector< Aws::String > &  value)
inline

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

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

Definition at line 1811 of file CreateClusterRequest.h.

◆ WithIamRoles() [2/2]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::WithIamRoles ( Aws::Vector< Aws::String > &&  value)
inline

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

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

Definition at line 1820 of file CreateClusterRequest.h.

◆ WithKmsKeyId() [1/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::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 1667 of file CreateClusterRequest.h.

◆ WithKmsKeyId() [2/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::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 1673 of file CreateClusterRequest.h.

◆ WithKmsKeyId() [3/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::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 1679 of file CreateClusterRequest.h.

◆ WithMaintenanceTrackName() [1/3]

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

An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current track.

Definition at line 1890 of file CreateClusterRequest.h.

◆ WithMaintenanceTrackName() [2/3]

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

An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current track.

Definition at line 1897 of file CreateClusterRequest.h.

◆ WithMaintenanceTrackName() [3/3]

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

An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current track.

Definition at line 1904 of file CreateClusterRequest.h.

◆ WithManualSnapshotRetentionPeriod()

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

The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

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

Definition at line 1168 of file CreateClusterRequest.h.

◆ WithMasterUsername() [1/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::WithMasterUsername ( const Aws::String value)
inline

The user name associated with the master user account for the cluster that is being created.

Constraints:

  • Must be 1 - 128 alphanumeric characters. The user name can't be PUBLIC.

  • First character must be a letter.

  • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Definition at line 512 of file CreateClusterRequest.h.

◆ WithMasterUsername() [2/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::WithMasterUsername ( Aws::String &&  value)
inline

The user name associated with the master user account for the cluster that is being created.

Constraints:

  • Must be 1 - 128 alphanumeric characters. The user name can't be PUBLIC.

  • First character must be a letter.

  • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Definition at line 523 of file CreateClusterRequest.h.

◆ WithMasterUsername() [3/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::WithMasterUsername ( const char *  value)
inline

The user name associated with the master user account for the cluster that is being created.

Constraints:

  • Must be 1 - 128 alphanumeric characters. The user name can't be PUBLIC.

  • First character must be a letter.

  • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Definition at line 534 of file CreateClusterRequest.h.

◆ WithMasterUserPassword() [1/3]

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

The password associated with the master user account for the cluster that is being created.

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 601 of file CreateClusterRequest.h.

◆ WithMasterUserPassword() [2/3]

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

The password associated with the master user account for the cluster that is being created.

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 612 of file CreateClusterRequest.h.

◆ WithMasterUserPassword() [3/3]

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

The password associated with the master user account for the cluster that is being created.

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 623 of file CreateClusterRequest.h.

◆ WithNodeType() [1/3]

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

The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters 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 421 of file CreateClusterRequest.h.

◆ WithNodeType() [2/3]

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

The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters 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 433 of file CreateClusterRequest.h.

◆ WithNodeType() [3/3]

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

The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters 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 445 of file CreateClusterRequest.h.

◆ WithNumberOfNodes()

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

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.

If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.

Default: 1

Constraints: Value must be at least 1 and no more than 100.

Definition at line 1364 of file CreateClusterRequest.h.

◆ WithPort()

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::WithPort ( int  value)
inline

The port number on which the cluster accepts incoming connections.

The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.

Default: 5439

Valid Values: 1150-65535

Definition at line 1205 of file CreateClusterRequest.h.

◆ WithPreferredMaintenanceWindow() [1/3]

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

The weekly time range (in UTC) during which automated cluster maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

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

Constraints: Minimum 30-minute window.

Definition at line 975 of file CreateClusterRequest.h.

◆ WithPreferredMaintenanceWindow() [2/3]

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

The weekly time range (in UTC) during which automated cluster maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

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

Constraints: Minimum 30-minute window.

Definition at line 988 of file CreateClusterRequest.h.

◆ WithPreferredMaintenanceWindow() [3/3]

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

The weekly time range (in UTC) during which automated cluster maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

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

Constraints: Minimum 30-minute window.

Definition at line 1001 of file CreateClusterRequest.h.

◆ WithPubliclyAccessible()

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

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

Definition at line 1385 of file CreateClusterRequest.h.

◆ WithSnapshotScheduleIdentifier() [1/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::WithSnapshotScheduleIdentifier ( const Aws::String value)
inline

A unique identifier for the snapshot schedule.

Definition at line 1935 of file CreateClusterRequest.h.

◆ WithSnapshotScheduleIdentifier() [2/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::WithSnapshotScheduleIdentifier ( Aws::String &&  value)
inline

A unique identifier for the snapshot schedule.

Definition at line 1940 of file CreateClusterRequest.h.

◆ WithSnapshotScheduleIdentifier() [3/3]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::WithSnapshotScheduleIdentifier ( const char *  value)
inline

A unique identifier for the snapshot schedule.

Definition at line 1945 of file CreateClusterRequest.h.

◆ WithTags() [1/2]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

A list of tag instances.

Definition at line 1615 of file CreateClusterRequest.h.

◆ WithTags() [2/2]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

A list of tag instances.

Definition at line 1620 of file CreateClusterRequest.h.

◆ WithVpcSecurityGroupIds() [1/2]

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

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Default: The default VPC security group is associated with the cluster.

Definition at line 714 of file CreateClusterRequest.h.

◆ WithVpcSecurityGroupIds() [2/2]

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

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Default: The default VPC security group is associated with the cluster.

Definition at line 721 of file CreateClusterRequest.h.


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