com.kdgregory.logging.aws.facade

Interface InfoFacade

public interface InfoFacade

A facade for various operations that retrieve information about the AWS environment.

Unlike the service-level facades, these operations are "best effort": if unable to perform the operation, the implementation is permitted to return a default value (typically null).

Also unlike service-level facades, implemtations are expected to retry if throttled.

Finally, these operations use the default client for whatever service they invoke. They do not attempt to assume a role or connect to an alternate region.

Method Summary

Modifier and Type	Method and Description
String	retrieveAccountId() Retrieves the current AWS account ID, "unknown" if unable to determine the account ID for any reason.
String	retrieveDefaultRegion() Retrieves the current configured region, using the default region provider.
String	retrieveEC2InstanceId() Returns the current instance ID, using the EC2 metadata service.
String	retrieveEC2Region() Returns the instance where the logger is running, using the EC2 metadata service.
Map<String,String>	retrieveEC2Tags(String instanceId) Returns all tags for the specified EC2 instance.
String	retrieveParameter(String parameterName) Retrieves a named Systems Manager parameter, null if it doesnt' exist or is a secure string.

Method Detail

retrieveAccountId

String retrieveAccountId()

Retrieves the current AWS account ID, "unknown" if unable to determine the account ID for any reason.

Requires the STS SDK.

retrieveDefaultRegion

String retrieveDefaultRegion()

Retrieves the current configured region, using the default region provider.

retrieveEC2InstanceId

String retrieveEC2InstanceId()

Returns the current instance ID, using the EC2 metadata service. This will only work valid when running on an EC2 instance, and may take a long time to return if running elsewhere.

retrieveEC2Region

String retrieveEC2Region()

Returns the instance where the logger is running, using the EC2 metadata service. This will only work valid when running on an EC2 instance, and may take a long time to return if running elsewhere.

See also retrieveDefaultRegion(), which uses the default region provider.

retrieveEC2Tags

Map<String,String> retrieveEC2Tags(String instanceId)

Returns all tags for the specified EC2 instance. Returns an empty map if unable to retrieve these tags for any reason (eg, invalid instance ID, permission denied).

retrieveParameter

String retrieveParameter(String parameterName)

Retrieves a named Systems Manager parameter, null if it doesnt' exist or is a secure string.

If throttled, this method will retry up to 4 times before returning null. Other exceptions are silently caught, and return null.

Requires the Systems Manager SDK.