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

Experimental

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

ApiKeyCredentialProviderAttributes Struct

Attributes for importing an existing API key credential provider.

Source

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

Example

// 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';
const apiKeyCredentialProviderAttributes: bedrock_agentcore_alpha.ApiKeyCredentialProviderAttributes = {
  credentialProviderArn: 'credentialProviderArn',

  // the properties below are optional
  apiKeySecretArn: 'apiKeySecretArn',
  createdTime: 'createdTime',
  lastUpdatedTime: 'lastUpdatedTime',
};

Properties

apiKeySecretArn?optionalstringapi_key_secret_arn?optionalstrapiKeySecretArn?optionalStringApiKeySecretArn?optionalstringApiKeySecretArn?optional*string#

ARN of the Secrets Manager secret for the API key, if known.

Default: not set; required for {@link ApiKeyCredentialProvider.bindForGatewayApiKeyTarget } on imported providers

createdTime?optionalstringcreated_time?optionalstrcreatedTime?optionalStringCreatedTime?optionalstringCreatedTime?optional*string#

Resource creation time.

Default: not set

credentialProviderArnstringcredential_provider_arnstrcredentialProviderArnStringCredentialProviderArnstringCredentialProviderArn*stringrequired#

ARN of the credential provider.

lastUpdatedTime?optionalstringlast_updated_time?optionalstrlastUpdatedTime?optionalStringLastUpdatedTime?optionalstringLastUpdatedTime?optional*string#

Resource last-updated time.

Default: not set