Package-level declarations

Types

Link copied to clipboard
data class Arn(val partition: String, val service: String, val region: String, val accountId: String, val resourceId: List<String>)

Represents a parsed form of an ARN (Amazon Resource Name).

Link copied to clipboard
data class Partition(val id: String, val regions: Map<String, PartitionConfig>, val regionRegex: <Error class: unknown class>, val baseConfig: PartitionConfig)

A partition defines a broader set of AWS regions.

Link copied to clipboard
data class PartitionConfig(val name: String? = null, val dnsSuffix: String? = null, val dualStackDnsSuffix: String? = null, val supportsFIPS: Boolean? = null, val supportsDualStack: Boolean? = null, val implicitGlobalRegion: String? = null)

The core configuration details for a partition. This is the structure that endpoint providers interface receive as the result of a partition call.

Functions

Link copied to clipboard
fun isVirtualHostableS3Bucket(value: String?, allowSubdomains: Boolean): Boolean

Evaluates whether a string is a DNS-compatible bucket name that can be used with virtual hosted-style addressing.

Link copied to clipboard
fun parseArn(value: String?): Arn?

Splits an ARN into its component parts.

Link copied to clipboard
fun partition(partitions: List<Partition>, region: String?): PartitionConfig?

Identifies the partition for the given AWS region.