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

#include <Cluster.h>

Public Member Functions

 Cluster ()
 
 Cluster (Aws::Utils::Json::JsonView jsonValue)
 
Clusteroperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetClusterName () const
 
bool ClusterNameHasBeenSet () const
 
void SetClusterName (const Aws::String &value)
 
void SetClusterName (Aws::String &&value)
 
void SetClusterName (const char *value)
 
ClusterWithClusterName (const Aws::String &value)
 
ClusterWithClusterName (Aws::String &&value)
 
ClusterWithClusterName (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)
 
ClusterWithDescription (const Aws::String &value)
 
ClusterWithDescription (Aws::String &&value)
 
ClusterWithDescription (const char *value)
 
const Aws::StringGetClusterArn () const
 
bool ClusterArnHasBeenSet () const
 
void SetClusterArn (const Aws::String &value)
 
void SetClusterArn (Aws::String &&value)
 
void SetClusterArn (const char *value)
 
ClusterWithClusterArn (const Aws::String &value)
 
ClusterWithClusterArn (Aws::String &&value)
 
ClusterWithClusterArn (const char *value)
 
int GetTotalNodes () const
 
bool TotalNodesHasBeenSet () const
 
void SetTotalNodes (int value)
 
ClusterWithTotalNodes (int value)
 
int GetActiveNodes () const
 
bool ActiveNodesHasBeenSet () const
 
void SetActiveNodes (int value)
 
ClusterWithActiveNodes (int value)
 
const Aws::StringGetNodeType () const
 
bool NodeTypeHasBeenSet () const
 
void SetNodeType (const Aws::String &value)
 
void SetNodeType (Aws::String &&value)
 
void SetNodeType (const char *value)
 
ClusterWithNodeType (const Aws::String &value)
 
ClusterWithNodeType (Aws::String &&value)
 
ClusterWithNodeType (const char *value)
 
const Aws::StringGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const Aws::String &value)
 
void SetStatus (Aws::String &&value)
 
void SetStatus (const char *value)
 
ClusterWithStatus (const Aws::String &value)
 
ClusterWithStatus (Aws::String &&value)
 
ClusterWithStatus (const char *value)
 
const EndpointGetClusterDiscoveryEndpoint () const
 
bool ClusterDiscoveryEndpointHasBeenSet () const
 
void SetClusterDiscoveryEndpoint (const Endpoint &value)
 
void SetClusterDiscoveryEndpoint (Endpoint &&value)
 
ClusterWithClusterDiscoveryEndpoint (const Endpoint &value)
 
ClusterWithClusterDiscoveryEndpoint (Endpoint &&value)
 
const Aws::Vector< Aws::String > & GetNodeIdsToRemove () const
 
bool NodeIdsToRemoveHasBeenSet () const
 
void SetNodeIdsToRemove (const Aws::Vector< Aws::String > &value)
 
void SetNodeIdsToRemove (Aws::Vector< Aws::String > &&value)
 
ClusterWithNodeIdsToRemove (const Aws::Vector< Aws::String > &value)
 
ClusterWithNodeIdsToRemove (Aws::Vector< Aws::String > &&value)
 
ClusterAddNodeIdsToRemove (const Aws::String &value)
 
ClusterAddNodeIdsToRemove (Aws::String &&value)
 
ClusterAddNodeIdsToRemove (const char *value)
 
const Aws::Vector< Node > & GetNodes () const
 
bool NodesHasBeenSet () const
 
void SetNodes (const Aws::Vector< Node > &value)
 
void SetNodes (Aws::Vector< Node > &&value)
 
ClusterWithNodes (const Aws::Vector< Node > &value)
 
ClusterWithNodes (Aws::Vector< Node > &&value)
 
ClusterAddNodes (const Node &value)
 
ClusterAddNodes (Node &&value)
 
const Aws::StringGetPreferredMaintenanceWindow () const
 
bool PreferredMaintenanceWindowHasBeenSet () const
 
void SetPreferredMaintenanceWindow (const Aws::String &value)
 
void SetPreferredMaintenanceWindow (Aws::String &&value)
 
void SetPreferredMaintenanceWindow (const char *value)
 
ClusterWithPreferredMaintenanceWindow (const Aws::String &value)
 
ClusterWithPreferredMaintenanceWindow (Aws::String &&value)
 
