Package software.amazon.awscdk.services.bedrockagentcore

Interface IApiKeyCredentialProvider

All Superinterfaces:

IApiKeyCredentialProviderRef, software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IGrantable, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IApiKeyCredentialProvider.Jsii$Default

All Known Implementing Classes:

ApiKeyCredentialProvider, IApiKeyCredentialProvider.Jsii$Proxy

@Generated(value="jsii-pacmak/1.129.0 (build eaca441)",
           date="2026-05-19T08:18:44.419Z")
@Stability(Stable)
public interface IApiKeyCredentialProvider
extends software.amazon.jsii.JsiiSerializable, IResource, IGrantable, IApiKeyCredentialProviderRef

An API key credential provider registered in AgentCore Token Vault.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IApiKeyCredentialProvider.Jsii$Default	Internal default implementation for IApiKeyCredentialProvider.
static final class	IApiKeyCredentialProvider.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
GatewayApiKeyIdentityBinding	bindForGatewayApiKeyTarget()	ARNs for use with gateway targets (GatewayCredentialProvider.fromApiKeyIdentity or fromApiKeyIdentityArn).
default String	getApiKeySecretArn()	The ARN of the Secrets Manager secret that stores the API key after the resource is created.
default String	getCreatedTime()	Timestamp when the credential provider was created.
String	getCredentialProviderArn()	The ARN of this credential provider.
default String	getLastUpdatedTime()	Timestamp when the credential provider was last updated.
Grant	grant(IGrantable grantee, String... actions)	Grants IAM actions to the IAM principal.
Grant	grantAdmin(IGrantable grantee)	Grant control plane permissions to manage this provider.
Grant	grantFullAccess(IGrantable grantee)	Grant read, admin, and credential retrieval permissions.
Grant	grantRead(IGrantable grantee)	Grant GetApiKeyCredentialProvider and ListApiKeyCredentialProviders, scoped to this provider and parent resources required by the Bedrock AgentCore authorization model.
Grant	grantUse(IGrantable grantee)	Grant permission to retrieve API key material for outbound calls (GetResourceApiKey).

Methods inherited from interface software.amazon.awscdk.interfaces.bedrockagentcore.IApiKeyCredentialProviderRef

getApiKeyCredentialProviderRef

Methods inherited from interface software.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.services.iam.IGrantable

getGrantPrincipal

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCredentialProviderArn

@Stability(Stable)
@NotNull
String getCredentialProviderArn()

The ARN of this credential provider.

getApiKeySecretArn

@Stability(Stable)
@Nullable
default String getApiKeySecretArn()

The ARN of the Secrets Manager secret that stores the API key after the resource is created.

May be undefined for resources imported without this attribute.

getCreatedTime

@Stability(Stable)
@Nullable
default String getCreatedTime()

Timestamp when the credential provider was created.

getLastUpdatedTime

@Stability(Stable)
@Nullable
default String getLastUpdatedTime()

Timestamp when the credential provider was last updated.

bindForGatewayApiKeyTarget

@Stability(Stable)
@NotNull
GatewayApiKeyIdentityBinding bindForGatewayApiKeyTarget()

ARNs for use with gateway targets (GatewayCredentialProvider.fromApiKeyIdentity or fromApiKeyIdentityArn).

grant

@Stability(Stable)
@NotNull
Grant grant(@NotNull
 IGrantable grantee,
 @NotNull
 String... actions)

Grants IAM actions to the IAM principal.

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantAdmin

@Stability(Stable)
@NotNull
Grant grantAdmin(@NotNull
 IGrantable grantee)

Grant control plane permissions to manage this provider.

Parameters:

grantee - This parameter is required.

grantFullAccess

@Stability(Stable)
@NotNull
Grant grantFullAccess(@NotNull
 IGrantable grantee)

Grant read, admin, and credential retrieval permissions.

Parameters:

grantee - This parameter is required.

grantRead

@Stability(Stable)
@NotNull
Grant grantRead(@NotNull
 IGrantable grantee)

Grant GetApiKeyCredentialProvider and ListApiKeyCredentialProviders, scoped to this provider and parent resources required by the Bedrock AgentCore authorization model.

Parameters:

grantee - This parameter is required.

grantUse

@Stability(Stable)
@NotNull
Grant grantUse(@NotNull
 IGrantable grantee)

Grant permission to retrieve API key material for outbound calls (GetResourceApiKey).

Parameters:

grantee - This parameter is required.