The client_aws_config contains the configuration for client to connect to nodes in aws environment. More...

#include <client_aws_config.h>

Public Member Functions
const std::string &	get_access_key () const
	Gets the access key to access AWS.
client_aws_config &	set_access_key (const std::string &access_key)
	Sets the access key to access AWS.
const std::string &	get_secret_key () const
	Gets the secret key to access AWS.
client_aws_config &	set_secret_key (const std::string &secret_key)
	Sets the secret key to access AWS.
const std::string &	get_region () const
	Gets the region where the EC2 instances running the Hazelcast members will be running.
client_aws_config &	set_region (const std::string &region)
	Sets the region where the EC2 instances running the Hazelcast members will be running.
const std::string &	get_host_header () const
	Gets the host header; the address where the EC2 API can be found.
client_aws_config &	set_host_header (const std::string &host_header)
	Sets the host header; the address where the EC2 API can be found.
client_aws_config &	set_enabled (bool enabled)
	Enables or disables the aws join mechanism.
bool	is_enabled () const
	Checks if the aws join mechanism is enabled.
client_aws_config &	set_security_group_name (const std::string &security_group_name)
	Sets the security group name.
const std::string &	get_security_group_name () const
	Gets the security group name.
client_aws_config &	set_tag_key (const std::string &tag_key)
	Sets the tag key.
const std::string &	get_tag_key () const
	Gets the tag key.
client_aws_config &	set_tag_value (const std::string &tag_value)
	Sets the tag value.
const std::string &	get_tag_value () const
	Gets the tag value.
const std::string &	get_iam_role () const
	Gets the iamRole name.
client_aws_config &	set_iam_role (const std::string &iam_role)
	Sets the tag value.
bool	is_inside_aws () const
	If client is inside aws, it will use private ip addresses directly, otherwise it will convert private ip addresses to public addresses internally by calling AWS API.
client_aws_config &	set_inside_aws (bool inside_aws)
	Set to true if client is inside aws environment Default value is false.

Detailed Description

The client_aws_config contains the configuration for client to connect to nodes in aws environment.

The client_aws_config contains the configuration for AWS join mechanism.

what happens behind the scenes is that data about the running AWS instances in a specific region are downloaded using the accesskey/secretkey and are potential Hazelcast members.

Filtering

There are 2 mechanisms for filtering out AWS instances and these mechanisms can be combined (AND).

If a securityGroup is configured, only instances within that security group are selected.
If a tag key/value is set, only instances with that tag key/value will be selected.

Definition at line 53 of file client_aws_config.h.

Constructor & Destructor Documentation

◆ client_aws_config()

hazelcast::client::config::client_aws_config::client_aws_config ( )

Definition at line 587 of file config.cpp.

  : enabled_(false)
  , region_("us-east-1")
  , host_header_("ec2.amazonaws.com")
  , inside_aws_(false)
{}

Member Function Documentation

◆ get_access_key()

const std::string & hazelcast::client::config::client_aws_config::get_access_key ( ) const

Gets the access key to access AWS.

Returns empty string if no access key is configured.

Returns: the access key to access AWS

See also: #set_access_key(std::string)

Definition at line 595 of file config.cpp.

{
    return access_key_;
}

◆ get_host_header()

const std::string & hazelcast::client::config::client_aws_config::get_host_header ( ) const

Gets the host header; the address where the EC2 API can be found.

Returns: the host header; the address where the EC2 API can be found

Definition at line 637 of file config.cpp.

{
    return host_header_;
}

◆ get_iam_role()

const std::string & hazelcast::client::config::client_aws_config::get_iam_role ( ) const

Gets the iamRole name.

Returns: the iamRole. empty string if nothing is returned.

See also: #set_iam_role(std::string) (int32_t)

Definition at line 705 of file config.cpp.

{
    return iam_role_;
}

◆ get_region()

const std::string & hazelcast::client::config::client_aws_config::get_region ( ) const

Gets the region where the EC2 instances running the Hazelcast members will be running.

Returns: the region where the EC2 instances running the Hazelcast members will be running

See also: #setRegion(std::string)

Definition at line 623 of file config.cpp.

{
    return region_;
}

◆ get_secret_key()

const std::string & hazelcast::client::config::client_aws_config::get_secret_key ( ) const

Gets the secret key to access AWS.

Returns empty string if no access key is configured.

Returns: the secret key.

See also: #set_secret_key(std::string)

Definition at line 609 of file config.cpp.

{
    return secret_key_;
}

◆ get_security_group_name()

const std::string & hazelcast::client::config::client_aws_config::get_security_group_name ( ) const

Gets the security group name.

If nothing has been configured, empty string is returned.

Returns: the security group name; empty string if nothing has been configured

Definition at line 673 of file config.cpp.

{
    return security_group_name_;
}

◆ get_tag_key()

const std::string & hazelcast::client::config::client_aws_config::get_tag_key ( ) const

Gets the tag key.

If nothing is specified, empty string is returned.

Returns: the tag key. empty string if nothing is returned.

Definition at line 686 of file config.cpp.

{
    return tag_key_;
}

◆ get_tag_value()

const std::string & hazelcast::client::config::client_aws_config::get_tag_value ( ) const

Gets the tag value.

If nothing is specified, empty string is returned.

Returns: the tag value. empty string if nothing is returned.

Definition at line 699 of file config.cpp.

{
    return tag_value_;
}

◆ is_enabled()

bool hazelcast::client::config::client_aws_config::is_enabled ( ) const

Checks if the aws join mechanism is enabled.

Returns: true if enabled, false otherwise.

Definition at line 659 of file config.cpp.

{
    return enabled_;
}

◆ is_inside_aws()

