Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Amazonka.Route53Resolver.Types.Filter
Description
Documentation
For Resolver list operations (ListResolverEndpoints, ListResolverRules, ListResolverRuleAssociations, ListResolverQueryLogConfigs, ListResolverQueryLogConfigAssociations), and ListResolverDnssecConfigs), an optional specification to return a subset of objects.
To filter objects, such as Resolver endpoints or Resolver rules, you
specify Name
and Values
. For example, to list only inbound Resolver
endpoints, specify Direction
for Name
and specify INBOUND
for
Values
.
See: newFilter
smart constructor.
Constructors
Filter' | |
Fields
|
Instances
Eq Filter Source # | |
Read Filter Source # | |
Show Filter Source # | |
Generic Filter Source # | |
NFData Filter Source # | |
Defined in Amazonka.Route53Resolver.Types.Filter | |
Hashable Filter Source # | |
Defined in Amazonka.Route53Resolver.Types.Filter | |
ToJSON Filter Source # | |
Defined in Amazonka.Route53Resolver.Types.Filter | |
type Rep Filter Source # | |
Defined in Amazonka.Route53Resolver.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.Route53Resolver.Types.Filter" "libZSservicesZSamazonka-route53resolverZSamazonka-route53resolver" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
Create a value of Filter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:values:Filter'
, filter_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
.
$sel:name:Filter'
, filter_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 specifyDIRECTION
forName
, specifyINBOUND
orOUTBOUND
forValues
.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 theHostVPCId
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 specifyStatus
forName
, specify one of the following status codes forValues
:CREATING
,OPERATIONAL
,UPDATING
,AUTO_RECOVERING
,ACTION_NEEDED
, orDELETING
. For more information, seeStatus
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 forValues
, include a trailing dot (.) after the domain name. For example, if the domain name is example.com, specify the following value. Note the "." aftercom
: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
forRuleType
.Status
: The status of the Resolver rule. If you specifyStatus
forName
, specify one of the following status codes forValues
:COMPLETE
,DELETING
,UPDATING
, orFAILED
.Type
: The type of the Resolver rule. If you specifyTYPE
forName
, specifyFORWARD
orSYSTEM
forValues
.
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 specifyStatus
forName
, specify one of the following status codes forValues
:CREATING
,COMPLETE
,DELETING
, orFAILED
.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 configurationName
: The name of the query logging configurationOwnerId
: 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
, orSHARED_BY_ME
.Status
: The status of the query logging configuration. If you specifyStatus
forName
, specify the applicable status code forValues
:CREATING
,CREATED
,DELETING
, orFAILED
. 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 ofStatus
isFAILED
, specify the cause:DESTINATION_NOT_FOUND
orACCESS_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 specifyStatus
forName
, specify the applicable status code forValues
:CREATING
,CREATED
,DELETING
, orFAILED
. For more information, see Status.
filter_values :: Lens' Filter (Maybe [Text]) Source #
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
.
filter_name :: Lens' Filter (Maybe Text) Source #
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 specifyDIRECTION
forName
, specifyINBOUND
orOUTBOUND
forValues
.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 theHostVPCId
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 specifyStatus
forName
, specify one of the following status codes forValues
:CREATING
,OPERATIONAL
,UPDATING
,AUTO_RECOVERING
,ACTION_NEEDED
, orDELETING
. For more information, seeStatus
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 forValues
, include a trailing dot (.) after the domain name. For example, if the domain name is example.com, specify the following value. Note the "." aftercom
: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
forRuleType
.Status
: The status of the Resolver rule. If you specifyStatus
forName
, specify one of the following status codes forValues
:COMPLETE
,DELETING
,UPDATING
, orFAILED
.Type
: The type of the Resolver rule. If you specifyTYPE
forName
, specifyFORWARD
orSYSTEM
forValues
.
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 specifyStatus
forName
, specify one of the following status codes forValues
:CREATING
,COMPLETE
,DELETING
, orFAILED
.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 configurationName
: The name of the query logging configurationOwnerId
: 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
, orSHARED_BY_ME
.Status
: The status of the query logging configuration. If you specifyStatus
forName
, specify the applicable status code forValues
:CREATING
,CREATED
,DELETING
, orFAILED
. 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 ofStatus
isFAILED
, specify the cause:DESTINATION_NOT_FOUND
orACCESS_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 specifyStatus
forName
, specify the applicable status code forValues
:CREATING
,CREATED
,DELETING
, orFAILED
. For more information, see Status.