ClusterWithPreferredMaintenanceWindow (const char *value)
 
const NotificationConfigurationGetNotificationConfiguration () const
 
bool NotificationConfigurationHasBeenSet () const
 
void SetNotificationConfiguration (const NotificationConfiguration &value)
 
void SetNotificationConfiguration (NotificationConfiguration &&value)
 
ClusterWithNotificationConfiguration (const NotificationConfiguration &value)
 
ClusterWithNotificationConfiguration (NotificationConfiguration &&value)
 
const Aws::StringGetSubnetGroup () const
 
bool SubnetGroupHasBeenSet () const
 
void SetSubnetGroup (const Aws::String &value)
 
void SetSubnetGroup (Aws::String &&value)
 
void SetSubnetGroup (const char *value)
 
ClusterWithSubnetGroup (const Aws::String &value)
 
ClusterWithSubnetGroup (Aws::String &&value)
 
ClusterWithSubnetGroup (const char *value)
 
const Aws::Vector< SecurityGroupMembership > & GetSecurityGroups () const
 
bool SecurityGroupsHasBeenSet () const
 
void SetSecurityGroups (const Aws::Vector< SecurityGroupMembership > &value)
 
void SetSecurityGroups (Aws::Vector< SecurityGroupMembership > &&value)
 
ClusterWithSecurityGroups (const Aws::Vector< SecurityGroupMembership > &value)
 
ClusterWithSecurityGroups (Aws::Vector< SecurityGroupMembership > &&value)
 
ClusterAddSecurityGroups (const SecurityGroupMembership &value)
 
ClusterAddSecurityGroups (SecurityGroupMembership &&value)
 
const Aws::StringGetIamRoleArn () const
 
bool IamRoleArnHasBeenSet () const
 
void SetIamRoleArn (const Aws::String &value)
 
void SetIamRoleArn (Aws::String &&value)
 
void SetIamRoleArn (const char *value)
 
ClusterWithIamRoleArn (const Aws::String &value)
 
ClusterWithIamRoleArn (Aws::String &&value)
 
ClusterWithIamRoleArn (const char *value)
 
const ParameterGroupStatusGetParameterGroup () const
 
bool ParameterGroupHasBeenSet () const
 
void SetParameterGroup (const ParameterGroupStatus &value)
 
void SetParameterGroup (ParameterGroupStatus &&value)
 
ClusterWithParameterGroup (const ParameterGroupStatus &value)
 
ClusterWithParameterGroup (ParameterGroupStatus &&value)
 
const SSEDescriptionGetSSEDescription () const
 
bool SSEDescriptionHasBeenSet () const
 
void SetSSEDescription (const SSEDescription &value)
 
void SetSSEDescription (SSEDescription &&value)
 
ClusterWithSSEDescription (const SSEDescription &value)
 
ClusterWithSSEDescription (SSEDescription &&value)
 
const ClusterEndpointEncryptionTypeGetClusterEndpointEncryptionType () const
 
bool ClusterEndpointEncryptionTypeHasBeenSet () const
 
void SetClusterEndpointEncryptionType (const ClusterEndpointEncryptionType &value)
 
void SetClusterEndpointEncryptionType (ClusterEndpointEncryptionType &&value)
 
ClusterWithClusterEndpointEncryptionType (const ClusterEndpointEncryptionType &value)
 
ClusterWithClusterEndpointEncryptionType (ClusterEndpointEncryptionType &&value)
 

Detailed Description

Contains all of the attributes of a specific DAX cluster.

See Also:

AWS API Reference

Definition at line 40 of file Cluster.h.

Constructor & Destructor Documentation

◆ Cluster() [1/2]

Aws::DAX::Model::Cluster::Cluster ( )

◆ Cluster() [2/2]

Aws::DAX::Model::Cluster::Cluster ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ActiveNodesHasBeenSet()

bool Aws::DAX::Model::Cluster::ActiveNodesHasBeenSet ( ) const
inline

The number of nodes in the cluster that are active (i.e., capable of serving requests).

Definition at line 203 of file Cluster.h.

◆ AddNodeIdsToRemove() [1/3]

Cluster& Aws::DAX::Model::Cluster::AddNodeIdsToRemove ( Aws::String &&  value)
inline

