api_key_credential_providers

Creates, updates, deletes, gets or lists an api_key_credential_providers resource.

Overview

Name	api_key_credential_providers
Type	Resource
Id	aws.bedrock_agentcore_control.api_key_credential_providers

Fields

The following fields are returned by SELECT queries:

get_api_key_credential_provider

Name	Datatype	Description
name	string	The name of the API key credential provider. (pattern: <code>[a-zA-Z0-9-_]+</code>)
api_key_secret_arn	object	Contains information about a secret in Amazon Web Services Secrets Manager.
api_key_secret_json_key	string	The JSON key used to extract the API key value from the Amazon Web Services Secrets Manager secret.
api_key_secret_source	string	The source type of the API key secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager. (MANAGED, EXTERNAL)
created_time	string (date-time)	The timestamp when the API key credential provider was created.
credential_provider_arn	string	The Amazon Resource Name (ARN) of the API key credential provider. (pattern: <code>arn:(aws|aws-us-gov):acps:[A-Za-z0-9-]{1,64}:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/apikeycredentialprovider/[a-zA-Z0-9-.]+</code>)
last_updated_time	string (date-time)	The timestamp when the API key credential provider was last updated.

list_api_key_credential_providers

Name	Datatype	Description
name	string	The name of the API key credential provider. (pattern: <code>[a-zA-Z0-9-_]+</code>)
created_time	string (date-time)	The timestamp when the API key credential provider was created.
credential_provider_arn	string	The Amazon Resource Name (ARN) of the API key credential provider. (pattern: <code>arn:(aws|aws-us-gov):acps:[A-Za-z0-9-]{1,64}:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/apikeycredentialprovider/[a-zA-Z0-9-.]+</code>)
last_updated_time	string (date-time)	The timestamp when the API key credential provider was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_api_key_credential_provider	select	region		Retrieves information about an API key credential provider.
list_api_key_credential_providers	select	region		Lists all API key credential providers in your account.
create_api_key_credential_provider	insert	region, name		Creates a new API key credential provider.
update_api_key_credential_provider	update	region, name		Updates an existing API key credential provider.
delete_api_key_credential_provider	delete	region		Deletes an API key credential provider.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_api_key_credential_provider

Retrieves information about an API key credential provider.

SELECT
name,
api_key_secret_arn,
api_key_secret_json_key,
api_key_secret_source,
created_time,
credential_provider_arn,
last_updated_time
FROM aws.bedrock_agentcore_control.api_key_credential_providers
WHERE region = '{{ region }}' -- required
;

list_api_key_credential_providers

Lists all API key credential providers in your account.

SELECT
name,
created_time,
credential_provider_arn,
last_updated_time
FROM aws.bedrock_agentcore_control.api_key_credential_providers
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_api_key_credential_provider

Creates a new API key credential provider.

INSERT INTO aws.bedrock_agentcore_control.api_key_credential_providers (
name,
apiKey,
apiKeySecretConfig,
apiKeySecretSource,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ apiKey }}',
'{{ apiKeySecretConfig }}',
'{{ apiKeySecretSource }}',
'{{ tags }}',
'{{ region }}'
RETURNING
name,
api_key_secret_arn,
api_key_secret_json_key,
api_key_secret_source,
credential_provider_arn
;

Manifest

# Description fields are for documentation purposes
- name: api_key_credential_providers
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the api_key_credential_providers resource.
  - name: name
    value: "{{ name }}"
  - name: apiKey
    value: "{{ apiKey }}"
  - name: apiKeySecretConfig
    description: |
      Contains a reference to a secret stored in Amazon Web Services Secrets Manager.
    value:
      secretId: "{{ secretId }}"
      jsonKey: "{{ jsonKey }}"
  - name: apiKeySecretSource
    value: "{{ apiKeySecretSource }}"
    valid_values: ['MANAGED', 'EXTERNAL']
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_api_key_credential_provider

Updates an existing API key credential provider.

UPDATE aws.bedrock_agentcore_control.api_key_credential_providers
SET 
name = '{{ name }}',
apiKey = '{{ apiKey }}',
apiKeySecretConfig = '{{ apiKeySecretConfig }}',
apiKeySecretSource = '{{ apiKeySecretSource }}'
WHERE 
region = '{{ region }}' --required
AND name = '{{ name }}' --required
RETURNING
name,
api_key_secret_arn,
api_key_secret_json_key,
api_key_secret_source,
created_time,
credential_provider_arn,
last_updated_time;

DELETE examples

delete_api_key_credential_provider

Deletes an API key credential provider.

DELETE FROM aws.bedrock_agentcore_control.api_key_credential_providers
WHERE region = '{{ region }}' --required
;