connectors

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

Overview

Name	connectors
Type	Resource
Id	aws.config.connectors

Fields

The following fields are returned by SELECT queries:

list_connectors

Name	Datatype	Description
name	string	The name of the connector.
arn	string	The Amazon Resource Name (ARN) of the connector.
created_time	string (date-time)	The date and time that the connector was created.
provider	string	The third-party cloud service provider. Currently, AZURE is supported. (AZURE)
tenant_identifier	string	The Azure tenant identifier for the connector.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_connectors	select	region		Returns a list of connectors depending on the filters you specify.
put_connector	replace	region, ConnectorConfiguration		Creates a connector that specifies the connection between a third-party cloud service provider and Config. A connector is required to create a service-linked configuration recorder for a third-party cloud service provider using the PutThirdPartyServiceLinkedConfigurationRecorder operation. This API creates a service-linked role AWSServiceRoleForConfigThirdParty in your account. The service-linked role is created only when the role does not exist in your account. Connectors cannot be updated To update the connector configuration, you must delete all associated configuration recorders, delete the connector, and recreate it with the updated configuration. Tags are added at creation and cannot be updated with this operation Use TagResource and UntagResource to update tags after creation.
delete_connector	delete	region		Deletes the specified connector.
get_connector	exec	region		Returns the details of the specified connector.

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

list_connectors

Returns a list of connectors depending on the filters you specify.

SELECT
name,
arn,
created_time,
provider,
tenant_identifier
FROM aws.config.connectors
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_connector

Creates a connector that specifies the connection between a third-party cloud service provider and Config. A connector is required to create a service-linked configuration recorder for a third-party cloud service provider using the PutThirdPartyServiceLinkedConfigurationRecorder operation. This API creates a service-linked role AWSServiceRoleForConfigThirdParty in your account. The service-linked role is created only when the role does not exist in your account. Connectors cannot be updated To update the connector configuration, you must delete all associated configuration recorders, delete the connector, and recreate it with the updated configuration. Tags are added at creation and cannot be updated with this operation Use TagResource and UntagResource to update tags after creation.

REPLACE aws.config.connectors
SET 
ConnectorConfiguration = '{{ ConnectorConfiguration }}',
Tags = '{{ Tags }}'
WHERE 
region = '{{ region }}' --required
AND ConnectorConfiguration = '{{ ConnectorConfiguration }}' --required
RETURNING
arn;

DELETE examples

delete_connector

Deletes the specified connector.

DELETE FROM aws.config.connectors
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

get_connector

Returns the details of the specified connector.

EXEC aws.config.connectors.get_connector 
@region='{{ region }}' --required 
@@json=
'{
"Arn": "{{ Arn }}"
}'
;