A list of nodes to be removed from the cluster.

Definition at line 389 of file Cluster.h.

◆ AddNodeIdsToRemove() [2/3]

Cluster& Aws::DAX::Model::Cluster::AddNodeIdsToRemove ( const Aws::String value)
inline

A list of nodes to be removed from the cluster.

Definition at line 384 of file Cluster.h.

◆ AddNodeIdsToRemove() [3/3]

Cluster& Aws::DAX::Model::Cluster::AddNodeIdsToRemove ( const char *  value)
inline

A list of nodes to be removed from the cluster.

Definition at line 394 of file Cluster.h.

◆ AddNodes() [1/2]

Cluster& Aws::DAX::Model::Cluster::AddNodes ( const Node value)
inline

A list of nodes that are currently in the cluster.

Definition at line 430 of file Cluster.h.

◆ AddNodes() [2/2]

Cluster& Aws::DAX::Model::Cluster::AddNodes ( Node &&  value)
inline

A list of nodes that are currently in the cluster.

Definition at line 435 of file Cluster.h.

◆ AddSecurityGroups() [1/2]

Cluster& Aws::DAX::Model::Cluster::AddSecurityGroups ( const SecurityGroupMembership value)
inline

A list of security groups, and the status of each, for the nodes in the cluster.

Definition at line 627 of file Cluster.h.

◆ AddSecurityGroups() [2/2]

Cluster& Aws::DAX::Model::Cluster::AddSecurityGroups ( SecurityGroupMembership &&  value)
inline

A list of security groups, and the status of each, for the nodes in the cluster.

Definition at line 633 of file Cluster.h.

◆ ClusterArnHasBeenSet()

bool Aws::DAX::Model::Cluster::ClusterArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Definition at line 139 of file Cluster.h.

◆ ClusterDiscoveryEndpointHasBeenSet()

bool Aws::DAX::Model::Cluster::ClusterDiscoveryEndpointHasBeenSet ( ) const
inline

The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.

Definition at line 320 of file Cluster.h.

◆ ClusterEndpointEncryptionTypeHasBeenSet()

bool Aws::DAX::Model::Cluster::ClusterEndpointEncryptionTypeHasBeenSet ( ) const
inline

The type of encryption supported by the cluster's endpoint. Values are:

  • NONE for no encryption

    TLS for Transport Layer Security

Definition at line 773 of file Cluster.h.

◆ ClusterNameHasBeenSet()

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

The name of the DAX cluster.

Definition at line 57 of file Cluster.h.

◆ DescriptionHasBeenSet()

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

The description of the cluster.

Definition at line 98 of file Cluster.h.

◆ GetActiveNodes()

int Aws::DAX::Model::Cluster::GetActiveNodes ( ) const
inline

The number of nodes in the cluster that are active (i.e., capable of serving requests).

Definition at line 197 of file Cluster.h.

◆ GetClusterArn()

const Aws::String& Aws::DAX::Model::Cluster::GetClusterArn ( ) const
inline

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Definition at line 134 of file Cluster.h.

◆ GetClusterDiscoveryEndpoint()

const Endpoint& Aws::DAX::Model::Cluster::GetClusterDiscoveryEndpoint ( ) const
inline

The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.

Definition at line 313 of file Cluster.h.

◆ GetClusterEndpointEncryptionType()

const ClusterEndpointEncryptionType& Aws::DAX::Model::Cluster::GetClusterEndpointEncryptionType ( ) const
inline

The type of encryption supported by the cluster's endpoint. Values are:

  • NONE for no encryption

    TLS for Transport Layer Security

Definition at line 766 of file Cluster.h.

◆ GetClusterName()

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

The name of the DAX cluster.

Definition at line 52 of file Cluster.h.

◆ GetDescription()

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

The description of the cluster.

Definition at line 93 of file Cluster.h.

◆ GetIamRoleArn()

const Aws::String& Aws::DAX::Model::Cluster::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 641 of file Cluster.h.

◆ GetNodeIdsToRemove()

const Aws::Vector<Aws::String>& Aws::DAX::Model::Cluster::GetNodeIdsToRemove ( ) const
inline

A list of nodes to be removed from the cluster.

Definition at line 354 of file Cluster.h.

◆ GetNodes()

