domain_configurations

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

Overview

Name	domain_configurations
Type	Resource
Id	aws.iot.domain_configurations

Fields

The following fields are returned by SELECT queries:

describe_domain_configuration

Name	Datatype	Description
application_protocol	string	An enumerated string that specifies the application-layer protocol. SECURE_MQTT - MQTT over TLS. MQTT_WSS - MQTT over WebSocket. HTTPS - HTTP over TLS. DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify application_layer protocol. For more information, see Device communication protocols. (SECURE_MQTT, MQTT_WSS, HTTPS, DEFAULT)
authentication_type	string	An enumerated string that specifies the authentication type. CUSTOM_AUTH_X509 - Use custom authentication and authorization with additional details from the X.509 client certificate. CUSTOM_AUTH - Use custom authentication and authorization. For more information, see Custom authentication and authorization. AWS_X509 - Use X.509 client certificates without custom authentication and authorization. For more information, see X.509 client certificates. AWS_SIGV4 - Use Amazon Web Services Signature Version 4. For more information, see IAM users, groups, and roles. DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify authentication type. For more information, see Device communication protocols. (CUSTOM_AUTH_X509, CUSTOM_AUTH, AWS_X509, AWS_SIGV4, DEFAULT)
authorizer_config	object	An object that specifies the authorization service for a domain.
client_certificate_config	object	An object that specifies the client certificate configuration for a domain.
domain_configuration_arn	string	The ARN of the domain configuration.
domain_configuration_name	string	The name of the domain configuration. (pattern: <code>[\w.:-]+</code>)
domain_configuration_status	string	A Boolean value that specifies the current state of the domain configuration. (ENABLED, DISABLED)
domain_name	string	The name of the domain. (pattern: <code>[\s\S]*</code>)
domain_type	string	The type of the domain. (ENDPOINT, AWS_MANAGED, CUSTOMER_MANAGED)
last_status_change_date	string (date-time)	The date and time the domain configuration's status was last changed.
server_certificate_config	object	The server certificate configuration.
server_certificates	array	A list containing summary information about the server certificate included in the domain configuration.
service_type	string	The type of service delivered by the endpoint. (DATA, CREDENTIAL_PROVIDER, JOBS)
tls_config	object	An object that specifies the TLS configuration for a domain.

list_domain_configurations

Name	Datatype	Description
domain_configuration_arn	string	The ARN of the domain configuration.
domain_configuration_name	string	The name of the domain configuration. This value must be unique to a region. (pattern: <code>[\w.:-]+</code>)
service_type	string	The type of service delivered by the endpoint. (DATA, CREDENTIAL_PROVIDER, JOBS)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_domain_configuration	select	domain_configuration_name, region		Gets summary information about a domain configuration. Requires permission to access the DescribeDomainConfiguration action.
list_domain_configurations	select	region	marker, pageSize, serviceType	Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name. Requires permission to access the ListDomainConfigurations action.
create_domain_configuration	insert	domain_configuration_name, region		Creates a domain configuration. Requires permission to access the CreateDomainConfiguration action.
update_domain_configuration	update	domain_configuration_name, region		Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated. Requires permission to access the UpdateDomainConfiguration action.
delete_domain_configuration	delete	domain_configuration_name, region		Deletes the specified domain configuration. Requires permission to access the DeleteDomainConfiguration action.

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
domain_configuration_name	string	The name of the domain configuration to be deleted.
region	string	AWS region (default: us-east-1)
marker	string	The marker for the next set of results.
pageSize	integer	The result page size.
serviceType	string	The type of service delivered by the endpoint.

SELECT examples

describe_domain_configuration

Gets summary information about a domain configuration. Requires permission to access the DescribeDomainConfiguration action.

SELECT
application_protocol,
authentication_type,
authorizer_config,
client_certificate_config,
domain_configuration_arn,
domain_configuration_name,
domain_configuration_status,
domain_name,
domain_type,
last_status_change_date,
server_certificate_config,
server_certificates,
service_type,
tls_config
FROM aws.iot.domain_configurations
WHERE domain_configuration_name = '{{ domain_configuration_name }}' -- required
AND region = '{{ region }}' -- required
;

list_domain_configurations

Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name. Requires permission to access the ListDomainConfigurations action.

