workload_identities

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

Overview

Name	workload_identities
Type	Resource
Id	aws.bedrock_agentcore_control.workload_identities

Fields

The following fields are returned by SELECT queries:

get_workload_identity

Name	Datatype	Description
name	string	The name of the workload identity. (pattern: <code>[A-Za-z0-9_.-]+</code>)
allowed_resource_oauth_2_return_urls	array	The list of allowed OAuth2 return URLs for resources associated with this workload identity.
created_time	string (date-time)	The timestamp when the workload identity was created.
last_updated_time	string (date-time)	The timestamp when the workload identity was last updated.
workload_identity_arn	string	The Amazon Resource Name (ARN) of the workload identity.

list_workload_identities

Name	Datatype	Description
name	string	The name of the workload identity. (pattern: <code>[A-Za-z0-9_.-]+</code>)
workload_identity_arn	string	The Amazon Resource Name (ARN) of the workload identity.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_workload_identity	select	region		Retrieves information about a workload identity.
list_workload_identities	select	region		Lists all workload identities in your account.
create_workload_identity	insert	region, name		Creates a new workload identity.
update_workload_identity	update	region, name		Updates an existing workload identity.
delete_workload_identity	delete	region		Deletes a workload identity.

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_workload_identity

Retrieves information about a workload identity.

SELECT
name,
allowed_resource_oauth_2_return_urls,
created_time,
last_updated_time,
workload_identity_arn
FROM aws.bedrock_agentcore_control.workload_identities
WHERE region = '{{ region }}' -- required
;

list_workload_identities

Lists all workload identities in your account.

SELECT
name,
workload_identity_arn
FROM aws.bedrock_agentcore_control.workload_identities
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_workload_identity

Creates a new workload identity.

INSERT INTO aws.bedrock_agentcore_control.workload_identities (
name,
allowedResourceOauth2ReturnUrls,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ allowedResourceOauth2ReturnUrls }}',
'{{ tags }}',
'{{ region }}'
RETURNING
name,
allowed_resource_oauth_2_return_urls,
workload_identity_arn
;

Manifest

# Description fields are for documentation purposes
- name: workload_identities
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the workload_identities resource.
  - name: name
    value: "{{ name }}"
  - name: allowedResourceOauth2ReturnUrls
    value:
      - "{{ allowedResourceOauth2ReturnUrls }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_workload_identity

Updates an existing workload identity.

UPDATE aws.bedrock_agentcore_control.workload_identities
SET 
name = '{{ name }}',
allowedResourceOauth2ReturnUrls = '{{ allowedResourceOauth2ReturnUrls }}'
WHERE 
region = '{{ region }}' --required
AND name = '{{ name }}' --required
RETURNING
name,
allowed_resource_oauth_2_return_urls,
created_time,
last_updated_time,
workload_identity_arn;

DELETE examples

delete_workload_identity

Deletes a workload identity.

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