const Aws::Vector<Node>& Aws::DAX::Model::Cluster::GetNodes ( ) const
inline

A list of nodes that are currently in the cluster.

Definition at line 400 of file Cluster.h.

◆ GetNodeType()

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

The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)

Definition at line 222 of file Cluster.h.

◆ GetNotificationConfiguration()

const NotificationConfiguration& Aws::DAX::Model::Cluster::GetNotificationConfiguration ( ) const
inline

Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

Definition at line 508 of file Cluster.h.

◆ GetParameterGroup()

const ParameterGroupStatus& Aws::DAX::Model::Cluster::GetParameterGroup ( ) const
inline

The parameter group being used by nodes in the cluster.

Definition at line 696 of file Cluster.h.

◆ GetPreferredMaintenanceWindow()

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

A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.

Definition at line 444 of file Cluster.h.

◆ GetSecurityGroups()

const Aws::Vector<SecurityGroupMembership>& Aws::DAX::Model::Cluster::GetSecurityGroups ( ) const
inline

A list of security groups, and the status of each, for the nodes in the cluster.

Definition at line 591 of file Cluster.h.

◆ GetSSEDescription()

const SSEDescription& Aws::DAX::Model::Cluster::GetSSEDescription ( ) const
inline

The description of the server-side encryption status on the specified DAX cluster.

Definition at line 728 of file Cluster.h.

◆ GetStatus()

const Aws::String& Aws::DAX::Model::Cluster::GetStatus ( ) const
inline

The current status of the cluster.

Definition at line 270 of file Cluster.h.

◆ GetSubnetGroup()

const Aws::String& Aws::DAX::Model::Cluster::GetSubnetGroup ( ) const
inline

The subnet group where the DAX cluster is running.

Definition at line 549 of file Cluster.h.

◆ GetTotalNodes()

int Aws::DAX::Model::Cluster::GetTotalNodes ( ) const
inline

The total number of nodes in the cluster.

Definition at line 175 of file Cluster.h.

◆ IamRoleArnHasBeenSet()

bool Aws::DAX::Model::Cluster::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 648 of file Cluster.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::DAX::Model::Cluster::Jsonize ( ) const

◆ NodeIdsToRemoveHasBeenSet()

bool Aws::DAX::Model::Cluster::NodeIdsToRemoveHasBeenSet ( ) const
inline

A list of nodes to be removed from the cluster.

Definition at line 359 of file Cluster.h.

◆ NodesHasBeenSet()

bool Aws::DAX::Model::Cluster::NodesHasBeenSet ( ) const
inline

A list of nodes that are currently in the cluster.

Definition at line 405 of file Cluster.h.

◆ NodeTypeHasBeenSet()

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

The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)

Definition at line 228 of file Cluster.h.

◆ NotificationConfigurationHasBeenSet()

bool Aws::DAX::Model::Cluster::NotificationConfigurationHasBeenSet ( ) const
inline

Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

Definition at line 515 of file Cluster.h.

◆ operator=()

Cluster& Aws::DAX::Model::Cluster::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ ParameterGroupHasBeenSet()

bool Aws::DAX::Model::Cluster::ParameterGroupHasBeenSet ( ) const
inline

The parameter group being used by nodes in the cluster.

Definition at line 701 of file Cluster.h.

◆ PreferredMaintenanceWindowHasBeenSet()

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

A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.

Definition at line 452 of file Cluster.h.

◆ SecurityGroupsHasBeenSet()

bool Aws::DAX::Model::Cluster::SecurityGroupsHasBeenSet ( ) const
inline

A list of security groups, and the status of each, for the nodes in the cluster.

Definition at line 597 of file Cluster.h.

◆ SetActiveNodes()

void Aws::DAX::Model::Cluster::SetActiveNodes ( int  value)
inline

The number of nodes in the cluster that are active (i.e., capable of serving requests).

Definition at line 209 of file Cluster.h.

◆ SetClusterArn() [1/3]

void Aws::DAX::Model::Cluster::SetClusterArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Definition at line 149 of file Cluster.h.

◆ SetClusterArn() [2/3]

void Aws::DAX::Model::Cluster::SetClusterArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Definition at line 144 of file Cluster.h.

◆ SetClusterArn() [3/3]

void Aws::DAX::Model::Cluster::SetClusterArn ( const char *  value)
inline

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Definition at line 154 of file Cluster.h.

