identity_sources

Creates, updates, deletes or gets an identity_source resource or lists identity_sources in a region

Overview

Name	identity_sources
Type	Resource
Description	Resource Type definition for AWS::MPA::IdentitySource.
Id	awscc.mpa.identity_sources

Fields

Name	Datatype	Description
identity_source_arn	string
▶identity_source_parameters	object
▶tags	array
identity_source_type	string
creation_time	string
status	string
status_code	string
status_message	string
region	string	AWS region.

For more information, see AWS::MPA::IdentitySource.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	IdentitySourceParameters, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all properties from an individual identity_source.

SELECT
region,
identity_source_arn,
identity_source_parameters,
tags,
identity_source_type,
creation_time,
status,
status_code,
status_message
FROM awscc.mpa.identity_sources
WHERE region = 'us-east-1' AND data__Identifier = '<IdentitySourceArn>';

INSERT example

Use the following StackQL query and manifest file to create a new identity_source resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.mpa.identity_sources (
 IdentitySourceParameters,
 region
)
SELECT 
'{{ IdentitySourceParameters }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.mpa.identity_sources (
 IdentitySourceParameters,
 Tags,
 region
)
SELECT 
 '{{ IdentitySourceParameters }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: identity_source
    props:
      - name: IdentitySourceParameters
        value:
          IamIdentityCenter:
            InstanceArn: '{{ InstanceArn }}'
            Region: '{{ Region }}'
            ApprovalPortalUrl: '{{ ApprovalPortalUrl }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.mpa.identity_sources
WHERE data__Identifier = '<IdentitySourceArn>'
AND region = 'us-east-1';

Permissions

To operate on the identity_sources resource, the following permissions are required:

Create

mpa:CreateIdentitySource,
mpa:TagResource,
mpa:ListTagsForResource,
mpa:GetIdentitySource,
sso:DescribeApplication,
sso:DescribeInstance,
sso:CreateApplication,
sso:PutApplicationAssignmentConfiguration,
sso:PutApplicationGrant,
sso:PutApplicationAuthenticationMethod,
sso:PutApplicationAccessScope,
kms:Decrypt

Read

mpa:GetIdentitySource,
mpa:ListTagsForResource

Update

mpa:GetIdentitySource,
mpa:TagResource,
mpa:ListTagsForResource,
mpa:UntagResource

Delete

mpa:DeleteIdentitySource,
mpa:GetIdentitySource,
mpa:UntagResource,
sso:DeleteApplication,
sso:ListInstances,
kms:Decrypt

List

mpa:ListIdentitySources,
mpa:ListTagsForResource