Skip to main content

IAWSSharedConfig

Interface in AWS.Core

Interface to shared configuration.

Ancestors​

  • IAWSCredentialsProvider

Properties​

ConfigEnabled​

property ConfigEnabled: Boolean

Boolean indicating if shared configuration is enabled.

ConfigFilePath​

property ConfigFilePath: string

Current path to configuration file.

CredentialProcess​

property CredentialProcess: string

Specifies an external command that generates or retrieves authentication credentials for use.

CredentialsFilePath​

property CredentialsFilePath: string

Current path to shared credentials file.

IgnoreConfiguredEndpointUrls​

property IgnoreConfiguredEndpointUrls: TOptional<Boolean>

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

MaxAttempts​

property MaxAttempts: TOptional<Integer>

Max Attempts for current profile.

ProfileName​

property ProfileName: string

Current profile name.

Profiles​

property Profiles: TList<string>

List of configured profile names.

Region​

property Region: string

Region for current profile.

RetryMode​

property RetryMode: string

Retry Mode for current profile.

SSOAccountId​

property SSOAccountId: string

The numeric ID of the AWS account that was addded through the AWS Organisations service to use authentication.

SSORegion​

property SSORegion: string

The AWS region that contains your IAM Identity Center portal host.

This is independent from your default AWS Region and can be different.

SSORegistrationScopes​

property SSORegistrationScopes: string

A comma-delimited list of valid scope strings to be authorized for the SSO Session.

SSORoleName​

property SSORoleName: string

The name of an SSO role defining the user's permissions.

SSOSession​

property SSOSession: string

The name of an SSO Session.

SSOStartUrl​

property SSOStartUrl: string

The URL of your organization's IAM Identity Center issuer URL or access portal URL.

UseDualstackEndpoint​

property UseDualstackEndpoint: TOptional<Boolean>

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

Methods​

GetCredentials​

function GetCredentials(const AProfileName: string): IAWSCredentialsProvider; overload;

Fetches credentials for the given profile name.

Parameters

NameDescription
AProfileNameProfile name to fetch credentials for.

Returns

Credentials provider instance for profile credentials.

GetEndpointUrl​

function GetEndpointUrl(const AServiceIdentifier: string): string;

Fetch the resolved custom endpoint URL for a given service.

Parameters

NameDescription
AServiceIdentifierSpecify the service identifier to fetch configured custom Specify the identifier of the service to resolve custom endpoint URLs for.

Returns

Returns the configured custom endpoint URL for the specified service.

GetValue​

function GetValue(const AName: string; AProfileName: string = ''): string;

Fetches a value for the given profile.

Parameters

NameDescription
ANameName of the value to return.
AProfileNameProfile name to fetch value from.

Returns

String value for the value specified.