connector_destinations

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

Overview

Name	connector_destinations
Type	Resource
Id	aws.iot_managed_integrations.connector_destinations

Fields

The following fields are returned by SELECT queries:

get_connector_destination

Name	Datatype	Description
auth_config	object	The authentication configuration details for a connector destination, including OAuth settings and other authentication parameters.
auth_type	string	The authentication type used for the connector destination, which determines how credentials and access are managed. (OAUTH)
cloud_connector_id	string	The identifier of the C2C connector. (pattern: <code>[A-Za-z0-9-_]+</code>)
description	string	A description of the connector destination. (pattern: <code>[0-9A-Za-z_- ]+</code>)
id	string	The unique identifier of the connector destination. (pattern: <code>[A-Za-z0-9-_]+</code>)
name	string	The display name of the connector destination. (pattern: <code>[A-Za-z0-9-_ ]+</code>)
o_auth_complete_redirect_url	string	The URL where users are redirected after completing the OAuth authorization process for the connector destination. (pattern: <code>(http|https):​//.*</code>)
secrets_manager	object	Configuration for AWS Secrets Manager, used to securely store and manage sensitive information for connector destinations.

list_connector_destinations

Name	Datatype	Description
cloud_connector_id	string	The identifier of the cloud connector associated with this connector destination. (pattern: <code>[A-Za-z0-9-_]+</code>)
description	string	A description of the connector destination. (pattern: <code>[0-9A-Za-z_- ]+</code>)
id	string	The unique identifier of the connector destination. (pattern: <code>[A-Za-z0-9-_]+</code>)
name	string	The display name of the connector destination. (pattern: <code>[A-Za-z0-9-_ ]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_connector_destination	select	identifier, region		Get connector destination details linked to a cloud-to-cloud (C2C) connector.
list_connector_destinations	select	region	CloudConnectorId, NextToken, MaxResults	Lists all connector destinations, with optional filtering by cloud connector ID.
create_connector_destination	insert	region, CloudConnectorId, AuthConfig		Create a connector destination for connecting a cloud-to-cloud (C2C) connector to the customer's Amazon Web Services account.
update_connector_destination	update	identifier, region		Updates the properties of an existing connector destination.
delete_connector_destination	delete	identifier, region		Delete a connector destination linked to a cloud-to-cloud (C2C) connector. Deletion can't be done if the account association has used this connector destination.

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 connector destination.
region	string	AWS region (default: us-east-1)
CloudConnectorId	string	The identifier of the cloud connector to filter connector destinations by.
MaxResults	integer	The maximum number of connector destinations to return in a single response.
NextToken	string	A token used for pagination of results.

SELECT examples

get_connector_destination

Get connector destination details linked to a cloud-to-cloud (C2C) connector.

SELECT
auth_config,
auth_type,
cloud_connector_id,
description,
id,
name,
o_auth_complete_redirect_url,
secrets_manager
FROM aws.iot_managed_integrations.connector_destinations
WHERE identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_connector_destinations

Lists all connector destinations, with optional filtering by cloud connector ID.

SELECT
cloud_connector_id,
description,
id,
name
FROM aws.iot_managed_integrations.connector_destinations
WHERE region = '{{ region }}' -- required
AND CloudConnectorId = '{{ CloudConnectorId }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
;

INSERT examples

create_connector_destination

Create a connector destination for connecting a cloud-to-cloud (C2C) connector to the customer's Amazon Web Services account.

INSERT INTO aws.iot_managed_integrations.connector_destinations (
Name,
Description,
CloudConnectorId,
AuthType,
AuthConfig,
SecretsManager,
ClientToken,
region
)
SELECT 
'{{ Name }}',
'{{ Description }}',
'{{ CloudConnectorId }}' /* required */,
'{{ AuthType }}',
'{{ AuthConfig }}' /* required */,
'{{ SecretsManager }}',
'{{ ClientToken }}',
'{{ region }}'
RETURNING
id
;

Manifest

# Description fields are for documentation purposes
- name: connector_destinations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the connector_destinations resource.
  - name: Name
    value: "{{ Name }}"
  - name: Description
    value: "{{ Description }}"
  - name: CloudConnectorId
    value: "{{ CloudConnectorId }}"
  - name: AuthType
    value: "{{ AuthType }}"
    valid_values: ['OAUTH']
  - name: AuthConfig
    description: |
      The authentication configuration details for a connector destination, including OAuth settings and other authentication parameters.
    value:
      oAuth:
        authUrl: "{{ authUrl }}"
        tokenUrl: "{{ tokenUrl }}"
        scope: "{{ scope }}"
        tokenEndpointAuthenticationScheme: "{{ tokenEndpointAuthenticationScheme }}"
        oAuthCompleteRedirectUrl: "{{ oAuthCompleteRedirectUrl }}"
        proactiveRefreshTokenRenewal:
          enabled: {{ enabled }}
          DaysBeforeRenewal: {{ DaysBeforeRenewal }}
      GeneralAuthorization:
        - SecretsManager:
            arn: "{{ arn }}"
            versionId: "{{ versionId }}"
          AuthMaterialName: "{{ AuthMaterialName }}"
  - name: SecretsManager
    description: |
      Configuration for AWS Secrets Manager, used to securely store and manage sensitive information for connector destinations.
    value:
      arn: "{{ arn }}"
      versionId: "{{ versionId }}"
  - name: ClientToken
    value: "{{ ClientToken }}"

UPDATE examples

update_connector_destination

Updates the properties of an existing connector destination.

UPDATE aws.iot_managed_integrations.connector_destinations
SET 
Description = '{{ Description }}',
Name = '{{ Name }}',
AuthType = '{{ AuthType }}',
AuthConfig = '{{ AuthConfig }}',
SecretsManager = '{{ SecretsManager }}'
WHERE 
identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_connector_destination

Delete a connector destination linked to a cloud-to-cloud (C2C) connector. Deletion can't be done if the account association has used this connector destination.

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