resolver_configs

Creates, updates, deletes or gets a resolver_config resource or lists resolver_configs in a region

Overview

Name	resolver_configs
Type	Resource
Description	Resource schema for AWS::Route53Resolver::ResolverConfig.
Id	awscc.route53resolver.resolver_configs

Fields

get (all properties)

Name	Datatype	Description
id	string	Id
owner_id	string	AccountId
resource_id	string	ResourceId
autodefined_reverse	string	ResolverAutodefinedReverseStatus, possible values are ENABLING, ENABLED, DISABLING AND DISABLED.
autodefined_reverse_flag	string	Represents the desired status of AutodefinedReverse. The only supported value on creation is DISABLE. Deletion of this resource will return AutodefinedReverse to its default value (ENABLED).
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string	Id
resource_id	string	ResourceId
region	string	AWS region.

For more information, see AWS::Route53Resolver::ResolverConfig.

Methods

Name	Resource	Accessible by	Required Params
create_resource	resolver_configs	INSERT	ResourceId, AutodefinedReverseFlag, region
delete_resource	resolver_configs	DELETE	Identifier, region
list_resources	resolver_configs_list_only	SELECT	region
get_resource	resolver_configs	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual resolver_config.

SELECT
  region,
  id,
  owner_id,
  resource_id,
  autodefined_reverse,
  autodefined_reverse_flag
FROM awscc.route53resolver.resolver_configs
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ resource_id }}';

list (identifiers only)

Lists all resolver_configs in a region.

SELECT
  region,
  resource_id
FROM awscc.route53resolver.resolver_configs_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.route53resolver.resolver_configs (
  ResourceId,
  AutodefinedReverseFlag,
  region
)
SELECT
  '{{ resource_id }}',
  '{{ autodefined_reverse_flag }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.route53resolver.resolver_configs (
  ResourceId,
  AutodefinedReverseFlag,
  region
)
SELECT
  '{{ resource_id }}',
  '{{ autodefined_reverse_flag }}',
  '{{ 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: resolver_config
  props:
    - name: resource_id
      value: '{{ resource_id }}'
    - name: autodefined_reverse_flag
      value: '{{ autodefined_reverse_flag }}'

DELETE example

/*+ delete */
DELETE FROM awscc.route53resolver.resolver_configs
WHERE
  Identifier = '{{ resource_id }}' 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 resolver_configs resource, the following permissions are required:

Create

route53resolver:UpdateResolverConfig,
route53resolver:GetResolverConfig,
ec2:DescribeVpcs

Read

route53resolver:GetResolverConfig,
ec2:DescribeVpcs

Delete

route53resolver:UpdateResolverConfig,
route53resolver:ListResolverConfigs,
ec2:DescribeVpcs

List

route53resolver:ListResolverConfigs,
ec2:DescribeVpcs