AWS SDK for C++  1.8.60
AWS SDK for C++
Public Member Functions | List of all members
Aws::DAX::Model::CreateClusterRequest Class Reference

#include <CreateClusterRequest.h>

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

Public Member Functions

 CreateClusterRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetClusterName () const
 
bool ClusterNameHasBeenSet () const
 
void SetClusterName (const Aws::String &value)
 
void SetClusterName (Aws::String &&value)
 
void SetClusterName (const char *value)
 
CreateClusterRequestWithClusterName (const Aws::String &value)
 
CreateClusterRequestWithClusterName (Aws::String &&value)
 
CreateClusterRequestWithClusterName (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::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
CreateClusterRequestWithDescription (const Aws::String &value)
 
CreateClusterRequestWithDescription (Aws::String &&value)
 
CreateClusterRequestWithDescription (const char *value)
 
int GetReplicationFactor () const
 
bool ReplicationFactorHasBeenSet () const
 
void SetReplicationFactor (int value)
 
CreateClusterRequestWithReplicationFactor (int value)
 
const Aws::Vector< Aws::String > & GetAvailabilityZones () const
 
bool AvailabilityZonesHasBeenSet () const
 
void SetAvailabilityZones (const Aws::Vector< Aws::String > &value)
 
void SetAvailabilityZones (Aws::Vector< Aws::String > &&value)
 
CreateClusterRequestWithAvailabilityZones (const Aws::Vector< Aws::String > &value)
 
CreateClusterRequestWithAvailabilityZones (Aws::Vector< Aws::String > &&value)
 
CreateClusterRequestAddAvailabilityZones (const Aws::String &value)
 
CreateClusterRequestAddAvailabilityZones (Aws::String &&value)
 
CreateClusterRequestAddAvailabilityZones (const char *value)
 
const Aws::StringGetSubnetGroupName () const
 
bool SubnetGroupNameHasBeenSet () const
 
void SetSubnetGroupName (const Aws::String &value)
 
void SetSubnetGroupName (Aws::String &&value)
 
void SetSubnetGroupName (const char *value)
 
CreateClusterRequestWithSubnetGroupName (const Aws::String &value)
 
CreateClusterRequestWithSubnetGroupName (Aws::String &&value)
 
CreateClusterRequestWithSubnetGroupName (const char *value)
 
const Aws::Vector< Aws::String > & GetSecurityGroupIds () const
 
bool SecurityGroupIdsHasBeenSet () const
 
void SetSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
void SetSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
CreateClusterRequestWithSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
CreateClusterRequestWithSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
CreateClusterRequestAddSecurityGroupIds (const Aws::String &value)
 
CreateClusterRequestAddSecurityGroupIds (Aws::String &&value)
 
CreateClusterRequestAddSecurityGroupIds (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::StringGetNotificationTopicArn () const
 
bool NotificationTopicArnHasBeenSet () const
 
void SetNotificationTopicArn (const Aws::String &value)
 
void SetNotificationTopicArn (Aws::String &&value)
 
void SetNotificationTopicArn (const char *value)
 
CreateClusterRequestWithNotificationTopicArn (const Aws::String &value)
 
CreateClusterRequestWithNotificationTopicArn (Aws::String &&value)
 
CreateClusterRequestWithNotificationTopicArn (const char *value)
 
const Aws::StringGetIamRoleArn () const
 
bool IamRoleArnHasBeenSet () const
 
void SetIamRoleArn (const Aws::String &value)
 
void SetIamRoleArn (Aws::String &&value)
 
void SetIamRoleArn (const char *value)
 
CreateClusterRequestWithIamRoleArn (const Aws::String &value)
 
CreateClusterRequestWithIamRoleArn (Aws::String &&value)
 
CreateClusterRequestWithIamRoleArn (const char *value)
 
const Aws::StringGetParameterGroupName () const
 
bool ParameterGroupNameHasBeenSet () const
 
void SetParameterGroupName (const Aws::String &value)
 
void SetParameterGroupName (Aws::String &&value)
 
void SetParameterGroupName (const char *value)
 
CreateClusterRequestWithParameterGroupName (const Aws::String &value)
 
CreateClusterRequestWithParameterGroupName (Aws::String &&value)
 
CreateClusterRequestWithParameterGroupName (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 SSESpecificationGetSSESpecification () const
 
bool SSESpecificationHasBeenSet () const
 
void SetSSESpecification (const SSESpecification &value)
 
void SetSSESpecification (SSESpecification &&value)
 
CreateClusterRequestWithSSESpecification (const SSESpecification &value)
 
CreateClusterRequestWithSSESpecification (SSESpecification &&value)
 
- Public Member Functions inherited from Aws::DAX::DAXRequest
virtual ~DAXRequest ()
 
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
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 24 of file CreateClusterRequest.h.

Constructor & Destructor Documentation

◆ CreateClusterRequest()

Aws::DAX::Model::CreateClusterRequest::CreateClusterRequest ( )

Member Function Documentation

◆ AddAvailabilityZones() [1/3]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::AddAvailabilityZones ( const Aws::String value)
inline

The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. If provided, the length of this list must equal the ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.

Definition at line 305 of file CreateClusterRequest.h.

◆ AddAvailabilityZones() [2/3]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::AddAvailabilityZones ( Aws::String &&  value)
inline

The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. If provided, the length of this list must equal the ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.

Definition at line 314 of file CreateClusterRequest.h.

◆ AddAvailabilityZones() [3/3]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::AddAvailabilityZones ( const char *  value)
inline

The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. If provided, the length of this list must equal the ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.

Definition at line 323 of file CreateClusterRequest.h.

◆ AddSecurityGroupIds() [1/3]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::AddSecurityGroupIds ( const Aws::String value)
inline

A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)

If this parameter is not specified, DAX assigns the default VPC security group to each node.

Definition at line 438 of file CreateClusterRequest.h.

◆ AddSecurityGroupIds() [2/3]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::AddSecurityGroupIds ( Aws::String &&  value)
inline

A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)

If this parameter is not specified, DAX assigns the default VPC security group to each node.

Definition at line 445 of file CreateClusterRequest.h.

◆ AddSecurityGroupIds() [3/3]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::AddSecurityGroupIds ( const char *  value)
inline

A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)