◆ SetClusterDiscoveryEndpoint() [1/2]

void Aws::DAX::Model::Cluster::SetClusterDiscoveryEndpoint ( const Endpoint value)
inline

The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.

Definition at line 327 of file Cluster.h.

◆ SetClusterDiscoveryEndpoint() [2/2]

void Aws::DAX::Model::Cluster::SetClusterDiscoveryEndpoint ( Endpoint &&  value)
inline

The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.

Definition at line 334 of file Cluster.h.

◆ SetClusterEndpointEncryptionType() [1/2]

void Aws::DAX::Model::Cluster::SetClusterEndpointEncryptionType ( ClusterEndpointEncryptionType &&  value)
inline

The type of encryption supported by the cluster's endpoint. Values are:

  • NONE for no encryption

    TLS for Transport Layer Security

Definition at line 787 of file Cluster.h.

◆ SetClusterEndpointEncryptionType() [2/2]

void Aws::DAX::Model::Cluster::SetClusterEndpointEncryptionType ( const ClusterEndpointEncryptionType value)
inline

The type of encryption supported by the cluster's endpoint. Values are:

  • NONE for no encryption

    TLS for Transport Layer Security

Definition at line 780 of file Cluster.h.

◆ SetClusterName() [1/3]

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

The name of the DAX cluster.

Definition at line 67 of file Cluster.h.

◆ SetClusterName() [2/3]

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

The name of the DAX cluster.

Definition at line 62 of file Cluster.h.

◆ SetClusterName() [3/3]

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

The name of the DAX cluster.

Definition at line 72 of file Cluster.h.

◆ SetDescription() [1/3]

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

The description of the cluster.

Definition at line 108 of file Cluster.h.

◆ SetDescription() [2/3]

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

The description of the cluster.

Definition at line 103 of file Cluster.h.

◆ SetDescription() [3/3]

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

The description of the cluster.

Definition at line 113 of file Cluster.h.

◆ SetIamRoleArn() [1/3]

void Aws::DAX::Model::Cluster::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 662 of file Cluster.h.

◆ SetIamRoleArn() [2/3]

void Aws::DAX::Model::Cluster::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 655 of file Cluster.h.

◆ SetIamRoleArn() [3/3]

void Aws::DAX::Model::Cluster::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 669 of file Cluster.h.

◆ SetNodeIdsToRemove() [1/2]

void Aws::DAX::Model::Cluster::SetNodeIdsToRemove ( Aws::Vector< Aws::String > &&  value)
inline

A list of nodes to be removed from the cluster.

Definition at line 369 of file Cluster.h.

◆ SetNodeIdsToRemove() [2/2]

void Aws::DAX::Model::Cluster::SetNodeIdsToRemove ( const Aws::Vector< Aws::String > &  value)
inline

A list of nodes to be removed from the cluster.

Definition at line 364 of file Cluster.h.

◆ SetNodes() [1/2]

void Aws::DAX::Model::Cluster::SetNodes ( Aws::Vector< Node > &&  value)
inline

A list of nodes that are currently in the cluster.

Definition at line 415 of file Cluster.h.

◆ SetNodes() [2/2]

void Aws::DAX::Model::Cluster::SetNodes ( const Aws::Vector< Node > &  value)
inline

A list of nodes that are currently in the cluster.

Definition at line 410 of file Cluster.h.

◆ SetNodeType() [1/3]

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

The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)

Definition at line 240 of file Cluster.h.

◆ SetNodeType() [2/3]

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

The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)

Definition at line 234 of file Cluster.h.

◆ SetNodeType() [3/3]

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

The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)

Definition at line 246 of file Cluster.h.

◆ SetNotificationConfiguration() [1/2]

void Aws::DAX::Model::Cluster::SetNotificationConfiguration ( const NotificationConfiguration value)
inline

Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

Definition at line 522 of file Cluster.h.

◆ SetNotificationConfiguration() [2/2]

void Aws::DAX::Model::Cluster::SetNotificationConfiguration ( NotificationConfiguration &&  value)
inline

Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

Definition at line 529 of file Cluster.h.

◆ SetParameterGroup() [1/2]

void Aws::DAX::Model::Cluster::SetParameterGroup ( const ParameterGroupStatus value)
inline

