aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
31 lines (30 loc) • 1.57 kB
TypeScript
/******************************************************************************
* IAM Role
*****************************************************************************/
import type { ICredentialProviderConfig } from './credential-provider';
import { CredentialProviderType } from './credential-provider';
import type { Grant } from '../../../../aws-iam';
import type { IGateway } from '../gateway-base';
/**
* Gateway IAM Role credential provider configuration implementation
* Can be used with Lambda and Smithy targets
* @internal
*/
export declare class GatewayIamRoleCredentialProviderConfig implements ICredentialProviderConfig {
readonly credentialProviderType = CredentialProviderType.GATEWAY_IAM_ROLE;
constructor();
/**
* @internal
*/
_render(): any;
/**
* No-op for IAM role authentication - no additional permissions are required.
* When using IAM role authentication for outbound calls, the gateway uses its own execution
* role to authenticate with the target endpoint. Unlike API Key and OAuth credential providers
* which require permissions to access external credential stores (Secrets Manager, Token Vault),
* IAM role authentication leverages AWS IAM's native authentication without additional resources.
* @param _gateway The gateway (unused - no credential provider permissions needed)
* @returns undefined - no additional credential provider permissions to grant
*/
grantNeededPermissionsToRole(_gateway: IGateway): Grant | undefined;
}