If this parameter is not specified, DAX assigns the default VPC security group to each node.

Definition at line 452 of file CreateClusterRequest.h.

◆ AddTags() [1/2]

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

A set of tags to associate with the DAX cluster.

Definition at line 764 of file CreateClusterRequest.h.

◆ AddTags() [2/2]

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

A set of tags to associate with the DAX cluster.

Definition at line 769 of file CreateClusterRequest.h.

◆ AvailabilityZonesHasBeenSet()

bool Aws::DAX::Model::CreateClusterRequest::AvailabilityZonesHasBeenSet ( ) const
inline

The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. If provided, the length of this list must equal the ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.

Definition at line 260 of file CreateClusterRequest.h.

◆ ClusterNameHasBeenSet()

bool Aws::DAX::Model::CreateClusterRequest::ClusterNameHasBeenSet ( ) const
inline

The cluster identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 20 alphanumeric characters or hyphens.

  • The first character must be a letter.

  • A name cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 56 of file CreateClusterRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::DAX::Model::CreateClusterRequest::DescriptionHasBeenSet ( ) const
inline

A description of the cluster.

Definition at line 162 of file CreateClusterRequest.h.

◆ GetAvailabilityZones()

const Aws::Vector<Aws::String>& Aws::DAX::Model::CreateClusterRequest::GetAvailabilityZones ( ) const
inline

The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. If provided, the length of this list must equal the ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.

Definition at line 251 of file CreateClusterRequest.h.

◆ GetClusterName()

const Aws::String& Aws::DAX::Model::CreateClusterRequest::GetClusterName ( ) const
inline

