qev2_idc_applications

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

Overview

Name	qev2_idc_applications
Type	Resource
Id	aws.redshift.qev2_idc_applications

Fields

The following fields are returned by SELECT queries:

describe_qev2_idc_applications

Name	Datatype	Description
idc_display_name	string	The display name for the Amazon Redshift Query Editor (QEV2) IAM Identity Center application. It appears in the console.
idc_instance_arn	string	The Amazon Resource Name (ARN) for the IAM Identity Center instance that the Amazon Redshift Query Editor (QEV2) application integrates with.
idc_managed_application_arn	string	The Amazon Resource Name (ARN) for the Amazon Redshift Query Editor (QEV2) IAM Identity Center managed application.
idc_onboard_status	string	The onboarding status for the Amazon Redshift Query Editor (QEV2) IAM Identity Center application.
qev_2_idc_application_arn	string	The Amazon Resource Name (ARN) for the Amazon Redshift Query Editor (QEV2) application that integrates with IAM Identity Center.
qev_2_idc_application_name	string	The name of the Amazon Redshift Query Editor (QEV2) application in IAM Identity Center.
tags	string	A list of tags associated with the application. Tags are key-value pairs that you can use to organize and identify your resources.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_qev2_idc_applications	select	region	Qev2IdcApplicationArn, MaxRecords, Marker	Lists the Amazon Redshift Query Editor (QEV2) IAM Identity Center applications. To retrieve additional results, use the MaxRecords and Marker parameters.
create_qev2_idc_application	insert	IdcInstanceArn, Qev2IdcApplicationName, IdcDisplayName, region	Tags	Creates an Amazon Redshift Query Editor (QEV2) IAM Identity Center application.
modify_qev2_idc_application	update	Qev2IdcApplicationArn, region	IdcDisplayName	Modifies an Amazon Redshift Query Editor (QEV2) IAM Identity Center application.
delete_qev2_idc_application	delete	Qev2IdcApplicationArn, region		Deletes an Amazon Redshift Query Editor (QEV2) IAM Identity Center application.

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
IdcDisplayName	string	The display name for the Amazon Redshift Query Editor (QEV2) IAM Identity Center application. It appears in the console.
IdcInstanceArn	string	The Amazon Resource Name (ARN) of the IAM Identity Center instance used to create the Amazon Redshift Query Editor (QEV2) managed application.
Qev2IdcApplicationArn	string	The Amazon Resource Name (ARN) for the Amazon Redshift Query Editor (QEV2) IAM Identity Center application to delete.
Qev2IdcApplicationName	string	The name of the Amazon Redshift Query Editor (QEV2) application in IAM Identity Center.
region	string	AWS region (default: us-east-1)
IdcDisplayName	string	The display name for the Amazon Redshift Query Editor (QEV2) IAM Identity Center application. It appears in the console.
Marker	string	A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
MaxRecords	integer	The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Qev2IdcApplicationArn	string	The Amazon Resource Name (ARN) for the Amazon Redshift Query Editor (QEV2) application that integrates with IAM Identity Center.
Tags	array	A list of tags to associate with the application. Tags are key-value pairs that you can use to organize and identify your resources.

SELECT examples

describe_qev2_idc_applications

Lists the Amazon Redshift Query Editor (QEV2) IAM Identity Center applications. To retrieve additional results, use the MaxRecords and Marker parameters.

SELECT
idc_display_name,
idc_instance_arn,
idc_managed_application_arn,
idc_onboard_status,
qev_2_idc_application_arn,
qev_2_idc_application_name,
tags
FROM aws.redshift.qev2_idc_applications
WHERE region = '{{ region }}' -- required
AND Qev2IdcApplicationArn = '{{ Qev2IdcApplicationArn }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;

INSERT examples

create_qev2_idc_application

Creates an Amazon Redshift Query Editor (QEV2) IAM Identity Center application.

INSERT INTO aws.redshift.qev2_idc_applications (
IdcInstanceArn,
Qev2IdcApplicationName,
IdcDisplayName,
region,
Tags
)
SELECT 
'{{ IdcInstanceArn }}',
'{{ Qev2IdcApplicationName }}',
'{{ IdcDisplayName }}',
'{{ region }}',
'{{ Tags }}'
RETURNING
idc_display_name,
idc_instance_arn,
idc_managed_application_arn,
idc_onboard_status,
qev_2_idc_application_arn,
qev_2_idc_application_name,
tags
;

Manifest

# Description fields are for documentation purposes
- name: qev2_idc_applications
props:
  - name: IdcInstanceArn
    value: "{{ IdcInstanceArn }}"
    description: Required parameter for the qev2_idc_applications resource.
  - name: Qev2IdcApplicationName
    value: "{{ Qev2IdcApplicationName }}"
    description: Required parameter for the qev2_idc_applications resource.
  - name: IdcDisplayName
    value: "{{ IdcDisplayName }}"
    description: Required parameter for the qev2_idc_applications resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the qev2_idc_applications resource.
  - name: Tags
    value: "{{ Tags }}"
    description: A list of tags to associate with the application. Tags are key-value pairs that you can use to organize and identify your resources.
    description: A list of tags to associate with the application. Tags are key-value pairs that you can use to organize and identify your resources.

UPDATE examples

modify_qev2_idc_application

Modifies an Amazon Redshift Query Editor (QEV2) IAM Identity Center application.

UPDATE aws.redshift.qev2_idc_applications
SET 
-- No updatable properties
WHERE 
Qev2IdcApplicationArn = '{{ Qev2IdcApplicationArn }}' --required
AND region = '{{ region }}' --required
AND IdcDisplayName = '{{ IdcDisplayName}}'
RETURNING
idc_display_name,
idc_instance_arn,
idc_managed_application_arn,
idc_onboard_status,
qev_2_idc_application_arn,
qev_2_idc_application_name,
tags;

DELETE examples

delete_qev2_idc_application

Deletes an Amazon Redshift Query Editor (QEV2) IAM Identity Center application.

DELETE FROM aws.redshift.qev2_idc_applications
WHERE Qev2IdcApplicationArn = '{{ Qev2IdcApplicationArn }}' --required
AND region = '{{ region }}' --required
;