AWS SDK for C++  1.9.21
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)
 
bool GetAvailabilityZoneRelocation () const
 
bool AvailabilityZoneRelocationHasBeenSet () const
 
void SetAvailabilityZoneRelocation (bool value)
 
CreateClusterRequestWithAvailabilityZoneRelocation (bool value)
 
const AquaConfigurationStatusGetAquaConfigurationStatus () const
 
bool AquaConfigurationStatusHasBeenSet () const
 
void SetAquaConfigurationStatus (const AquaConfigurationStatus &value)
 
void SetAquaConfigurationStatus (AquaConfigurationStatus &&value)
 
CreateClusterRequestWithAquaConfigurationStatus (const AquaConfigurationStatus &value)
 
CreateClusterRequestWithAquaConfigurationStatus (AquaConfigurationStatus &&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 27 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 ( 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 673 of file CreateClusterRequest.h.

◆ AddClusterSecurityGroups() [2/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 667 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 679 of file CreateClusterRequest.h.

◆ AddIamRoles() [1/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 1847 of file CreateClusterRequest.h.

◆ AddIamRoles() [2/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 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 1856 of file CreateClusterRequest.h.

◆ AdditionalInfoHasBeenSet()

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

Reserved.

Definition at line 1744 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 1634 of file CreateClusterRequest.h.

◆ AddTags() [2/2]

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

A list of tag instances.

Definition at line 1639 of file CreateClusterRequest.h.

◆ AddVpcSecurityGroupIds() [1/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 736 of file CreateClusterRequest.h.

◆ AddVpcSecurityGroupIds() [2/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 729 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 743 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 1300 of file CreateClusterRequest.h.

◆ AquaConfigurationStatusHasBeenSet()

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

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) when it is created. Possible values include the following.

  • enabled - Use AQUA if it is available for the current AWS Region and Amazon Redshift node type.

  • disabled - Don't use AQUA.

  • auto - Amazon Redshift determines whether to use AQUA.

Definition at line 2000 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.

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

Default: 1

Constraints: Must be a value from 0 to 35.

Definition at line 1122 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 825 of file CreateClusterRequest.h.

◆ AvailabilityZoneRelocationHasBeenSet()

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

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.

Definition at line 1967 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 198 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 1027 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 637 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 758 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 295 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 1231 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 75 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 1538 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 1407 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 1711 of file CreateClusterRequest.h.

◆ GetAdditionalInfo()

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

Reserved.

Definition at line 1739 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 1290 of file CreateClusterRequest.h.

◆ GetAquaConfigurationStatus()

const AquaConfigurationStatus& Aws::Redshift::Model::CreateClusterRequest::GetAquaConfigurationStatus ( ) const
inline

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) when it is created. Possible values include the following.

  • enabled - Use AQUA if it is available for the current AWS Region and Amazon Redshift node type.

  • disabled - Don't use AQUA.

  • auto - Amazon Redshift determines whether to use AQUA.

Definition at line 1990 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.

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

Default: 1

Constraints: Must be a value from 0 to 35.

Definition at line 1111 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 813 of file CreateClusterRequest.h.

◆ GetAvailabilityZoneRelocation()

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

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.

Definition at line 1961 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 185 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 1015 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 631 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 751 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 286 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 1223 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 59 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 1528 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 1401 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 1700 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 1426 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 1475 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 1784 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 1646 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 1864 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 1153 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 458 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 547 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.xlplus | ra3.4xlarge | ra3.16xlarge

Definition at line 362 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 1334 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 1187 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 911 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 1379 of file CreateClusterRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 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 1919 of file CreateClusterRequest.h.

◆ GetTags()

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

A list of tag instances.

Definition at line 1604 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 687 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 1432 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 1481 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 1793 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 1652 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 1871 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 1161 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 469 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 558 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.xlplus | ra3.4xlarge | ra3.16xlarge

Definition at line 374 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 1347 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 1196 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 924 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 1384 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 ( Aws::String &&  value)
inline

Reserved.

Definition at line 1754 of file CreateClusterRequest.h.

◆ SetAdditionalInfo() [2/3]

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

Reserved.

Definition at line 1749 of file CreateClusterRequest.h.

◆ SetAdditionalInfo() [3/3]

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

Reserved.

Definition at line 1759 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 1310 of file CreateClusterRequest.h.

◆ SetAquaConfigurationStatus() [1/2]

void Aws::Redshift::Model::CreateClusterRequest::SetAquaConfigurationStatus ( AquaConfigurationStatus &&  value)
inline

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) when it is created. Possible values include the following.

  • enabled - Use AQUA if it is available for the current AWS Region and Amazon Redshift node type.

  • disabled - Don't use AQUA.

  • auto - Amazon Redshift determines whether to use AQUA.

Definition at line 2020 of file CreateClusterRequest.h.

◆ SetAquaConfigurationStatus() [2/2]

void Aws::Redshift::Model::CreateClusterRequest::SetAquaConfigurationStatus ( const AquaConfigurationStatus value)
inline

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) when it is created. Possible values include the following.

  • enabled - Use AQUA if it is available for the current AWS Region and Amazon Redshift node type.

  • disabled - Don't use AQUA.

  • auto - Amazon Redshift determines whether to use AQUA.

Definition at line 2010 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.

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

Default: 1

Constraints: Must be a value from 0 to 35.

Definition at line 1133 of file CreateClusterRequest.h.

◆ SetAvailabilityZone() [1/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 849 of file CreateClusterRequest.h.

◆ SetAvailabilityZone() [2/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 837 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 861 of file CreateClusterRequest.h.

◆ SetAvailabilityZoneRelocation()

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

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.

Definition at line 1973 of file CreateClusterRequest.h.

◆ SetClusterIdentifier() [1/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 224 of file CreateClusterRequest.h.

◆ SetClusterIdentifier() [2/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 211 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 237 of file CreateClusterRequest.h.

◆ SetClusterParameterGroupName() [1/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 1051 of file CreateClusterRequest.h.

◆ SetClusterParameterGroupName() [2/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 1039 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 1063 of file CreateClusterRequest.h.

◆ SetClusterSecurityGroups() [1/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 649 of file CreateClusterRequest.h.

◆ SetClusterSecurityGroups() [2/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 643 of file CreateClusterRequest.h.

◆ SetClusterSubnetGroupName() [1/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 772 of file CreateClusterRequest.h.

◆ SetClusterSubnetGroupName() [2/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 765 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 779 of file CreateClusterRequest.h.

◆ SetClusterType() [1/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 313 of file CreateClusterRequest.h.

◆ SetClusterType() [2/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 304 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 322 of file CreateClusterRequest.h.

◆ SetClusterVersion() [1/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 1247 of file CreateClusterRequest.h.

◆ SetClusterVersion() [2/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 1239 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 1255 of file CreateClusterRequest.h.

◆ SetDBName() [1/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 107 of file CreateClusterRequest.h.

◆ SetDBName() [2/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 91 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 123 of file CreateClusterRequest.h.

◆ SetElasticIp() [1/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 1558 of file CreateClusterRequest.h.

◆ SetElasticIp() [2/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 1548 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 1568 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 1413 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 1722 of file CreateClusterRequest.h.

◆ SetHsmClientCertificateIdentifier() [1/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 1444 of file CreateClusterRequest.h.

◆ SetHsmClientCertificateIdentifier() [2/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 1438 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 1450 of file CreateClusterRequest.h.

◆ SetHsmConfigurationIdentifier() [1/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 1493 of file CreateClusterRequest.h.

◆ SetHsmConfigurationIdentifier() [2/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 1487 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 1499 of file CreateClusterRequest.h.

◆ SetIamRoles() [1/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 1811 of file CreateClusterRequest.h.

◆ SetIamRoles() [2/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 1802 of file CreateClusterRequest.h.

◆ SetKmsKeyId() [1/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 1664 of file CreateClusterRequest.h.

◆ SetKmsKeyId() [2/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 1658 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 1670 of file CreateClusterRequest.h.

◆ SetMaintenanceTrackName() [1/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 1885 of file CreateClusterRequest.h.

◆ SetMaintenanceTrackName() [2/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 1878 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 1892 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 1169 of file CreateClusterRequest.h.

◆ SetMasterUsername() [1/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 491 of file CreateClusterRequest.h.

◆ SetMasterUsername() [2/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 480 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 502 of file CreateClusterRequest.h.

◆ SetMasterUserPassword() [1/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 580 of file CreateClusterRequest.h.

◆ SetMasterUserPassword() [2/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 569 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 591 of file CreateClusterRequest.h.

◆ SetNodeType() [1/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.xlplus | ra3.4xlarge | ra3.16xlarge

Definition at line 398 of file CreateClusterRequest.h.

◆ SetNodeType() [2/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.xlplus | ra3.4xlarge | ra3.16xlarge

Definition at line 386 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.xlplus | ra3.4xlarge | ra3.16xlarge

Definition at line 410 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 1360 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 1205 of file CreateClusterRequest.h.

◆ SetPreferredMaintenanceWindow() [1/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 950 of file CreateClusterRequest.h.

◆ SetPreferredMaintenanceWindow() [2/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 937 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 963 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 1389 of file CreateClusterRequest.h.

◆ SetSnapshotScheduleIdentifier() [1/3]

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

A unique identifier for the snapshot schedule.

Definition at line 1934 of file CreateClusterRequest.h.

◆ SetSnapshotScheduleIdentifier() [2/3]

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

A unique identifier for the snapshot schedule.

Definition at line 1929 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 1939 of file CreateClusterRequest.h.

◆ SetTags() [1/2]

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

A list of tag instances.

Definition at line 1619 of file CreateClusterRequest.h.

◆ SetTags() [2/2]

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

A list of tag instances.

Definition at line 1614 of file CreateClusterRequest.h.

◆ SetVpcSecurityGroupIds() [1/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 708 of file CreateClusterRequest.h.

◆ SetVpcSecurityGroupIds() [2/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 701 of file CreateClusterRequest.h.

◆ SnapshotScheduleIdentifierHasBeenSet()

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

A unique identifier for the snapshot schedule.

Definition at line 1924 of file CreateClusterRequest.h.

◆ TagsHasBeenSet()

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

A list of tag instances.

Definition at line 1609 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 694 of file CreateClusterRequest.h.

◆ WithAdditionalInfo() [1/3]

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

Reserved.

Definition at line 1769 of file CreateClusterRequest.h.

◆ WithAdditionalInfo() [2/3]

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

Reserved.

Definition at line 1764 of file CreateClusterRequest.h.

◆ WithAdditionalInfo() [3/3]

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

Reserved.

Definition at line 1774 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 1320 of file CreateClusterRequest.h.

◆ WithAquaConfigurationStatus() [1/2]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::WithAquaConfigurationStatus ( AquaConfigurationStatus &&  value)
inline

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) when it is created. Possible values include the following.

  • enabled - Use AQUA if it is available for the current AWS Region and Amazon Redshift node type.

  • disabled - Don't use AQUA.

  • auto - Amazon Redshift determines whether to use AQUA.

Definition at line 2040 of file CreateClusterRequest.h.

◆ WithAquaConfigurationStatus() [2/2]

CreateClusterRequest& Aws::Redshift::Model::CreateClusterRequest::WithAquaConfigurationStatus ( const AquaConfigurationStatus value)
inline

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) when it is created. Possible values include the following.

  • enabled - Use AQUA if it is available for the current AWS Region and Amazon Redshift node type.

  • disabled - Don't use AQUA.

  • auto - Amazon Redshift determines whether to use AQUA.

Definition at line 2030 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.

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

Default: 1

Constraints: Must be a value from 0 to 35.

Definition at line 1144 of file CreateClusterRequest.h.

◆ WithAvailabilityZone() [1/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 885 of file CreateClusterRequest.h.

◆ WithAvailabilityZone() [2/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 873 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 897 of file CreateClusterRequest.h.

◆ WithAvailabilityZoneRelocation()

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

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.

Definition at line 1979 of file CreateClusterRequest.h.

◆ WithClusterIdentifier() [1/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 263 of file CreateClusterRequest.h.

◆ WithClusterIdentifier() [2/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 250 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 276 of file CreateClusterRequest.h.

◆ WithClusterParameterGroupName() [1/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 1087 of file CreateClusterRequest.h.

◆ WithClusterParameterGroupName() [2/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 1075 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 1099 of file CreateClusterRequest.h.

◆ WithClusterSecurityGroups() [1/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 661 of file CreateClusterRequest.h.

◆ WithClusterSecurityGroups() [2/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 655 of file CreateClusterRequest.h.

◆ WithClusterSubnetGroupName() [1/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 793 of file CreateClusterRequest.h.

◆ WithClusterSubnetGroupName() [2/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 786 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 800 of file CreateClusterRequest.h.

◆ WithClusterType() [1/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 340 of file CreateClusterRequest.h.

◆ WithClusterType() [2/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 331 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 349 of file CreateClusterRequest.h.

◆ WithClusterVersion() [1/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 1271 of file CreateClusterRequest.h.

◆ WithClusterVersion() [2/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 1263 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 1279 of file CreateClusterRequest.h.

◆ WithDBName() [1/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 155 of file CreateClusterRequest.h.

◆ WithDBName() [2/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 139 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 171 of file CreateClusterRequest.h.

◆ WithElasticIp() [1/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 1588 of file CreateClusterRequest.h.

◆ WithElasticIp() [2/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 1578 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 1598 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 1419 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 1733 of file CreateClusterRequest.h.

◆ WithHsmClientCertificateIdentifier() [1/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 1462 of file CreateClusterRequest.h.

◆ WithHsmClientCertificateIdentifier() [2/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 1456 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 1468 of file CreateClusterRequest.h.

◆ WithHsmConfigurationIdentifier() [1/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 1511 of file CreateClusterRequest.h.

◆ WithHsmConfigurationIdentifier() [2/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 1505 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 1517 of file CreateClusterRequest.h.

◆ WithIamRoles() [1/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 1829 of file CreateClusterRequest.h.

◆ WithIamRoles() [2/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 1820 of file CreateClusterRequest.h.

◆ WithKmsKeyId() [1/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 1682 of file CreateClusterRequest.h.

◆ WithKmsKeyId() [2/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 1676 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 1688 of file CreateClusterRequest.h.

◆ WithMaintenanceTrackName() [1/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 1906 of file CreateClusterRequest.h.

◆ WithMaintenanceTrackName() [2/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 1899 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 1913 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 1177 of file CreateClusterRequest.h.

◆ WithMasterUsername() [1/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 524 of file CreateClusterRequest.h.

◆ WithMasterUsername() [2/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 513 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 535 of file CreateClusterRequest.h.

◆ WithMasterUserPassword() [1/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 613 of file CreateClusterRequest.h.

◆ WithMasterUserPassword() [2/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 602 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 624 of file CreateClusterRequest.h.

◆ WithNodeType() [1/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.xlplus | ra3.4xlarge | ra3.16xlarge

Definition at line 434 of file CreateClusterRequest.h.

◆ WithNodeType() [2/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.xlplus | ra3.4xlarge | ra3.16xlarge

Definition at line 422 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.xlplus | ra3.4xlarge | ra3.16xlarge

Definition at line 446 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 1373 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 1214 of file CreateClusterRequest.h.

◆ WithPreferredMaintenanceWindow() [1/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 989 of file CreateClusterRequest.h.

◆ WithPreferredMaintenanceWindow() [2/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 976 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 1002 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 1394 of file CreateClusterRequest.h.

◆ WithSnapshotScheduleIdentifier() [1/3]

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

A unique identifier for the snapshot schedule.

Definition at line 1949 of file CreateClusterRequest.h.

◆ WithSnapshotScheduleIdentifier() [2/3]

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

A unique identifier for the snapshot schedule.

Definition at line 1944 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 1954 of file CreateClusterRequest.h.

◆ WithTags() [1/2]

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

A list of tag instances.

Definition at line 1629 of file CreateClusterRequest.h.

◆ WithTags() [2/2]

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

A list of tag instances.

Definition at line 1624 of file CreateClusterRequest.h.

◆ WithVpcSecurityGroupIds() [1/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 722 of file CreateClusterRequest.h.

◆ WithVpcSecurityGroupIds() [2/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 715 of file CreateClusterRequest.h.


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