security_profiles

Creates, updates, deletes or gets a security_profile resource or lists security_profiles in a region

Overview

Name	security_profiles
Type	Resource
Description	Resource Type definition for AWS::Connect::SecurityProfile
Id	aws.connect.security_profiles

Fields

Name	Datatype	Description
allowed_access_control_tags	array	The list of tags that a security profile uses to restrict access to resources in Amazon Connect.
description	string	The description of the security profile.
instance_arn	string	The identifier of the Amazon Connect instance.
permissions	array	Permissions assigned to the security profile.
security_profile_arn	string	The Amazon Resource Name (ARN) for the security profile.
security_profile_name	string	The name of the security profile.
tag_restricted_resources	array	The list of resources that a security profile applies tag restrictions to in Amazon Connect.
hierarchy_restricted_resources	array	The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect.
allowed_access_control_hierarchy_group_id	string	The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.
applications	array	A list of third-party applications that the security profile will give access to.
tags	array	The tags used to organize, track, or control access for this resource.
last_modified_region	string	The AWS Region where this resource was last modified.
last_modified_time	number	The timestamp when this resource was last modified.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	InstanceArn, SecurityProfileName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all security_profiles in a region.

SELECT
region,
allowed_access_control_tags,
description,
instance_arn,
permissions,
security_profile_arn,
security_profile_name,
tag_restricted_resources,
hierarchy_restricted_resources,
allowed_access_control_hierarchy_group_id,
applications,
tags,
last_modified_region,
last_modified_time
FROM aws.connect.security_profiles
WHERE region = 'us-east-1';

Gets all properties from an individual security_profile.

SELECT
region,
allowed_access_control_tags,
description,
instance_arn,
permissions,
security_profile_arn,
security_profile_name,
tag_restricted_resources,
hierarchy_restricted_resources,
allowed_access_control_hierarchy_group_id,
applications,
tags,
last_modified_region,
last_modified_time
FROM aws.connect.security_profiles
WHERE region = 'us-east-1' AND data__Identifier = '<SecurityProfileArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.connect.security_profiles (
 InstanceArn,
 SecurityProfileName,
 region
)
SELECT 
'{{ InstanceArn }}',
 '{{ SecurityProfileName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.connect.security_profiles (
 AllowedAccessControlTags,
 Description,
 InstanceArn,
 Permissions,
 SecurityProfileName,
 TagRestrictedResources,
 HierarchyRestrictedResources,
 AllowedAccessControlHierarchyGroupId,
 Applications,
 Tags,
 region
)
SELECT 
 '{{ AllowedAccessControlTags }}',
 '{{ Description }}',
 '{{ InstanceArn }}',
 '{{ Permissions }}',
 '{{ SecurityProfileName }}',
 '{{ TagRestrictedResources }}',
 '{{ HierarchyRestrictedResources }}',
 '{{ AllowedAccessControlHierarchyGroupId }}',
 '{{ Applications }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: security_profile
    props:
      - name: AllowedAccessControlTags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: Description
        value: '{{ Description }}'
      - name: InstanceArn
        value: '{{ InstanceArn }}'
      - name: Permissions
        value:
          - '{{ Permissions[0] }}'
      - name: SecurityProfileName
        value: '{{ SecurityProfileName }}'
      - name: TagRestrictedResources
        value:
          - '{{ TagRestrictedResources[0] }}'
      - name: HierarchyRestrictedResources
        value:
          - null
      - name: AllowedAccessControlHierarchyGroupId
        value: '{{ AllowedAccessControlHierarchyGroupId }}'
      - name: Applications
        value:
          - ApplicationPermissions:
              - '{{ ApplicationPermissions[0] }}'
            Namespace: '{{ Namespace }}'
      - name: Tags
        value:
          - null

DELETE example

/*+ delete */
DELETE FROM aws.connect.security_profiles
WHERE data__Identifier = '<SecurityProfileArn>'
AND region = 'us-east-1';

Permissions

To operate on the security_profiles resource, the following permissions are required:

Create

connect:CreateSecurityProfile,
connect:TagResource

Read

connect:DescribeSecurityProfile,
connect:ListSecurityProfileApplications,
connect:ListSecurityProfilePermissions

Update

connect:TagResource,
connect:UpdateSecurityProfile,
connect:UntagResource

Delete

connect:DeleteSecurityProfile,
connect:UntagResource

List

connect:ListSecurityProfiles