packages/functions/docs/interfaces/oidc.AwsCredentialsProviderInit.md
oidc.AwsCredentialsProviderInit
The init object for the awsCredentialsProvider function.
Omit<FromWebTokenInit, "webIdentityToken">
↳ AwsCredentialsProviderInit
• Optional clientConfig: any
Custom STS client configurations overriding the default ones.
Omit.clientConfig
nodemodules/.pnpm/@[email protected]@[email protected]/node_modules/@aws-sdk/credential-provider-web-identity/dist-types/fromWebToken.d.ts:135
• Optional clientPlugins: Pluggable<any, any>[]
Custom STS client middleware plugin to modify the client default behavior.
Omit.clientPlugins
nodemodules/.pnpm/@[email protected]@[email protected]/node_modules/@aws-sdk/credential-provider-web-identity/dist-types/fromWebToken.d.ts:139
• durationSeconds: undefined | number
The duration, in seconds, of the role session. Defaults to 3600 seconds.
Omit.durationSeconds
• Optional logger: Logger
This logger is only used to provide information on what credential providers were used during resolution.
It does not log credentials.
Omit.logger
node_modules/.pnpm/@[email protected]/node_modules/@aws-sdk/types/dist-types/credentials.d.ts:31
• Optional parentClientConfig: Object
Present if the credential provider was created by calling the defaultCredentialProvider in a client's middleware, having access to the client's config.
The region of that parent or outer client is important because an inner client used by the credential provider may need to match its default partition or region with that of the outer client.
Deprecated
▪ [key: string]: unknown
| Name | Type |
|---|---|
region? | string | Provider<string> |
Omit.parentClientConfig
node_modules/.pnpm/@[email protected]/node_modules/@aws-sdk/types/dist-types/credentials.d.ts:45
• policy: undefined | string
An IAM policy in JSON format that you want to use as an inline session policy.
Omit.policy
• policyArns: undefined | { arn?: string }[]
ARNs of the IAM managed policies that you want to use as managed session policies.
Omit.policyArns
• providerId: undefined | string
The fully qualified host component of the domain name of the identity provider.
Omit.providerId
• roleArn: string
ARN of the role that the caller is assuming.
Omit.roleArn
• Optional roleAssumerWithWebIdentity: (params: AssumeRoleWithWebIdentityParams) => Promise<AwsCredentialIdentity>
▸ (params): Promise<AwsCredentialIdentity>
A function that assumes a role with web identity and returns a promise fulfilled with credentials for the assumed role.
| Name | Type |
|---|---|
params | AssumeRoleWithWebIdentityParams |
Promise<AwsCredentialIdentity>
Omit.roleAssumerWithWebIdentity
nodemodules/.pnpm/@[email protected]@[email protected]/node_modules/@aws-sdk/credential-provider-web-identity/dist-types/fromWebToken.d.ts:130
• Optional roleSessionName: string
An identifier for the assumed role session.
Omit.roleSessionName
nodemodules/.pnpm/@[email protected]@[email protected]/node_modules/@aws-sdk/credential-provider-web-identity/dist-types/fromWebToken.d.ts:123