The cluster identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 20 alphanumeric characters or hyphens.

  • The first character must be a letter.

  • A name cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 47 of file CreateClusterRequest.h.

◆ GetDescription()

const Aws::String& Aws::DAX::Model::CreateClusterRequest::GetDescription ( ) const
inline

A description of the cluster.

Definition at line 157 of file CreateClusterRequest.h.

◆ GetIamRoleArn()

const Aws::String& Aws::DAX::Model::CreateClusterRequest::GetIamRoleArn ( ) const
inline

A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

Definition at line 638 of file CreateClusterRequest.h.

◆ GetNodeType()

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

The compute and memory capacity of the nodes in the cluster.

Definition at line 116 of file CreateClusterRequest.h.

◆ GetNotificationTopicArn()

const Aws::String& Aws::DAX::Model::CreateClusterRequest::GetNotificationTopicArn ( ) const
inline

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

The Amazon SNS topic owner must be same as the DAX cluster owner.

Definition at line 581 of file CreateClusterRequest.h.

◆ GetParameterGroupName()

const Aws::String& Aws::DAX::Model::CreateClusterRequest::GetParameterGroupName ( ) const
inline

The parameter group to be associated with the DAX cluster.

Definition at line 693 of file CreateClusterRequest.h.

◆ GetPreferredMaintenanceWindow()

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

Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:05:00-sun:09:00

If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.

Definition at line 468 of file CreateClusterRequest.h.

◆ GetReplicationFactor()

int Aws::DAX::Model::CreateClusterRequest::GetReplicationFactor ( ) const
inline

The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor.

AWS recommends that you have at least two read replicas per cluster.

Definition at line 205 of file CreateClusterRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::DAX::Model::CreateClusterRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::DAX::DAXRequest.

◆ GetSecurityGroupIds()

const Aws::Vector<Aws::String>& Aws::DAX::Model::CreateClusterRequest::GetSecurityGroupIds ( ) const
inline

A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)

If this parameter is not specified, DAX assigns the default VPC security group to each node.

Definition at line 396 of file CreateClusterRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file CreateClusterRequest.h.

◆ GetSSESpecification()

const SSESpecification& Aws::DAX::Model::CreateClusterRequest::GetSSESpecification ( ) const
inline

Represents the settings used to enable server-side encryption on the cluster.

Definition at line 776 of file CreateClusterRequest.h.

◆ GetSubnetGroupName()

const Aws::String& Aws::DAX::Model::CreateClusterRequest::GetSubnetGroupName ( ) const
inline

The name of the subnet group to be used for the replication group.

DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.

Definition at line 332 of file CreateClusterRequest.h.

◆ GetTags()

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

A set of tags to associate with the DAX cluster.

Definition at line 734 of file CreateClusterRequest.h.

◆ IamRoleArnHasBeenSet()

bool Aws::DAX::Model::CreateClusterRequest::IamRoleArnHasBeenSet ( ) const
inline

A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

Definition at line 645 of file CreateClusterRequest.h.

◆ NodeTypeHasBeenSet()

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

The compute and memory capacity of the nodes in the cluster.

Definition at line 121 of file CreateClusterRequest.h.

◆ NotificationTopicArnHasBeenSet()

bool Aws::DAX::Model::CreateClusterRequest::NotificationTopicArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

The Amazon SNS topic owner must be same as the DAX cluster owner.

Definition at line 588 of file CreateClusterRequest.h.

◆ ParameterGroupNameHasBeenSet()

bool Aws::DAX::Model::CreateClusterRequest::ParameterGroupNameHasBeenSet ( ) const
inline

The parameter group to be associated with the DAX cluster.

Definition at line 698 of file CreateClusterRequest.h.

◆ PreferredMaintenanceWindowHasBeenSet()

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

Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:05:00-sun:09:00

If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.

Definition at line 483 of file CreateClusterRequest.h.

◆ ReplicationFactorHasBeenSet()