The parameter group being used by nodes in the cluster.

Definition at line 706 of file Cluster.h.

◆ SetParameterGroup() [2/2]

void Aws::DAX::Model::Cluster::SetParameterGroup ( ParameterGroupStatus &&  value)
inline

The parameter group being used by nodes in the cluster.

Definition at line 711 of file Cluster.h.

◆ SetPreferredMaintenanceWindow() [1/3]

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

A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.

Definition at line 468 of file Cluster.h.

◆ SetPreferredMaintenanceWindow() [2/3]

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

A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.

Definition at line 460 of file Cluster.h.

◆ SetPreferredMaintenanceWindow() [3/3]

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

A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.

Definition at line 476 of file Cluster.h.

◆ SetSecurityGroups() [1/2]

void Aws::DAX::Model::Cluster::SetSecurityGroups ( Aws::Vector< SecurityGroupMembership > &&  value)
inline

A list of security groups, and the status of each, for the nodes in the cluster.

Definition at line 609 of file Cluster.h.

◆ SetSecurityGroups() [2/2]

void Aws::DAX::Model::Cluster::SetSecurityGroups ( const Aws::Vector< SecurityGroupMembership > &  value)
inline

A list of security groups, and the status of each, for the nodes in the cluster.

Definition at line 603 of file Cluster.h.

◆ SetSSEDescription() [1/2]

void Aws::DAX::Model::Cluster::SetSSEDescription ( const SSEDescription value)
inline

The description of the server-side encryption status on the specified DAX cluster.

Definition at line 740 of file Cluster.h.

◆ SetSSEDescription() [2/2]

void Aws::DAX::Model::Cluster::SetSSEDescription ( SSEDescription &&  value)
inline

The description of the server-side encryption status on the specified DAX cluster.

Definition at line 746 of file Cluster.h.

◆ SetStatus() [1/3]

void Aws::DAX::Model::Cluster::SetStatus ( Aws::String &&  value)
inline

The current status of the cluster.

Definition at line 285 of file Cluster.h.

◆ SetStatus() [2/3]

void Aws::DAX::Model::Cluster::SetStatus ( const Aws::String value)
inline

The current status of the cluster.

Definition at line 280 of file Cluster.h.

◆ SetStatus() [3/3]

void Aws::DAX::Model::Cluster::SetStatus ( const char *  value)
inline

The current status of the cluster.

Definition at line 290 of file Cluster.h.

◆ SetSubnetGroup() [1/3]

void Aws::DAX::Model::Cluster::SetSubnetGroup ( Aws::String &&  value)
inline

The subnet group where the DAX cluster is running.

Definition at line 564 of file Cluster.h.

◆ SetSubnetGroup() [2/3]

void Aws::DAX::Model::Cluster::SetSubnetGroup ( const Aws::String value)
inline

The subnet group where the DAX cluster is running.

Definition at line 559 of file Cluster.h.

◆ SetSubnetGroup() [3/3]

void Aws::DAX::Model::Cluster::SetSubnetGroup ( const char *  value)
inline

The subnet group where the DAX cluster is running.

Definition at line 569 of file Cluster.h.

◆ SetTotalNodes()

void Aws::DAX::Model::Cluster::SetTotalNodes ( int  value)
inline

The total number of nodes in the cluster.

Definition at line 185 of file Cluster.h.

◆ SSEDescriptionHasBeenSet()

bool Aws::DAX::Model::Cluster::SSEDescriptionHasBeenSet ( ) const
inline

The description of the server-side encryption status on the specified DAX cluster.

Definition at line 734 of file Cluster.h.

◆ StatusHasBeenSet()

bool Aws::DAX::Model::Cluster::StatusHasBeenSet ( ) const
inline

The current status of the cluster.

Definition at line 275 of file Cluster.h.

◆ SubnetGroupHasBeenSet()

bool Aws::DAX::Model::Cluster::SubnetGroupHasBeenSet ( ) const
inline

The subnet group where the DAX cluster is running.

Definition at line 554 of file Cluster.h.

◆ TotalNodesHasBeenSet()

bool Aws::DAX::Model::Cluster::TotalNodesHasBeenSet ( ) const
inline

The total number of nodes in the cluster.

Definition at line 180 of file Cluster.h.

◆ WithActiveNodes()

