instance_access_control_attribute_configurations

Creates, updates, deletes, gets or lists an instance_access_control_attribute_configurations resource.

Overview

Name	instance_access_control_attribute_configurations
Type	Resource
Id	aws.sso_admin.instance_access_control_attribute_configurations

Fields

The following fields are returned by SELECT queries:

describe_instance_access_control_attribute_configuration

Name	Datatype	Description
instance_access_control_attribute_configuration	object	Gets the list of IAM Identity Center identity store attributes that have been added to your ABAC configuration.
status	string	The status of the attribute configuration process. (ENABLED, CREATION_IN_PROGRESS, CREATION_FAILED)
status_reason	string	Provides more details about the current status of the specified attribute.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_instance_access_control_attribute_configuration	select	region		Returns the list of IAM Identity Center identity store attributes that have been configured to work with attributes-based access control (ABAC) for the specified IAM Identity Center instance. This will not return attributes configured and sent by an external identity provider. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
create_instance_access_control_attribute_configuration	insert	region, InstanceArn, InstanceAccessControlAttributeConfiguration		Enables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance. You can also specify new attributes to add to your ABAC configuration during the enabling process. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide. After a successful response, call DescribeInstanceAccessControlAttributeConfiguration to validate that InstanceAccessControlAttributeConfiguration was created.
update_instance_access_control_attribute_configuration	update	region, InstanceArn, InstanceAccessControlAttributeConfiguration		Updates the IAM Identity Center identity store attributes that you can use with the IAM Identity Center instance for attributes-based access control (ABAC). When using an external identity provider as an identity source, you can pass attributes through the SAML assertion as an alternative to configuring attributes from the IAM Identity Center identity store. If a SAML assertion passes any of these attributes, IAM Identity Center replaces the attribute value with the value from the IAM Identity Center identity store. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
delete_instance_access_control_attribute_configuration	delete	region		Disables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance and deletes all of the attribute mappings that have been configured. Once deleted, any attributes that are received from an identity source and any custom attributes you have previously configured will not be passed. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_instance_access_control_attribute_configuration

Returns the list of IAM Identity Center identity store attributes that have been configured to work with attributes-based access control (ABAC) for the specified IAM Identity Center instance. This will not return attributes configured and sent by an external identity provider. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.

SELECT
instance_access_control_attribute_configuration,
status,
status_reason
FROM aws.sso_admin.instance_access_control_attribute_configurations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_instance_access_control_attribute_configuration

Enables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance. You can also specify new attributes to add to your ABAC configuration during the enabling process. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide. After a successful response, call DescribeInstanceAccessControlAttributeConfiguration to validate that InstanceAccessControlAttributeConfiguration was created.

INSERT INTO aws.sso_admin.instance_access_control_attribute_configurations (
InstanceArn,
InstanceAccessControlAttributeConfiguration,
region
)
SELECT 
'{{ InstanceArn }}' /* required */,
'{{ InstanceAccessControlAttributeConfiguration }}' /* required */,
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: instance_access_control_attribute_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the instance_access_control_attribute_configurations resource.
  - name: InstanceArn
    value: "{{ InstanceArn }}"
    description: |
      The ARN of the IAM Identity Center instance under which the operation will be executed.
  - name: InstanceAccessControlAttributeConfiguration
    description: |
      Specifies the IAM Identity Center identity store attributes to add to your ABAC configuration. When using an external identity provider as an identity source, you can pass attributes through the SAML assertion. Doing so provides an alternative to configuring attributes from the IAM Identity Center identity store. If a SAML assertion passes any of these attributes, IAM Identity Center will replace the attribute value with the value from the IAM Identity Center identity store.
    value:
      AccessControlAttributes:
        - Key: "{{ Key }}"
          Value:
            Source:
              - "{{ Source }}"

UPDATE examples

update_instance_access_control_attribute_configuration

Updates the IAM Identity Center identity store attributes that you can use with the IAM Identity Center instance for attributes-based access control (ABAC). When using an external identity provider as an identity source, you can pass attributes through the SAML assertion as an alternative to configuring attributes from the IAM Identity Center identity store. If a SAML assertion passes any of these attributes, IAM Identity Center replaces the attribute value with the value from the IAM Identity Center identity store. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.

UPDATE aws.sso_admin.instance_access_control_attribute_configurations
SET 
InstanceArn = '{{ InstanceArn }}',
InstanceAccessControlAttributeConfiguration = '{{ InstanceAccessControlAttributeConfiguration }}'
WHERE 
region = '{{ region }}' --required
AND InstanceArn = '{{ InstanceArn }}' --required
AND InstanceAccessControlAttributeConfiguration = '{{ InstanceAccessControlAttributeConfiguration }}' --required;

DELETE examples

delete_instance_access_control_attribute_configuration

Disables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance and deletes all of the attribute mappings that have been configured. Once deleted, any attributes that are received from an identity source and any custom attributes you have previously configured will not be passed. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.

DELETE FROM aws.sso_admin.instance_access_control_attribute_configurations
WHERE region = '{{ region }}' --required
;