instance
Gets an individual instance
resource
Overview
Name | instance |
Type | Resource |
Description | instance |
Id | awscc.connect.instance |
Fields
Name | Datatype | Description |
---|---|---|
id | string | An instanceId is automatically generated on creation and assigned as the unique identifier. |
arn | string | An instanceArn is automatically generated on creation based on instanceId. |
identity_management_type | string | Specifies the type of directory integration for new instance. |
instance_alias | string | Alias of the new directory created as part of new instance creation. |
created_time | string | Timestamp of instance creation logged as part of instance creation. |
service_role | string | Service linked role created as part of instance creation. |
instance_status | string | Specifies the creation status of new instance. |
directory_id | string | Existing directoryId user wants to map to the new Connect instance. |
attributes | object | The attributes for the instance. |
tags | array | An array of key-value pairs to apply to this resource. |
region | string | AWS region. |
Methods
Currently only SELECT
is supported for this resource resource.
Example
SELECT
region,
id,
arn,
identity_management_type,
instance_alias,
created_time,
service_role,
instance_status,
directory_id,
attributes,
tags
FROM awscc.connect.instance
WHERE data__Identifier = '<Arn>';
Permissions
To operate on the instance
resource, the following permissions are required:
Read
connect:DescribeInstance,
connect:ListInstanceAttributes,
ds:DescribeDirectories
Update
connect:ListInstanceAttributes,
connect:UpdateInstanceAttribute,
iam:CreateServiceLinkedRole,
iam:PutRolePolicy,
connect:TagResource,
connect:UntagResource
Delete
connect:DeleteInstance,
connect:DescribeInstance,
connect:UntagResource,
ds:DeleteDirectory,
ds:UnauthorizeApplication,
ds:DescribeDirectories