aws-config/aws.sdk.kotlin.runtime.region

Package-level declarations

Types

DefaultRegionProviderChain

expect class DefaultRegionProviderChain

RegionProvider that looks for region in this order:

actual class DefaultRegionProviderChain : RegionProviderChain, RegionProvider

actual class DefaultRegionProviderChain

EnvironmentRegionProvider

class EnvironmentRegionProvider(environ: <Error class: unknown class> = PlatformProvider.System)

RegionProvider that checks AWS_REGION region environment variable

ImdsRegionProvider

class ImdsRegionProvider(client: <Error class: unknown class><InstanceMetadataProvider> = lazy { ImdsClient() }, platformProvider: <Error class: unknown class> = PlatformProvider.System)

RegionProvider that uses EC2 instance metadata service (IMDS) to provider region information

JvmSystemPropRegionProvider

class JvmSystemPropRegionProvider(propertyProvider: PropertyProvider = PlatformProvider.System) : RegionProvider

RegionProvider that checks aws.region system property

ProfileRegionProvider

class ProfileRegionProvider(profile: <Error class: unknown class><AwsProfile> = asyncLazy { loadAwsSharedConfig(PlatformProvider.System).activeProfile })

RegionProvider that sources region information from the active profile

Functions

isRegionValid

fun isRegionValid(region: String): Boolean

Determines if the given region is valid for the purposes of endpoint lookup, specifically that the region is suitable to use in a URI hostname according to RFC 3986 § 3.2.2.

resolveRegion

suspend fun resolveRegion(platformProvider: <Error class: unknown class> = PlatformProvider.System, profile: <Error class: unknown class><AwsProfile> = asyncLazy { loadAwsSharedConfig(platformProvider).activeProfile }): String?

Attempt to resolve the AWS region to which requests should be made. Returns null if none was detected.

resolveSigV4aSigningRegionSet

suspend fun resolveSigV4aSigningRegionSet(platform: <Error class: unknown class> = PlatformProvider.System, profile: <Error class: unknown class><AwsProfile>): Set<String>?

Attempts to resolve sigV4aSigningRegionSet from the JVM system properties, environment variables, and file based configuration

validateRegion

fun validateRegion(region: String): String

Validates that a region is suitable to use in a URI hostname according to RFC 3986 § 3.2.2. See isRegionValid for a detailed description of the validation criteria.