redshift_idc_applications

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

Overview

Name	redshift_idc_applications
Type	Resource
Id	aws.redshift.redshift_idc_applications

Fields

The following fields are returned by SELECT queries:

describe_redshift_idc_applications

Name	Datatype	Description
application_type	string	The type of application being created. Valid values are None or Lakehouse. Use Lakehouse to enable Amazon Redshift federated permissions on cluster.
authorized_token_issuer_list	string	The authorized token issuer list for the Amazon Redshift IAM Identity Center application.
iam_role_arn	string	The ARN for the Amazon Redshift IAM Identity Center application. It has the required permissions to be assumed and invoke the IDC Identity Center API.
idc_display_name	string	The display name for the Amazon Redshift IAM Identity Center application. It appears on the console.
idc_instance_arn	string	The ARN for the IAM Identity Center instance that Redshift integrates with.
idc_managed_application_arn	string	The ARN for the Amazon Redshift IAM Identity Center application.
idc_onboard_status	string	The onboarding status for the Amazon Redshift IAM Identity Center application.
identity_namespace	string	The identity namespace for the Amazon Redshift IAM Identity Center application. It determines which managed application verifies the connection token.
redshift_idc_application_arn	string	The ARN for the Redshift application that integrates with IAM Identity Center.
redshift_idc_application_name	string	The name of the Redshift application in IAM Identity Center.
service_integrations	string	A list of service integrations for the Redshift IAM Identity Center application.
sso_tag_keys	string	A list of tags keys that Redshift Identity Center applications copy to IAM Identity Center. For each input key, the tag corresponding to the key-value pair is propagated.
tags	string	A list of tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_redshift_idc_applications	select	region	RedshiftIdcApplicationArn, MaxRecords, Marker	Lists the Amazon Redshift IAM Identity Center applications.
create_redshift_idc_application	insert	IdcInstanceArn, RedshiftIdcApplicationName, IdcDisplayName, IamRoleArn, region	IdentityNamespace, AuthorizedTokenIssuerList, ServiceIntegrations, ApplicationType, Tags, SsoTagKeys	Creates an Amazon Redshift application for use with IAM Identity Center.
modify_redshift_idc_application	update	RedshiftIdcApplicationArn, region	IdentityNamespace, IamRoleArn, IdcDisplayName, AuthorizedTokenIssuerList, ServiceIntegrations	Changes an existing Amazon Redshift IAM Identity Center application.
delete_redshift_idc_application	delete	RedshiftIdcApplicationArn, region		Deletes an Amazon Redshift 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
IamRoleArn	string	The IAM role ARN for the Amazon Redshift IAM Identity Center application instance. It has the required permissions to be assumed and invoke the IDC Identity Center API.
IdcDisplayName	string	The display name for the Amazon Redshift IAM Identity Center application instance. It appears in the console.
IdcInstanceArn	string	The Amazon resource name (ARN) of the IAM Identity Center instance where Amazon Redshift creates a new managed application.
RedshiftIdcApplicationArn	string	The ARN for a deleted Amazon Redshift IAM Identity Center application.
RedshiftIdcApplicationName	string	The name of the Redshift application in IAM Identity Center.
region	string	AWS region (default: us-east-1)
ApplicationType	string	The type of application being created. Valid values are None or Lakehouse. Use Lakehouse to enable Amazon Redshift federated permissions on cluster.
AuthorizedTokenIssuerList	array	The authorized token issuer list for the Amazon Redshift IAM Identity Center application to change.
IamRoleArn	string	The IAM role ARN associated with the Amazon Redshift IAM Identity Center application to change. It has the required permissions to be assumed and invoke the IDC Identity Center API.
IdcDisplayName	string	The display name for the Amazon Redshift IAM Identity Center application to change. It appears on the console.
IdentityNamespace	string	The namespace for the Amazon Redshift IAM Identity Center application to change. It determines which managed application verifies the connection token.
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.
RedshiftIdcApplicationArn	string	The ARN for the Redshift application that integrates with IAM Identity Center.
ServiceIntegrations	array	A collection of service integrations associated with the application.
SsoTagKeys	array	A list of tags keys that Redshift Identity Center applications copy to IAM Identity Center. For each input key, the tag corresponding to the key-value pair is propagated.
Tags	array	A list of tags.

SELECT examples

describe_redshift_idc_applications

Lists the Amazon Redshift IAM Identity Center applications.

SELECT
application_type,
authorized_token_issuer_list,
iam_role_arn,
idc_display_name,
idc_instance_arn,
idc_managed_application_arn,
idc_onboard_status,
identity_namespace,
redshift_idc_application_arn,
redshift_idc_application_name,
service_integrations,
sso_tag_keys,
tags
FROM aws.redshift.redshift_idc_applications
WHERE region = '{{ region }}' -- required
AND RedshiftIdcApplicationArn = '{{ RedshiftIdcApplicationArn }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;

