assignments

Creates, updates, deletes or gets an assignment resource or lists assignments in a region

Overview

Name	assignments
Type	Resource
Description	Resource Type definition for SSO assignmet
Id	awscc.sso.assignments

Fields

get (all properties)

Name	Datatype	Description
instance_arn	string	The sso instance that the permission set is owned.
target_id	string	The account id to be provisioned.
target_type	string	The type of resource to be provsioned to, only aws account now
permission_set_arn	string	The permission set that the assignemt will be assigned
principal_type	string	The assignee's type, user/group
principal_id	string	The assignee's identifier, user id/group id
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
instance_arn	string	The sso instance that the permission set is owned.
target_id	string	The account id to be provisioned.
target_type	string	The type of resource to be provsioned to, only aws account now
permission_set_arn	string	The permission set that the assignemt will be assigned
principal_type	string	The assignee's type, user/group
principal_id	string	The assignee's identifier, user id/group id
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	assignments	INSERT	InstanceArn, TargetId, TargetType, PermissionSetArn, PrincipalType, PrincipalId, region
delete_resource	assignments	DELETE	Identifier, region
list_resources	assignments_list_only	SELECT	region
get_resource	assignments	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual assignment.

SELECT
  region,
  instance_arn,
  target_id,
  target_type,
  permission_set_arn,
  principal_type,
  principal_id
FROM awscc.sso.assignments
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ instance_arn }}|{{ target_id }}|{{ target_type }}|{{ permission_set_arn }}|{{ principal_type }}|{{ principal_id }}';

list (identifiers only)

Lists all assignments in a region.

SELECT
  region,
  instance_arn,
  target_id,
  target_type,
  permission_set_arn,
  principal_type,
  principal_id
FROM awscc.sso.assignments_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.sso.assignments (
  InstanceArn,
  TargetId,
  TargetType,
  PermissionSetArn,
  PrincipalType,
  PrincipalId,
  region
)
SELECT
  '{{ instance_arn }}',
  '{{ target_id }}',
  '{{ target_type }}',
  '{{ permission_set_arn }}',
  '{{ principal_type }}',
  '{{ principal_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.sso.assignments (
  InstanceArn,
  TargetId,
  TargetType,
  PermissionSetArn,
  PrincipalType,
  PrincipalId,
  region
)
SELECT
  '{{ instance_arn }}',
  '{{ target_id }}',
  '{{ target_type }}',
  '{{ permission_set_arn }}',
  '{{ principal_type }}',
  '{{ principal_id }}',
  '{{ 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: assignment
  props:
    - name: instance_arn
      value: '{{ instance_arn }}'
    - name: target_id
      value: '{{ target_id }}'
    - name: target_type
      value: '{{ target_type }}'
    - name: permission_set_arn
      value: '{{ permission_set_arn }}'
    - name: principal_type
      value: '{{ principal_type }}'
    - name: principal_id
      value: '{{ principal_id }}'

DELETE example

/*+ delete */
DELETE FROM awscc.sso.assignments
WHERE
  Identifier = '{{ instance_arn }}|{{ target_id }}|{{ target_type }}|{{ permission_set_arn }}|{{ principal_type }}|{{ principal_id }}' 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 assignments resource, the following permissions are required:

Create

sso:CreateAccountAssignment,
sso:DescribeAccountAssignmentCreationStatus,
sso:ListAccountAssignments,
iam:GetSAMLProvider,
iam:CreateSAMLProvider,
iam:AttachRolePolicy,
iam:PutRolePolicy,
iam:CreateRole,
iam:ListRolePolicies

Read

sso:ListAccountAssignments,
iam:GetSAMLProvider,
iam:ListRolePolicies

Delete

sso:ListAccountAssignments,
sso:DeleteAccountAssignment,
sso:DescribeAccountAssignmentDeletionStatus,
iam:GetSAMLProvider,
iam:ListRolePolicies

List

sso:ListAccountAssignments,
iam:ListRolePolicies