ApiKeyCredentialProviderProps

class aws_cdk.aws_bedrock_agentcore_alpha.ApiKeyCredentialProviderProps(*, provider_arn, secret_arn, credential_location=None)

Bases: object

(experimental) API key credential provider ARNs for gateway outbound auth (Token Vault identity).

Pass this to {@link GatewayCredentialProvider.fromApiKeyIdentityArn } or to {@link ApiKeyCredentialProviderConfiguration}.

Parameters:

provider_arn (str) – (experimental) The API key credential provider ARN. This is returned when creating the API key credential provider via Console or API. Format: arn:aws:bedrock-agentcore:region:account:token-vault/id/apikeycredentialprovider/name
secret_arn (str) – (experimental) The ARN of the Secrets Manager secret containing the API key. This is returned when creating the API key credential provider via Console or API. Format: arn:aws:secretsmanager:region:account:secret:name
credential_location (Optional[ApiKeyCredentialLocation]) – (experimental) The location of the API key credential. This field specifies where in the request the API key should be placed. Default: - HEADER

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_bedrock_agentcore_alpha as bedrock_agentcore_alpha

# api_key_credential_location: bedrock_agentcore_alpha.ApiKeyCredentialLocation

api_key_credential_provider_props = bedrock_agentcore_alpha.ApiKeyCredentialProviderProps(
    provider_arn="providerArn",
    secret_arn="secretArn",

    # the properties below are optional
    credential_location=api_key_credential_location
)

Attributes

credential_location

(experimental) The location of the API key credential.

This field specifies where in the request the API key should be placed.

Default:

HEADER

Stability:

experimental

provider_arn

(experimental) The API key credential provider ARN.

This is returned when creating the API key credential provider via Console or API. Format: arn:aws:bedrock-agentcore:region:account:token-vault/id/apikeycredentialprovider/name

Stability:: experimental

secret_arn

(experimental) The ARN of the Secrets Manager secret containing the API key.

This is returned when creating the API key credential provider via Console or API. Format: arn:aws:secretsmanager:region:account:secret:name

Stability:: experimental