IAWSOptions

Interface in AWS.Core

Base interface to common options for all AWS service classes.

Properties

AccessKeyId

property AccessKeyId: string

Static credentials AccessKeyId.

ConfigEnabled

property ConfigEnabled: Boolean

Boolean value indicating if shared configuration file is enabled.

ConfigFile

property ConfigFile: string

Path to current configuration file.

Credentials

property Credentials: IAWSCredentialsProvider

Static credentials provider.

Optionally specify static credentials via a provider instance. Setting Credentials takes precedence over the static credential attributes AccessKeyId, SecretAccessKey, and SessionToken.

Endpoint

property Endpoint: IAWSEndpoint

Type: IAWSEndpoint

Optionally, direct all requests to a specific endpoint.

Endpoint and EndpointUrl are mutually exclusive. Set only one. Endpoint takes priority over EndpointUrl.

EndpointProvider

property EndpointProvider: IAWSEndpointProvider

Type: IAWSEndpointProvider

Optionally, provide a custom endpoint provider for the client.

Endpoint providers generate context-specific endpoints on demand.

EndpointProviderRegistry

property EndpointProviderRegistry: TDictionary<string, IAWSEndpointProvider>

Type: IAWSEndpointProvider

A registry of endpoint providers for the client.

EndpointRegistry

property EndpointRegistry: TDictionary<string, IAWSEndpoint>

Type: IAWSEndpoint

A registry of service endpoints.

EndpointUrl

property EndpointUrl: string

Optionally, direct all requests to a specific endpoint URL.

Endpoint and EndpointUrl are mutually exclusive. Set only one. Endpoint takes priority over EndpointUrl.

Environment

property Environment: IAWSEnvironment

Type: IAWSEnvironment

Environment used for configuration.

Can be used specify custom environment values for configuration.

HttpOpenTimeout

property HttpOpenTimeout: Integer

HTTP open timeout value in millseconds.

HttpReadTimeout

property HttpReadTimeout: Integer

HTTP read timeout value in milliseconds.

IgnoreConfiguredEndpointUrls

property IgnoreConfiguredEndpointUrls: Boolean

Specifies whether to ignore custom endpoint configurations.

Custom endpoint configurations specified in code will not be affected by this.

MaxAttempts

property MaxAttempts: Integer

Maximum number of attempts a client will make.

Profile

property Profile: string

Current profile name.

HasRegion

property HasRegion: Boolean

Boolean value indicating if the region has been explicitly set.

Region

property Region: string

Current configured region.

RetryBaseDelay

property RetryBaseDelay: Integer

Base delay value between retries.

Only used for legacy RetryMode. Value specified in milliseconds.

RetryJitter

property RetryJitter: string

Retry jitter mode.

Only used for legacy RetryMode. Valid values are: none, equal, full. Default value is none.

RetryLimit

property RetryLimit: Integer

Maximum number of retries a client will attempt.

Only used for legacy RetryMode.

RetryMaxDelay

property RetryMaxDelay: Integer

Value used to cap the delay between retries.

Only used for legacy RetryMode. Value is specified in milliseconds.

RetryMode

property RetryMode: string

Retry mode.

Valid values are legacy, standard, or adaptive. Currently, legacy is the only supported mode.

SecretAccessKey

property SecretAccessKey: string

Static credentials SecretAccessKey.

SessionToken

property SessionToken: string

Static credentials SessionToken.

UseDualstackEndpoint

property UseDualstackEndpoint: Boolean

Specify whether clients should use the IPv4/IPv6 dualstack endpoints.

SharedCredentialsFile

property SharedCredentialsFile: string

Path to current shared credentials file.

SharedConfig

property SharedConfig: IAWSSharedConfig

Type: IAWSSharedConfig

Current loaded shared configuration.

Values

property Values: TDictionary<string, TValue>

Dictionary of stored values.

Returns only values configured. Any values loaded from shared configuration or environment are not present in this dictionary.

Methods

Merge

procedure Merge(const AOtherOptions: IAWSOptions);

IAWSOptions

Merges other options into this options.

Parameters

Name	Description
AOtherOptions	Other instance of IAWSOptions.

GetBoolean

function GetBoolean(const AKey: string; const ADefault: Boolean = True; const ANamespace: string = 'AWS'): Boolean;

Resolves a Boolean value.

Parameters

Name	Description
AKey	Key name to resolve.
ADefault	A default value to use if the value is not present.
ANamespace	Specifies the namespace to fetch value from. Defaults to.

Returns

Boolean value.

GetInteger

function GetInteger(const AKey: string; const ADefault: Integer = 0; const ANamespace: string = 'AWS'): Integer;

Resolves an Integer value.

Parameters

Name	Description
AKey	Key name to resolve.
ADefault	A default value to use if the value is not present.
ANamespace	Specifies the namespace to fetch value from. Defaults to.

Returns

Integer value.

GetString

function GetString(const AKey: string; const ADefault: string = ''; const ANamespace: string = 'AWS'): string;

Resolves a String value.

Parameters

Name	Description
AKey	Key name to resolve.
ADefault	A default value to use if the value is not present.
ANamespace	Specifies the namespace to fetch value from. Defaults to.

Returns

String value.

SetValueForKey

procedure SetValueForKey(const AValue: TValue; AKey: string; const ANamespace: string = 'AWS');

Sets a value for key.

Parameters

Name	Description
AValue	A value to store.
AKey	A key to store the value under.
ANamespace	A namespace to store the value in. Defaults to.