feat: configuration options for sigv4aSigningRegionSet (#1235)

Author: 0marperez

.changes/2654f439-0c1a-470f-951b-740d13f51bd6.json

@@ -0,0 +1,5 @@
+{
+    "id": "2654f439-0c1a-470f-951b-740d13f51bd6",
+    "type": "feature",
+    "description": "Added the `sigV4aSigningRegionSet` configuration option"
+}

aws-runtime/aws-config/api/aws-config.api

@@ -251,6 +251,7 @@ public final class aws/sdk/kotlin/runtime/config/AwsSdkSetting {
 	public final fun getAwsSecretAccessKey ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting;
 	public final fun getAwsSessionToken ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting;
 	public final fun getAwsSharedCredentialsFile ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting;
+	public final fun getAwsSigV4aSigningRegionSet ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting;
 	public final fun getAwsUseDualStackEndpoint ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting;
 	public final fun getAwsUseFipsEndpoint ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting;
 	public final fun getAwsWebIdentityTokenFile ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting;
@@ -472,6 +473,7 @@ public final class aws/sdk/kotlin/runtime/config/profile/AwsProfileKt {
 	public static final fun getRoleArn (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/String;
 	public static final fun getSdkUserAgentAppId (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/String;
 	public static final fun getServicesSection (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/String;
+	public static final fun getSigV4aSigningRegionSet (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/String;
 	public static final fun getSourceProfile (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/String;
 	public static final fun getUseDualStack (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/Boolean;
 	public static final fun getUseFips (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/Boolean;
@@ -563,5 +565,7 @@ public class aws/sdk/kotlin/runtime/region/RegionProviderChain : aws/sdk/kotlin/
 public final class aws/sdk/kotlin/runtime/region/ResolveRegionKt {
 	public static final fun resolveRegion (Laws/smithy/kotlin/runtime/util/PlatformProvider;Laws/smithy/kotlin/runtime/util/LazyAsyncValue;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public static synthetic fun resolveRegion$default (Laws/smithy/kotlin/runtime/util/PlatformProvider;Laws/smithy/kotlin/runtime/util/LazyAsyncValue;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
+	public static final fun resolveSigV4aSigningRegionSet (Laws/smithy/kotlin/runtime/util/PlatformProvider;Laws/smithy/kotlin/runtime/util/LazyAsyncValue;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public static synthetic fun resolveSigV4aSigningRegionSet$default (Laws/smithy/kotlin/runtime/util/PlatformProvider;Laws/smithy/kotlin/runtime/util/LazyAsyncValue;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
 }
 

aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/AbstractAwsSdkClientFactory.kt

@@ -16,7 +16,9 @@ import aws.sdk.kotlin.runtime.config.profile.loadAwsSharedConfig
 import aws.sdk.kotlin.runtime.config.retries.resolveRetryStrategy
 import aws.sdk.kotlin.runtime.config.useragent.resolveUserAgentAppId
 import aws.sdk.kotlin.runtime.region.resolveRegion
+import aws.sdk.kotlin.runtime.region.resolveSigV4aSigningRegionSet
 import aws.smithy.kotlin.runtime.ExperimentalApi
+import aws.smithy.kotlin.runtime.auth.awscredentials.SigV4aClientConfig
 import aws.smithy.kotlin.runtime.client.RetryStrategyClientConfig
 import aws.smithy.kotlin.runtime.client.SdkClient
 import aws.smithy.kotlin.runtime.client.SdkClientConfig
@@ -90,6 +92,11 @@ public abstract class AbstractAwsSdkClientFactory<
                         ?: resolveRequestMinCompressionSizeBytes(platform, profile)
             }
 
+            if (config is SigV4aClientConfig.Builder) {
+                config.sigV4aSigningRegionSet =
+                    config.sigV4aSigningRegionSet ?: resolveSigV4aSigningRegionSet(platform, profile)
+            }
+
             finalizeConfig(builder, sharedConfig, profile)
         }
         return builder.build()

aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/AwsSdkSetting.kt

@@ -202,6 +202,12 @@ public object AwsSdkSetting {
      */
     public val AwsRequestMinCompressionSizeBytes: EnvironmentSetting<Long> =
         longEnvSetting("aws.requestMinCompressionSizeBytes", "AWS_REQUEST_MIN_COMPRESSION_SIZE_BYTES")
+
+    /**
+     * The set of regions to use when signing a request with sigV4a.
+     */
+    public val AwsSigV4aSigningRegionSet: EnvironmentSetting<String> =
+        strEnvSetting("aws.sigV4aSigningRegionSet", "AWS_SIGV4A_SIGNING_REGION_SET")
 }
 
 /**

aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/profile/AwsProfile.kt

@@ -160,6 +160,13 @@ public val AwsProfile.disableRequestCompression: Boolean?
 public val AwsProfile.requestMinCompressionSizeBytes: Long?
     get() = getLongOrNull("request_min_compression_size_bytes")
 
+/**
+ * The set of regions to use when signing a request with sigV4a.
+ */
+@InternalSdkApi
+public val AwsProfile.sigV4aSigningRegionSet: String?
+    get() = getOrNull("sigv4a_signing_region_set")
+
 /**
  * Parse a config value as a boolean, ignoring case.
  */

aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/region/ResolveRegion.kt

@@ -6,8 +6,11 @@
 package aws.sdk.kotlin.runtime.region
 
 import aws.sdk.kotlin.runtime.InternalSdkApi
+import aws.sdk.kotlin.runtime.config.AwsSdkSetting
 import aws.sdk.kotlin.runtime.config.profile.AwsProfile
 import aws.sdk.kotlin.runtime.config.profile.loadAwsSharedConfig
+import aws.sdk.kotlin.runtime.config.profile.sigV4aSigningRegionSet
+import aws.smithy.kotlin.runtime.config.resolve
 import aws.smithy.kotlin.runtime.io.use
 import aws.smithy.kotlin.runtime.util.LazyAsyncValue
 import aws.smithy.kotlin.runtime.util.PlatformProvider
@@ -21,3 +24,17 @@ public suspend fun resolveRegion(
     platformProvider: PlatformProvider = PlatformProvider.System,
     profile: LazyAsyncValue<AwsProfile> = asyncLazy { loadAwsSharedConfig(platformProvider).activeProfile },
 ): String? = DefaultRegionProviderChain(platformProvider, profile = profile).use { it.getRegion() }
+
+/**
+ * Attempts to resolve sigV4aSigningRegionSet from the JVM system properties, environment variables, and file based configuration
+ * @return The sigV4aSigningRegionSet if found, null if not
+ */
+@InternalSdkApi
+public suspend fun resolveSigV4aSigningRegionSet(platform: PlatformProvider = PlatformProvider.System, profile: LazyAsyncValue<AwsProfile>): Set<String>? {
+    val rawString = AwsSdkSetting.AwsSigV4aSigningRegionSet.resolve(platform) ?: profile.get().sigV4aSigningRegionSet
+    return rawString
+        ?.split(",")
+        ?.map { it.trim() }
+        ?.filter { it.isNotEmpty() }
+        ?.toSet()
+}

gradle/libs.versions.toml

@@ -9,8 +9,8 @@ coroutines-version = "1.7.3"
 atomicfu-version = "0.23.1"
 
 # smithy-kotlin codegen and runtime are versioned separately
-smithy-kotlin-runtime-version = "1.0.17"
-smithy-kotlin-codegen-version = "0.30.18"
+smithy-kotlin-runtime-version = "1.0.18"
+smithy-kotlin-codegen-version = "0.30.19"
 
 # codegen
 smithy-version = "1.42.0"