bool Aws::DAX::Model::CreateClusterRequest::ReplicationFactorHasBeenSet ( ) const
inline

The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor.

AWS recommends that you have at least two read replicas per cluster.

Definition at line 217 of file CreateClusterRequest.h.

◆ SecurityGroupIdsHasBeenSet()

bool Aws::DAX::Model::CreateClusterRequest::SecurityGroupIdsHasBeenSet ( ) const
inline

A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)

If this parameter is not specified, DAX assigns the default VPC security group to each node.

Definition at line 403 of file CreateClusterRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAvailabilityZones() [1/2]

void Aws::DAX::Model::CreateClusterRequest::SetAvailabilityZones ( const Aws::Vector< Aws::String > &  value)
inline

The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. If provided, the length of this list must equal the ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.

Definition at line 269 of file CreateClusterRequest.h.

◆ SetAvailabilityZones() [2/2]

void Aws::DAX::Model::CreateClusterRequest::SetAvailabilityZones ( Aws::Vector< Aws::String > &&  value)
inline

The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. If provided, the length of this list must equal the ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.

Definition at line 278 of file CreateClusterRequest.h.

◆ SetClusterName() [1/3]

void Aws::DAX::Model::CreateClusterRequest::SetClusterName ( const Aws::String value)
inline

The cluster identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 20 alphanumeric characters or hyphens.

  • The first character must be a letter.

  • A name cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 65 of file CreateClusterRequest.h.

◆ SetClusterName() [2/3]

void Aws::DAX::Model::CreateClusterRequest::SetClusterName ( Aws::String &&  value)
inline

The cluster identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 20 alphanumeric characters or hyphens.

  • The first character must be a letter.

  • A name cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 74 of file CreateClusterRequest.h.

◆ SetClusterName() [3/3]

void Aws::DAX::Model::CreateClusterRequest::SetClusterName ( const char *  value)
inline

The cluster identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 20 alphanumeric characters or hyphens.

  • The first character must be a letter.

  • A name cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 83 of file CreateClusterRequest.h.

◆ SetDescription() [1/3]

void Aws::DAX::Model::CreateClusterRequest::SetDescription ( const Aws::String value)
inline

A description of the cluster.

Definition at line 167 of file CreateClusterRequest.h.

◆ SetDescription() [2/3]

void Aws::DAX::Model::CreateClusterRequest::SetDescription ( Aws::String &&  value)
inline

A description of the cluster.

Definition at line 172 of file CreateClusterRequest.h.

◆ SetDescription() [3/3]

void Aws::DAX::Model::CreateClusterRequest::SetDescription ( const char *  value)
inline

A description of the cluster.

Definition at line 177 of file CreateClusterRequest.h.

◆ SetIamRoleArn() [1/3]

void Aws::DAX::Model::CreateClusterRequest::SetIamRoleArn ( const Aws::String value)
inline

A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

Definition at line 652 of file CreateClusterRequest.h.

◆ SetIamRoleArn() [2/3]

void Aws::DAX::Model::CreateClusterRequest::SetIamRoleArn ( Aws::String &&  value)
inline

A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

Definition at line 659 of file CreateClusterRequest.h.

◆ SetIamRoleArn() [3/3]

void Aws::DAX::Model::CreateClusterRequest::SetIamRoleArn ( const char *  value)
inline

A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

Definition at line 666 of file CreateClusterRequest.h.

◆ SetNodeType() [1/3]

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

The compute and memory capacity of the nodes in the cluster.

Definition at line 126 of file CreateClusterRequest.h.

◆ SetNodeType() [2/3]

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

The compute and memory capacity of the nodes in the cluster.

Definition at line 131 of file CreateClusterRequest.h.

◆ SetNodeType() [3/3]

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

The compute and memory capacity of the nodes in the cluster.

Definition at line 136 of file CreateClusterRequest.h.

◆ SetNotificationTopicArn() [1/3]

void Aws::DAX::Model::CreateClusterRequest::SetNotificationTopicArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