Cluster& Aws::DAX::Model::Cluster::WithActiveNodes ( int  value)
inline

The number of nodes in the cluster that are active (i.e., capable of serving requests).

Definition at line 215 of file Cluster.h.

◆ WithClusterArn() [1/3]

Cluster& Aws::DAX::Model::Cluster::WithClusterArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Definition at line 164 of file Cluster.h.

◆ WithClusterArn() [2/3]

Cluster& Aws::DAX::Model::Cluster::WithClusterArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Definition at line 159 of file Cluster.h.

◆ WithClusterArn() [3/3]

Cluster& Aws::DAX::Model::Cluster::WithClusterArn ( const char *  value)
inline

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Definition at line 169 of file Cluster.h.

◆ WithClusterDiscoveryEndpoint() [1/2]

Cluster& Aws::DAX::Model::Cluster::WithClusterDiscoveryEndpoint ( const Endpoint value)
inline

The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.

Definition at line 341 of file Cluster.h.

◆ WithClusterDiscoveryEndpoint() [2/2]

Cluster& Aws::DAX::Model::Cluster::WithClusterDiscoveryEndpoint ( Endpoint &&  value)
inline

The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.

Definition at line 348 of file Cluster.h.

◆ WithClusterEndpointEncryptionType() [1/2]

Cluster& Aws::DAX::Model::Cluster::WithClusterEndpointEncryptionType ( ClusterEndpointEncryptionType &&  value)
inline

The type of encryption supported by the cluster's endpoint. Values are:

  • NONE for no encryption

    TLS for Transport Layer Security

Definition at line 801 of file Cluster.h.

◆ WithClusterEndpointEncryptionType() [2/2]

Cluster& Aws::DAX::Model::Cluster::WithClusterEndpointEncryptionType ( const ClusterEndpointEncryptionType value)
inline

The type of encryption supported by the cluster's endpoint. Values are:

  • NONE for no encryption

    TLS for Transport Layer Security

Definition at line 794 of file Cluster.h.

◆ WithClusterName() [1/3]

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

The name of the DAX cluster.

Definition at line 82 of file Cluster.h.

◆ WithClusterName() [2/3]

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

The name of the DAX cluster.

Definition at line 77 of file Cluster.h.

◆ WithClusterName() [3/3]

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

The name of the DAX cluster.

Definition at line 87 of file Cluster.h.

◆ WithDescription() [1/3]

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

The description of the cluster.

Definition at line 123 of file Cluster.h.

◆ WithDescription() [2/3]

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

The description of the cluster.

Definition at line 118 of file Cluster.h.

◆ WithDescription() [3/3]

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

The description of the cluster.

Definition at line 128 of file Cluster.h.

◆ WithIamRoleArn() [1/3]

Cluster& Aws::DAX::Model::Cluster::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 683 of file Cluster.h.

◆ WithIamRoleArn() [2/3]

Cluster& Aws::DAX::Model::Cluster::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 676 of file Cluster.h.

◆ WithIamRoleArn() [3/3]

Cluster& Aws::DAX::Model::Cluster::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 690 of file Cluster.h.

◆ WithNodeIdsToRemove() [1/2]

Cluster& Aws::DAX::Model::Cluster::WithNodeIdsToRemove ( Aws::Vector< Aws::String > &&  value)
inline

A list of nodes to be removed from the cluster.

Definition at line 379 of file Cluster.h.

◆ WithNodeIdsToRemove() [2/2]

Cluster& Aws::DAX::Model::Cluster::WithNodeIdsToRemove ( const Aws::Vector< Aws::String > &  value)
inline

A list of nodes to be removed from the cluster.

Definition at line 374 of file Cluster.h.

◆ WithNodes() [1/2]

Cluster& Aws::DAX::Model::Cluster::WithNodes ( Aws::Vector< Node > &&  value)
inline

A list of nodes that are currently in the cluster.

Definition at line 425 of file Cluster.h.

◆ WithNodes() [2/2]

Cluster& Aws::DAX::Model::Cluster::WithNodes ( const Aws::Vector< Node > &  value)
inline

A list of nodes that are currently in the cluster.

Definition at line 420 of file Cluster.h.

◆ WithNodeType() [1/3]

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

The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)

Definition at line 258 of file Cluster.h.

