payment_connectors

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

Overview

Name	payment_connectors
Type	Resource
Id	aws.bedrock_agentcore_control.payment_connectors

Fields

The following fields are returned by SELECT queries:

get_payment_connector

Name	Datatype	Description
name	string	The name of the payment connector. (pattern: <code>[a-zA-Z][a-zA-Z0-9_]{0,47}</code>)
authorization_url	string	The URL that the user must open to complete OAuth consent. This field is only present when the payment connector status is PENDING_AUTHENTICATION. (pattern: <code>https:​//[^\p{C}]*</code>)
created_at	string (date-time)	The timestamp when the payment connector was created.
credential_provider_configurations	array	The credential provider configurations for the payment connector.
description	string	The description of the payment connector. (pattern: <code>[^\p{C}]*</code>)
last_updated_at	string (date-time)	The timestamp when the payment connector was last updated.
payment_connector_id	string	The unique identifier of the payment connector. (pattern: <code>([0-9a-z_][-]?){1,100}-[0-9a-z]{10}</code>)
status	string	The current status of the payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED. (CREATING, UPDATING, DELETING, READY, CREATE_FAILED, UPDATE_FAILED, DELETE_FAILED, AWS_MARKETPLACE_SUBSCRIPTION_REQUIRED, PENDING_AUTHENTICATION, PROVISIONING, AUTHENTICATION_EXPIRED, AUTHENTICATION_FAILED)
type_	string	The type of the payment connector, which determines the payment provider integration. (CoinbaseCDP, StripePrivy)

list_payment_connectors

Name	Datatype	Description
name	string	The name of the payment connector. (pattern: <code>[a-zA-Z][a-zA-Z0-9_]{0,47}</code>)
last_updated_at	string (date-time)	The timestamp when the payment connector was last updated.
payment_connector_id	string	The unique identifier of the payment connector. (pattern: <code>([0-9a-z_][-]?){1,100}-[0-9a-z]{10}</code>)
status	string	The current status of the payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED. (CREATING, UPDATING, DELETING, READY, CREATE_FAILED, UPDATE_FAILED, DELETE_FAILED, AWS_MARKETPLACE_SUBSCRIPTION_REQUIRED, PENDING_AUTHENTICATION, PROVISIONING, AUTHENTICATION_EXPIRED, AUTHENTICATION_FAILED)
type_	string	The type of the payment connector, which determines the payment provider integration. (CoinbaseCDP, StripePrivy)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_payment_connector	select	payment_manager_id, payment_connector_id, region		Retrieves information about a specific payment connector.
list_payment_connectors	select	payment_manager_id, region	maxResults, nextToken	Lists all payment connectors for a specified payment manager.
create_payment_connector	insert	payment_manager_id, region, name, type, credentialProviderConfigurations		Creates a new payment connector for a payment manager. A payment connector integrates with a supported payment provider to enable payment processing capabilities.
update_payment_connector	update	payment_manager_id, payment_connector_id, region		Updates an existing payment connector. This operation uses PATCH semantics, so you only need to specify the fields you want to change.
delete_payment_connector	delete	payment_manager_id, payment_connector_id, region	clientToken	Deletes a payment connector.

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
payment_connector_id	string	The unique identifier of the payment connector to delete.
payment_manager_id	string	The unique identifier of the parent payment manager.
region	string	AWS region (default: us-east-1)
clientToken	string	A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
maxResults	integer	The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
nextToken	string	If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

SELECT examples

get_payment_connector

Retrieves information about a specific payment connector.

SELECT
name,
authorization_url,
created_at,
credential_provider_configurations,
description,
last_updated_at,
payment_connector_id,
status,
type_
FROM aws.bedrock_agentcore_control.payment_connectors
WHERE payment_manager_id = '{{ payment_manager_id }}' -- required
AND payment_connector_id = '{{ payment_connector_id }}' -- required
AND region = '{{ region }}' -- required
;

list_payment_connectors

Lists all payment connectors for a specified payment manager.

SELECT
name,
last_updated_at,
payment_connector_id,
status,
type_
FROM aws.bedrock_agentcore_control.payment_connectors
WHERE payment_manager_id = '{{ payment_manager_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_payment_connector

Creates a new payment connector for a payment manager. A payment connector integrates with a supported payment provider to enable payment processing capabilities.

INSERT INTO aws.bedrock_agentcore_control.payment_connectors (
name,
description,
type,
credentialProviderConfigurations,
provisionMode,
clientToken,
payment_manager_id,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ type }}' /* required */,
'{{ credentialProviderConfigurations }}' /* required */,
'{{ provisionMode }}',
'{{ clientToken }}',
'{{ payment_manager_id }}',
'{{ region }}'
RETURNING
name,
authorization_url,
created_at,
credential_provider_configurations,
payment_connector_id,
payment_manager_id,
status,
type_
;

Manifest

# Description fields are for documentation purposes
- name: payment_connectors
props:
  - name: payment_manager_id
    value: "{{ payment_manager_id }}"
    description: Required parameter for the payment_connectors resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the payment_connectors resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: type
    value: "{{ type }}"
    valid_values: ['CoinbaseCDP', 'StripePrivy']
  - name: credentialProviderConfigurations
    value:
      - coinbaseCDP:
          credentialProviderArn: "{{ credentialProviderArn }}"
        stripePrivy:
          credentialProviderArn: "{{ credentialProviderArn }}"
  - name: provisionMode
    value: "{{ provisionMode }}"
    valid_values: ['MANUAL', 'QUICK_CREATE']
  - name: clientToken
    value: "{{ clientToken }}"

UPDATE examples

update_payment_connector

Updates an existing payment connector. This operation uses PATCH semantics, so you only need to specify the fields you want to change.

UPDATE aws.bedrock_agentcore_control.payment_connectors
SET 
description = '{{ description }}',
type = '{{ type }}',
credentialProviderConfigurations = '{{ credentialProviderConfigurations }}',
clientToken = '{{ clientToken }}'
WHERE 
payment_manager_id = '{{ payment_manager_id }}' --required
AND payment_connector_id = '{{ payment_connector_id }}' --required
AND region = '{{ region }}' --required
RETURNING
name,
authorization_url,
credential_provider_configurations,
last_updated_at,
payment_connector_id,
payment_manager_id,
status,
type_;

DELETE examples

delete_payment_connector

Deletes a payment connector.

DELETE FROM aws.bedrock_agentcore_control.payment_connectors
WHERE payment_manager_id = '{{ payment_manager_id }}' --required
AND payment_connector_id = '{{ payment_connector_id }}' --required
AND region = '{{ region }}' --required
AND clientToken = '{{ clientToken }}'
;