io.sphere.sdk.subscriptions

Class AwsCredentials

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.subscriptions.AwsCredentials

public final class AwsCredentials
extends Base

This class represents the credentials required to use SnsDestination and SqsDestination. It allows the retrieval of the aws credentials from environment variables ofEnv(String, String) and from the standard aws cli environment variables ofAwsCliEnv().

Field Summary

Fields

Modifier and Type	Field and Description
static String	AWS_ACCESS_KEY_ID_ENV Constant to retrieve accessKey from the standard AWS CLI environment variable.
static String	AWS_SECRET_ACCESS_KEY_ENV Constant to retrieve accessSecret from the standard AWS CLI environment variable.

Method Summary

Modifier and Type	Method and Description
String	getAccessKey()
String	getAccessSecret()
static AwsCredentials	of(String accessKey, String accessSecret)
static AwsCredentials	ofAwsCliEnv() Creates the aws credentials based on the environment variable names used by the AWS CLI.
static AwsCredentials	ofEnv(String accessKeyEnv, String accessSecretEnv) Creates the aws credentials based on the environment variable names given as parameters.

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

AWS_ACCESS_KEY_ID_ENV

public static final String AWS_ACCESS_KEY_ID_ENV

Constant to retrieve accessKey from the standard AWS CLI environment variable.

See Also:

Constant Field Values

AWS_SECRET_ACCESS_KEY_ENV

public static final String AWS_SECRET_ACCESS_KEY_ENV

Constant to retrieve accessSecret from the standard AWS CLI environment variable.

See Also:

Constant Field Values

Method Detail

getAccessKey

public String getAccessKey()

getAccessSecret

public String getAccessSecret()

ofEnv

public static AwsCredentials ofEnv(String accessKeyEnv,
                                   String accessSecretEnv)

Creates the aws credentials based on the environment variable names given as parameters.

Parameters:

accessKeyEnv - the name of the environment variable to retrieve getAccessKey()

accessSecretEnv - the name of the environment variable to retrieve getAccessSecret()

Returns:

aws credentials retrieved from System.getenv(String)

ofAwsCliEnv

public static AwsCredentials ofAwsCliEnv()

Creates the aws credentials based on the environment variable names used by the AWS CLI.

Returns:

aws credentials retrieved from System.getenv(String)

See Also:

AWS_ACCESS_KEY_ID_ENV, AWS_SECRET_ACCESS_KEY_ENV,

of

public static AwsCredentials of(String accessKey,
                                String accessSecret)