The Amazon SNS topic owner must be same as the DAX cluster owner.

Definition at line 595 of file CreateClusterRequest.h.

◆ SetNotificationTopicArn() [2/3]

void Aws::DAX::Model::CreateClusterRequest::SetNotificationTopicArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

The Amazon SNS topic owner must be same as the DAX cluster owner.

Definition at line 602 of file CreateClusterRequest.h.

◆ SetNotificationTopicArn() [3/3]

void Aws::DAX::Model::CreateClusterRequest::SetNotificationTopicArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

The Amazon SNS topic owner must be same as the DAX cluster owner.

Definition at line 609 of file CreateClusterRequest.h.

◆ SetParameterGroupName() [1/3]

void Aws::DAX::Model::CreateClusterRequest::SetParameterGroupName ( const Aws::String value)
inline

The parameter group to be associated with the DAX cluster.

Definition at line 703 of file CreateClusterRequest.h.

◆ SetParameterGroupName() [2/3]

void Aws::DAX::Model::CreateClusterRequest::SetParameterGroupName ( Aws::String &&  value)
inline

The parameter group to be associated with the DAX cluster.

Definition at line 708 of file CreateClusterRequest.h.

◆ SetParameterGroupName() [3/3]

void Aws::DAX::Model::CreateClusterRequest::SetParameterGroupName ( const char *  value)
inline

The parameter group to be associated with the DAX cluster.

Definition at line 713 of file CreateClusterRequest.h.

◆ SetPreferredMaintenanceWindow() [1/3]

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

Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:05:00-sun:09:00

If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.

Definition at line 498 of file CreateClusterRequest.h.

◆ SetPreferredMaintenanceWindow() [2/3]

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

Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:05:00-sun:09:00

If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.

Definition at line 513 of file CreateClusterRequest.h.

◆ SetPreferredMaintenanceWindow() [3/3]

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

Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:05:00-sun:09:00

If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.

Definition at line 528 of file CreateClusterRequest.h.

◆ SetReplicationFactor()

void Aws::DAX::Model::CreateClusterRequest::SetReplicationFactor ( int  value)
inline

The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor.

AWS recommends that you have at least two read replicas per cluster.

Definition at line 229 of file CreateClusterRequest.h.

◆ SetSecurityGroupIds() [1/2]

void Aws::DAX::Model::CreateClusterRequest::SetSecurityGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)

If this parameter is not specified, DAX assigns the default VPC security group to each node.

Definition at line 410 of file CreateClusterRequest.h.

◆ SetSecurityGroupIds() [2/2]

void Aws::DAX::Model::CreateClusterRequest::SetSecurityGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)

If this parameter is not specified, DAX assigns the default VPC security group to each node.

Definition at line 417 of file CreateClusterRequest.h.

◆ SetSSESpecification() [1/2]

void Aws::DAX::Model::CreateClusterRequest::SetSSESpecification ( const SSESpecification value)
inline

Represents the settings used to enable server-side encryption on the cluster.

Definition at line 788 of file CreateClusterRequest.h.

◆ SetSSESpecification() [2/2]

void Aws::DAX::Model::CreateClusterRequest::SetSSESpecification ( SSESpecification &&  value)
inline

Represents the settings used to enable server-side encryption on the cluster.

Definition at line 794 of file CreateClusterRequest.h.

◆ SetSubnetGroupName() [1/3]

void Aws::DAX::Model::CreateClusterRequest::SetSubnetGroupName ( const Aws::String value)
inline

The name of the subnet group to be used for the replication group.

DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.

Definition at line 348 of file CreateClusterRequest.h.

◆ SetSubnetGroupName() [2/3]

void Aws::DAX::Model::CreateClusterRequest::SetSubnetGroupName ( Aws::String &&  value)
inline

The name of the subnet group to be used for the replication group.

DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.

Definition at line 356 of file CreateClusterRequest.h.

◆ SetSubnetGroupName() [3/3]

