String creatorRequestId
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.
String firewallRuleGroupId
The unique identifier of the firewall rule group.
String vpcId
The unique identifier of the VPC that you want to associate with the rule group.
Integer priority
The setting that determines the processing order of the rule group among the rule groups that you associate with the specified VPC. DNS Firewall filters VPC traffic starting from the rule group with the lowest numeric priority setting.
You must specify a unique priority for each rule group that you associate with a single VPC. To make it easier to insert rule groups later, leave space between the numbers, for example, use 101, 200, and so on. You can change the priority setting for a rule group association after you create it.
The allowed values for Priority are between 100 and 9900.
String name
A name that lets you identify the association, to manage and use it.
String mutationProtection
If enabled, this setting disallows modification or removal of the association, to help prevent against
accidentally altering DNS firewall protections. When you create the association, the default setting is
DISABLED.
List<E> tags
A list of the tag keys and values that you want to associate with the rule group association.
FirewallRuleGroupAssociation firewallRuleGroupAssociation
The association that you just created. The association has an ID that you can use to identify it in other requests, like update and delete.
String resolverEndpointId
The ID of the Resolver endpoint that you want to associate IP addresses with.
IpAddressUpdate ipAddress
Either the IPv4 address that you want to add to a Resolver endpoint or a subnet ID. If you specify a subnet ID, Resolver chooses an IP address for you from the available IPs in the specified subnet.
ResolverEndpoint resolverEndpoint
The response to an AssociateResolverEndpointIpAddress request.
String resolverQueryLogConfigId
The ID of the query logging configuration that you want to associate a VPC with.
String resourceId
The ID of an Amazon VPC that you want this query logging configuration to log queries for.
The VPCs and the query logging configuration must be in the same Region.
ResolverQueryLogConfigAssociation resolverQueryLogConfigAssociation
A complex type that contains settings for a specified association between an Amazon VPC and a query logging configuration.
String resolverRuleId
The ID of the Resolver rule that you want to associate with the VPC. To list the existing Resolver rules, use ListResolverRules.
String name
A name for the association that you're creating between a Resolver rule and a VPC.
String vPCId
The ID of the VPC that you want to associate the Resolver rule with.
ResolverRuleAssociation resolverRuleAssociation
Information about the AssociateResolverRule request, including the status of the request.
String creatorRequestId
A unique string that identifies the request and that allows you to retry failed requests without the risk of
running the operation twice. CreatorRequestId can be any unique string, for example, a date/time
stamp.
String name
A name that lets you identify the domain list to manage and use it.
List<E> tags
A list of the tag keys and values that you want to associate with the domain list.
FirewallDomainList firewallDomainList
The domain list that you just created.
String creatorRequestId
A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.
String name
A name that lets you identify the rule group, to manage and use it.
List<E> tags
A list of the tag keys and values that you want to associate with the rule group.
FirewallRuleGroup firewallRuleGroup
A collection of rules used to filter DNS network traffic.
String creatorRequestId
A unique string that identifies the request and that allows you to retry failed requests without the risk of
running the operation twice. CreatorRequestId can be any unique string, for example, a date/time
stamp.
String firewallRuleGroupId
The unique identifier of the firewall rule group where you want to create the rule.
String firewallDomainListId
The ID of the domain list that you want to use in the rule.
Integer priority
The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.
You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time.
String action
The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:
ALLOW - Permit the request to go through.
ALERT - Permit the request and send metrics and logs to Cloud Watch.
BLOCK - Disallow the request. This option requires additional details in the rule's
BlockResponse.
String blockResponse
The way that you want DNS Firewall to block the request, used with the rule action setting BLOCK.
NODATA - Respond indicating that the query was successful, but no response is available for it.
NXDOMAIN - Respond indicating that the domain name that's in the query doesn't exist.
OVERRIDE - Provide a custom override in the response. This option requires custom handling details
in the rule's BlockOverride* settings.
This setting is required if the rule action setting is BLOCK.
String blockOverrideDomain
The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a
BlockResponse setting of OVERRIDE.
This setting is required if the BlockResponse setting is OVERRIDE.
String blockOverrideDnsType
The DNS record's type. This determines the format of the record value that you provided in
BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse
setting of OVERRIDE.
This setting is required if the BlockResponse setting is OVERRIDE.
Integer blockOverrideTtl
The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override
record. Used for the rule action BLOCK with a BlockResponse setting of
OVERRIDE.
This setting is required if the BlockResponse setting is OVERRIDE.
String name
A name that lets you identify the rule in the rule group.
String firewallDomainRedirectionAction
How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.
Inspect_Redirection_Domain (Default) inspects all domains in the redirection chain. The individual
domains in the redirection chain must be added to the domain list.
Trust_Redirection_Domain inspects only the first domain in the redirection chain. You don't need to
add the subsequent domains in the domain in the redirection list to the domain list.
String qtype
The DNS query type you want the rule to evaluate. Allowed values are;
A: Returns an IPv4 address.
AAAA: Returns an Ipv6 address.
CAA: Restricts CAs that can create SSL/TLS certifications for the domain.
CNAME: Returns another domain name.
DS: Record that identifies the DNSSEC signing key of a delegated zone.
MX: Specifies mail servers.
NAPTR: Regular-expression-based rewriting of domain names.
NS: Authoritative name servers.
PTR: Maps an IP address to a domain name.
SOA: Start of authority record for the zone.
SPF: Lists the servers authorized to send emails from a domain.
SRV: Application specific values that identify servers.
TXT: Verifies email senders and application-specific values.
A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65334, for example, TYPE28. For more information, see List of DNS record types.
FirewallRule firewallRule
The firewall rule that you just created.
String creatorRequestId
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.
String name
A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.
Integer instanceCount
Number of Amazon EC2 instances for the Resolver on Outpost. The default and minimal value is 4.
String preferredInstanceType
The Amazon EC2 instance type. If you specify this, you must also specify a value for the OutpostArn.
String outpostArn
The Amazon Resource Name (ARN) of the Outpost. If you specify this, you must also specify a value for the
PreferredInstanceType.
List<E> tags
A string that helps identify the Route 53 Resolvers on Outpost.
OutpostResolver outpostResolver
Information about the CreateOutpostResolver request, including the status of the request.
String creatorRequestId
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.
String name
A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.
List<E> securityGroupIds
The ID of one or more security groups that you want to use to control access to this VPC. The security group that you specify must include one or more inbound rules (for inbound Resolver endpoints) or outbound rules (for outbound Resolver endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.
Some security group rules will cause your connection to be tracked. For outbound resolver endpoint, it can potentially impact the maximum queries per second from outbound endpoint to your target name server. For inbound resolver endpoint, it can bring down the overall maximum queries per second per IP address to as low as 1500. To avoid connection tracking caused by security group, see Untracked connections.
String direction
Specify the applicable value:
INBOUND: Resolver forwards DNS queries to the DNS service for a VPC from your network
OUTBOUND: Resolver forwards DNS queries from the DNS service for a VPC to your network
List<E> ipAddresses
The subnets and IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints). The subnet ID uniquely identifies a VPC.
Even though the minimum is 1, Route 53 requires that you create at least two.
String outpostArn
The Amazon Resource Name (ARN) of the Outpost. If you specify this, you must also specify a value for the
PreferredInstanceType.
String preferredInstanceType
The instance type. If you specify this, you must also specify a value for the OutpostArn.
List<E> tags
A list of the tag keys and values that you want to associate with the endpoint.
String resolverEndpointType
For the endpoint type you can choose either IPv4, IPv6, or dual-stack. A dual-stack endpoint means that it will resolve via both IPv4 and IPv6. This endpoint type is applied to all IP addresses.
List<E> protocols
The protocols you want to use for the endpoint. DoH-FIPS is applicable for inbound endpoints only.
For an inbound endpoint you can apply the protocols as follows:
Do53 and DoH in combination.
Do53 and DoH-FIPS in combination.
Do53 alone.
DoH alone.
DoH-FIPS alone.
None, which is treated as Do53.
For an outbound endpoint you can apply the protocols as follows:
Do53 and DoH in combination.
Do53 alone.
DoH alone.
None, which is treated as Do53.
ResolverEndpoint resolverEndpoint
Information about the CreateResolverEndpoint request, including the status of the request.
String name
The name that you want to give the query logging configuration.
String destinationArn
The ARN of the resource that you want Resolver to send query logs. You can send query logs to an S3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream. Examples of valid values include the following:
S3 bucket:
arn:aws:s3:::examplebucket
You can optionally append a file prefix to the end of the ARN.
arn:aws:s3:::examplebucket/development/
CloudWatch Logs log group:
arn:aws:logs:us-west-1:123456789012:log-group:/mystack-testgroup-12ABC1AB12A1:*
Kinesis Data Firehose delivery stream:
arn:aws:kinesis:us-east-2:0123456789:stream/my_stream_name
String creatorRequestId
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.
List<E> tags
A list of the tag keys and values that you want to associate with the query logging configuration.
ResolverQueryLogConfig resolverQueryLogConfig
Information about the CreateResolverQueryLogConfig request, including the status of the request.
String creatorRequestId
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.
String name
A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
String ruleType
When you want to forward DNS queries for specified domain name to resolvers on your network, specify
FORWARD.
When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to
process queries for a subdomain of that domain, specify SYSTEM.
For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify
FORWARD for RuleType. To then have Resolver process queries for apex.example.com, you
create a rule and specify SYSTEM for RuleType.
Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType.
String domainName
DNS queries for this domain name are forwarded to the IP addresses that you specify in TargetIps. If
a query matches multiple Resolver rules (example.com and www.example.com), outbound DNS queries are routed using
the Resolver rule that contains the most specific domain name (www.example.com).
List<E> targetIps
The IPs that you want Resolver to forward DNS queries to. You can specify either Ipv4 or Ipv6 addresses but not both in the same rule. Separate IP addresses with a space.
TargetIps is available only when the value of Rule type is FORWARD.
String resolverEndpointId
The ID of the outbound Resolver endpoint that you want to use to route DNS queries to the IP addresses that you
specify in TargetIps.
List<E> tags
A list of the tag keys and values that you want to associate with the endpoint.
ResolverRule resolverRule
Information about the CreateResolverRule request, including the status of the request.
String firewallDomainListId
The ID of the domain list that you want to delete.
FirewallDomainList firewallDomainList
The domain list that you just deleted.
String firewallRuleGroupId
The unique identifier of the firewall rule group that you want to delete.
FirewallRuleGroup firewallRuleGroup
A collection of rules used to filter DNS network traffic.
String firewallRuleGroupId
The unique identifier of the firewall rule group that you want to delete the rule from.
String firewallDomainListId
The ID of the domain list that's used in the rule.
String qtype
The DNS query type that the rule you are deleting evaluates. Allowed values are;
A: Returns an IPv4 address.
AAAA: Returns an Ipv6 address.
CAA: Restricts CAs that can create SSL/TLS certifications for the domain.
CNAME: Returns another domain name.
DS: Record that identifies the DNSSEC signing key of a delegated zone.
MX: Specifies mail servers.
NAPTR: Regular-expression-based rewriting of domain names.
NS: Authoritative name servers.
PTR: Maps an IP address to a domain name.
SOA: Start of authority record for the zone.
SPF: Lists the servers authorized to send emails from a domain.
SRV: Application specific values that identify servers.
TXT: Verifies email senders and application-specific values.
A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65334, for example, TYPE28. For more information, see List of DNS record types.
FirewallRule firewallRule
The specification for the firewall rule that you just deleted.
String id
A unique string that identifies the Resolver on the Outpost.
OutpostResolver outpostResolver
Information about the DeleteOutpostResolver request, including the status of the request.
String resolverEndpointId
The ID of the Resolver endpoint that you want to delete.
ResolverEndpoint resolverEndpoint
Information about the DeleteResolverEndpoint request, including the status of the request.
String resolverQueryLogConfigId
The ID of the query logging configuration that you want to delete.
ResolverQueryLogConfig resolverQueryLogConfig
Information about the query logging configuration that you deleted, including the status of the request.
String resolverRuleId
The ID of the Resolver rule that you want to delete.
ResolverRule resolverRule
Information about the DeleteResolverRule request, including the status of the request.
String firewallRuleGroupAssociationId
The identifier of the FirewallRuleGroupAssociation.
FirewallRuleGroupAssociation firewallRuleGroupAssociation
The firewall rule group association that you just removed.
String resolverEndpointId
The ID of the Resolver endpoint that you want to disassociate an IP address from.
IpAddressUpdate ipAddress
The IPv4 address that you want to remove from a Resolver endpoint.
ResolverEndpoint resolverEndpoint
The response to an DisassociateResolverEndpointIpAddress request.
ResolverQueryLogConfigAssociation resolverQueryLogConfigAssociation
A complex type that contains settings for the association that you deleted between an Amazon VPC and a query logging configuration.
ResolverRuleAssociation resolverRuleAssociation
Information about the DisassociateResolverRule request, including the status of the request.
String name
The name of the parameter that you want to use to filter objects.
The valid values for Name depend on the action that you're including the filter in, ListResolverEndpoints, ListResolverRules, ListResolverRuleAssociations, ListResolverQueryLogConfigs, or ListResolverQueryLogConfigAssociations.
In early versions of Resolver, values for Name were listed as uppercase, with underscore (_)
delimiters. For example, CreatorRequestId was originally listed as CREATOR_REQUEST_ID.
Uppercase values for Name are still supported.
ListResolverEndpoints
Valid values for Name include the following:
CreatorRequestId: The value that you specified when you created the Resolver endpoint.
Direction: Whether you want to return inbound or outbound Resolver endpoints. If you specify
DIRECTION for Name, specify INBOUND or OUTBOUND for
Values.
HostVPCId: The ID of the VPC that inbound DNS queries pass through on the way from your network to
your VPCs in a region, or the VPC that outbound queries pass through on the way from your VPCs to your network.
In a CreateResolverEndpoint request, SubnetId indirectly identifies the VPC. In a GetResolverEndpoint request, the VPC ID for a Resolver endpoint is returned in the HostVPCId
element.
IpAddressCount: The number of IP addresses that you have associated with the Resolver endpoint.
Name: The name of the Resolver endpoint.
SecurityGroupIds: The IDs of the VPC security groups that you specified when you created the
Resolver endpoint.
Status: The status of the Resolver endpoint. If you specify Status for
Name, specify one of the following status codes for Values: CREATING,
OPERATIONAL, UPDATING, AUTO_RECOVERING, ACTION_NEEDED, or
DELETING. For more information, see Status in ResolverEndpoint.
ListResolverRules
Valid values for Name include the following:
CreatorRequestId: The value that you specified when you created the Resolver rule.
DomainName: The domain name for which Resolver is forwarding DNS queries to your network. In the
value that you specify for Values, include a trailing dot (.) after the domain name. For example, if
the domain name is example.com, specify the following value. Note the "." after com:
example.com.
Name: The name of the Resolver rule.
ResolverEndpointId: The ID of the Resolver endpoint that the Resolver rule is associated with.
You can filter on the Resolver endpoint only for rules that have a value of FORWARD for
RuleType.
Status: The status of the Resolver rule. If you specify Status for Name,
specify one of the following status codes for Values: COMPLETE, DELETING,
UPDATING, or FAILED.
Type: The type of the Resolver rule. If you specify TYPE for Name, specify
FORWARD or SYSTEM for Values.
ListResolverRuleAssociations
Valid values for Name include the following:
Name: The name of the Resolver rule association.
ResolverRuleId: The ID of the Resolver rule that is associated with one or more VPCs.
Status: The status of the Resolver rule association. If you specify Status for
Name, specify one of the following status codes for Values: CREATING,
COMPLETE, DELETING, or FAILED.
VPCId: The ID of the VPC that the Resolver rule is associated with.
ListResolverQueryLogConfigs
Valid values for Name include the following:
Arn: The ARN for the query logging configuration.
AssociationCount: The number of VPCs that are associated with the query logging configuration.
CreationTime: The date and time that the query logging configuration was created, in Unix time
format and Coordinated Universal Time (UTC).
CreatorRequestId: A unique string that identifies the request that created the query logging
configuration.
Destination: The Amazon Web Services service that you want to forward query logs to. Valid values
include the following:
S3
CloudWatchLogs
KinesisFirehose
DestinationArn: The ARN of the location that Resolver is sending query logs to. This value can be
the ARN for an S3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream.
Id: The ID of the query logging configuration
Name: The name of the query logging configuration
OwnerId: The Amazon Web Services account ID for the account that created the query logging
configuration.
ShareStatus: An indication of whether the query logging configuration is shared with other Amazon
Web Services accounts, or was shared with the current account by another Amazon Web Services account. Valid
values include: NOT_SHARED, SHARED_WITH_ME, or SHARED_BY_ME.
Status: The status of the query logging configuration. If you specify Status for
Name, specify the applicable status code for Values: CREATING,
CREATED, DELETING, or FAILED. For more information, see Status.
ListResolverQueryLogConfigAssociations
Valid values for Name include the following:
CreationTime: The date and time that the VPC was associated with the query logging configuration, in
Unix time format and Coordinated Universal Time (UTC).
Error: If the value of Status is FAILED, specify the cause:
DESTINATION_NOT_FOUND or ACCESS_DENIED.
Id: The ID of the query logging association.
ResolverQueryLogConfigId: The ID of the query logging configuration that a VPC is associated with.
ResourceId: The ID of the Amazon VPC that is associated with the query logging configuration.
Status: The status of the query logging association. If you specify Status for
Name, specify the applicable status code for Values: CREATING,
CREATED, DELETING, or FAILED. For more information, see Status.
List<E> values
When you're using a List operation and you want the operation to return a subset of objects, such as
Resolver endpoints or Resolver rules, the value of the parameter that you want to use to filter objects. For
example, to list only inbound Resolver endpoints, specify Direction for Name and
specify INBOUND for Values.
String id
The ID of the firewall configuration.
String resourceId
The ID of the VPC that this firewall configuration applies to.
String ownerId
The Amazon Web Services account ID of the owner of the VPC that this firewall configuration applies to.
String firewallFailOpen
Determines how DNS Firewall operates during failures, for example when all traffic that is sent to DNS Firewall fails to receive a reply.
By default, fail open is disabled, which means the failure mode is closed. This approach favors security over availability. DNS Firewall returns a failure error when it is unable to properly evaluate a query.
If you enable this option, the failure mode is open. This approach favors availability over security. DNS Firewall allows queries to proceed if it is unable to properly evaluate them.
This behavior is only enforced for VPCs that have at least one DNS Firewall rule group association.
String id
The ID of the domain list.
String arn
The Amazon Resource Name (ARN) of the firewall domain list.
String name
The name of the domain list.
Integer domainCount
The number of domain names that are specified in the domain list.
String status
The status of the domain list.
String statusMessage
Additional information about the status of the list, if available.
String managedOwnerName
The owner of the list, used only for lists that are not managed by you. For example, the managed domain list
AWSManagedDomainsMalwareDomainList has the managed owner name
Route 53 Resolver DNS Firewall.
String creatorRequestId
A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.
String creationTime
The date and time that the domain list was created, in Unix time format and Coordinated Universal Time (UTC).
String modificationTime
The date and time that the domain list was last modified, in Unix time format and Coordinated Universal Time (UTC).
String id
The ID of the domain list.
String arn
The Amazon Resource Name (ARN) of the firewall domain list metadata.
String name
The name of the domain list.
String creatorRequestId
A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.
String managedOwnerName
The owner of the list, used only for lists that are not managed by you. For example, the managed domain list
AWSManagedDomainsMalwareDomainList has the managed owner name
Route 53 Resolver DNS Firewall.
String firewallRuleGroupId
The unique identifier of the firewall rule group of the rule.
String firewallDomainListId
The ID of the domain list that's used in the rule.
String name
The name of the rule.
Integer priority
The priority of the rule in the rule group. This value must be unique within the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.
String action
The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:
ALLOW - Permit the request to go through.
ALERT - Permit the request to go through but send an alert to the logs.
BLOCK - Disallow the request. If this is specified, additional handling details are provided in the
rule's BlockResponse setting.
String blockResponse
The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK.
NODATA - Respond indicating that the query was successful, but no response is available for it.
NXDOMAIN - Respond indicating that the domain name that's in the query doesn't exist.
OVERRIDE - Provide a custom override in the response. This option requires custom handling details
in the rule's BlockOverride* settings.
String blockOverrideDomain
The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a
BlockResponse setting of OVERRIDE.
String blockOverrideDnsType
The DNS record's type. This determines the format of the record value that you provided in
BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse
setting of OVERRIDE.
Integer blockOverrideTtl
The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override
record. Used for the rule action BLOCK with a BlockResponse setting of
OVERRIDE.
String creatorRequestId
A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of executing the operation twice. This can be any unique string, for example, a timestamp.
String creationTime
The date and time that the rule was created, in Unix time format and Coordinated Universal Time (UTC).
String modificationTime
The date and time that the rule was last modified, in Unix time format and Coordinated Universal Time (UTC).
String firewallDomainRedirectionAction
How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.
Inspect_Redirection_Domain (Default) inspects all domains in the redirection chain. The individual
domains in the redirection chain must be added to the domain list.
Trust_Redirection_Domain inspects only the first domain in the redirection chain. You don't need to
add the subsequent domains in the domain in the redirection list to the domain list.
String qtype
The DNS query type you want the rule to evaluate. Allowed values are;
A: Returns an IPv4 address.
AAAA: Returns an Ipv6 address.
CAA: Restricts CAs that can create SSL/TLS certifications for the domain.
CNAME: Returns another domain name.
DS: Record that identifies the DNSSEC signing key of a delegated zone.
MX: Specifies mail servers.
NAPTR: Regular-expression-based rewriting of domain names.
NS: Authoritative name servers.
PTR: Maps an IP address to a domain name.
SOA: Start of authority record for the zone.
SPF: Lists the servers authorized to send emails from a domain.
SRV: Application specific values that identify servers.
TXT: Verifies email senders and application-specific values.
A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65334, for example, TYPE28. For more information, see List of DNS record types.
String id
The ID of the rule group.
String arn
The ARN (Amazon Resource Name) of the rule group.
String name
The name of the rule group.
Integer ruleCount
The number of rules in the rule group.
String status
The status of the domain list.
String statusMessage
Additional information about the status of the rule group, if available.
String ownerId
The Amazon Web Services account ID for the account that created the rule group. When a rule group is shared with your account, this is the account that has shared the rule group with you.
String creatorRequestId
A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.
String shareStatus
Whether the rule group is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).
String creationTime
The date and time that the rule group was created, in Unix time format and Coordinated Universal Time (UTC).
String modificationTime
The date and time that the rule group was last modified, in Unix time format and Coordinated Universal Time (UTC).
String id
The identifier for the association.
String arn
The Amazon Resource Name (ARN) of the firewall rule group association.
String firewallRuleGroupId
The unique identifier of the firewall rule group.
String vpcId
The unique identifier of the VPC that is associated with the rule group.
String name
The name of the association.
Integer priority
The setting that determines the processing order of the rule group among the rule groups that are associated with a single VPC. DNS Firewall filters VPC traffic starting from rule group with the lowest numeric priority setting.
String mutationProtection
If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections.
String managedOwnerName
The owner of the association, used only for associations that are not managed by you. If you use Firewall Manager to manage your DNS Firewalls, then this reports Firewall Manager as the managed owner.
String status
The current status of the association.
String statusMessage
Additional information about the status of the response, if available.
String creatorRequestId
A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.
String creationTime
The date and time that the association was created, in Unix time format and Coordinated Universal Time (UTC).
String modificationTime
The date and time that the association was last modified, in Unix time format and Coordinated Universal Time (UTC).
String id
The ID of the rule group.
String arn
The ARN (Amazon Resource Name) of the rule group.
String name
The name of the rule group.
String ownerId
The Amazon Web Services account ID for the account that created the rule group. When a rule group is shared with your account, this is the account that has shared the rule group with you.
String creatorRequestId
A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.
String shareStatus
Whether the rule group is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).
String resourceId
The ID of the VPC from Amazon VPC that the configuration is for.
FirewallConfig firewallConfig
Configuration of the firewall behavior provided by DNS Firewall for a single VPC from AmazonVPC.
String firewallDomainListId
The ID of the domain list.
FirewallDomainList firewallDomainList
The domain list that you requested.
String firewallRuleGroupAssociationId
The identifier of the FirewallRuleGroupAssociation.
FirewallRuleGroupAssociation firewallRuleGroupAssociation
The association that you requested.
String arn
The ARN (Amazon Resource Name) for the rule group.
String firewallRuleGroupPolicy
The Identity and Access Management (Amazon Web Services IAM) policy for sharing the specified rule group. You can use the policy to share the rule group using Resource Access Manager (RAM).
String firewallRuleGroupId
The unique identifier of the firewall rule group.
FirewallRuleGroup firewallRuleGroup
A collection of rules used to filter DNS network traffic.
String id
The ID of the Resolver on the Outpost.
OutpostResolver outpostResolver
Information about the GetOutpostResolver request, including the status of the request.
String resourceId
Resource ID of the Amazon VPC that you want to get information about.
ResolverConfig resolverConfig
Information about the behavior configuration of Route 53 Resolver behavior for the VPC you specified in the
GetResolverConfig request.
String resourceId
The ID of the virtual private cloud (VPC) for the DNSSEC validation status.
ResolverDnssecConfig resolverDNSSECConfig
The information about a configuration for DNSSEC validation.
String resolverEndpointId
The ID of the Resolver endpoint that you want to get information about.
ResolverEndpoint resolverEndpoint
Information about the Resolver endpoint that you specified in a GetResolverEndpoint request.
String resolverQueryLogConfigAssociationId
The ID of the Resolver query logging configuration association that you want to get information about.
ResolverQueryLogConfigAssociation resolverQueryLogConfigAssociation
Information about the Resolver query logging configuration association that you specified in a
GetQueryLogConfigAssociation request.
String arn
The ARN of the query logging configuration that you want to get the query logging policy for.
String resolverQueryLogConfigPolicy
Information about the query logging policy for the query logging configuration that you specified in a
GetResolverQueryLogConfigPolicy request.
String resolverQueryLogConfigId
The ID of the Resolver query logging configuration that you want to get information about.
ResolverQueryLogConfig resolverQueryLogConfig
Information about the Resolver query logging configuration that you specified in a GetQueryLogConfig
request.
String resolverRuleAssociationId
The ID of the Resolver rule association that you want to get information about.
ResolverRuleAssociation resolverRuleAssociation
Information about the Resolver rule association that you specified in a GetResolverRuleAssociation
request.
String arn
The ID of the Resolver rule that you want to get the Resolver rule policy for.
String resolverRulePolicy
The Resolver rule policy for the rule that you specified in a GetResolverRulePolicy request.
String resolverRuleId
The ID of the Resolver rule that you want to get information about.
ResolverRule resolverRule
Information about the Resolver rule that you specified in a GetResolverRule request.
String firewallDomainListId
The ID of the domain list that you want to modify with the import operation.
String operation
What you want DNS Firewall to do with the domains that are listed in the file. This must be set to
REPLACE, which updates the domain list to exactly match the list in the file.
String domainFileUrl
The fully qualified URL or URI of the file stored in Amazon Simple Storage Service (Amazon S3) that contains the list of domains to import.
The file must be in an S3 bucket that's in the same Region as your DNS Firewall. The file must be a text file and must contain a single domain per line.
String fieldName
For an InvalidParameterException error, the name of the parameter that's invalid.
String ipId
The ID of one IP address.
String subnetId
The ID of one subnet.
String ip
One IPv4 address that the Resolver endpoint uses for DNS queries.
String ipv6
One IPv6 address that the Resolver endpoint uses for DNS queries.
String status
A status code that gives the current status of the request.
String statusMessage
A message that provides additional information about the status of the request.
String creationTime
The date and time that the IP address was created, in Unix time format and Coordinated Universal Time (UTC).
String modificationTime
The date and time that the IP address was last modified, in Unix time format and Coordinated Universal Time (UTC).
String ipId
Only when removing an IP address from a Resolver endpoint: The ID of the IP address that you want to remove. To get this ID, use GetResolverEndpoint.
String subnetId
The ID of the subnet that includes the IP address that you want to update. To get this ID, use GetResolverEndpoint.
String ip
The new IPv4 address.
String ipv6
The new IPv6 address.
String resourceType
For a LimitExceededException error, the type of resource that exceeded the current limit.
Integer maxResults
The maximum number of objects that you want Resolver to return for this request. If more objects are available,
in the response, Resolver provides a NextToken value that you can use in a subsequent call to get
the next batch of objects.
If you don't specify a value for MaxResults, Resolver returns up to 100 objects.
String nextToken
For the first call to this list request, omit this value.
When you request a list of objects, Resolver returns at most the number of objects specified in
MaxResults. If more objects are available for retrieval, Resolver returns a NextToken
value in the response. To retrieve the next batch of objects, use the token that was returned for the prior
request in your next request.
String nextToken
If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.
List<E> firewallConfigs
The configurations for the firewall behavior provided by DNS Firewall for VPCs from Amazon Virtual Private Cloud (Amazon VPC).
Integer maxResults
The maximum number of objects that you want Resolver to return for this request. If more objects are available,
in the response, Resolver provides a NextToken value that you can use in a subsequent call to get
the next batch of objects.
If you don't specify a value for MaxResults, Resolver returns up to 100 objects.
String nextToken
For the first call to this list request, omit this value.
When you request a list of objects, Resolver returns at most the number of objects specified in
MaxResults. If more objects are available for retrieval, Resolver returns a NextToken
value in the response. To retrieve the next batch of objects, use the token that was returned for the prior
request in your next request.
String nextToken
If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.
List<E> firewallDomainLists
A list of the domain lists that you have defined.
This might be a partial list of the domain lists that you've defined. For information, see
MaxResults.
String firewallDomainListId
The ID of the domain list whose domains you want to retrieve.
Integer maxResults
The maximum number of objects that you want Resolver to return for this request. If more objects are available,
in the response, Resolver provides a NextToken value that you can use in a subsequent call to get
the next batch of objects.
If you don't specify a value for MaxResults, Resolver returns up to 100 objects.
String nextToken
For the first call to this list request, omit this value.
When you request a list of objects, Resolver returns at most the number of objects specified in
MaxResults. If more objects are available for retrieval, Resolver returns a NextToken
value in the response. To retrieve the next batch of objects, use the token that was returned for the prior
request in your next request.
String nextToken
If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.
List<E> domains
A list of the domains in the firewall domain list.
This might be a partial list of the domains that you've defined in the domain list. For information, see
MaxResults.
String firewallRuleGroupId
The unique identifier of the firewall rule group that you want to retrieve the associations for. Leave this blank to retrieve associations for any rule group.
String vpcId
The unique identifier of the VPC that you want to retrieve the associations for. Leave this blank to retrieve associations for any VPC.
Integer priority
The setting that determines the processing order of the rule group among the rule groups that are associated with a single VPC. DNS Firewall filters VPC traffic starting from the rule group with the lowest numeric priority setting.
String status
The association Status setting that you want DNS Firewall to filter on for the list. If you don't
specify this, then DNS Firewall returns all associations, regardless of status.
Integer maxResults
The maximum number of objects that you want Resolver to return for this request. If more objects are available,
in the response, Resolver provides a NextToken value that you can use in a subsequent call to get
the next batch of objects.
If you don't specify a value for MaxResults, Resolver returns up to 100 objects.
String nextToken
For the first call to this list request, omit this value.
When you request a list of objects, Resolver returns at most the number of objects specified in
MaxResults. If more objects are available for retrieval, Resolver returns a NextToken
value in the response. To retrieve the next batch of objects, use the token that was returned for the prior
request in your next request.
String nextToken
If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.
List<E> firewallRuleGroupAssociations
A list of your firewall rule group associations.
This might be a partial list of the associations that you have defined. For information, see
MaxResults.
Integer maxResults
The maximum number of objects that you want Resolver to return for this request. If more objects are available,
in the response, Resolver provides a NextToken value that you can use in a subsequent call to get
the next batch of objects.
If you don't specify a value for MaxResults, Resolver returns up to 100 objects.
String nextToken
For the first call to this list request, omit this value.
When you request a list of objects, Resolver returns at most the number of objects specified in
MaxResults. If more objects are available for retrieval, Resolver returns a NextToken
value in the response. To retrieve the next batch of objects, use the token that was returned for the prior
request in your next request.
String nextToken
If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.
List<E> firewallRuleGroups
A list of your firewall rule groups.
This might be a partial list of the rule groups that you have defined. For information, see
MaxResults.
String firewallRuleGroupId
The unique identifier of the firewall rule group that you want to retrieve the rules for.
Integer priority
Optional additional filter for the rules to retrieve.
The setting that determines the processing order of the rules in a rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.
String action
Optional additional filter for the rules to retrieve.
The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:
ALLOW - Permit the request to go through.
ALERT - Permit the request to go through but send an alert to the logs.
BLOCK - Disallow the request. If this is specified, additional handling details are provided in the
rule's BlockResponse setting.
Integer maxResults
The maximum number of objects that you want Resolver to return for this request. If more objects are available,
in the response, Resolver provides a NextToken value that you can use in a subsequent call to get
the next batch of objects.
If you don't specify a value for MaxResults, Resolver returns up to 100 objects.
String nextToken
For the first call to this list request, omit this value.
When you request a list of objects, Resolver returns at most the number of objects specified in
MaxResults. If more objects are available for retrieval, Resolver returns a NextToken
value in the response. To retrieve the next batch of objects, use the token that was returned for the prior
request in your next request.
String nextToken
If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.
List<E> firewallRules
A list of the rules that you have defined.
This might be a partial list of the firewall rules that you've defined. For information, see
MaxResults.
String outpostArn
The Amazon Resource Name (ARN) of the Outpost.
Integer maxResults
The maximum number of Resolvers on the Outpost that you want to return in the response to a
ListOutpostResolver request. If you don't specify a value for MaxResults, the request
returns up to 100 Resolvers.
String nextToken
For the first ListOutpostResolver request, omit this value.
List<E> outpostResolvers
The Resolvers on Outposts that were created by using the current Amazon Web Services account, and that match the specified filters, if any.
String nextToken
If more than MaxResults Resolvers match the specified criteria, you can submit another
ListOutpostResolver request to get the next group of results. In the next request, specify the value
of NextToken from the previous response.
Integer maxResults
The maximum number of Resolver configurations that you want to return in the response to a
ListResolverConfigs request. If you don't specify a value for MaxResults, up to 100
Resolver configurations are returned.
String nextToken
(Optional) If the current Amazon Web Services account has more than MaxResults Resolver
configurations, use NextToken to get the second and subsequent pages of results.
For the first ListResolverConfigs request, omit this value.
For the second and subsequent requests, get the value of NextToken from the previous response and
specify that value for NextToken in the request.
String nextToken
If a response includes the last of the Resolver configurations that are associated with the current Amazon Web
Services account, NextToken doesn't appear in the response.
If a response doesn't include the last of the configurations, you can get more configurations by submitting
another ListResolverConfigs request. Get the value of NextToken that Amazon Route 53
returned in the previous response and include it in NextToken in the next request.
List<E> resolverConfigs
An array that contains one ResolverConfigs element for each Resolver configuration that is
associated with the current Amazon Web Services account.
Integer maxResults
Optional: An integer that specifies the maximum number of DNSSEC configuration results that you want
Amazon Route 53 to return. If you don't specify a value for MaxResults, Route 53 returns up to 100
configuration per page.
String nextToken
(Optional) If the current Amazon Web Services account has more than MaxResults DNSSEC
configurations, use NextToken to get the second and subsequent pages of results.
For the first ListResolverDnssecConfigs request, omit this value.
For the second and subsequent requests, get the value of NextToken from the previous response and
specify that value for NextToken in the request.
List<E> filters
An optional specification to return a subset of objects.
String nextToken
If a response includes the last of the DNSSEC configurations that are associated with the current Amazon Web
Services account, NextToken doesn't appear in the response.
If a response doesn't include the last of the configurations, you can get more configurations by submitting
another
ListResolverDnssecConfigs request. Get the value of NextToken that Amazon Route 53 returned in
the previous response and include it in NextToken in the next request.
List<E> resolverDnssecConfigs
An array that contains one ResolverDnssecConfig element for each configuration for DNSSEC validation that is associated with the current Amazon Web Services account. It doesn't contain disabled DNSSEC configurations for the resource.
String resolverEndpointId
The ID of the Resolver endpoint that you want to get IP addresses for.
Integer maxResults
The maximum number of IP addresses that you want to return in the response to a
ListResolverEndpointIpAddresses request. If you don't specify a value for MaxResults,
Resolver returns up to 100 IP addresses.
String nextToken
For the first ListResolverEndpointIpAddresses request, omit this value.
If the specified Resolver endpoint has more than MaxResults IP addresses, you can submit another
ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request,
specify the value of NextToken from the previous response.
String nextToken
If the specified endpoint has more than MaxResults IP addresses, you can submit another
ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request,
specify the value of NextToken from the previous response.
Integer maxResults
The value that you specified for MaxResults in the request.
List<E> ipAddresses
Information about the IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints).
Integer maxResults
The maximum number of Resolver endpoints that you want to return in the response to a
ListResolverEndpoints request. If you don't specify a value for MaxResults, Resolver
returns up to 100 Resolver endpoints.
String nextToken
For the first ListResolverEndpoints request, omit this value.
If you have more than MaxResults Resolver endpoints, you can submit another
ListResolverEndpoints request to get the next group of Resolver endpoints. In the next request,
specify the value of NextToken from the previous response.
List<E> filters
An optional specification to return a subset of Resolver endpoints, such as all inbound Resolver endpoints.
If you submit a second or subsequent ListResolverEndpoints request and specify the
NextToken parameter, you must use the same values for Filters, if any, as in the
previous request.
String nextToken
If more than MaxResults IP addresses match the specified criteria, you can submit another
ListResolverEndpoint request to get the next group of results. In the next request, specify the
value of NextToken from the previous response.
Integer maxResults
The value that you specified for MaxResults in the request.
List<E> resolverEndpoints
The Resolver endpoints that were created by using the current Amazon Web Services account, and that match the specified filters, if any.
Integer maxResults
The maximum number of query logging associations that you want to return in the response to a
ListResolverQueryLogConfigAssociations request. If you don't specify a value for
MaxResults, Resolver returns up to 100 query logging associations.
String nextToken
For the first ListResolverQueryLogConfigAssociations request, omit this value.
If there are more than MaxResults query logging associations that match the values that you specify
for Filters, you can submit another ListResolverQueryLogConfigAssociations request to
get the next group of associations. In the next request, specify the value of NextToken from the
previous response.
List<E> filters
An optional specification to return a subset of query logging associations.
If you submit a second or subsequent ListResolverQueryLogConfigAssociations request and specify the
NextToken parameter, you must use the same values for Filters, if any, as in the
previous request.
String sortBy
The element that you want Resolver to sort query logging associations by.
If you submit a second or subsequent ListResolverQueryLogConfigAssociations request and specify the
NextToken parameter, you must use the same value for SortBy, if any, as in the previous
request.
Valid values include the following elements:
CreationTime: The ID of the query logging association.
Error: If the value of Status is FAILED, the value of Error
indicates the cause:
DESTINATION_NOT_FOUND: The specified destination (for example, an Amazon S3 bucket) was deleted.
ACCESS_DENIED: Permissions don't allow sending logs to the destination.
If Status is a value other than FAILED, ERROR is null.
Id: The ID of the query logging association
ResolverQueryLogConfigId: The ID of the query logging configuration
ResourceId: The ID of the VPC that is associated with the query logging configuration
Status: The current status of the configuration. Valid values include the following:
CREATING: Resolver is creating an association between an Amazon VPC and a query logging
configuration.
CREATED: The association between an Amazon VPC and a query logging configuration was successfully
created. Resolver is logging queries that originate in the specified VPC.
DELETING: Resolver is deleting this query logging association.
FAILED: Resolver either couldn't create or couldn't delete the query logging association. Here are
two common causes:
The specified destination (for example, an Amazon S3 bucket) was deleted.
Permissions don't allow sending logs to the destination.
String sortOrder
If you specified a value for SortBy, the order that you want query logging associations to be listed
in, ASCENDING or DESCENDING.
If you submit a second or subsequent ListResolverQueryLogConfigAssociations request and specify the
NextToken parameter, you must use the same value for SortOrder, if any, as in the
previous request.
String nextToken
If there are more than MaxResults query logging associations, you can submit another
ListResolverQueryLogConfigAssociations request to get the next group of associations. In the next
request, specify the value of NextToken from the previous response.
Integer totalCount
The total number of query logging associations that were created by the current account in the specified Region.
This count can differ from the number of associations that are returned in a
ListResolverQueryLogConfigAssociations response, depending on the values that you specify in the
request.
Integer totalFilteredCount
The total number of query logging associations that were created by the current account in the specified Region
and that match the filters that were specified in the ListResolverQueryLogConfigAssociations
request. For the total number of associations that were created by the current account in the specified Region,
see TotalCount.
List<E> resolverQueryLogConfigAssociations
A list that contains one ResolverQueryLogConfigAssociations element for each query logging
association that matches the values that you specified for Filter.
Integer maxResults
The maximum number of query logging configurations that you want to return in the response to a
ListResolverQueryLogConfigs request. If you don't specify a value for MaxResults,
Resolver returns up to 100 query logging configurations.
String nextToken
For the first ListResolverQueryLogConfigs request, omit this value.
If there are more than MaxResults query logging configurations that match the values that you
specify for Filters, you can submit another ListResolverQueryLogConfigs request to get
the next group of configurations. In the next request, specify the value of NextToken from the
previous response.
List<E> filters
An optional specification to return a subset of query logging configurations.
If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the
NextToken parameter, you must use the same values for Filters, if any, as in the
previous request.
String sortBy
The element that you want Resolver to sort query logging configurations by.
If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the
NextToken parameter, you must use the same value for SortBy, if any, as in the previous
request.
Valid values include the following elements:
Arn: The ARN of the query logging configuration
AssociationCount: The number of VPCs that are associated with the specified configuration
CreationTime: The date and time that Resolver returned when the configuration was created
CreatorRequestId: The value that was specified for CreatorRequestId when the
configuration was created
DestinationArn: The location that logs are sent to
Id: The ID of the configuration
Name: The name of the configuration
OwnerId: The Amazon Web Services account number of the account that created the configuration
ShareStatus: Whether the configuration is shared with other Amazon Web Services accounts or shared
with the current account by another Amazon Web Services account. Sharing is configured through Resource Access
Manager (RAM).
Status: The current status of the configuration. Valid values include the following:
CREATING: Resolver is creating the query logging configuration.
CREATED: The query logging configuration was successfully created. Resolver is logging queries that
originate in the specified VPC.
DELETING: Resolver is deleting this query logging configuration.
FAILED: Resolver either couldn't create or couldn't delete the query logging configuration. Here are
two common causes:
The specified destination (for example, an Amazon S3 bucket) was deleted.
Permissions don't allow sending logs to the destination.
String sortOrder
If you specified a value for SortBy, the order that you want query logging configurations to be
listed in, ASCENDING or DESCENDING.
If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the
NextToken parameter, you must use the same value for SortOrder, if any, as in the
previous request.
String nextToken
If there are more than MaxResults query logging configurations, you can submit another
ListResolverQueryLogConfigs request to get the next group of configurations. In the next request,
specify the value of NextToken from the previous response.
Integer totalCount
The total number of query logging configurations that were created by the current account in the specified
Region. This count can differ from the number of query logging configurations that are returned in a
ListResolverQueryLogConfigs response, depending on the values that you specify in the request.
Integer totalFilteredCount
The total number of query logging configurations that were created by the current account in the specified Region
and that match the filters that were specified in the ListResolverQueryLogConfigs request. For the
total number of query logging configurations that were created by the current account in the specified Region,
see TotalCount.
List<E> resolverQueryLogConfigs
A list that contains one ResolverQueryLogConfig element for each query logging configuration that
matches the values that you specified for Filter.
Integer maxResults
The maximum number of rule associations that you want to return in the response to a
ListResolverRuleAssociations request. If you don't specify a value for MaxResults,
Resolver returns up to 100 rule associations.
String nextToken
For the first ListResolverRuleAssociation request, omit this value.
If you have more than MaxResults rule associations, you can submit another
ListResolverRuleAssociation request to get the next group of rule associations. In the next request,
specify the value of NextToken from the previous response.
List<E> filters
An optional specification to return a subset of Resolver rules, such as Resolver rules that are associated with the same VPC ID.
If you submit a second or subsequent ListResolverRuleAssociations request and specify the
NextToken parameter, you must use the same values for Filters, if any, as in the
previous request.
String nextToken
If more than MaxResults rule associations match the specified criteria, you can submit another
ListResolverRuleAssociation request to get the next group of results. In the next request, specify
the value of NextToken from the previous response.
Integer maxResults
The value that you specified for MaxResults in the request.
List<E> resolverRuleAssociations
The associations that were created between Resolver rules and VPCs using the current Amazon Web Services account, and that match the specified filters, if any.
Integer maxResults
The maximum number of Resolver rules that you want to return in the response to a ListResolverRules
request. If you don't specify a value for MaxResults, Resolver returns up to 100 Resolver rules.
String nextToken
For the first ListResolverRules request, omit this value.
If you have more than MaxResults Resolver rules, you can submit another
ListResolverRules request to get the next group of Resolver rules. In the next request, specify the
value of NextToken from the previous response.
List<E> filters
An optional specification to return a subset of Resolver rules, such as all Resolver rules that are associated with the same Resolver endpoint.
If you submit a second or subsequent ListResolverRules request and specify the
NextToken parameter, you must use the same values for Filters, if any, as in the
previous request.
String nextToken
If more than MaxResults Resolver rules match the specified criteria, you can submit another
ListResolverRules request to get the next group of results. In the next request, specify the value
of NextToken from the previous response.
Integer maxResults
The value that you specified for MaxResults in the request.
List<E> resolverRules
The Resolver rules that were created using the current Amazon Web Services account and that match the specified filters, if any.
String resourceArn
The Amazon Resource Name (ARN) for the resource that you want to list tags for.
Integer maxResults
The maximum number of tags that you want to return in the response to a ListTagsForResource request.
If you don't specify a value for MaxResults, Resolver returns up to 100 tags.
String nextToken
For the first ListTagsForResource request, omit this value.
If you have more than MaxResults tags, you can submit another ListTagsForResource
request to get the next group of tags for the resource. In the next request, specify the value of
NextToken from the previous response.
List<E> tags
The tags that are associated with the resource that you specified in the ListTagsForResource
request.
String nextToken
If more than MaxResults tags match the specified criteria, you can submit another
ListTagsForResource request to get the next group of results. In the next request, specify the value
of NextToken from the previous response.
String arn
The ARN (Amazon Resource Name) for the Resolver on an Outpost.
String creationTime
The date and time that the Outpost Resolver was created, in Unix time format and Coordinated Universal Time (UTC).
String modificationTime
The date and time that the Outpost Resolver was modified, in Unix time format and Coordinated Universal Time (UTC).
String creatorRequestId
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.
String id
The ID of the Resolver on Outpost.
Integer instanceCount
Amazon EC2 instance count for the Resolver on the Outpost.
String preferredInstanceType
The Amazon EC2 instance type.
String name
Name of the Resolver.
String status
Status of the Resolver.
String statusMessage
A detailed description of the Resolver.
String outpostArn
The ARN (Amazon Resource Name) for the Outpost.
Boolean returnValue
String arn
The Amazon Resource Name (ARN) of the account that you want to share rules with.
String resolverQueryLogConfigPolicy
An Identity and Access Management policy statement that lists the query logging configurations that you want to
share with another Amazon Web Services account and the operations that you want the account to be able to
perform. You can specify the following operations in the Actions section of the statement:
route53resolver:AssociateResolverQueryLogConfig
route53resolver:DisassociateResolverQueryLogConfig
route53resolver:ListResolverQueryLogConfigs
In the Resource section of the statement, you specify the ARNs for the query logging configurations
that you want to share with the account that you specified in Arn.
Boolean returnValue
Whether the PutResolverQueryLogConfigPolicy request was successful.
String arn
The Amazon Resource Name (ARN) of the rule that you want to share with another account.
String resolverRulePolicy
An Identity and Access Management policy statement that lists the rules that you want to share with another
Amazon Web Services account and the operations that you want the account to be able to perform. You can specify
the following operations in the Action section of the statement:
route53resolver:GetResolverRule
route53resolver:AssociateResolverRule
route53resolver:DisassociateResolverRule
route53resolver:ListResolverRules
route53resolver:ListResolverRuleAssociations
In the Resource section of the statement, specify the ARN for the rule that you want to share with
another account. Specify the same ARN that you specified in Arn.
Boolean returnValue
Whether the PutResolverRulePolicy request was successful.
String id
ID for the Resolver configuration.
String resourceId
The ID of the Amazon Virtual Private Cloud VPC that you're configuring Resolver for.
String ownerId
The owner account ID of the Amazon Virtual Private Cloud VPC.
String autodefinedReverse
The status of whether or not the Resolver will create autodefined rules for reverse DNS lookups. This is enabled by default. The status can be one of following:
ENABLING: Autodefined rules for reverse DNS lookups are being enabled but are not complete.
ENABLED: Autodefined rules for reverse DNS lookups are enabled.
DISABLING: Autodefined rules for reverse DNS lookups are being disabled but are not complete.
DISABLED: Autodefined rules for reverse DNS lookups are disabled.
String id
The ID for a configuration for DNSSEC validation.
String ownerId
The owner account ID of the virtual private cloud (VPC) for a configuration for DNSSEC validation.
String resourceId
The ID of the virtual private cloud (VPC) that you're configuring the DNSSEC validation status for.
String validationStatus
The validation status for a DNSSEC configuration. The status can be one of the following:
ENABLING: DNSSEC validation is being enabled but is not complete.
ENABLED: DNSSEC validation is enabled.
DISABLING: DNSSEC validation is being disabled but is not complete.
DISABLED DNSSEC validation is disabled.
String id
The ID of the Resolver endpoint.
String creatorRequestId
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.
String arn
The ARN (Amazon Resource Name) for the Resolver endpoint.
String name
The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request.
List<E> securityGroupIds
The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.
String direction
Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:
INBOUND: allows DNS queries to your VPC from your network
OUTBOUND: allows DNS queries from your VPC to your network
Integer ipAddressCount
The number of IP addresses that the Resolver endpoint can use for DNS queries.
String hostVPCId
The ID of the VPC that you want to create the Resolver endpoint in.
String status
A code that specifies the current status of the Resolver endpoint. Valid values include the following:
CREATING: Resolver is creating and configuring one or more Amazon VPC network interfaces for this
endpoint.
OPERATIONAL: The Amazon VPC network interfaces for this endpoint are correctly configured and able
to pass inbound or outbound DNS queries between your network and Resolver.
UPDATING: Resolver is associating or disassociating one or more network interfaces with this
endpoint.
AUTO_RECOVERING: Resolver is trying to recover one or more of the network interfaces that are
associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because
of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see
Limits on Route 53 Resolver.
ACTION_NEEDED: This endpoint is unhealthy, and Resolver can't automatically recover it. To resolve
the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP
address that isn't available, add another IP address and then delete the IP address that isn't available. (An
endpoint must always include at least two IP addresses.) A status of ACTION_NEEDED can have a
variety of causes. Here are two common causes:
One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.
The network interface couldn't be created for some reason that's outside the control of Resolver.
DELETING: Resolver is deleting this endpoint and the associated network interfaces.
String statusMessage
A detailed description of the status of the Resolver endpoint.
String creationTime
The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).
String modificationTime
The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).
String outpostArn
The ARN (Amazon Resource Name) for the Outpost.
String preferredInstanceType
The Amazon EC2 instance type.
String resolverEndpointType
The Resolver endpoint IP address type.
List<E> protocols
Protocols used for the endpoint. DoH-FIPS is applicable for inbound endpoints only.
For an inbound endpoint you can apply the protocols as follows:
Do53 and DoH in combination.
Do53 and DoH-FIPS in combination.
Do53 alone.
DoH alone.
DoH-FIPS alone.
None, which is treated as Do53.
For an outbound endpoint you can apply the protocols as follows:
Do53 and DoH in combination.
Do53 alone.
DoH alone.
None, which is treated as Do53.
String id
The ID for the query logging configuration.
String ownerId
The Amazon Web Services account ID for the account that created the query logging configuration.
String status
The status of the specified query logging configuration. Valid values include the following:
CREATING: Resolver is creating the query logging configuration.
CREATED: The query logging configuration was successfully created. Resolver is logging queries that
originate in the specified VPC.
DELETING: Resolver is deleting this query logging configuration.
FAILED: Resolver can't deliver logs to the location that is specified in the query logging
configuration. Here are two common causes:
The specified destination (for example, an Amazon S3 bucket) was deleted.
Permissions don't allow sending logs to the destination.
String shareStatus
An indication of whether the query logging configuration is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).
Integer associationCount
The number of VPCs that are associated with the query logging configuration.
String arn
The ARN for the query logging configuration.
String name
The name of the query logging configuration.
String destinationArn
The ARN of the resource that you want Resolver to send query logs: an Amazon S3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream.
String creatorRequestId
A unique string that identifies the request that created the query logging configuration. The
CreatorRequestId allows failed requests to be retried without the risk of running the operation
twice.
String creationTime
The date and time that the query logging configuration was created, in Unix time format and Coordinated Universal Time (UTC).
String id
The ID of the query logging association.
String resolverQueryLogConfigId
The ID of the query logging configuration that a VPC is associated with.
String resourceId
The ID of the Amazon VPC that is associated with the query logging configuration.
String status
The status of the specified query logging association. Valid values include the following:
CREATING: Resolver is creating an association between an Amazon VPC and a query logging
configuration.
CREATED: The association between an Amazon VPC and a query logging configuration was successfully
created. Resolver is logging queries that originate in the specified VPC.
DELETING: Resolver is deleting this query logging association.
FAILED: Resolver either couldn't create or couldn't delete the query logging association.
String error
If the value of Status is FAILED, the value of Error indicates the cause:
DESTINATION_NOT_FOUND: The specified destination (for example, an Amazon S3 bucket) was deleted.
ACCESS_DENIED: Permissions don't allow sending logs to the destination.
If the value of Status is a value other than FAILED, Error is null.
String errorMessage
Contains additional information about the error. If the value or Error is null, the value of
ErrorMessage also is null.
String creationTime
The date and time that the VPC was associated with the query logging configuration, in Unix time format and Coordinated Universal Time (UTC).
String id
The ID that Resolver assigned to the Resolver rule when you created it.
String creatorRequestId
A unique string that you specified when you created the Resolver rule. CreatorRequestId identifies
the request and allows failed requests to be retried without the risk of running the operation twice.
String arn
The ARN (Amazon Resource Name) for the Resolver rule specified by Id.
String domainName
DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps.
If a query matches multiple Resolver rules (example.com and www.example.com), the query is routed using the
Resolver rule that contains the most specific domain name (www.example.com).
String status
A code that specifies the current status of the Resolver rule.
String statusMessage
A detailed description of the status of a Resolver rule.
String ruleType
When you want to forward DNS queries for specified domain name to resolvers on your network, specify
FORWARD.
When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to
process queries for a subdomain of that domain, specify SYSTEM.
For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify
FORWARD for RuleType. To then have Resolver process queries for apex.example.com, you
create a rule and specify SYSTEM for RuleType.
Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType.
String name
The name for the Resolver rule, which you specified when you created the Resolver rule.
List<E> targetIps
An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network.
String resolverEndpointId
The ID of the endpoint that the rule is associated with.
String ownerId
When a rule is shared with another Amazon Web Services account, the account ID of the account that the rule is shared with.
String shareStatus
Whether the rule is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.
String creationTime
The date and time that the Resolver rule was created, in Unix time format and Coordinated Universal Time (UTC).
String modificationTime
The date and time that the Resolver rule was last updated, in Unix time format and Coordinated Universal Time (UTC).
String id
The ID of the association between a Resolver rule and a VPC. Resolver assigns this value when you submit an AssociateResolverRule request.
String resolverRuleId
The ID of the Resolver rule that you associated with the VPC that is specified by VPCId.
String name
The name of an association between a Resolver rule and a VPC.
String vPCId
The ID of the VPC that you associated the Resolver rule with.
String status
A code that specifies the current status of the association between a Resolver rule and a VPC.
String statusMessage
A detailed description of the status of the association between a Resolver rule and a VPC.
String name
The new name for the Resolver rule. The name that you specify appears in the Resolver dashboard in the Route 53 console.
List<E> targetIps
For DNS queries that originate in your VPC, the new IP addresses that you want to route outbound DNS queries to.
String resolverEndpointId
The ID of the new outbound Resolver endpoint that you want to use to route DNS queries to the IP addresses that
you specify in TargetIps.
String resourceType
For a ResourceExistsException error, the type of resource that the error applies to.
String resourceType
For a ResourceInUseException error, the type of resource that is currently in use.
String resourceType
For a ResourceNotFoundException error, the type of resource that doesn't exist.
String resourceType
For a ResourceUnavailableException error, the type of resource that isn't available.
String key
The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your
customers for billing purposes, the value of Key might be account-id.
String value
The value for the tag. For example, if Key is account-id, then Value might
be the ID of the customer account that you're creating the resource for.
String ip
One IPv4 address that you want to forward DNS queries to.
Integer port
The port at Ip that you want to forward DNS queries to.
String ipv6
One IPv6 address that you want to forward DNS queries to.
String protocol
The protocols for the Resolver endpoints. DoH-FIPS is applicable for inbound endpoints only.
For an inbound endpoint you can apply the protocols as follows:
Do53 and DoH in combination.
Do53 and DoH-FIPS in combination.
Do53 alone.
DoH alone.
DoH-FIPS alone.
None, which is treated as Do53.
For an outbound endpoint you can apply the protocols as follows:
Do53 and DoH in combination.
Do53 alone.
DoH alone.
None, which is treated as Do53.
String resourceId
The ID of the VPC that the configuration is for.
String firewallFailOpen
Determines how Route 53 Resolver handles queries during failures, for example when all traffic that is sent to DNS Firewall fails to receive a reply.
By default, fail open is disabled, which means the failure mode is closed. This approach favors security over availability. DNS Firewall blocks queries that it is unable to evaluate properly.
If you enable this option, the failure mode is open. This approach favors availability over security. DNS Firewall allows queries to proceed if it is unable to properly evaluate them.
This behavior is only enforced for VPCs that have at least one DNS Firewall rule group association.
FirewallConfig firewallConfig
Configuration of the firewall behavior provided by DNS Firewall for a single VPC.
String firewallDomainListId
The ID of the domain list whose domains you want to update.
String operation
What you want DNS Firewall to do with the domains that you are providing:
ADD - Add the domains to the ones that are already in the domain list.
REMOVE - Search the domain list for the domains and remove them from the list.
REPLACE - Update the domain list to exactly match the list that you are providing.
List<E> domains
A list of domains to use in the update operation.
There is a limit of 1000 domains per request.
Each domain specification in your domain list must satisfy the following requirements:
It can optionally start with * (asterisk).
With the exception of the optional starting asterisk, it must only contain the following characters:
A-Z, a-z, 0-9, - (hyphen).
It must be from 1-255 characters in length.
String firewallRuleGroupAssociationId
The identifier of the FirewallRuleGroupAssociation.
Integer priority
The setting that determines the processing order of the rule group among the rule groups that you associate with the specified VPC. DNS Firewall filters VPC traffic starting from the rule group with the lowest numeric priority setting.
You must specify a unique priority for each rule group that you associate with a single VPC. To make it easier to insert rule groups later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for a rule group association after you create it.
String mutationProtection
If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections.
String name
The name of the rule group association.
FirewallRuleGroupAssociation firewallRuleGroupAssociation
The association that you just updated.
String firewallRuleGroupId
The unique identifier of the firewall rule group for the rule.
String firewallDomainListId
The ID of the domain list to use in the rule.
Integer priority
The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.
You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time.
String action
The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:
ALLOW - Permit the request to go through.
ALERT - Permit the request to go through but send an alert to the logs.
BLOCK - Disallow the request. This option requires additional details in the rule's
BlockResponse.
String blockResponse
The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK.
NODATA - Respond indicating that the query was successful, but no response is available for it.
NXDOMAIN - Respond indicating that the domain name that's in the query doesn't exist.
OVERRIDE - Provide a custom override in the response. This option requires custom handling details
in the rule's BlockOverride* settings.
String blockOverrideDomain
The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a
BlockResponse setting of OVERRIDE.
String blockOverrideDnsType
The DNS record's type. This determines the format of the record value that you provided in
BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse
setting of OVERRIDE.
Integer blockOverrideTtl
The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override
record. Used for the rule action BLOCK with a BlockResponse setting of
OVERRIDE.
String name
The name of the rule.
String firewallDomainRedirectionAction
How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.
Inspect_Redirection_Domain (Default) inspects all domains in the redirection chain. The individual
domains in the redirection chain must be added to the domain list.
Trust_Redirection_Domain inspects only the first domain in the redirection chain. You don't need to
add the subsequent domains in the domain in the redirection list to the domain list.
String qtype
The DNS query type you want the rule to evaluate. Allowed values are;
A: Returns an IPv4 address.
AAAA: Returns an Ipv6 address.
CAA: Restricts CAs that can create SSL/TLS certifications for the domain.
CNAME: Returns another domain name.
DS: Record that identifies the DNSSEC signing key of a delegated zone.
MX: Specifies mail servers.
NAPTR: Regular-expression-based rewriting of domain names.
NS: Authoritative name servers.
PTR: Maps an IP address to a domain name.
SOA: Start of authority record for the zone.
SPF: Lists the servers authorized to send emails from a domain.
SRV: Application specific values that identify servers.
TXT: Verifies email senders and application-specific values.
A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65334, for example, TYPE28. For more information, see List of DNS record types.
FirewallRule firewallRule
The firewall rule that you just updated.
OutpostResolver outpostResolver
The response to an UpdateOutpostResolver request.
String resourceId
Resource ID of the Amazon VPC that you want to update the Resolver configuration for.
String autodefinedReverseFlag
Indicates whether or not the Resolver will create autodefined rules for reverse DNS lookups. This is enabled by default. Disabling this option will also affect EC2-Classic instances using ClassicLink. For more information, see ClassicLink in the Amazon EC2 guide.
We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 guide and the blog EC2-Classic Networking is Retiring – Here’s How to Prepare.
It can take some time for the status change to be completed.
ResolverConfig resolverConfig
An array that contains settings for the specified Resolver configuration.
String resourceId
The ID of the virtual private cloud (VPC) that you're updating the DNSSEC validation status for.
String validation
The new value that you are specifying for DNSSEC validation for the VPC. The value can be ENABLE or
DISABLE. Be aware that it can take time for a validation status change to be completed.
ResolverDnssecConfig resolverDNSSECConfig
A complex type that contains settings for the specified DNSSEC configuration.
String resolverEndpointId
The ID of the Resolver endpoint that you want to update.
String name
The name of the Resolver endpoint that you want to update.
String resolverEndpointType
Specifies the endpoint type for what type of IP address the endpoint uses to forward DNS queries.
Updating to IPV6 type isn't currently supported.
List<E> updateIpAddresses
Specifies the IPv6 address when you update the Resolver endpoint from IPv4 to dual-stack. If you don't specify an IPv6 address, one will be automatically chosen from your subnet.
List<E> protocols
The protocols you want to use for the endpoint. DoH-FIPS is applicable for inbound endpoints only.
For an inbound endpoint you can apply the protocols as follows:
Do53 and DoH in combination.
Do53 and DoH-FIPS in combination.
Do53 alone.
DoH alone.
DoH-FIPS alone.
None, which is treated as Do53.
For an outbound endpoint you can apply the protocols as follows:
Do53 and DoH in combination.
Do53 alone.
DoH alone.
None, which is treated as Do53.
You can't change the protocol of an inbound endpoint directly from only Do53 to only DoH, or DoH-FIPS. This is to prevent a sudden disruption to incoming traffic that relies on Do53. To change the protocol from Do53 to DoH, or DoH-FIPS, you must first enable both Do53 and DoH, or Do53 and DoH-FIPS, to make sure that all incoming traffic has transferred to using the DoH protocol, or DoH-FIPS, and then remove the Do53.
ResolverEndpoint resolverEndpoint
The response to an UpdateResolverEndpoint request.
String resolverRuleId
The ID of the Resolver rule that you want to update.
ResolverRuleConfig config
The new settings for the Resolver rule.
ResolverRule resolverRule
The response to an UpdateResolverRule request.
Copyright © 2025. All rights reserved.