operator_apps

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

Overview

Name	operator_apps
Type	Resource
Id	aws.devops_agent.operator_apps

Fields

The following fields are returned by SELECT queries:

get_operator_app

Name	Datatype	Description
iam	object	Configuration for IAM-based authentication flow for the Operator App.
idc	object	Configuration for AWS Identity Center (IdC) authentication flow for the Operator App.
idp	object	Configuration for external Identity Provider OIDC authentication flow for the Operator App.
operator_app_url	string	The URL for operators to access the Operator App (pattern: <code>https:​//[a-zA-Z0-9.-]+(/.*)?</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_operator_app	select	agent_space_id, region		Get the full auth configuration of operator including any enabled auth flow
update_operator_app_idp_config	update	agent_space_id, region		Update the external Identity Provider configuration for the Operator App

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
agent_space_id	string	The unique identifier of the AgentSpace
region	string	AWS region (default: us-east-1)

SELECT examples

get_operator_app

Get the full auth configuration of operator including any enabled auth flow

SELECT
iam,
idc,
idp,
operator_app_url
FROM aws.devops_agent.operator_apps
WHERE agent_space_id = '{{ agent_space_id }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_operator_app_idp_config

Update the external Identity Provider configuration for the Operator App

UPDATE aws.devops_agent.operator_apps
SET 
idpClientSecret = '{{ idpClientSecret }}'
WHERE 
agent_space_id = '{{ agent_space_id }}' --required
AND region = '{{ region }}' --required
RETURNING
agent_space_id,
idp;