Skip to main content

IAWSEnvironment

Interface in AWS.Core

Interface to configuration supplied by the environment.

Properties​

AccessKeyId​

property AccessKeyId: string

Access Key Id.

Provided by AWS_ACCESS_KEY_ID.

ConfigFile​

property ConfigFile: string

Path to config file.

Provided by AWS_CONFIG_FILE.

ConfigDirectory​

property ConfigDirectory: string

Path to config directory.

On Windows the configuration directory will be based on \%UserProfile\%. On Linux or macOS (UNIX-based systems) the path will based on $PATH.

ContainerCredentialsRelativeUri​

property ContainerCredentialsRelativeUri: string

Container credentials relative URI.

Provided by AWS_CONTAINER_CREDENTIALS_RELATIVE_URI.

DefaultRegion​

property DefaultRegion: string

Default region.

Provided by AWS_DEFAULT_REGION.

EndpointUrl​

property EndpointUrl: string

The service endpoint URL.

Provided by AWS_ENDPOINT_URL.

IgnoreConfiguredEndpointUrls​

property IgnoreConfiguredEndpointUrls: TOptional<Boolean>

( Specifies whether shared configuration values for </code>(endpoint_url<code> should be read/used. Provided by AWS_IGNORE_CONFIGURED_ENDPOINT_URLS.

MaxAttempts​

property MaxAttempts: TOptional<Integer>

Max attempts.

Provided by AWS_MAX_ATTEMPTS.

Profile​

property Profile: string

Profile name.

Provided by AWS_PROFILE.

Region​

property Region: string

The specified region.

Provided by AWS_REGION.

RetryMode​

property RetryMode: string

Retry mode.

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

SecretAccessKey​

property SecretAccessKey: string

Secret Access Key.

Provided by AWS_SECRET_ACCESS_KEY.

SessionToken​

property SessionToken: string

Session Token.

Provided by AWS_SESSION_TOKEN.

UseDualstackEndpoint​

property UseDualstackEndpoint: TOptional<Boolean>

Specifies whether the IPv4/IPv6 dualstack endpoints should be used.

Provided by ``(AWS_USE_DUALSTACK_ENDPOINT<.c>.

SharedCredentialsFile​

property SharedCredentialsFile: string

Path to shared credentials file.

Provided by AWS_SHARED_CREDENTIALS_FILE.

Methods​

EndpointUrlFor​

function EndpointUrlFor(const AServiceIdentifier: string): string;

Get the service-specific endpoint-url.

Parameters

NameDescription
AServiceIdentifierSpecify the identifier for the service.

Returns

Returns the value specified by.