Interface EventsClientConfig

The configuration interface of EventsClient class constructor that set the region, credentials and other options.

Hierarchy

Properties

apiKey? bearerToken? defaultsMode? disableHostPrefix? logger? productPrefix? retryMode? stage? token?

Properties

Optional apiKey

apiKey?: string | Provider<string>

The API key to use when making requests.

This is optional because some operations may not require an API key.

Optional bearerToken

bearerToken?: string | Provider<string>

Deprecated

token property should be used, instead. This will be removed on our next major release.

Optional defaultsMode

defaultsMode?: DefaultsMode | Provider<DefaultsMode>

The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.

Optional disableHostPrefix

disableHostPrefix?: boolean

Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

Optional logger

logger?: Logger

Optional logger for logging debug/info/warn/error.

Optional productPrefix

productPrefix?: string

Optional retryMode

retryMode?: string | Provider<string>

Specifies which retry algorithm to use.

Optional stage

stage?: string | Provider<string>

Optional token

token?: TokenIdentity | TokenIdentityProvider

The Bearer token to use when making requests.

This is optional because some operations may not require a Bearer token.

Settings

Member Visibility

Theme