security_profiles

Creates, updates, deletes, gets or lists a security_profiles resource.

Overview

Name	security_profiles
Type	Resource
Id	aws.connect.security_profiles

Fields

The following fields are returned by SELECT queries:

describe_security_profile

Name	Datatype	Description
allowed_access_control_hierarchy_group_id	string	The identifier of the hierarchy group that a security profile uses to restrict access to resources in Connect Customer.
allowed_access_control_tags	object	The list of tags that a security profile uses to restrict access to resources in Connect Customer.
arn	string	The Amazon Resource Name (ARN) for the security profile.
description	string	The description of the security profile.
granular_access_control_configuration	object	Contains granular access control configuration for security profiles, including data table access permissions.
hierarchy_restricted_resources	array	The list of resources that a security profile applies hierarchy restrictions to in Connect Customer. Following are acceptable ResourceNames: User.
id	string	The identifier for the security profile.
last_modified_region	string	The Amazon Web Services Region where this resource was last modified. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
last_modified_time	string (date-time)	The timestamp when this resource was last modified.
organization_resource_id	string	The organization resource identifier for the security profile.
security_profile_name	string	The name for the security profile.
tag_restricted_resources	array	The list of resources that a security profile applies tag restrictions to in Connect Customer.
tags	object	The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

list_security_profiles

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the security profile.
id	string	The identifier of the security profile.
last_modified_region	string	The Amazon Web Services Region where this resource was last modified. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
last_modified_time	string (date-time)	The timestamp when this resource was last modified.
name	string	The name of the security profile.

search_security_profiles

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the security profile.
description	string	The description of the security profile.
id	string	The identifier of the security profile.
organization_resource_id	string	The organization resource identifier.
security_profile_name	string	The name of the security profile.
tags	object	The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_security_profile	select	security_profile_id, instance_id, region		Gets basic information about the security profile. For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
list_security_profiles	select	instance_id, region	nextToken, maxResults	Provides summary information about the security profiles for the specified Connect Customer instance. For more information about security profiles, see Security Profiles in the Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
search_security_profiles	select	region		Searches security profiles in an Connect Customer instance, with optional filtering. For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
create_security_profile	insert	instance_id, region, SecurityProfileName		Creates a security profile. For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
associate_security_profiles	update	instance_id, region, SecurityProfiles, EntityType, EntityArn		Associate security profiles with an Entity in an Amazon Connect instance.
update_user_security_profiles	update	user_id, instance_id, region, SecurityProfileIds		Assigns the specified security profiles to the specified user.
update_security_profile	update	security_profile_id, instance_id, region		Updates a security profile. For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
delete_security_profile	delete	instance_id, security_profile_id, region		Deletes a security profile.
disassociate_security_profiles	exec	instance_id, region, SecurityProfiles, EntityType, EntityArn		Disassociates a security profile attached to a Q in Connect AI Agent Entity in an Amazon Connect instance.

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
instance_id	string	The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
region	string	AWS region (default: us-east-1)
security_profile_id	string	The identifier for the security profle.
user_id	string	The identifier of the user account.
maxResults	integer	The maximum number of results to return per page. The default MaxResult size is 100.
nextToken	string	The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

SELECT examples

describe_security_profile

Gets basic information about the security profile. For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

SELECT
allowed_access_control_hierarchy_group_id,
allowed_access_control_tags,
arn,
description,
granular_access_control_configuration,
hierarchy_restricted_resources,
id,
last_modified_region,
last_modified_time,
organization_resource_id,
security_profile_name,
tag_restricted_resources,
tags
FROM aws.connect.security_profiles
WHERE security_profile_id = '{{ security_profile_id }}' -- required
AND instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
;

list_security_profiles

Provides summary information about the security profiles for the specified Connect Customer instance. For more information about security profiles, see Security Profiles in the Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

SELECT
arn,
id,
last_modified_region,
last_modified_time,
name
FROM aws.connect.security_profiles
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

search_security_profiles

Searches security profiles in an Connect Customer instance, with optional filtering. For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

SELECT
arn,
description,
id,
organization_resource_id,
security_profile_name,
tags
FROM aws.connect.security_profiles
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_security_profile

Creates a security profile. For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

