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	awscc.sso.instances

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
instance_arn	string	The SSO Instance ARN that is returned upon creation of the Identity Center (SSO) Instance
region	string	AWS region.

For more information, see AWS::SSO::Instance.

Methods

Name	Resource	Accessible by	Required Params
create_resource	instances	INSERT	region
delete_resource	instances	DELETE	Identifier, region
update_resource	instances	UPDATE	Identifier, PatchDocument, region
list_resources	instances_list_only	SELECT	region
get_resource	instances	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual instance.

SELECT
  region,
  name,
  instance_arn,
  owner_account_id,
  identity_store_id,
  status,
  tags
FROM awscc.sso.instances
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ instance_arn }}';

list (identifiers only)

Lists all instances in a region.

SELECT
  region,
  instance_arn
FROM awscc.sso.instances_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.sso.instances (
  Name,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.sso.instances (
  Name,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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 }}'

UPDATE example

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

/*+ update */
UPDATE awscc.sso.instances
SET PatchDocument = string('{{ {
    "Name": name,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ instance_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.sso.instances
WHERE
  Identifier = '{{ instance_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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