bool hazelcast::client::config::client_aws_config::is_inside_aws ( ) const

If client is inside aws, it will use private ip addresses directly, otherwise it will convert private ip addresses to public addresses internally by calling AWS API.

Returns: bool true if client is inside aws environment.

Definition at line 718 of file config.cpp.

{
    return inside_aws_;
}

◆ set_access_key()

client_aws_config & hazelcast::client::config::client_aws_config::set_access_key ( const std::string & access_key )

Sets the access key to access AWS.

Parameters

accessKey the access key to access AWS

Returns: the updated client_aws_config.

Exceptions

illegal_argument if accessKey is empty.

See also: #getAccessKey(); #set_secret_key(std::string)

Definition at line 601 of file config.cpp.

{
    this->access_key_ = util::Preconditions::check_has_text(
      access_key, "accessKey must contain text");
    return *this;
}

◆ set_enabled()

client_aws_config & hazelcast::client::config::client_aws_config::set_enabled ( bool enabled )

Enables or disables the aws join mechanism.

Parameters

enabled true if enabled, false otherwise.

Returns: the updated client_aws_config.

Definition at line 651 of file config.cpp.

{
    util::Preconditions::check_ssl("get_aws_config");
    this->enabled_ = enabled;
    return *this;
}

◆ set_host_header()

client_aws_config & hazelcast::client::config::client_aws_config::set_host_header ( const std::string & host_header )

Sets the host header; the address where the EC2 API can be found.

Parameters

hostHeader the new host header; the address where the EC2 API can be found

Returns: the updated client_aws_config

Exceptions

illegal_argument if hostHeader is an empty string.

Definition at line 643 of file config.cpp.

{
    this->host_header_ = util::Preconditions::check_has_text(
      host_header, "hostHeader must contain text");
    return *this;
}

◆ set_iam_role()

client_aws_config & hazelcast::client::config::client_aws_config::set_iam_role ( const std::string & iam_role )

Sets the tag value.

See the filtering section above for more information.

Parameters

iamRole the IAM Role name.

Returns: the updated client_aws_config.

See also: #getIamRole()

Definition at line 711 of file config.cpp.

{
    this->iam_role_ = iam_role;
    return *this;
}

◆ set_inside_aws()

client_aws_config & hazelcast::client::config::client_aws_config::set_inside_aws ( bool inside_aws )

Set to true if client is inside aws environment Default value is false.

Parameters

insideAws isInsideAws

Definition at line 724 of file config.cpp.

{
    this->inside_aws_ = inside_aws;
    return *this;
}

◆ set_region()

client_aws_config & hazelcast::client::config::client_aws_config::set_region ( const std::string & region )

Sets the region where the EC2 instances running the Hazelcast members will be running.

Parameters

region the region where the EC2 instances running the Hazelcast members will be running

Returns: the updated client_aws_config

Exceptions

illegal_argument if region is empty.

Definition at line 629 of file config.cpp.

{
    this->region_ =
      util::Preconditions::check_has_text(region, "region must contain text");
    return *this;
}

◆ set_secret_key()

client_aws_config & hazelcast::client::config::client_aws_config::set_secret_key ( const std::string & secret_key )

Sets the secret key to access AWS.

Parameters

secretKey the secret key to access AWS

Returns: the updated client_aws_config.

Exceptions

illegal_argument if secretKey is empty.

See also: #getSecretKey(); #set_access_key(std::string)

Definition at line 615 of file config.cpp.

{
    this->secret_key_ = util::Preconditions::check_has_text(
      secret_key, "secretKey must contain text");
    return *this;
}

◆ set_security_group_name()

client_aws_config & hazelcast::client::config::client_aws_config::set_security_group_name ( const std::string & security_group_name )

Sets the security group name.

See the filtering section above for more information.

Parameters

securityGroupName the security group name.

Returns: the updated client_aws_config.

See also: #getSecurityGroupName()

Definition at line 665 of file config.cpp.

{
    this->security_group_name_ = security_group_name;
    return *this;
}

◆ set_tag_key()

client_aws_config & hazelcast::client::config::client_aws_config::set_tag_key ( const std::string & tag_key )

Sets the tag key.

See the filtering section above for more information.

Parameters

tagKey the tag key. See the filtering section above for more information.

Returns: the updated client_aws_config.

See also: #set_tag_key(std::string)

Definition at line 679 of file config.cpp.

{
    this->tag_key_ = tag_key;
    return *this;
}

◆ set_tag_value()

client_aws_config & hazelcast::client::config::client_aws_config::set_tag_value ( const std::string & tag_value )

Sets the tag value.

See the filtering section above for more information.

Parameters

tagValue the tag value. See the filtering section above for more information.

Returns: the updated client_aws_config.

See also: #set_tag_key(std::string); #getTagValue()

Definition at line 692 of file config.cpp.

{
    this->tag_value_ = tag_value;
    return *this;
}

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

hazelcast/include/hazelcast/client/config/client_aws_config.h
hazelcast/src/hazelcast/client/config.cpp

Public Member Functions

Detailed Description

Filtering

Constructor & Destructor Documentation

◆ client_aws_config()

Member Function Documentation

◆ get_access_key()

◆ get_host_header()

◆ get_iam_role()

◆ get_region()

◆ get_secret_key()

◆ get_security_group_name()

◆ get_tag_key()

◆ get_tag_value()

◆ is_enabled()

◆ is_inside_aws()

◆ set_access_key()

◆ set_enabled()

◆ set_host_header()

◆ set_iam_role()

◆ set_inside_aws()

◆ set_region()

◆ set_secret_key()

◆ set_security_group_name()

◆ set_tag_key()

◆ set_tag_value()