INSERT INTO aws.connect.security_profiles (
SecurityProfileName,
Description,
Permissions,
Tags,
AllowedAccessControlTags,
TagRestrictedResources,
Applications,
HierarchyRestrictedResources,
AllowedAccessControlHierarchyGroupId,
AllowedFlowModules,
GranularAccessControlConfiguration,
instance_id,
region
)
SELECT 
'{{ SecurityProfileName }}' /* required */,
'{{ Description }}',
'{{ Permissions }}',
'{{ Tags }}',
'{{ AllowedAccessControlTags }}',
'{{ TagRestrictedResources }}',
'{{ Applications }}',
'{{ HierarchyRestrictedResources }}',
'{{ AllowedAccessControlHierarchyGroupId }}',
'{{ AllowedFlowModules }}',
'{{ GranularAccessControlConfiguration }}',
'{{ instance_id }}',
'{{ region }}'
RETURNING
security_profile_arn,
security_profile_id
;

Manifest

# Description fields are for documentation purposes
- name: security_profiles
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the security_profiles resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the security_profiles resource.
  - name: SecurityProfileName
    value: "{{ SecurityProfileName }}"
  - name: Description
    value: "{{ Description }}"
  - name: Permissions
    value:
      - "{{ Permissions }}"
  - name: Tags
    value: "{{ Tags }}"
  - name: AllowedAccessControlTags
    value: "{{ AllowedAccessControlTags }}"
  - name: TagRestrictedResources
    value:
      - "{{ TagRestrictedResources }}"
  - name: Applications
    value:
      - Namespace: "{{ Namespace }}"
        ApplicationPermissions: "{{ ApplicationPermissions }}"
        Type: "{{ Type }}"
  - name: HierarchyRestrictedResources
    value:
      - "{{ HierarchyRestrictedResources }}"
  - name: AllowedAccessControlHierarchyGroupId
    value: "{{ AllowedAccessControlHierarchyGroupId }}"
  - name: AllowedFlowModules
    value:
      - Type: "{{ Type }}"
        FlowModuleId: "{{ FlowModuleId }}"
  - name: GranularAccessControlConfiguration
    description: |
      Contains granular access control configuration for security profiles, including data table access permissions.
    value:
      DataTableAccessControlConfiguration:
        PrimaryAttributeAccessControlConfiguration:
          PrimaryAttributeValues:
            - AccessType: "{{ AccessType }}"
              AttributeName: "{{ AttributeName }}"
              Values: "{{ Values }}"

UPDATE examples

associate_security_profiles

Associate security profiles with an Entity in an Amazon Connect instance.

UPDATE aws.connect.security_profiles
SET 
SecurityProfiles = '{{ SecurityProfiles }}',
EntityType = '{{ EntityType }}',
EntityArn = '{{ EntityArn }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND region = '{{ region }}' --required
AND SecurityProfiles = '{{ SecurityProfiles }}' --required
AND EntityType = '{{ EntityType }}' --required
AND EntityArn = '{{ EntityArn }}' --required;

update_user_security_profiles

Assigns the specified security profiles to the specified user.

UPDATE aws.connect.security_profiles
SET 
SecurityProfileIds = '{{ SecurityProfileIds }}'
WHERE 
user_id = '{{ user_id }}' --required
AND instance_id = '{{ instance_id }}' --required
AND region = '{{ region }}' --required
AND SecurityProfileIds = '{{ SecurityProfileIds }}' --required;

update_security_profile

Updates a security profile. For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

UPDATE aws.connect.security_profiles
SET 
Description = '{{ Description }}',
Permissions = '{{ Permissions }}',
AllowedAccessControlTags = '{{ AllowedAccessControlTags }}',
TagRestrictedResources = '{{ TagRestrictedResources }}',
Applications = '{{ Applications }}',
HierarchyRestrictedResources = '{{ HierarchyRestrictedResources }}',
AllowedAccessControlHierarchyGroupId = '{{ AllowedAccessControlHierarchyGroupId }}',
AllowedFlowModules = '{{ AllowedFlowModules }}',
GranularAccessControlConfiguration = '{{ GranularAccessControlConfiguration }}'
WHERE 
security_profile_id = '{{ security_profile_id }}' --required
AND instance_id = '{{ instance_id }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_security_profile

Deletes a security profile.

DELETE FROM aws.connect.security_profiles
WHERE instance_id = '{{ instance_id }}' --required
AND security_profile_id = '{{ security_profile_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

disassociate_security_profiles

Disassociates a security profile attached to a Q in Connect AI Agent Entity in an Amazon Connect instance.

EXEC aws.connect.security_profiles.disassociate_security_profiles 
@instance_id='{{ instance_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"SecurityProfiles": "{{ SecurityProfiles }}", 
"EntityType": "{{ EntityType }}", 
"EntityArn": "{{ EntityArn }}"
}'
;