> **Experimental**
>
> `@aws-cdk/aws-bedrock-agentcore-alpha` is an [**experimental**](/stability) (alpha) package: its API may change in any release, without a major version bump.
# ApiKeyCredentialProvider

L2 construct for `AWS::BedrockAgentCore::ApiKeyCredentialProvider`.

Use this to register an API key identity in AgentCore Token Vault. To attach the identity to a
gateway target, use {@link GatewayCredentialProvider.fromApiKeyIdentity } with this construct, or
{@link ApiKeyCredentialProvider.bindForGatewayApiKeyTarget} with {@link GatewayCredentialProvider.fromApiKeyIdentityArn }.

Extends: Construct › Resource › ApiKeyCredentialProvider
Implements: IApiKeyCredentialProvider, IResource, IGrantable, IEnvironmentAware, IApiKeyCredentialProviderRef, IConstruct, IDependable

- Stability: [Experimental](/cdk/api/stability.html)
- CloudFormation: [`AWS::BedrockAgentCore::ApiKeyCredentialProvider`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-bedrockagentcore-apikeycredentialprovider.html)
- L1 type: [`CfnApiKeyCredentialProvider`](/cdk/api/v2/docs/aws-cdk-lib.aws_bedrockagentcore.CfnApiKeyCredentialProvider.html)
- Source: [`lib/identity/api-key-credential-provider.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0-alpha.0/packages/@aws-cdk/aws-bedrock-agentcore-alpha/lib/identity/api-key-credential-provider.ts#L305)

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as bedrock_agentcore_alpha from '@aws-cdk/aws-bedrock-agentcore-alpha';
import * as cdk from 'aws-cdk-lib';

declare const secretValue: cdk.SecretValue;
const apiKeyCredentialProvider = new bedrock_agentcore_alpha.ApiKeyCredentialProvider(this, 'MyApiKeyCredentialProvider', /* all optional props */ {
  apiKey: secretValue,
  apiKeyCredentialProviderName: 'apiKeyCredentialProviderName',
  tags: {
    tagsKey: 'tags',
  },
});
```

## Initializer

```ts
new ApiKeyCredentialProvider(scope: Construct, id: string, props?: ApiKeyCredentialProviderResourceProps)
```

## Construct Props

- `apiKey`: [SecretValue](/cdk/api/v2/docs/aws-cdk-lib.SecretValue.html) — The API key value.

  **Default:** no key in template (provider may still be created depending on service behavior)

  **NOTE:** The API key will be included in the CloudFormation template as part of synthesis.
  The service stores the key in Secrets Manager after creation, but the value is visible
  in the template and deployment history. Use `SecretValue.unsafePlainText()` to explicitly
  acknowledge plaintext, or pass a reference from another construct to avoid embedding the
  literal value.

  If omitted, you can supply the key through another mechanism supported by the service.

- `apiKeyCredentialProviderName`: string — Name of the credential provider.

  **Default:** a name generated by CDK

- `tags`: { [key: string]: string } — Tags for this credential provider.

  **Default:** no tags

## Properties

- `apiKeyCredentialProviderName`: string — The name of this API key credential provider.

- `apiKeyCredentialProviderRef`: [ApiKeyCredentialProviderReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_bedrockagentcore.ApiKeyCredentialProviderReference.html) — A reference to a ApiKeyCredentialProvider resource.

- `apiKeySecretArn`: 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`: string — Timestamp when the credential provider was created.

- `credentialProviderArn`: string — The ARN of this credential provider.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) — The environment this resource belongs to.

  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.

- `grantPrincipal`: [IPrincipal](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IPrincipal.html) — The principal to grant permissions to.

- `lastUpdatedTime`: string — Timestamp when the credential provider was last updated.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `PROPERTY_INJECTION_ID`: string (static) — Uniquely identifies this class.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this resource is defined.

## Methods

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource.

  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(): GatewayApiKeyIdentityBinding` — ARNs for {@link GatewayCredentialProvider.fromApiKeyIdentity } / {@link GatewayCredentialProvider.fromApiKeyIdentityArn }.

- `fromApiKeyCredentialProviderAttributes(scope: Construct, id: string, attrs: ApiKeyCredentialProviderAttributes): IApiKeyCredentialProvider` (static) — Import an existing API key credential provider.

- `grant(grantee: IGrantable, ...actions: string[]): Grant` — [disable-awslint:no-grants].

- `grantAdmin(grantee: IGrantable): Grant` — [disable-awslint:no-grants].

- `grantFullAccess(grantee: IGrantable): Grant` — [disable-awslint:no-grants].

- `grantRead(grantee: IGrantable): Grant` — [disable-awslint:no-grants].

- `grantUse(grantee: IGrantable): Grant` — [disable-awslint:no-grants].

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `toString(): string` — Returns a string representation of this construct.

- `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.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.