void Aws::DAX::Model::CreateClusterRequest::SetSubnetGroupName ( const char *  value)
inline

The name of the subnet group to be used for the replication group.

DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.

Definition at line 364 of file CreateClusterRequest.h.

◆ SetTags() [1/2]

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

A set of tags to associate with the DAX cluster.

Definition at line 744 of file CreateClusterRequest.h.

◆ SetTags() [2/2]

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

A set of tags to associate with the DAX cluster.

Definition at line 749 of file CreateClusterRequest.h.

◆ SSESpecificationHasBeenSet()

bool Aws::DAX::Model::CreateClusterRequest::SSESpecificationHasBeenSet ( ) const
inline

Represents the settings used to enable server-side encryption on the cluster.

Definition at line 782 of file CreateClusterRequest.h.

◆ SubnetGroupNameHasBeenSet()

bool Aws::DAX::Model::CreateClusterRequest::SubnetGroupNameHasBeenSet ( ) const
inline

The name of the subnet group to be used for the replication group.

DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.

Definition at line 340 of file CreateClusterRequest.h.

◆ TagsHasBeenSet()

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

A set of tags to associate with the DAX cluster.

Definition at line 739 of file CreateClusterRequest.h.

◆ WithAvailabilityZones() [1/2]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::WithAvailabilityZones ( const Aws::Vector< Aws::String > &  value)
inline

The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. If provided, the length of this list must equal the ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.

Definition at line 287 of file CreateClusterRequest.h.

◆ WithAvailabilityZones() [2/2]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::WithAvailabilityZones ( Aws::Vector< Aws::String > &&  value)
inline

The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. If provided, the length of this list must equal the ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.

Definition at line 296 of file CreateClusterRequest.h.

◆ WithClusterName() [1/3]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::WithClusterName ( const Aws::String value)
inline

The cluster identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 20 alphanumeric characters or hyphens.

  • The first character must be a letter.

  • A name cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 92 of file CreateClusterRequest.h.

◆ WithClusterName() [2/3]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::WithClusterName ( Aws::String &&  value)
inline

The cluster identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 20 alphanumeric characters or hyphens.

  • The first character must be a letter.

  • A name cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 101 of file CreateClusterRequest.h.

◆ WithClusterName() [3/3]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::WithClusterName ( const char *  value)
inline

The cluster identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 20 alphanumeric characters or hyphens.

  • The first character must be a letter.

  • A name cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 110 of file CreateClusterRequest.h.

◆ WithDescription() [1/3]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::WithDescription ( const Aws::String value)
inline

A description of the cluster.

Definition at line 182 of file CreateClusterRequest.h.

◆ WithDescription() [2/3]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::WithDescription ( Aws::String &&  value)
inline

A description of the cluster.

Definition at line 187 of file CreateClusterRequest.h.

◆ WithDescription() [3/3]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::WithDescription ( const char *  value)
inline

A description of the cluster.

Definition at line 192 of file CreateClusterRequest.h.

◆ WithIamRoleArn() [1/3]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::WithIamRoleArn ( const Aws::String value)
inline

A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

Definition at line 673 of file CreateClusterRequest.h.

◆ WithIamRoleArn() [2/3]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::WithIamRoleArn ( Aws::String &&  value)
inline

A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

Definition at line 680 of file CreateClusterRequest.h.

◆ WithIamRoleArn() [3/3]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::WithIamRoleArn ( const char *  value)
inline

A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

Definition at line 687 of file CreateClusterRequest.h.

◆ WithNodeType() [1/3]

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

The compute and memory capacity of the nodes in the cluster.

Definition at line 141 of file CreateClusterRequest.h.

◆ WithNodeType() [2/3]

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

The compute and memory capacity of the nodes in the cluster.

Definition at line 146 of file CreateClusterRequest.h.

◆ WithNodeType() [3/3]

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

The compute and memory capacity of the nodes in the cluster.

Definition at line 151 of file CreateClusterRequest.h.

