payment_credential_providers

Creates, updates, deletes, gets or lists a payment_credential_providers resource.

Overview

Name	payment_credential_providers
Type	Resource
Id	aws.bedrock_agentcore_control.payment_credential_providers

Fields

The following fields are returned by SELECT queries:

get_payment_credential_provider

Name	Datatype	Description
name	string	The name of the payment credential provider. (pattern: <code>[a-zA-Z0-9-_]+</code>)
created_time	string (date-time)	The timestamp when the payment credential provider was created.
credential_provider_arn	string	The Amazon Resource Name (ARN) of the payment 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-.]+/paymentcredentialprovider/[a-zA-Z0-9-.]+</code>)
credential_provider_vendor	string	Supported vendor types for payment providers using non-standard auth protocols. (CoinbaseCDP, StripePrivy)
last_updated_time	string (date-time)	The timestamp when the payment credential provider was last updated.
provider_configuration_output	object	Output configuration (contains secret ARNs, excludes actual secret values).
tags	object	The tags associated with the payment credential provider.

list_payment_credential_providers

Name	Datatype	Description
name	string	The name of the payment credential provider. (pattern: <code>[a-zA-Z0-9-_]+</code>)
created_time	string (date-time)	The timestamp when the payment credential provider was created.
credential_provider_arn	string	The Amazon Resource Name (ARN) of the payment 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-.]+/paymentcredentialprovider/[a-zA-Z0-9-.]+</code>)
credential_provider_vendor	string	Supported vendor types for payment providers using non-standard auth protocols. (CoinbaseCDP, StripePrivy)
last_updated_time	string (date-time)	The timestamp when the payment credential provider was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_payment_credential_provider	select	region		Retrieves information about a specific payment credential provider.
list_payment_credential_providers	select	region		Lists all payment credential providers in the account.
create_payment_credential_provider	insert	region, name, credentialProviderVendor, providerConfigurationInput		Creates a new payment credential provider for storing authentication credentials used by payment connectors to communicate with external payment providers.
update_payment_credential_provider	update	region, name, credentialProviderVendor, providerConfigurationInput		Updates an existing payment credential provider with new authentication credentials.
delete_payment_credential_provider	delete	region		Deletes a payment credential provider and its associated stored credentials.

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_payment_credential_provider

Retrieves information about a specific payment credential provider.

SELECT
name,
created_time,
credential_provider_arn,
credential_provider_vendor,
last_updated_time,
provider_configuration_output,
tags
FROM aws.bedrock_agentcore_control.payment_credential_providers
WHERE region = '{{ region }}' -- required
;

list_payment_credential_providers

Lists all payment credential providers in the account.

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

INSERT examples

create_payment_credential_provider

Creates a new payment credential provider for storing authentication credentials used by payment connectors to communicate with external payment providers.

INSERT INTO aws.bedrock_agentcore_control.payment_credential_providers (
name,
credentialProviderVendor,
providerConfigurationInput,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ credentialProviderVendor }}' /* required */,
'{{ providerConfigurationInput }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
name,
credential_provider_arn,
credential_provider_vendor,
provider_configuration_output
;

Manifest

# Description fields are for documentation purposes
- name: payment_credential_providers
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the payment_credential_providers resource.
  - name: name
    value: "{{ name }}"
  - name: credentialProviderVendor
    value: "{{ credentialProviderVendor }}"
    description: |
      Supported vendor types for payment providers using non-standard auth protocols.
    valid_values: ['CoinbaseCDP', 'StripePrivy']
  - name: providerConfigurationInput
    description: |
      Provider configuration input — contains secrets for creation and update. Varies by vendor type.
    value:
      coinbaseCdpConfiguration:
        apiKeyId: "{{ apiKeyId }}"
        apiKeySecret: "{{ apiKeySecret }}"
        apiKeySecretSource: "{{ apiKeySecretSource }}"
        apiKeySecretConfig:
          secretId: "{{ secretId }}"
          jsonKey: "{{ jsonKey }}"
        walletSecret: "{{ walletSecret }}"
        walletSecretSource: "{{ walletSecretSource }}"
        walletSecretConfig:
          secretId: "{{ secretId }}"
          jsonKey: "{{ jsonKey }}"
      stripePrivyConfiguration:
        appId: "{{ appId }}"
        appSecret: "{{ appSecret }}"
        appSecretSource: "{{ appSecretSource }}"
        appSecretConfig:
          secretId: "{{ secretId }}"
          jsonKey: "{{ jsonKey }}"
        authorizationPrivateKey: "{{ authorizationPrivateKey }}"
        authorizationPrivateKeySource: "{{ authorizationPrivateKeySource }}"
        authorizationPrivateKeyConfig:
          secretId: "{{ secretId }}"
          jsonKey: "{{ jsonKey }}"
        authorizationId: "{{ authorizationId }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_payment_credential_provider

Updates an existing payment credential provider with new authentication credentials.

UPDATE aws.bedrock_agentcore_control.payment_credential_providers
SET 
name = '{{ name }}',
credentialProviderVendor = '{{ credentialProviderVendor }}',
providerConfigurationInput = '{{ providerConfigurationInput }}'
WHERE 
region = '{{ region }}' --required
AND name = '{{ name }}' --required
AND credentialProviderVendor = '{{ credentialProviderVendor }}' --required
AND providerConfigurationInput = '{{ providerConfigurationInput }}' --required
RETURNING
name,
created_time,
credential_provider_arn,
credential_provider_vendor,
last_updated_time,
provider_configuration_output;

DELETE examples

delete_payment_credential_provider

Deletes a payment credential provider and its associated stored credentials.

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