INSERT examples

create_redshift_idc_application

Creates an Amazon Redshift application for use with IAM Identity Center.

INSERT INTO aws.redshift.redshift_idc_applications (
IdcInstanceArn,
RedshiftIdcApplicationName,
IdcDisplayName,
IamRoleArn,
region,
IdentityNamespace,
AuthorizedTokenIssuerList,
ServiceIntegrations,
ApplicationType,
Tags,
SsoTagKeys
)
SELECT 
'{{ IdcInstanceArn }}',
'{{ RedshiftIdcApplicationName }}',
'{{ IdcDisplayName }}',
'{{ IamRoleArn }}',
'{{ region }}',
'{{ IdentityNamespace }}',
'{{ AuthorizedTokenIssuerList }}',
'{{ ServiceIntegrations }}',
'{{ ApplicationType }}',
'{{ Tags }}',
'{{ SsoTagKeys }}'
RETURNING
application_type,
authorized_token_issuer_list,
iam_role_arn,
idc_display_name,
idc_instance_arn,
idc_managed_application_arn,
idc_onboard_status,
identity_namespace,
redshift_idc_application_arn,
redshift_idc_application_name,
service_integrations,
sso_tag_keys,
tags
;

Manifest

# Description fields are for documentation purposes
- name: redshift_idc_applications
props:
  - name: IdcInstanceArn
    value: "{{ IdcInstanceArn }}"
    description: Required parameter for the redshift_idc_applications resource.
  - name: RedshiftIdcApplicationName
    value: "{{ RedshiftIdcApplicationName }}"
    description: Required parameter for the redshift_idc_applications resource.
  - name: IdcDisplayName
    value: "{{ IdcDisplayName }}"
    description: Required parameter for the redshift_idc_applications resource.
  - name: IamRoleArn
    value: "{{ IamRoleArn }}"
    description: Required parameter for the redshift_idc_applications resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the redshift_idc_applications resource.
  - name: IdentityNamespace
    value: "{{ IdentityNamespace }}"
    description: The namespace for the Amazon Redshift IAM Identity Center application instance. It determines which managed application verifies the connection token.
    description: The namespace for the Amazon Redshift IAM Identity Center application instance. It determines which managed application verifies the connection token.
  - name: AuthorizedTokenIssuerList
    value: "{{ AuthorizedTokenIssuerList }}"
    description: The token issuer list for the Amazon Redshift IAM Identity Center application instance.
    description: The token issuer list for the Amazon Redshift IAM Identity Center application instance.
  - name: ServiceIntegrations
    value: "{{ ServiceIntegrations }}"
    description: A collection of service integrations for the Redshift IAM Identity Center application.
    description: A collection of service integrations for the Redshift IAM Identity Center application.
  - name: ApplicationType
    value: "{{ ApplicationType }}"
    description: The type of application being created. Valid values are None or Lakehouse. Use Lakehouse to enable Amazon Redshift federated permissions on cluster.
    description: The type of application being created. Valid values are None or Lakehouse. Use Lakehouse to enable Amazon Redshift federated permissions on cluster.
  - name: Tags
    value: "{{ Tags }}"
    description: A list of tags.
    description: A list of tags.
  - name: SsoTagKeys
    value: "{{ SsoTagKeys }}"
    description: A list of tags keys that Redshift Identity Center applications copy to IAM Identity Center. For each input key, the tag corresponding to the key-value pair is propagated.
    description: A list of tags keys that Redshift Identity Center applications copy to IAM Identity Center. For each input key, the tag corresponding to the key-value pair is propagated.

UPDATE examples

modify_redshift_idc_application

Changes an existing Amazon Redshift IAM Identity Center application.

UPDATE aws.redshift.redshift_idc_applications
SET 
-- No updatable properties
WHERE 
RedshiftIdcApplicationArn = '{{ RedshiftIdcApplicationArn }}' --required
AND region = '{{ region }}' --required
AND IdentityNamespace = '{{ IdentityNamespace}}'
AND IamRoleArn = '{{ IamRoleArn}}'
AND IdcDisplayName = '{{ IdcDisplayName}}'
AND AuthorizedTokenIssuerList = '{{ AuthorizedTokenIssuerList}}'
AND ServiceIntegrations = '{{ ServiceIntegrations}}'
RETURNING
application_type,
authorized_token_issuer_list,
iam_role_arn,
idc_display_name,
idc_instance_arn,
idc_managed_application_arn,
idc_onboard_status,
identity_namespace,
redshift_idc_application_arn,
redshift_idc_application_name,
service_integrations,
sso_tag_keys,
tags;

DELETE examples

delete_redshift_idc_application

Deletes an Amazon Redshift IAM Identity Center application.

DELETE FROM aws.redshift.redshift_idc_applications
WHERE RedshiftIdcApplicationArn = '{{ RedshiftIdcApplicationArn }}' --required
AND region = '{{ region }}' --required
;