◆ WithNodeType() [2/3]

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

The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)

Definition at line 252 of file Cluster.h.

◆ WithNodeType() [3/3]

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

The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)

Definition at line 264 of file Cluster.h.

◆ WithNotificationConfiguration() [1/2]

Cluster& Aws::DAX::Model::Cluster::WithNotificationConfiguration ( const NotificationConfiguration value)
inline

Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

Definition at line 536 of file Cluster.h.

◆ WithNotificationConfiguration() [2/2]

Cluster& Aws::DAX::Model::Cluster::WithNotificationConfiguration ( NotificationConfiguration &&  value)
inline

Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

Definition at line 543 of file Cluster.h.

◆ WithParameterGroup() [1/2]

Cluster& Aws::DAX::Model::Cluster::WithParameterGroup ( const ParameterGroupStatus value)
inline

The parameter group being used by nodes in the cluster.

Definition at line 716 of file Cluster.h.

◆ WithParameterGroup() [2/2]

Cluster& Aws::DAX::Model::Cluster::WithParameterGroup ( ParameterGroupStatus &&  value)
inline

The parameter group being used by nodes in the cluster.

Definition at line 721 of file Cluster.h.

◆ WithPreferredMaintenanceWindow() [1/3]

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

A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.

Definition at line 492 of file Cluster.h.

◆ WithPreferredMaintenanceWindow() [2/3]

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

A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.

Definition at line 484 of file Cluster.h.

◆ WithPreferredMaintenanceWindow() [3/3]

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

A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.

Definition at line 500 of file Cluster.h.

◆ WithSecurityGroups() [1/2]

Cluster& Aws::DAX::Model::Cluster::WithSecurityGroups ( Aws::Vector< SecurityGroupMembership > &&  value)
inline

A list of security groups, and the status of each, for the nodes in the cluster.

Definition at line 621 of file Cluster.h.

◆ WithSecurityGroups() [2/2]

Cluster& Aws::DAX::Model::Cluster::WithSecurityGroups ( const Aws::Vector< SecurityGroupMembership > &  value)
inline

A list of security groups, and the status of each, for the nodes in the cluster.

Definition at line 615 of file Cluster.h.

◆ WithSSEDescription() [1/2]

Cluster& Aws::DAX::Model::Cluster::WithSSEDescription ( const SSEDescription value)
inline

The description of the server-side encryption status on the specified DAX cluster.

Definition at line 752 of file Cluster.h.

◆ WithSSEDescription() [2/2]

Cluster& Aws::DAX::Model::Cluster::WithSSEDescription ( SSEDescription &&  value)
inline

The description of the server-side encryption status on the specified DAX cluster.

Definition at line 758 of file Cluster.h.

◆ WithStatus() [1/3]

Cluster& Aws::DAX::Model::Cluster::WithStatus ( Aws::String &&  value)
inline

The current status of the cluster.

Definition at line 300 of file Cluster.h.

◆ WithStatus() [2/3]

Cluster& Aws::DAX::Model::Cluster::WithStatus ( const Aws::String value)
inline

The current status of the cluster.

Definition at line 295 of file Cluster.h.

◆ WithStatus() [3/3]

Cluster& Aws::DAX::Model::Cluster::WithStatus ( const char *  value)
inline

The current status of the cluster.

Definition at line 305 of file Cluster.h.

◆ WithSubnetGroup() [1/3]

Cluster& Aws::DAX::Model::Cluster::WithSubnetGroup ( Aws::String &&  value)
inline

The subnet group where the DAX cluster is running.

Definition at line 579 of file Cluster.h.

◆ WithSubnetGroup() [2/3]

Cluster& Aws::DAX::Model::Cluster::WithSubnetGroup ( const Aws::String value)
inline

The subnet group where the DAX cluster is running.

Definition at line 574 of file Cluster.h.

◆ WithSubnetGroup() [3/3]

Cluster& Aws::DAX::Model::Cluster::WithSubnetGroup ( const char *  value)
inline

The subnet group where the DAX cluster is running.

Definition at line 584 of file Cluster.h.

◆ WithTotalNodes()

Cluster& Aws::DAX::Model::Cluster::WithTotalNodes ( int  value)
inline

The total number of nodes in the cluster.

Definition at line 190 of file Cluster.h.


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