connect_client_add_ins

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

Overview

Name	connect_client_add_ins
Type	Resource
Id	aws.workspaces.connect_client_add_ins

Fields

The following fields are returned by SELECT queries:

describe_connect_client_add_ins

Name	Datatype	Description
add_ins	array	Information about client add-ins.
next_token	string	The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_connect_client_add_ins	select	region		Retrieves a list of Connect Customer client add-ins that have been created.
create_connect_client_add_in	insert	region, ResourceId, Name, URL		Creates a client-add-in for Connect Customer within a directory. You can create only one Connect Customer client add-in within a directory. This client add-in allows WorkSpaces users to seamlessly connect to Connect Customer.
update_connect_client_add_in	update	region, AddInId, ResourceId		Updates a Connect Customer client add-in. Use this action to update the name and endpoint URL of a Connect Customer client add-in.
delete_connect_client_add_in	delete	region		Deletes a client-add-in for Connect Customer that is configured within a directory.

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_connect_client_add_ins

Retrieves a list of Connect Customer client add-ins that have been created.

SELECT
add_ins,
next_token
FROM aws.workspaces.connect_client_add_ins
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_connect_client_add_in

Creates a client-add-in for Connect Customer within a directory. You can create only one Connect Customer client add-in within a directory. This client add-in allows WorkSpaces users to seamlessly connect to Connect Customer.

INSERT INTO aws.workspaces.connect_client_add_ins (
ResourceId,
Name,
URL,
region
)
SELECT 
'{{ ResourceId }}' /* required */,
'{{ Name }}' /* required */,
'{{ URL }}' /* required */,
'{{ region }}'
RETURNING
add_in_id
;

Manifest

# Description fields are for documentation purposes
- name: connect_client_add_ins
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the connect_client_add_ins resource.
  - name: ResourceId
    value: "{{ ResourceId }}"
    description: |
      The directory identifier for which to configure the client add-in.
  - name: Name
    value: "{{ Name }}"
    description: |
      The name of the client add-in.
  - name: URL
    value: "{{ URL }}"
    description: |
      The endpoint URL of the Connect Customer client add-in.

UPDATE examples

update_connect_client_add_in

Updates a Connect Customer client add-in. Use this action to update the name and endpoint URL of a Connect Customer client add-in.

UPDATE aws.workspaces.connect_client_add_ins
SET 
AddInId = '{{ AddInId }}',
ResourceId = '{{ ResourceId }}',
Name = '{{ Name }}',
URL = '{{ URL }}'
WHERE 
region = '{{ region }}' --required
AND AddInId = '{{ AddInId }}' --required
AND ResourceId = '{{ ResourceId }}' --required;

DELETE examples

delete_connect_client_add_in

Deletes a client-add-in for Connect Customer that is configured within a directory.

DELETE FROM aws.workspaces.connect_client_add_ins
WHERE region = '{{ region }}' --required
;