instance_access_control_attribute_configurations

Creates, updates, deletes or gets an instance_access_control_attribute_configuration resource or lists instance_access_control_attribute_configurations in a region

Overview

Name	instance_access_control_attribute_configurations
Type	Resource
Description	Resource Type definition for SSO InstanceAccessControlAttributeConfiguration
Id	awscc.sso.instance_access_control_attribute_configurations

Fields

get (all properties)

Name	Datatype	Description
instance_arn	string	The ARN of the AWS SSO instance under which the operation will be executed.
▶instance_access_control_attribute_configuration	object	The InstanceAccessControlAttributeConfiguration property has been deprecated but is still supported for backwards compatibility purposes. We recomend that you use AccessControlAttributes property instead.
▶access_control_attributes	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
instance_arn	string	The ARN of the AWS SSO instance under which the operation will be executed.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	instance_access_control_attribute_configurations	INSERT	InstanceArn, region
delete_resource	instance_access_control_attribute_configurations	DELETE	Identifier, region
update_resource	instance_access_control_attribute_configurations	UPDATE	Identifier, PatchDocument, region
list_resources	instance_access_control_attribute_configurations_list_only	SELECT	region
get_resource	instance_access_control_attribute_configurations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual instance_access_control_attribute_configuration.

SELECT
  region,
  instance_arn,
  instance_access_control_attribute_configuration,
  access_control_attributes
FROM awscc.sso.instance_access_control_attribute_configurations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ instance_arn }}';

list (identifiers only)

Lists all instance_access_control_attribute_configurations in a region.

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

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.sso.instance_access_control_attribute_configurations (
  InstanceArn,
  region
)
SELECT
  '{{ instance_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.sso.instance_access_control_attribute_configurations (
  InstanceArn,
  InstanceAccessControlAttributeConfiguration,
  AccessControlAttributes,
  region
)
SELECT
  '{{ instance_arn }}',
  '{{ instance_access_control_attribute_configuration }}',
  '{{ access_control_attributes }}',
  '{{ 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_access_control_attribute_configuration
  props:
    - name: instance_arn
      value: '{{ instance_arn }}'
    - name: instance_access_control_attribute_configuration
      value:
        access_control_attributes:
          - key: '{{ key }}'
            value:
              source:
                - '{{ source[0] }}'
    - name: access_control_attributes
      value: null

UPDATE example

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

/*+ update */
UPDATE awscc.sso.instance_access_control_attribute_configurations
SET PatchDocument = string('{{ {
    "InstanceAccessControlAttributeConfiguration": instance_access_control_attribute_configuration,
    "AccessControlAttributes": access_control_attributes
} | 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.instance_access_control_attribute_configurations
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 instance_access_control_attribute_configurations resource, the following permissions are required:

Create

sso:CreateInstanceAccessControlAttributeConfiguration,
sso:UpdateApplicationProfileForAWSAccountInstance,
sso:DescribeInstanceAccessControlAttributeConfiguration

Read

sso:DescribeInstanceAccessControlAttributeConfiguration

Update

sso:UpdateInstanceAccessControlAttributeConfiguration,
sso:DescribeInstanceAccessControlAttributeConfiguration

Delete

sso:DeleteInstanceAccessControlAttributeConfiguration,
sso:DescribeInstanceAccessControlAttributeConfiguration

List

sso:DescribeInstanceAccessControlAttributeConfiguration