Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AwsClientOptions

AWS credentials JSON interface. This is used for AWS workloads.

Hierarchy

Index

Properties

Properties

audience

audience: string

Optional client_id

client_id?: string

Optional client_secret

client_secret?: string

credential_source

credential_source: { environment_id: string; imdsv2_session_token_url?: string; region_url?: string; regional_cred_verification_url: string; url?: string }

Type declaration

  • environment_id: string
  • Optional imdsv2_session_token_url?: string
  • Optional region_url?: string
  • regional_cred_verification_url: string
  • Optional url?: string

Optional credentials

credentials?: Credentials

Optional eagerRefreshThresholdMillis

eagerRefreshThresholdMillis?: number

The expiration threshold in milliseconds before forcing token refresh of unexpired tokens.

Optional forceRefreshOnFailure

forceRefreshOnFailure?: boolean

Whether to attempt to refresh tokens on status 401/403 responses even if an attempt is made to refresh the token preemptively based on the expiry_date.

projectId

projectId: undefined | null | string

project_id

project_id: undefined | null | string

quotaProjectId

quotaProjectId: undefined | string

quota_project_id

quota_project_id: undefined | string

Optional service_account_impersonation

service_account_impersonation?: { token_lifetime_seconds?: number }

Type declaration

  • Optional token_lifetime_seconds?: number

Optional service_account_impersonation_url

service_account_impersonation_url?: string

subject_token_type

subject_token_type: string

Optional token_info_url

token_info_url?: string

token_url

token_url: string

Optional transporter

transporter?: Transporter | Gaxios

A Gaxios or Transporter instance to use for AuthClient requests.

Optional transporterOptions

transporterOptions?: GaxiosOptions

Provides default options to the transporter, such as agent or retryConfig.

type

type: string

universeDomain

universeDomain: undefined | string

universe_domain

universe_domain: undefined | string

Optional workforce_pool_user_project

workforce_pool_user_project?: string