SELECT
domain_configuration_arn,
domain_configuration_name,
service_type
FROM aws.iot.domain_configurations
WHERE region = '{{ region }}' -- required
AND marker = '{{ marker }}'
AND pageSize = '{{ pageSize }}'
AND serviceType = '{{ serviceType }}'
;

INSERT examples

create_domain_configuration

Creates a domain configuration. Requires permission to access the CreateDomainConfiguration action.

INSERT INTO aws.iot.domain_configurations (
domainName,
serverCertificateArns,
validationCertificateArn,
authorizerConfig,
serviceType,
tags,
tlsConfig,
serverCertificateConfig,
authenticationType,
applicationProtocol,
clientCertificateConfig,
domain_configuration_name,
region
)
SELECT 
'{{ domainName }}',
'{{ serverCertificateArns }}',
'{{ validationCertificateArn }}',
'{{ authorizerConfig }}',
'{{ serviceType }}',
'{{ tags }}',
'{{ tlsConfig }}',
'{{ serverCertificateConfig }}',
'{{ authenticationType }}',
'{{ applicationProtocol }}',
'{{ clientCertificateConfig }}',
'{{ domain_configuration_name }}',
'{{ region }}'
RETURNING
domain_configuration_arn,
domain_configuration_name
;

Manifest

# Description fields are for documentation purposes
- name: domain_configurations
props:
  - name: domain_configuration_name
    value: "{{ domain_configuration_name }}"
    description: Required parameter for the domain_configurations resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the domain_configurations resource.
  - name: domainName
    value: "{{ domainName }}"
  - name: serverCertificateArns
    value:
      - "{{ serverCertificateArns }}"
  - name: validationCertificateArn
    value: "{{ validationCertificateArn }}"
  - name: authorizerConfig
    description: |
      An object that specifies the authorization service for a domain.
    value:
      defaultAuthorizerName: "{{ defaultAuthorizerName }}"
      allowAuthorizerOverride: {{ allowAuthorizerOverride }}
  - name: serviceType
    value: "{{ serviceType }}"
    valid_values: ['DATA', 'CREDENTIAL_PROVIDER', 'JOBS']
  - name: tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: tlsConfig
    description: |
      An object that specifies the TLS configuration for a domain.
    value:
      securityPolicy: "{{ securityPolicy }}"
  - name: serverCertificateConfig
    description: |
      The server certificate configuration.
    value:
      enableOCSPCheck: {{ enableOCSPCheck }}
      ocspLambdaArn: "{{ ocspLambdaArn }}"
      ocspAuthorizedResponderArn: "{{ ocspAuthorizedResponderArn }}"
  - name: authenticationType
    value: "{{ authenticationType }}"
    valid_values: ['CUSTOM_AUTH_X509', 'CUSTOM_AUTH', 'AWS_X509', 'AWS_SIGV4', 'DEFAULT']
  - name: applicationProtocol
    value: "{{ applicationProtocol }}"
    valid_values: ['SECURE_MQTT', 'MQTT_WSS', 'HTTPS', 'DEFAULT']
  - name: clientCertificateConfig
    description: |
      An object that specifies the client certificate configuration for a domain.
    value:
      clientCertificateCallbackArn: "{{ clientCertificateCallbackArn }}"

UPDATE examples

update_domain_configuration

Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated. Requires permission to access the UpdateDomainConfiguration action.

UPDATE aws.iot.domain_configurations
SET 
authorizerConfig = '{{ authorizerConfig }}',
domainConfigurationStatus = '{{ domainConfigurationStatus }}',
removeAuthorizerConfig = {{ removeAuthorizerConfig }},
tlsConfig = '{{ tlsConfig }}',
serverCertificateConfig = '{{ serverCertificateConfig }}',
authenticationType = '{{ authenticationType }}',
applicationProtocol = '{{ applicationProtocol }}',
clientCertificateConfig = '{{ clientCertificateConfig }}'
WHERE 
domain_configuration_name = '{{ domain_configuration_name }}' --required
AND region = '{{ region }}' --required
RETURNING
domain_configuration_arn,
domain_configuration_name;

DELETE examples

delete_domain_configuration

Deletes the specified domain configuration. Requires permission to access the DeleteDomainConfiguration action.

DELETE FROM aws.iot.domain_configurations
WHERE domain_configuration_name = '{{ domain_configuration_name }}' --required
AND region = '{{ region }}' --required
;