AwsSdkSetting

Settings to configure SDK runtime behavior

Properties

Link copied to clipboard
val AwsAccessKeyId: <Error class: unknown class><String>

Configure the AWS access key ID.

Link copied to clipboard
val AwsAccountId: <Error class: unknown class><String>

Configure the AWS account ID

Link copied to clipboard
val AwsAccountIdEndpointMode: <Error class: unknown class><AccountIdEndpointMode>

The mode to use when resolving endpoints that make use of the AWS account ID.

Link copied to clipboard
val AwsAppId: <Error class: unknown class><String>

Configure the user agent app ID

Link copied to clipboard
val AwsAuthSchemePreference: <Error class: unknown class><String>

Configures an ordered preference of auth schemes

Link copied to clipboard
val AwsConfigFile: <Error class: unknown class><String>

Configure the default path to the shared config file.

Link copied to clipboard
val AwsContainerAuthorizationToken: <Error class: unknown class><String>

An authorization token to pass to a container metadata service.

Link copied to clipboard
val AwsContainerAuthorizationTokenFile: <Error class: unknown class><String>

A path to a file which contains an authorization token to pass to a container metadata service.

Link copied to clipboard
val AwsContainerCredentialsFullUri: <Error class: unknown class><String>

The full URI path to a localhost metadata service to be used. This is ignored if AwsContainerCredentialsRelativeUri is set.

Link copied to clipboard
val AwsContainerCredentialsRelativeUri: <Error class: unknown class><String>

The elastic container metadata service path that should be called by the aws.sdk.kotlin.runtime.auth.credentials.EcsCredentialsProvider when loading credentials from the container metadata service.

Link copied to clipboard
val AwsDisableRequestCompression: <Error class: unknown class><Boolean>

Determines if a request should be compressed or not

Link copied to clipboard
val AwsEc2MetadataDisabled: <Error class: unknown class><Boolean>

Whether to load information such as credentials, regions from EC2 Metadata instance service.

Link copied to clipboard
val AwsEc2MetadataServiceEndpoint: <Error class: unknown class><String>

The EC2 instance metadata service endpoint.

Link copied to clipboard
val AwsEc2MetadataServiceEndpointMode: <Error class: unknown class><String>

The endpoint mode to use when connecting to the EC2 metadata service endpoint

Link copied to clipboard
val AwsEndpointDiscoveryEnabled: <Error class: unknown class><Boolean>

A flag indicating whether endpoint discovery is enabled for AWS services that support it. The implicit default value for this setting is:

Link copied to clipboard
val AwsEndpointUrl: <Error class: unknown class><<Error class: unknown class>>

The globally-configured endpoint URL that applies to all services.

Link copied to clipboard
val AwsExecutionEnv: <Error class: unknown class><String>

The execution environment of the SDK user. This is automatically set in certain environments by the underlying AWS service. For example, AWS Lambda will automatically specify a runtime indicating that the SDK is being used within Lambda.

Link copied to clipboard
val AwsIgnoreEndpointUrls: <Error class: unknown class><Boolean>

Whether to ignore configured endpoint URLs.

Link copied to clipboard
val AwsMaxAttempts: <Error class: unknown class><Int>

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
val AwsProfile: <Error class: unknown class><String>

The name of the default profile that should be loaded from config

Link copied to clipboard
val AwsRegion: <Error class: unknown class><String>

Configure the default region.

Link copied to clipboard
val AwsRequestChecksumCalculation: <Error class: unknown class><<Error class: unknown class>>

Configures request checksum calculation

Link copied to clipboard
val AwsRequestMinCompressionSizeBytes: <Error class: unknown class><Long>

The threshold used to determine if a request should be compressed. Is only checked if request compression is enabled

Link copied to clipboard
val AwsResponseChecksumValidation: <Error class: unknown class><<Error class: unknown class>>

Configures response checksum validation

Link copied to clipboard
val AwsRetryMode: <Error class: unknown class><<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
val AwsRoleArn: <Error class: unknown class><String>

The ARN of a role to assume

Link copied to clipboard
val AwsRoleSessionName: <Error class: unknown class><String>

The session name to use for assumed roles

Link copied to clipboard
val AwsSecretAccessKey: <Error class: unknown class><String>

Configure the AWS secret access key.

Link copied to clipboard
val AwsSessionToken: <Error class: unknown class><String>

Configure the AWS session token.

Link copied to clipboard
val AwsSharedCredentialsFile: <Error class: unknown class><String>

Configure the default path to the shared credentials profile file.

Link copied to clipboard
val AwsSigV4aSigningRegionSet: <Error class: unknown class><String>

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

Link copied to clipboard
val AwsUseDualStackEndpoint: <Error class: unknown class><Boolean>

Whether to use dual-stack endpoints when making requests.

Link copied to clipboard
val AwsUseFipsEndpoint: <Error class: unknown class><Boolean>

Whether to use FIPS endpoints when making requests.

Link copied to clipboard
val AwsWebIdentityTokenFile: <Error class: unknown class><String>

The AWS web identity token file path

Inherited functions

Link copied to clipboard
fun AwsSdkSetting.resolveEndpointUrl(provider: <Error class: unknown class>, sysPropSuffix: String, envSuffix: String): <Error class: unknown class>?

Resolves an endpoint url for a given service.