outpost_resolvers

Creates, updates, deletes or gets an outpost_resolver resource or lists outpost_resolvers in a region

Overview

Name	outpost_resolvers
Type	Resource
Description	Resource schema for AWS::Route53Resolver::OutpostResolver.
Id	awscc.route53resolver.outpost_resolvers

Fields

get (all properties)

Name	Datatype	Description
id	string	Id
creator_request_id	string	The id of the creator request.
name	string	The OutpostResolver name.
arn	string	The OutpostResolver ARN.
outpost_arn	string	The Outpost ARN.
preferred_instance_type	string	The OutpostResolver instance type.
status	string	The OutpostResolver status, possible values are CREATING, OPERATIONAL, UPDATING, DELETING, ACTION_NEEDED, FAILED_CREATION and FAILED_DELETION.
status_message	string	The OutpostResolver status message.
instance_count	integer	The number of OutpostResolvers.
creation_time	string	The OutpostResolver creation time
modification_time	string	The OutpostResolver last modified time
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string	Id
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	outpost_resolvers	INSERT	OutpostArn, PreferredInstanceType, Name, region
delete_resource	outpost_resolvers	DELETE	Identifier, region
update_resource	outpost_resolvers	UPDATE	Identifier, PatchDocument, region
list_resources	outpost_resolvers_list_only	SELECT	region
get_resource	outpost_resolvers	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual outpost_resolver.

SELECT
  region,
  id,
  creator_request_id,
  name,
  arn,
  outpost_arn,
  preferred_instance_type,
  status,
  status_message,
  instance_count,
  creation_time,
  modification_time,
  tags
FROM awscc.route53resolver.outpost_resolvers
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all outpost_resolvers in a region.

SELECT
  region,
  id
FROM awscc.route53resolver.outpost_resolvers_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.route53resolver.outpost_resolvers (
  Name,
  OutpostArn,
  PreferredInstanceType,
  region
)
SELECT
  '{{ name }}',
  '{{ outpost_arn }}',
  '{{ preferred_instance_type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.route53resolver.outpost_resolvers (
  Name,
  OutpostArn,
  PreferredInstanceType,
  InstanceCount,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ outpost_arn }}',
  '{{ preferred_instance_type }}',
  '{{ instance_count }}',
  '{{ 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: outpost_resolver
  props:
    - name: name
      value: '{{ name }}'
    - name: outpost_arn
      value: '{{ outpost_arn }}'
    - name: preferred_instance_type
      value: '{{ preferred_instance_type }}'
    - name: instance_count
      value: '{{ instance_count }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.route53resolver.outpost_resolvers
SET PatchDocument = string('{{ {
    "Name": name,
    "PreferredInstanceType": preferred_instance_type,
    "InstanceCount": instance_count,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

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

Create

route53resolver:CreateOutpostResolver,
route53resolver:GetOutpostResolver,
route53resolver:ListOutpostResolvers,
route53resolver:ListTagsForResource,
outposts:GetOutpost,
route53resolver:TagResource

Read

route53resolver:GetOutpostResolver,
route53resolver:ListTagsForResource

Update

route53resolver:UpdateOutpostResolver,
route53resolver:GetOutpostResolver,
route53resolver:UntagResource,
route53resolver:TagResource,
route53resolver:ListTagsForResource

Delete

route53resolver:DeleteOutpostResolver,
route53resolver:GetOutpostResolver,
route53resolver:ListOutpostResolvers,
route53resolver:ListResolverEndpoints

List

route53resolver:ListOutpostResolvers,
route53resolver:ListTagsForResource