◆ WithNotificationTopicArn() [1/3]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::WithNotificationTopicArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

The Amazon SNS topic owner must be same as the DAX cluster owner.

Definition at line 616 of file CreateClusterRequest.h.

◆ WithNotificationTopicArn() [2/3]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::WithNotificationTopicArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

The Amazon SNS topic owner must be same as the DAX cluster owner.

Definition at line 623 of file CreateClusterRequest.h.

◆ WithNotificationTopicArn() [3/3]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::WithNotificationTopicArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

The Amazon SNS topic owner must be same as the DAX cluster owner.

Definition at line 630 of file CreateClusterRequest.h.

◆ WithParameterGroupName() [1/3]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::WithParameterGroupName ( const Aws::String value)
inline

The parameter group to be associated with the DAX cluster.

Definition at line 718 of file CreateClusterRequest.h.

◆ WithParameterGroupName() [2/3]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::WithParameterGroupName ( Aws::String &&  value)
inline

The parameter group to be associated with the DAX cluster.

Definition at line 723 of file CreateClusterRequest.h.

◆ WithParameterGroupName() [3/3]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::WithParameterGroupName ( const char *  value)
inline

The parameter group to be associated with the DAX cluster.

Definition at line 728 of file CreateClusterRequest.h.

◆ WithPreferredMaintenanceWindow() [1/3]

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

Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:05:00-sun:09:00

If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.

Definition at line 543 of file CreateClusterRequest.h.

◆ WithPreferredMaintenanceWindow() [2/3]

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

Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:05:00-sun:09:00

If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.

Definition at line 558 of file CreateClusterRequest.h.

◆ WithPreferredMaintenanceWindow() [3/3]

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

Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:05:00-sun:09:00

If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.

Definition at line 573 of file CreateClusterRequest.h.

◆ WithReplicationFactor()

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::WithReplicationFactor ( int  value)
inline

The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor.

AWS recommends that you have at least two read replicas per cluster.

Definition at line 241 of file CreateClusterRequest.h.

◆ WithSecurityGroupIds() [1/2]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::WithSecurityGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)

If this parameter is not specified, DAX assigns the default VPC security group to each node.

Definition at line 424 of file CreateClusterRequest.h.

◆ WithSecurityGroupIds() [2/2]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::WithSecurityGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)

If this parameter is not specified, DAX assigns the default VPC security group to each node.

Definition at line 431 of file CreateClusterRequest.h.

◆ WithSSESpecification() [1/2]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::WithSSESpecification ( const SSESpecification value)
inline

Represents the settings used to enable server-side encryption on the cluster.

Definition at line 800 of file CreateClusterRequest.h.

◆ WithSSESpecification() [2/2]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::WithSSESpecification ( SSESpecification &&  value)
inline

Represents the settings used to enable server-side encryption on the cluster.

Definition at line 806 of file CreateClusterRequest.h.

◆ WithSubnetGroupName() [1/3]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::WithSubnetGroupName ( const Aws::String value)
inline

The name of the subnet group to be used for the replication group.

DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.

Definition at line 372 of file CreateClusterRequest.h.

◆ WithSubnetGroupName() [2/3]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::WithSubnetGroupName ( Aws::String &&  value)
inline

The name of the subnet group to be used for the replication group.

DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.

Definition at line 380 of file CreateClusterRequest.h.

◆ WithSubnetGroupName() [3/3]

CreateClusterRequest& Aws::DAX::Model::CreateClusterRequest::WithSubnetGroupName ( const char *  value)
inline

The name of the subnet group to be used for the replication group.

DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.

Definition at line 388 of file CreateClusterRequest.h.

◆ WithTags() [1/2]

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

A set of tags to associate with the DAX cluster.

Definition at line 754 of file CreateClusterRequest.h.

◆ WithTags() [2/2]

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

A set of tags to associate with the DAX cluster.

Definition at line 759 of file CreateClusterRequest.h.


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