domain_configurations

Creates, updates, deletes or gets a domain_configuration resource or lists domain_configurations in a region

Overview

Name	domain_configurations
Type	Resource
Description	Create and manage a Domain Configuration
Id	aws.iot.domain_configurations

Fields

Name	Datatype	Description
domain_configuration_name	string
authorizer_config	object
domain_name	string
server_certificate_arns	array
service_type	string
validation_certificate_arn	string
arn	string
domain_configuration_status	string
domain_type	string
server_certificate_config	object
server_certificates	array
tls_config	object
tags	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all domain_configurations in a region.

SELECT
region,
domain_configuration_name,
authorizer_config,
domain_name,
server_certificate_arns,
service_type,
validation_certificate_arn,
arn,
domain_configuration_status,
domain_type,
server_certificate_config,
server_certificates,
tls_config,
tags
FROM aws.iot.domain_configurations
WHERE region = 'us-east-1';

Gets all properties from an individual domain_configuration.

SELECT
region,
domain_configuration_name,
authorizer_config,
domain_name,
server_certificate_arns,
service_type,
validation_certificate_arn,
arn,
domain_configuration_status,
domain_type,
server_certificate_config,
server_certificates,
tls_config,
tags
FROM aws.iot.domain_configurations
WHERE region = 'us-east-1' AND data__Identifier = '<DomainConfigurationName>';

INSERT example

Use the following StackQL query and manifest file to create a new domain_configuration resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.iot.domain_configurations (
 ,
 region
)
SELECT 
'{{  }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.iot.domain_configurations (
 DomainConfigurationName,
 AuthorizerConfig,
 DomainName,
 ServerCertificateArns,
 ServiceType,
 ValidationCertificateArn,
 DomainConfigurationStatus,
 ServerCertificateConfig,
 TlsConfig,
 Tags,
 region
)
SELECT 
 '{{ DomainConfigurationName }}',
 '{{ AuthorizerConfig }}',
 '{{ DomainName }}',
 '{{ ServerCertificateArns }}',
 '{{ ServiceType }}',
 '{{ ValidationCertificateArn }}',
 '{{ DomainConfigurationStatus }}',
 '{{ ServerCertificateConfig }}',
 '{{ TlsConfig }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: domain_configuration
    props:
      - name: DomainConfigurationName
        value: '{{ DomainConfigurationName }}'
      - name: AuthorizerConfig
        value:
          AllowAuthorizerOverride: '{{ AllowAuthorizerOverride }}'
          DefaultAuthorizerName: '{{ DefaultAuthorizerName }}'
      - name: DomainName
        value: '{{ DomainName }}'
      - name: ServerCertificateArns
        value:
          - '{{ ServerCertificateArns[0] }}'
      - name: ServiceType
        value: '{{ ServiceType }}'
      - name: ValidationCertificateArn
        value: '{{ ValidationCertificateArn }}'
      - name: DomainConfigurationStatus
        value: '{{ DomainConfigurationStatus }}'
      - name: ServerCertificateConfig
        value:
          EnableOCSPCheck: '{{ EnableOCSPCheck }}'
      - name: TlsConfig
        value:
          SecurityPolicy: '{{ SecurityPolicy }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.iot.domain_configurations
WHERE data__Identifier = '<DomainConfigurationName>'
AND region = 'us-east-1';

Permissions

To operate on the domain_configurations resource, the following permissions are required:

Create

iot:CreateDomainConfiguration,
iot:UpdateDomainConfiguration,
iot:DescribeDomainConfiguration,
iot:TagResource,
iot:ListTagsForResource,
acm:GetCertificate

Read

iot:DescribeDomainConfiguration,
iot:ListTagsForResource

Update

iot:UpdateDomainConfiguration,
iot:DescribeDomainConfiguration,
iot:ListTagsForResource,
iot:TagResource,
iot:UntagResource

Delete

iot:DescribeDomainConfiguration,
iot:DeleteDomainConfiguration,
iot:UpdateDomainConfiguration

List

iot:ListDomainConfigurations