Package software.amazon.awssdk.profiles

Enum ProfileFileSystemSetting

java.lang.Object

java.lang.Enum<ProfileFileSystemSetting>

software.amazon.awssdk.profiles.ProfileFileSystemSetting

All Implemented Interfaces:

Serializable, Comparable<ProfileFileSystemSetting>, SystemSetting

public enum ProfileFileSystemSetting
extends Enum<ProfileFileSystemSetting>
implements SystemSetting

System settings for loading configuration from profile files.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AWS_CONFIG_FILE	Configure the default configuration file used in the ProfileFile.
AWS_PROFILE	Configure the default profile that should be loaded from the AWS_CONFIG_FILE
AWS_SHARED_CREDENTIALS_FILE	Configure the default credentials file used in the ProfileFile.

Method Summary

Modifier and Type	Method	Description
String	defaultValue()	The default value of the setting (or empty if there is no default).
String	environmentVariable()	The environment variable of the setting (or null if there is no environment variable for this setting).
String	property()	The system property of the setting (or null if there is no property for this setting).
static ProfileFileSystemSetting	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ProfileFileSystemSetting[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.SystemSetting

getBooleanValue, getBooleanValueOrThrow, getIntegerValue, getIntegerValueOrThrow, getNonDefaultStringValue, getStringValue, getStringValueOrThrow

Enum Constant Details

AWS_CONFIG_FILE

public static final ProfileFileSystemSetting AWS_CONFIG_FILE

Configure the default configuration file used in the ProfileFile. When not explicitly overridden in a client (eg. by specifying the region or credentials provider), this will be the location used when an AWS client is created. See http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html for more information on configuring the SDK via a configuration file.

AWS_SHARED_CREDENTIALS_FILE

public static final ProfileFileSystemSetting AWS_SHARED_CREDENTIALS_FILE

Configure the default credentials file used in the ProfileFile. When not explicitly overridden in a client (eg. by specifying the region or credentials provider), this will be the location used when an AWS client is created. See http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html for more information on configuring the SDK via a credentials file.

AWS_PROFILE

public static final ProfileFileSystemSetting AWS_PROFILE

Configure the default profile that should be loaded from the AWS_CONFIG_FILE

See Also:

• AWS_CONFIG_FILE

Method Details

values

public static ProfileFileSystemSetting[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ProfileFileSystemSetting valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

property

public String property()

Description copied from interface: SystemSetting

The system property of the setting (or null if there is no property for this setting).

Specified by:

property in interface SystemSetting

environmentVariable

public String environmentVariable()

Description copied from interface: SystemSetting

The environment variable of the setting (or null if there is no environment variable for this setting).

Specified by:

environmentVariable in interface SystemSetting

defaultValue

public String defaultValue()

Description copied from interface: SystemSetting

The default value of the setting (or empty if there is no default). This value will be applied if the customer did not specify a setting.

Specified by:

defaultValue in interface SystemSetting