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	awscc.iot.domain_configurations

Fields

get (all properties)

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
authentication_type	string
application_protocol	string
▶client_certificate_config	object
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
domain_configuration_name	string
region	string	AWS region.

For more information, see AWS::IoT::DomainConfiguration.

Methods

Name	Resource	Accessible by	Required Params
create_resource	domain_configurations	INSERT	, region
delete_resource	domain_configurations	DELETE	Identifier, region
update_resource	domain_configurations	UPDATE	Identifier, PatchDocument, region
list_resources	domain_configurations_list_only	SELECT	region
get_resource	domain_configurations	SELECT	Identifier, region

SELECT examples

get (all properties)

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,
  authentication_type,
  application_protocol,
  client_certificate_config,
  tags
FROM awscc.iot.domain_configurations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ domain_configuration_name }}';

list (identifiers only)

Lists all domain_configurations in a region.

SELECT
  region,
  domain_configuration_name
FROM awscc.iot.domain_configurations_list_only
WHERE
  region = '{{ region }}';

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 awscc.iot.domain_configurations (
  ,
  region
)
SELECT
  '{{  }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.iot.domain_configurations (
  DomainConfigurationName,
  AuthorizerConfig,
  DomainName,
  ServerCertificateArns,
  ServiceType,
  ValidationCertificateArn,
  DomainConfigurationStatus,
  ServerCertificateConfig,
  TlsConfig,
  AuthenticationType,
  ApplicationProtocol,
  ClientCertificateConfig,
  Tags,
  region
)
SELECT
  '{{ domain_configuration_name }}',
  '{{ authorizer_config }}',
  '{{ domain_name }}',
  '{{ server_certificate_arns }}',
  '{{ service_type }}',
  '{{ validation_certificate_arn }}',
  '{{ domain_configuration_status }}',
  '{{ server_certificate_config }}',
  '{{ tls_config }}',
  '{{ authentication_type }}',
  '{{ application_protocol }}',
  '{{ client_certificate_config }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: domain_configuration
  props:
    - name: domain_configuration_name
      value: '{{ domain_configuration_name }}'
    - name: authorizer_config
      value:
        allow_authorizer_override: '{{ allow_authorizer_override }}'
        default_authorizer_name: '{{ default_authorizer_name }}'
    - name: domain_name
      value: '{{ domain_name }}'
    - name: server_certificate_arns
      value:
        - '{{ server_certificate_arns[0] }}'
    - name: service_type
      value: '{{ service_type }}'
    - name: validation_certificate_arn
      value: '{{ validation_certificate_arn }}'
    - name: domain_configuration_status
      value: '{{ domain_configuration_status }}'
    - name: server_certificate_config
      value:
        enable_oc_sp_check: '{{ enable_oc_sp_check }}'
        ocsp_lambda_arn: '{{ ocsp_lambda_arn }}'
        ocsp_authorized_responder_arn: '{{ ocsp_authorized_responder_arn }}'
    - name: tls_config
      value:
        security_policy: '{{ security_policy }}'
    - name: authentication_type
      value: '{{ authentication_type }}'
    - name: application_protocol
      value: '{{ application_protocol }}'
    - name: client_certificate_config
      value:
        client_certificate_callback_arn: '{{ client_certificate_callback_arn }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.iot.domain_configurations
SET PatchDocument = string('{{ {
    "AuthorizerConfig": authorizer_config,
    "DomainConfigurationStatus": domain_configuration_status,
    "ServerCertificateConfig": server_certificate_config,
    "TlsConfig": tls_config,
    "AuthenticationType": authentication_type,
    "ApplicationProtocol": application_protocol,
    "ClientCertificateConfig": client_certificate_config,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ domain_configuration_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.iot.domain_configurations
WHERE
  Identifier = '{{ domain_configuration_name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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,
kms:Decrypt

Read

iot:DescribeDomainConfiguration,
iot:ListTagsForResource,
kms:Decrypt

Update

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

Delete

iot:DescribeDomainConfiguration,
iot:DeleteDomainConfiguration,
iot:UpdateDomainConfiguration,
kms:Decrypt

List

iot:ListDomainConfigurations