connect_instance_configs

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

Overview

Name	connect_instance_configs
Type	Resource
Id	aws.connectcampaignsv2.connect_instance_configs

Fields

The following fields are returned by SELECT queries:

get_connect_instance_config

Name	Datatype	Description
connect_instance_id	string	Amazon Connect Instance Id (pattern: <code>[-_.a-zA-Z0-9]+</code>)
encryption_config	object	Encryption config for Connect Instance. Note that sensitive data will always be encrypted. If disabled, service will perform encryption with its own key. If enabled, a KMS key id needs to be provided and KMS charges will apply. KMS is only type supported
service_linked_role_arn	string	Service linked role arn

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_connect_instance_config	select	connect_instance_id, region		Get the specific Connect instance config.
delete_connect_instance_config	delete	connect_instance_id, region	campaignDeletionPolicy	Deletes a connect instance config from the specified AWS account.

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
connect_instance_id	string
region	string	AWS region (default: us-east-1)
campaignDeletionPolicy	string

SELECT examples

get_connect_instance_config

Get the specific Connect instance config.

SELECT
connect_instance_id,
encryption_config,
service_linked_role_arn
FROM aws.connectcampaignsv2.connect_instance_configs
WHERE connect_instance_id = '{{ connect_instance_id }}' -- required
AND region = '{{ region }}' -- required
;

DELETE examples

delete_connect_instance_config

Deletes a connect instance config from the specified AWS account.

DELETE FROM aws.connectcampaignsv2.connect_instance_configs
WHERE connect_instance_id = '{{ connect_instance_id }}' --required
AND region = '{{ region }}' --required
AND campaignDeletionPolicy = '{{ campaignDeletionPolicy }}'
;