application_assignments

Creates, updates, deletes or gets an application_assignment resource or lists application_assignments in a region

Overview

Name	application_assignments
Type	Resource
Description	Resource Type definition for SSO application access grant to a user or group.
Id	awscc.sso.application_assignments

Fields

get (all properties)

Name	Datatype	Description
application_arn	string	The ARN of the application.
principal_type	string	The entity type for which the assignment will be created.
principal_id	string	An identifier for an object in IAM Identity Center, such as a user or group
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
application_arn	string	The ARN of the application.
principal_type	string	The entity type for which the assignment will be created.
principal_id	string	An identifier for an object in IAM Identity Center, such as a user or group
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	application_assignments	INSERT	ApplicationArn, PrincipalType, PrincipalId, region
delete_resource	application_assignments	DELETE	Identifier, region
list_resources	application_assignments_list_only	SELECT	region
get_resource	application_assignments	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual application_assignment.

SELECT
  region,
  application_arn,
  principal_type,
  principal_id
FROM awscc.sso.application_assignments
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ application_arn }}|{{ principal_type }}|{{ principal_id }}';

list (identifiers only)

Lists all application_assignments in a region.

SELECT
  region,
  application_arn,
  principal_type,
  principal_id
FROM awscc.sso.application_assignments_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.sso.application_assignments (
  ApplicationArn,
  PrincipalType,
  PrincipalId,
  region
)
SELECT
  '{{ application_arn }}',
  '{{ principal_type }}',
  '{{ principal_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.sso.application_assignments (
  ApplicationArn,
  PrincipalType,
  PrincipalId,
  region
)
SELECT
  '{{ application_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: application_assignment
  props:
    - name: application_arn
      value: '{{ application_arn }}'
    - name: principal_type
      value: '{{ principal_type }}'
    - name: principal_id
      value: '{{ principal_id }}'

DELETE example

/*+ delete */
DELETE FROM awscc.sso.application_assignments
WHERE
  Identifier = '{{ application_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 application_assignments resource, the following permissions are required:

Create

sso:CreateApplicationAssignment,
sso:DescribeApplicationAssignment

Read

sso:DescribeApplicationAssignment

Delete

sso:DeleteApplicationAssignment

List

sso:ListApplicationAssignments