com.netflix.priam.identity.config

Interface InstanceInfo

All Known Implementing Classes:

AWSInstanceInfo, LocalInstanceInfo

public interface InstanceInfo

A means to fetch meta data of running instance

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	InstanceInfo.InstanceEnvironment

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAutoScalingGroup() Get the ASG in which this instance is deployed.
default java.util.List<java.lang.String>	getDefaultRacks() Get the list of default racks available for this DC.
java.lang.String	getHostIP() Get ip address for running instance.
java.lang.String	getHostname() Get the hostname for the running instance.
InstanceInfo.InstanceEnvironment	getInstanceEnvironment() Environment of the current running instance.
java.lang.String	getInstanceId() Get the instance id of the running instance.
java.lang.String	getInstanceType() Get the instance type of the running instance.
java.lang.String	getPrivateIP() Get private ip address for running instance.
java.lang.String	getRac() Get the availability zone of the running instance.
java.lang.String	getRegion() Get the region/data center of the running instance
java.lang.String	getVpcId() Get the id of the vpc account for running instance.

Method Detail

getRac

java.lang.String getRac()

Get the availability zone of the running instance.

Returns:

the availability zone of the running instance. e.g. us-east-1c

getDefaultRacks

default java.util.List<java.lang.String> getDefaultRacks()

Get the list of default racks available for this DC. This is used if no value is configured for IConfiguration.getRacs()

Returns:

list of default racks.

getHostname

java.lang.String getHostname()

Get the hostname for the running instance. Cannot be null.

Returns:

the public hostname for the running instance. e.g.: ec2-12-34-56-78.compute-1.amazonaws.com, if available. Else return private ip address for running instance.

getHostIP

java.lang.String getHostIP()

Get ip address for running instance. Cannot be null.

Returns:

public ip if one is provided or private ip address for running instance.

getPrivateIP

java.lang.String getPrivateIP()

Get private ip address for running instance.

Returns:

private ip address for running instance.

getInstanceId

java.lang.String getInstanceId()

Get the instance id of the running instance.

Returns:

the instance id of the running instance. e.g. i-07a88a49ff155353

getInstanceType

java.lang.String getInstanceType()

Get the instance type of the running instance.

Returns:

the instance type of the running instance. e.g. i3.2xlarge

getVpcId

java.lang.String getVpcId()

Get the id of the vpc account for running instance.

Returns:

the id of the vpc account for running instance, null if does not exist.

getRegion

java.lang.String getRegion()

Get the region/data center of the running instance

Returns:

the region of the running instance, could be null/empty (e.g. us-east-1)

getAutoScalingGroup

java.lang.String getAutoScalingGroup()

Get the ASG in which this instance is deployed. Note that Priam requires instances to be under an ASG.

Returns:

the ASG of the instance. ex: cassandra_app--useast1e

getInstanceEnvironment

InstanceInfo.InstanceEnvironment getInstanceEnvironment()

Environment of the current running instance. AWS only allows VPC environment (default). Classic is deprecated environment by AWS.

Returns:

Environment of the current running instance.