Package-level declarations

Types

Link copied to clipboard
class AwsConfigParseException(message: String, lineNumber: Int)

Base exception for AWS config file parser errors.

Link copied to clipboard
data class AwsConfigurationSource(val profile: String, val configPath: String, val credentialsPath: String)

Specifies the active profile and configured (may not actually exist) locations of configuration files.

Link copied to clipboard
sealed class AwsConfigValue

Container for the different types of property values within an AWS config profile. A property can either be a string or mapping of strings. Maps cannot be nested.

Link copied to clipboard

Represents an AWS config profile.

Link copied to clipboard

Represents shared configuration (profiles, SSO sessions, credentials, etc)

Link copied to clipboard
data class ConfigSection
Link copied to clipboard
Link copied to clipboard

Inherited properties

Link copied to clipboard

Whether service clients should make requests to the dual-stack endpoint variant.

Link copied to clipboard

The ordered preference of AuthScheme that this client will use

Link copied to clipboard

The identifier that specifies the entity making the request for a profile

Link copied to clipboard

The credentials that authenticate the entity specified by the access key

Link copied to clipboard

A semi-temporary session token that authenticates the entity is allowed to access a specific set of resources

Link copied to clipboard

The command which the SDK will invoke to retrieve credentials

Link copied to clipboard

Determines when a request should be compressed or not

Link copied to clipboard

A flag indicating whether endpoint discovery should be enabled for a service that supports it. This setting has no effect for services which do not support endpoint discovery.

Link copied to clipboard
val AwsProfile.endpointUrl: <Error class: unknown class>?

The default endpoint URL that applies to all services.

Link copied to clipboard

Whether to ignore configured endpoint URLs.

Link copied to clipboard

The maximum number of request attempts to perform. This is one more than the number of retries, so aws.maxAttempts = 1 will have 0 retries.

Link copied to clipboard

The AWS signing and endpoint region to use for a profile

Link copied to clipboard
val AwsProfile.requestChecksumCalculation: <Error class: unknown class>?

Configures request checksum calculation

Link copied to clipboard

The threshold used to determine when a request should be compressed

Link copied to clipboard
val AwsProfile.responseChecksumValidation: <Error class: unknown class>?

Configures response checksum validation

Link copied to clipboard
val AwsProfile.retryMode: <Error class: unknown class>?

Which RetryMode to use for the default RetryPolicy, when one is not specified at the client level.

Link copied to clipboard

A role that the user must automatically assume, giving it semi-temporary access to a specific set of resources

Link copied to clipboard

The SDK user agent app ID used to identify applications.

Link copied to clipboard

The name of the services config section used by this profile.

Link copied to clipboard

The set of regions to use when signing a request with sigV4a.

Link copied to clipboard

Specifies which profile must be used to automatically assume the role specified by role_arn

Link copied to clipboard

Whether service clients should make requests to the dual-stack endpoint variant.

Link copied to clipboard

Whether service clients should make requests to the FIPS endpoint variant.

Functions

Link copied to clipboard
suspend fun loadAwsSharedConfig(platform: <Error class: unknown class>, profileNameOverride: String? = null, configurationSource: AwsConfigurationSource? = null): AwsSharedConfig

Load the shared AWS configuration specified in local configuration files.

Inherited functions

Link copied to clipboard
fun AwsProfile.getBooleanOrNull(key: String, subKey: String? = null): Boolean?

Parse a config value as a boolean, ignoring case.

Link copied to clipboard
inline fun <T : Enum<T>> AwsProfile.getEnumOrNull(key: String, subKey: String? = null): T?

Parse a config value as an enum.

Link copied to clipboard
fun AwsProfile.getIntOrNull(key: String, subKey: String? = null): Int?

Parse a config value as an int.

Link copied to clipboard
fun AwsProfile.getLongOrNull(key: String, subKey: String? = null): Long?

Parse a config value as a long.

Link copied to clipboard
fun AwsSharedConfig.resolveEndpointUrl(serviceKey: String): <Error class: unknown class>?

Get the configured endpoint URL for a specific service, falling back to the global default.