instances

Creates, updates, deletes or gets an instance resource or lists instances in a region

Overview

Name	instances
Type	Resource
Description	Resource Type definition for Identity Center (SSO) Instance
Id	aws.sso.instances

Fields

Name	Datatype	Description
name	string	The name you want to assign to this Identity Center (SSO) Instance
instance_arn	string	The SSO Instance ARN that is returned upon creation of the Identity Center (SSO) Instance
owner_account_id	string	The AWS accountId of the owner of the Identity Center (SSO) Instance
identity_store_id	string	The ID of the identity store associated with the created Identity Center (SSO) Instance
status	string	The status of the Identity Center (SSO) Instance, create_in_progress/delete_in_progress/active
tags	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	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 instances in a region.

SELECT
region,
name,
instance_arn,
owner_account_id,
identity_store_id,
status,
tags
FROM aws.sso.instances
WHERE region = 'us-east-1';

Gets all properties from an individual instance.

SELECT
region,
name,
instance_arn,
owner_account_id,
identity_store_id,
status,
tags
FROM aws.sso.instances
WHERE region = 'us-east-1' AND data__Identifier = '<InstanceArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.sso.instances (
 Name,
 Tags,
 region
)
SELECT 
'{{ Name }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.sso.instances (
 Name,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: instance
    props:
      - name: Name
        value: '{{ Name }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.sso.instances
WHERE data__Identifier = '<InstanceArn>'
AND region = 'us-east-1';

Permissions

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

Create

sso:CreateInstance,
sso:DescribeInstance,
sso:TagResource,
iam:CreateServiceLinkedRole,
sso:TagInstance,
sso:ListTagsForResource

Read

sso:DescribeInstance,
sso:ListTagsForResource

Update

sso:UpdateInstance,
sso:TagResource,
sso:UntagResource,
sso:ListTagsForResource,
sso:TagInstance,
sso:DescribeInstance

Delete

sso:DeleteInstance

List

sso:ListInstances