outpost_resolvers

Creates, updates, deletes, gets or lists an outpost_resolvers resource.

Overview

Name	outpost_resolvers
Type	Resource
Id	aws.route53resolver.outpost_resolvers

Fields

The following fields are returned by SELECT queries:

get_outpost_resolver

Name	Datatype	Description
arn	string	The ARN (Amazon Resource Name) for the Resolver on an Outpost.
creation_time	string	The date and time that the Outpost Resolver was created, in Unix time format and Coordinated Universal Time (UTC).
creator_request_id	string	A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice.
id	string	The ID of the Resolver on Outpost.
instance_count	integer	Amazon EC2 instance count for the Resolver on the Outpost.
modification_time	string	The date and time that the Outpost Resolver was modified, in Unix time format and Coordinated Universal Time (UTC).
name	string	Name of the Resolver.
outpost_arn	string	The ARN (Amazon Resource Name) for the Outpost. (pattern: <code>^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/op-[a-f0-9]{17}$</code>)
preferred_instance_type	string	The Amazon EC2 instance type.
status	string	Status of the Resolver. (CREATING, OPERATIONAL, UPDATING, DELETING, ACTION_NEEDED, FAILED_CREATION, FAILED_DELETION)
status_message	string	A detailed description of the Resolver.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_outpost_resolver	select	region		Gets information about a specified Resolver on the Outpost, such as its instance count and type, name, and the current status of the Resolver.
create_outpost_resolver	insert	region, CreatorRequestId, PreferredInstanceType, OutpostArn		Creates a Route 53 Resolver on an Outpost.
update_outpost_resolver	update	region		You can use UpdateOutpostResolver to update the instance count, type, or name of a Resolver on an Outpost.
delete_outpost_resolver	delete	region		Deletes a Resolver on the Outpost.
list_outpost_resolvers	exec	region		Lists all the Resolvers on Outposts that were created using the current Amazon Web Services account.

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
region	string	AWS region (default: us-east-1)

SELECT examples

get_outpost_resolver

Gets information about a specified Resolver on the Outpost, such as its instance count and type, name, and the current status of the Resolver.

SELECT
arn,
creation_time,
creator_request_id,
id,
instance_count,
modification_time,
name,
outpost_arn,
preferred_instance_type,
status,
status_message
FROM aws.route53resolver.outpost_resolvers
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_outpost_resolver

Creates a Route 53 Resolver on an Outpost.

INSERT INTO aws.route53resolver.outpost_resolvers (
CreatorRequestId,
Name,
InstanceCount,
PreferredInstanceType,
OutpostArn,
Tags,
region
)
SELECT 
'{{ CreatorRequestId }}' /* required */,
'{{ Name }}',
{{ InstanceCount }},
'{{ PreferredInstanceType }}' /* required */,
'{{ OutpostArn }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
outpost_resolver
;

Manifest

# Description fields are for documentation purposes
- name: outpost_resolvers
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the outpost_resolvers resource.
  - name: CreatorRequestId
    value: "{{ CreatorRequestId }}"
    description: |
      A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.
  - name: Name
    value: "{{ Name }}"
    description: |
      A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.
  - name: InstanceCount
    value: {{ InstanceCount }}
    description: |
      Number of Amazon EC2 instances for the Resolver on Outpost. The default and minimal value is 4.
  - name: PreferredInstanceType
    value: "{{ PreferredInstanceType }}"
    description: |
      The Amazon EC2 instance type. If you specify this, you must also specify a value for the OutpostArn.
  - name: OutpostArn
    value: "{{ OutpostArn }}"
    description: |
      The Amazon Resource Name (ARN) of the Outpost. If you specify this, you must also specify a value for the PreferredInstanceType.
  - name: Tags
    description: |
      A string that helps identify the Route 53 Resolvers on Outpost.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_outpost_resolver

You can use UpdateOutpostResolver to update the instance count, type, or name of a Resolver on an Outpost.

UPDATE aws.route53resolver.outpost_resolvers
SET 
Id = '{{ Id }}',
Name = '{{ Name }}',
InstanceCount = {{ InstanceCount }},
PreferredInstanceType = '{{ PreferredInstanceType }}'
WHERE 
region = '{{ region }}' --required
RETURNING
outpost_resolver;

DELETE examples

delete_outpost_resolver

Deletes a Resolver on the Outpost.

DELETE FROM aws.route53resolver.outpost_resolvers
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

list_outpost_resolvers

Lists all the Resolvers on Outposts that were created using the current Amazon Web Services account.

EXEC aws.route53resolver.outpost_resolvers.list_outpost_resolvers 
@region='{{ region }}' --required 
@@json=
'{
"OutpostArn": "{{ OutpostArn }}", 
"MaxResults": {{ MaxResults }}, 
"NextToken": "{{ NextToken }}"
}'
;