custom_endpoints

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

Overview

Name	custom_endpoints
Type	Resource
Id	aws.iot_managed_integrations.custom_endpoints

Fields

The following fields are returned by SELECT queries:

get_custom_endpoint

Name	Datatype	Description
endpoint_address	string	The IoT managed integrations dedicated, custom endpoint for the device to route traffic through. (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_custom_endpoint	select	region		Returns the IoT managed integrations custom endpoint.
register_custom_endpoint	insert	region		Customers can request IoT managed integrations to manage the server trust for them or bring their own external server trusts for the custom domain. Returns an IoT managed integrations endpoint.

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

get_custom_endpoint

Returns the IoT managed integrations custom endpoint.

SELECT
endpoint_address
FROM aws.iot_managed_integrations.custom_endpoints
WHERE region = '{{ region }}' -- required
;

INSERT examples

register_custom_endpoint

Customers can request IoT managed integrations to manage the server trust for them or bring their own external server trusts for the custom domain. Returns an IoT managed integrations endpoint.

INSERT INTO aws.iot_managed_integrations.custom_endpoints (
region
)
SELECT 
'{{ region }}'
RETURNING
endpoint_address
;

Manifest

# Description fields are for documentation purposes
- name: custom_endpoints
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the custom_endpoints resource.