@aws-cdk/aws-bedrock-agentcore-alpha.IApiKeyCredentialProvider

Experimental

@aws-cdk/aws-bedrock-agentcore-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

IApiKeyCredentialProvider Interface

An API key credential provider registered in AgentCore Token Vault.

IApiKeyCredentialProvider

extends

• IResource,
• IGrantable,
• IApiKeyCredentialProviderRef

implemented by

• ApiKeyCredentialProvider

Source

lib/identity/api-key-credential-provider.ts

Properties

apiKeyCredentialProviderRefApiKeyCredentialProviderReferenceapi_key_credential_provider_refApiKeyCredentialProviderReferenceapiKeyCredentialProviderRefApiKeyCredentialProviderReferenceApiKeyCredentialProviderRefApiKeyCredentialProviderReferenceApiKeyCredentialProviderRefApiKeyCredentialProviderReference#

A reference to a ApiKeyCredentialProvider resource.

apiKeySecretArn?may be undefinedstringapi_key_secret_arn?may be undefinedstrapiKeySecretArn?may be undefinedStringApiKeySecretArn?may be undefinedstringApiKeySecretArn?may be undefined*string#

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.

createdTime?may be undefinedstringcreated_time?may be undefinedstrcreatedTime?may be undefinedStringCreatedTime?may be undefinedstringCreatedTime?may be undefined*string#

Timestamp when the credential provider was created.

credentialProviderArnstringcredential_provider_arnstrcredentialProviderArnStringCredentialProviderArnstringCredentialProviderArn*string#

The ARN of this credential provider.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

The environment this resource belongs to.

notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

grantPrincipalIPrincipalgrant_principalIPrincipalgrantPrincipalIPrincipalGrantPrincipalIPrincipalGrantPrincipalIPrincipal#

The principal to grant permissions to.

lastUpdatedTime?may be undefinedstringlast_updated_time?may be undefinedstrlastUpdatedTime?may be undefinedStringLastUpdatedTime?may be undefinedstringLastUpdatedTime?may be undefined*string#

Timestamp when the credential provider was last updated.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

stackStackstackStackstackStackStackStackStackStack#

The stack in which this resource is defined.

Methods

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

bindForGatewayApiKeyTarget(): GatewayApiKeyIdentityBindingdef bind_for_gateway_api_key_target(self, ) -> GatewayApiKeyIdentityBindingpublic GatewayApiKeyIdentityBinding bindForGatewayApiKeyTarget()public GatewayApiKeyIdentityBinding BindForGatewayApiKeyTarget()func BindForGatewayApiKeyTarget() GatewayApiKeyIdentityBinding#

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

grant(grantee: IGrantable, ...actions: string[]): Grantdef grant(self, grantee: IGrantable, actions: str) -> Grantpublic Grant grant(IGrantable grantee, String actions)public Grant Grant(IGrantable grantee, string actions)func Grant(Grantee IGrantable, Actions *string) Grant#

Grants IAM actions to the IAM principal.

grantAdmin(grantee: IGrantable): Grantdef grant_admin(self, grantee: IGrantable) -> Grantpublic Grant grantAdmin(IGrantable grantee)public Grant GrantAdmin(IGrantable grantee)func GrantAdmin(Grantee IGrantable) Grant#

Grant control plane permissions to manage this provider.

grantFullAccess(grantee: IGrantable): Grantdef grant_full_access(self, grantee: IGrantable) -> Grantpublic Grant grantFullAccess(IGrantable grantee)public Grant GrantFullAccess(IGrantable grantee)func GrantFullAccess(Grantee IGrantable) Grant#

Grant read, admin, and credential retrieval permissions.

grantRead(grantee: IGrantable): Grantdef grant_read(self, grantee: IGrantable) -> Grantpublic Grant grantRead(IGrantable grantee)public Grant GrantRead(IGrantable grantee)func GrantRead(Grantee IGrantable) Grant#

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

grantUse(grantee: IGrantable): Grantdef grant_use(self, grantee: IGrantable) -> Grantpublic Grant grantUse(IGrantable grantee)public Grant GrantUse(IGrantable grantee)func GrantUse(Grantee IGrantable) Grant#

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

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

1 parameter · returns

Parameters

• mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining