cloud_connectors

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

Overview

Name	cloud_connectors
Type	Resource
Id	aws.iot_managed_integrations.cloud_connectors

Fields

The following fields are returned by SELECT queries:

get_cloud_connector

Name	Datatype	Description
description	string	A description of the C2C connector. (pattern: <code>[0-9A-Za-z_- ]+</code>)
endpoint_config	object	The configuration details for an endpoint, which defines how to connect to and communicate with external services.
endpoint_type	string	The type of endpoint used for the cloud connector, which defines how the connector communicates with external services. (LAMBDA)
id	string	The unique identifier of the cloud connector. (pattern: <code>[A-Za-z0-9-_]+</code>)
name	string	The display name of the C2C connector. (pattern: <code>[A-Za-z0-9-_ ]+</code>)
type	string	The type of cloud connector created. (LISTED, UNLISTED)

list_cloud_connectors

Name	Datatype	Description
description	string	A description of the C2C connector. (pattern: <code>[0-9A-Za-z_- ]+</code>)
endpoint_config	object	The configuration details for an endpoint, which defines how to connect to and communicate with external services.
endpoint_type	string	The type of endpoint used for the C2C connector. (LAMBDA)
id	string	The identifier of the C2C connector. (pattern: <code>[A-Za-z0-9-_]+</code>)
name	string	The display name of the C2C connector. (pattern: <code>[A-Za-z0-9-_ ]+</code>)
type	string	The type of cloud connector created. (LISTED, UNLISTED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_cloud_connector	select	identifier, region		Get configuration details for a cloud connector.
list_cloud_connectors	select	region	Type, LambdaArn, MaxResults, NextToken	Returns a list of connectors filtered by its Lambda Amazon Resource Name (ARN) and type.
create_cloud_connector	insert	region, EndpointConfig		Creates a C2C (cloud-to-cloud) connector.
update_cloud_connector	update	identifier, region		Update an existing cloud connector.
delete_cloud_connector	delete	identifier, region		Delete a cloud 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
identifier	string	The identifier of the cloud connector.
region	string	AWS region (default: us-east-1)
LambdaArn	string	The Amazon Resource Name (ARN) of the Lambda function to filter cloud connectors by.
MaxResults	integer	The maximum number of results to return at one time.
NextToken	string	A token that can be used to retrieve the next set of results.
Type	string	The type of cloud connectors to filter by when listing available connectors.

SELECT examples

get_cloud_connector

Get configuration details for a cloud connector.

SELECT
description,
endpoint_config,
endpoint_type,
id,
name,
type
FROM aws.iot_managed_integrations.cloud_connectors
WHERE identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_cloud_connectors

Returns a list of connectors filtered by its Lambda Amazon Resource Name (ARN) and type.

SELECT
description,
endpoint_config,
endpoint_type,
id,
name,
type
FROM aws.iot_managed_integrations.cloud_connectors
WHERE region = '{{ region }}' -- required
AND Type = '{{ Type }}'
AND LambdaArn = '{{ LambdaArn }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;

INSERT examples

create_cloud_connector

Creates a C2C (cloud-to-cloud) connector.

INSERT INTO aws.iot_managed_integrations.cloud_connectors (
Name,
EndpointConfig,
Description,
EndpointType,
ClientToken,
region
)
SELECT 
'{{ Name }}',
'{{ EndpointConfig }}' /* required */,
'{{ Description }}',
'{{ EndpointType }}',
'{{ ClientToken }}',
'{{ region }}'
RETURNING
id
;

Manifest

# Description fields are for documentation purposes
- name: cloud_connectors
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the cloud_connectors resource.
  - name: Name
    value: "{{ Name }}"
  - name: EndpointConfig
    description: |
      The configuration details for an endpoint, which defines how to connect to and communicate with external services.
    value:
      lambda:
        arn: "{{ arn }}"
  - name: Description
    value: "{{ Description }}"
  - name: EndpointType
    value: "{{ EndpointType }}"
    valid_values: ['LAMBDA']
  - name: ClientToken
    value: "{{ ClientToken }}"

UPDATE examples

update_cloud_connector

Update an existing cloud connector.

UPDATE aws.iot_managed_integrations.cloud_connectors
SET 
Name = '{{ Name }}',
Description = '{{ Description }}'
WHERE 
identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_cloud_connector

Delete a cloud connector.

DELETE FROM aws.iot_managed_integrations.cloud_connectors
WHERE identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
;