Package org.apereo.cas.configuration.model.support.hazelcast.discovery

Class HazelcastAwsDiscoveryProperties

java.lang.Object
org.apereo.cas.configuration.model.support.hazelcast.discovery.HazelcastAwsDiscoveryProperties
All Implemented Interfaces:
Serializable
@RequiresModule(name="cas-server-support-hazelcast-discovery-aws") public class HazelcastAwsDiscoveryProperties extends Object implements Serializable
This is HazelcastAwsDiscoveryProperties.
Since:
5.3.0
See Also:

  • Field Details

    • AWS_DISCOVERY_ACCESS_KEY

      public static final String AWS_DISCOVERY_ACCESS_KEY
      AWS discovery access key property.
      See Also:

    • AWS_DISCOVERY_SECRET_KEY

      public static final String AWS_DISCOVERY_SECRET_KEY
      AWS discovery secret key property.
      See Also:

    • AWS_DISCOVERY_IAM_ROLE

      public static final String AWS_DISCOVERY_IAM_ROLE
      AWS discovery IAM role property.
      See Also:

    • AWS_DISCOVERY_REGION

      public static final String AWS_DISCOVERY_REGION
      AWS discovery region property.
      See Also:

    • AWS_DISCOVERY_HOST_HEADER

      public static final String AWS_DISCOVERY_HOST_HEADER
      AWS discovery host header property.
      See Also:

    • AWS_DISCOVERY_SECURITY_GROUP_NAME

      public static final String AWS_DISCOVERY_SECURITY_GROUP_NAME
      AWS discovery security group name property.
      See Also:

    • AWS_DISCOVERY_TAG_KEY

      public static final String AWS_DISCOVERY_TAG_KEY
      AWS discovery tag key property.
      See Also:

    • AWS_DISCOVERY_TAG_VALUE

      public static final String AWS_DISCOVERY_TAG_VALUE
      AWS discovery tag value property.
      See Also:

    • AWS_DISCOVERY_PORT

      public static final String AWS_DISCOVERY_PORT
      AWS discovery HZ port property.
      See Also:

    • AWS_DISCOVERY_CONNECTION_TIMEOUT

      public static final String AWS_DISCOVERY_CONNECTION_TIMEOUT
      Property name for connection and read timeouts when making a call to AWS API.
      See Also:

    • AWS_DISCOVERY_READ_TIMEOUT

      public static final String AWS_DISCOVERY_READ_TIMEOUT
      Property name for connection and read timeouts when making a call to AWS API.
      See Also:

    • AWS_DISCOVERY_CLUSTER

      public static final String AWS_DISCOVERY_CLUSTER
      Property name for ECS cluster short name or ARN; default is the current cluster.
      See Also:

    • AWS_DISCOVERY_SERVCE_NAME

      public static final String AWS_DISCOVERY_SERVCE_NAME
      Property name for filter to look only for ECS tasks from the given service; mutually exclusive with AWS_DISCOVERY_FAMILY.
      See Also:

    • AWS_DISCOVERY_FAMILY

      public static final String AWS_DISCOVERY_FAMILY
      Property name for filter to look only for ECS tasks with the given family name; mutually exclusive with AWS_DISCOVERY_SERVCE_NAME.
      See Also:

  • Constructor Details

    • HazelcastAwsDiscoveryProperties

      public HazelcastAwsDiscoveryProperties()

  • Method Details

    • getAccessKey

      public String getAccessKey()
      AWS access key.

    • getSecretKey

      public String getSecretKey()
      AWS secret key.

    • getIamRole

      public String getIamRole()
      If you do not want to use access key and secret key, you can specify iam-role. Hazelcast fetches your credentials by using your IAM role. This setting only affects deployments on Amazon EC2. If you are deploying CAS in an Amazon ECS environment, the role should not be specified. The role is fetched from the task definition that is assigned to run CAS.

    • getRegion

      public String getRegion()
      AWS region. i.e. us-east-1. The region where your members are running.

    • getHostHeader

      public String getHostHeader()
      Host header. i.e. ec2.amazonaws.com. The URL that is the entry point for a web service.

    • getSecurityGroupName

      public String getSecurityGroupName()
      If a security group is configured, only instances within that security group are selected.

    • getTagKey

      public String getTagKey()
      If a tag key/value is set, only instances with that tag key/value will be selected.

    • getTagValue

      public String getTagValue()
      If a tag key/value is set, only instances with that tag key/value will be selected.

    • getPort

      public int getPort()
      Hazelcast port. Typically may be set to 5701. You can set searching for other ports rather than 5701 if you've members on different ports.

    • getConnectionTimeoutSeconds

      public int getConnectionTimeoutSeconds()
      The maximum amount of time Hazelcast will try to connect to a well known member before giving up. Setting this value too low could mean that a member is not able to connect to a cluster. Setting the value too high means that member startup could slow down because of longer timeouts (for example, when a well known member is not up). Increasing this value is recommended if you have many IPs listed and the members cannot properly build up the cluster. Its default value is 5.

    • getCluster

      public String getCluster()
      ECS cluster short name or ARN; default is the current cluster.

    • getServiceName

      public String getServiceName()
      Filter to look only for ECS tasks from the given service; mutually exclusive with getFamily().

    • getFamily

      public String getFamily()
      Filter to look only for ECS tasks with the given family name; mutually exclusive with getServiceName().

    • setAccessKey

      public HazelcastAwsDiscoveryProperties setAccessKey(String accessKey)
      AWS access key.
      Returns:
      this.

    • setSecretKey

      public HazelcastAwsDiscoveryProperties setSecretKey(String secretKey)
      AWS secret key.
      Returns:
      this.

    • setIamRole

      public HazelcastAwsDiscoveryProperties setIamRole(String iamRole)
      If you do not want to use access key and secret key, you can specify iam-role. Hazelcast fetches your credentials by using your IAM role. This setting only affects deployments on Amazon EC2. If you are deploying CAS in an Amazon ECS environment, the role should not be specified. The role is fetched from the task definition that is assigned to run CAS.
      Returns:
      this.

    • setRegion

      public HazelcastAwsDiscoveryProperties setRegion(String region)
      AWS region. i.e. us-east-1. The region where your members are running.
      Returns:
      this.

    • setHostHeader

      public HazelcastAwsDiscoveryProperties setHostHeader(String hostHeader)
      Host header. i.e. ec2.amazonaws.com. The URL that is the entry point for a web service.
      Returns:
      this.

    • setSecurityGroupName

      public HazelcastAwsDiscoveryProperties setSecurityGroupName(String securityGroupName)
      If a security group is configured, only instances within that security group are selected.
      Returns:
      this.

    • setTagKey

      public HazelcastAwsDiscoveryProperties setTagKey(String tagKey)
      If a tag key/value is set, only instances with that tag key/value will be selected.
      Returns:
      this.

    • setTagValue

      public HazelcastAwsDiscoveryProperties setTagValue(String tagValue)
      If a tag key/value is set, only instances with that tag key/value will be selected.
      Returns:
      this.

    • setPort

      public HazelcastAwsDiscoveryProperties setPort(int port)
      Hazelcast port. Typically may be set to 5701. You can set searching for other ports rather than 5701 if you've members on different ports.
      Returns:
      this.

    • setConnectionTimeoutSeconds

      public HazelcastAwsDiscoveryProperties setConnectionTimeoutSeconds(int connectionTimeoutSeconds)
      The maximum amount of time Hazelcast will try to connect to a well known member before giving up. Setting this value too low could mean that a member is not able to connect to a cluster. Setting the value too high means that member startup could slow down because of longer timeouts (for example, when a well known member is not up). Increasing this value is recommended if you have many IPs listed and the members cannot properly build up the cluster. Its default value is 5.
      Returns:
      this.

    • setCluster

      public HazelcastAwsDiscoveryProperties setCluster(String cluster)
      ECS cluster short name or ARN; default is the current cluster.
      Returns:
      this.

    • setServiceName

      public HazelcastAwsDiscoveryProperties setServiceName(String serviceName)
      Filter to look only for ECS tasks from the given service; mutually exclusive with getFamily().
      Returns:
      this.

    • setFamily

      public HazelcastAwsDiscoveryProperties setFamily(String family)
      Filter to look only for ECS tasks with the given family name; mutually exclusive with getServiceName().
      Returns:
      this.