pub struct Client { /* private fields */ }Expand description
Client for Amazon Route 53 Global Resolver
Client for invoking operations on Amazon Route 53 Global Resolver. Each operation on Amazon Route 53 Global Resolver is a method on this
this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env() instead, which returns a ConfigLoader that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_route53globalresolver::Client::new(&config);Occasionally, SDKs may have additional service-specific values that can be set on the Config that
is absent from SdkConfig, or slightly different settings for a specific client may be desired.
The Builder struct implements From<&SdkConfig>, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_route53globalresolver::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();See the aws-config docs and Config for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the AssociateHostedZone operation has
a Client::associate_hosted_zone, function which returns a builder for that operation.
The fluent builder ultimately has a send() function that returns an async future that
returns a result, as illustrated below:
let result = client.associate_hosted_zone()
.hosted_zone_id("example")
.send()
.await;The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize module for more
information.
Implementations§
Source§impl Client
impl Client
Sourcepub fn associate_hosted_zone(&self) -> AssociateHostedZoneFluentBuilder
pub fn associate_hosted_zone(&self) -> AssociateHostedZoneFluentBuilder
Constructs a fluent builder for the AssociateHostedZone operation.
- The fluent builder is configurable:
hosted_zone_id(impl Into<String>)/set_hosted_zone_id(Option<String>):
required: trueThe ID of the Route 53 private hosted zone to associate with the Route 53 Global Resolver resource.
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueAn Amazon Resource Name (ARN) of the Route 53 Global Resolver the private hosted zone will be associated to.
name(impl Into<String>)/set_name(Option<String>):
required: trueName for the private hosted zone association.
- On success, responds with
AssociateHostedZoneOutputwith field(s):id(String):ID of the association.
resource_arn(String):An Amazon Resource Name (ARN) of the Route 53 Global Resolver the private hosted zone is associated to.
hosted_zone_id(String):ID of the private hosted zone.
hosted_zone_name(String):Name of the hosted zone (also the domain associated with the hosted zone).
name(String):Name for the private hosted zone association.
created_at(DateTime):The date and time the private hosted zone association was created.
updated_at(DateTime):The date and time the private hosted zone association was modified.
status(HostedZoneAssociationStatus):Aggregate status for all the AWS Regions in which the Route 53 Global Resolver exists.
- On failure, responds with
SdkError<AssociateHostedZoneError>
Source§impl Client
impl Client
Sourcepub fn batch_create_firewall_rule(&self) -> BatchCreateFirewallRuleFluentBuilder
pub fn batch_create_firewall_rule(&self) -> BatchCreateFirewallRuleFluentBuilder
Constructs a fluent builder for the BatchCreateFirewallRule operation.
- The fluent builder is configurable:
firewall_rules(BatchCreateFirewallRuleInputItem)/set_firewall_rules(Option<Vec::<BatchCreateFirewallRuleInputItem>>):
required: trueThe
BatchCreateFirewallRuleInputItemobjects contain the information for each Firewall rule.
- On success, responds with
BatchCreateFirewallRuleOutputwith field(s):failures(Vec::<BatchCreateFirewallRuleOutputItem>):High level information about the DNS Firewall rules that failed to create.
successes(Vec::<BatchCreateFirewallRuleOutputItem>):High level information about the DNS Firewall rules that were created.
- On failure, responds with
SdkError<BatchCreateFirewallRuleError>
Source§impl Client
impl Client
Sourcepub fn batch_delete_firewall_rule(&self) -> BatchDeleteFirewallRuleFluentBuilder
pub fn batch_delete_firewall_rule(&self) -> BatchDeleteFirewallRuleFluentBuilder
Constructs a fluent builder for the BatchDeleteFirewallRule operation.
- The fluent builder is configurable:
firewall_rules(BatchDeleteFirewallRuleInputItem)/set_firewall_rules(Option<Vec::<BatchDeleteFirewallRuleInputItem>>):
required: trueAn array of the DNS Firewall IDs to be deleted.
- On success, responds with
BatchDeleteFirewallRuleOutputwith field(s):failures(Vec::<BatchDeleteFirewallRuleOutputItem>):High level information about the DNS Firewall rules that failed to delete.
successes(Vec::<BatchDeleteFirewallRuleOutputItem>):High level information about the DNS Firewall rules that were deleted successfully.
- On failure, responds with
SdkError<BatchDeleteFirewallRuleError>
Source§impl Client
impl Client
Sourcepub fn batch_update_firewall_rule(&self) -> BatchUpdateFirewallRuleFluentBuilder
pub fn batch_update_firewall_rule(&self) -> BatchUpdateFirewallRuleFluentBuilder
Constructs a fluent builder for the BatchUpdateFirewallRule operation.
- The fluent builder is configurable:
firewall_rules(BatchUpdateFirewallRuleInputItem)/set_firewall_rules(Option<Vec::<BatchUpdateFirewallRuleInputItem>>):
required: trueThe DNS Firewall rule IDs to be updated.
- On success, responds with
BatchUpdateFirewallRuleOutputwith field(s):failures(Vec::<BatchUpdateFirewallRuleOutputItem>):High level information about the DNS Firewall rules that failed to update.
successes(Vec::<BatchUpdateFirewallRuleOutputItem>):High level information about the DNS Firewall rules that were successfully updated.
- On failure, responds with
SdkError<BatchUpdateFirewallRuleError>
Source§impl Client
impl Client
Sourcepub fn create_access_source(&self) -> CreateAccessSourceFluentBuilder
pub fn create_access_source(&self) -> CreateAccessSourceFluentBuilder
Constructs a fluent builder for the CreateAccessSource operation.
- The fluent builder is configurable:
cidr(impl Into<String>)/set_cidr(Option<String>):
required: trueThe IP address or CIDR range that is allowed to send DNS queries to the Route 53 Global Resolver.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique string that identifies the request and ensures idempotency.
ip_address_type(IpAddressType)/set_ip_address_type(Option<IpAddressType>):
required: falseThe IP address type for this access source. Valid values are IPv4 and IPv6 (if the Route 53 Global Resolver supports dual-stack).
name(impl Into<String>)/set_name(Option<String>):
required: falseA descriptive name for the access source.
dns_view_id(impl Into<String>)/set_dns_view_id(Option<String>):
required: trueThe ID of the DNS view to associate with this access source.
protocol(DnsProtocol)/set_protocol(Option<DnsProtocol>):
required: trueThe DNS protocol that is permitted for this access source. Valid values are Do53 (DNS over port 53), DoT (DNS over TLS), and DoH (DNS over HTTPS).
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseTags to associate with the access source.
- On success, responds with
CreateAccessSourceOutputwith field(s):arn(String):The Amazon Resource Name (ARN) of the access source.
cidr(String):The IP address or CIDR range that is allowed to send DNS queries to the Route 53 Global Resolver.
created_at(DateTime):The date and time when the access source was created.
id(String):The unique identifier for the access source.
ip_address_type(IpAddressType):The IP address type for this access source (IPv4 or IPv6).
name(Option<String>):The descriptive name of the access source.
dns_view_id(String):The ID of the DNS view associated with this access source.
protocol(DnsProtocol):The DNS protocol that is permitted for this access source (Do53, DoT, or DoH).
status(CrResourceStatus):The operational status of the access source.
updated_at(DateTime):The date and time when the access source was last updated.
- On failure, responds with
SdkError<CreateAccessSourceError>
Source§impl Client
impl Client
Sourcepub fn create_access_token(&self) -> CreateAccessTokenFluentBuilder
pub fn create_access_token(&self) -> CreateAccessTokenFluentBuilder
Constructs a fluent builder for the CreateAccessToken operation.
- The fluent builder is configurable:
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure idempotency. This means that making the same request multiple times with the same
clientTokenhas the same result every time.dns_view_id(impl Into<String>)/set_dns_view_id(Option<String>):
required: trueThe ID of the DNS view to associate with this token.
expires_at(DateTime)/set_expires_at(Option<DateTime>):
required: falseThe date and time when the token expires. Tokens can have a minimum expiration of 30 days and maximum of 365 days from creation.
name(impl Into<String>)/set_name(Option<String>):
required: falseA descriptive name for the access token.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseAn array of user-defined keys and optional values. These tags can be used for categorization and organization.
- On success, responds with
CreateAccessTokenOutputwith field(s):id(String):The unique identifier for the access token.
arn(String):The Amazon Resource Name (ARN) of the access token.
client_token(Option<String>):The unique string that identifies the request and ensures idempotency.
created_at(DateTime):The date and time when the access token was created.
dns_view_id(String):The ID of the DNS view associated with this access token.
expires_at(DateTime):The date and time when the access token expires.
name(Option<String>):The name of the access token.
status(TokenStatus):The operational status of the access token.
value(String):The access token value. This token should be included in DoH and DoT requests for authentication. Keep this value secure as it provides access to your Route 53 Global Resolver.
- On failure, responds with
SdkError<CreateAccessTokenError>
Source§impl Client
impl Client
Sourcepub fn create_dns_view(&self) -> CreateDNSViewFluentBuilder
pub fn create_dns_view(&self) -> CreateDNSViewFluentBuilder
Constructs a fluent builder for the CreateDNSView operation.
- The fluent builder is configurable:
global_resolver_id(impl Into<String>)/set_global_resolver_id(Option<String>):
required: trueThe ID of the Route 53 Global Resolver to associate with this DNS view.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique string that identifies the request and ensures idempotency.
name(impl Into<String>)/set_name(Option<String>):
required: trueA descriptive name for the DNS view.
dnssec_validation(DnsSecValidationType)/set_dnssec_validation(Option<DnsSecValidationType>):
required: falseWhether to enable DNSSEC validation for DNS queries in this DNS view. When enabled, the resolver verifies the authenticity and integrity of DNS responses from public name servers for DNSSEC-signed domains.
edns_client_subnet(EdnsClientSubnetType)/set_edns_client_subnet(Option<EdnsClientSubnetType>):
required: falseWhether to enable EDNS Client Subnet injection for DNS queries in this DNS view. When enabled, client subnet information is forwarded to provide more accurate geographic-based DNS responses.
firewall_rules_fail_open(FirewallRulesFailOpenType)/set_firewall_rules_fail_open(Option<FirewallRulesFailOpenType>):
required: falseDetermines the behavior when Route 53 Global Resolver cannot apply DNS firewall rules due to service impairment. When enabled, DNS queries are allowed through; when disabled, queries are blocked.
description(impl Into<String>)/set_description(Option<String>):
required: falseAn optional description for the DNS view.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseTags to associate with the DNS view.
- On success, responds with
CreateDnsViewOutputwith field(s):id(String):The unique identifier for the DNS view.
arn(String):The Amazon Resource Name (ARN) of the DNS view.
client_token(Option<String>):The unique string that identifies the request and ensures idempotency.
dnssec_validation(DnsSecValidationType):Whether DNSSEC validation is enabled for DNS queries in this DNS view.
edns_client_subnet(EdnsClientSubnetType):Whether EDNS Client Subnet injection is enabled for DNS queries in this DNS view.
firewall_rules_fail_open(FirewallRulesFailOpenType):The behavior when Route 53 Global Resolver cannot apply DNS firewall rules due to service impairment.
name(String):The descriptive name of the DNS view.
description(Option<String>):The description of the DNS view.
global_resolver_id(String):The ID of the Route 53 Global Resolver instance the DNS view is created for.
created_at(DateTime):The date and time when the DNS view was created.
updated_at(DateTime):The date and time when the DNS view was last updated.
status(ProfileResourceStatus):The operational status of the DNS view.
- On failure, responds with
SdkError<CreateDNSViewError>
Source§impl Client
impl Client
Sourcepub fn create_firewall_domain_list(
&self,
) -> CreateFirewallDomainListFluentBuilder
pub fn create_firewall_domain_list( &self, ) -> CreateFirewallDomainListFluentBuilder
Constructs a fluent builder for the CreateFirewallDomainList operation.
- The fluent builder is configurable:
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure idempotency. This means that making the same request multiple times with the same
clientTokenhas the same result every time.global_resolver_id(impl Into<String>)/set_global_resolver_id(Option<String>):
required: trueThe ID of the Route 53 Global Resolver that the domain list will be associated with.
description(impl Into<String>)/set_description(Option<String>):
required: falseAn optional description for the firewall domain list.
name(impl Into<String>)/set_name(Option<String>):
required: trueA descriptive name for the firewall domain list.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseAn array of user-defined keys and optional values. These tags can be used for categorization and organization.
- On success, responds with
CreateFirewallDomainListOutputwith field(s):arn(String):An Amazon Resource Name (ARN) for the domain list.
global_resolver_id(String):The ID of the Route 53 Global Resolver that the domain list is associated with.
created_at(DateTime):The time and date the domain list was created on.
description(Option<String>):Description for the domain list.
domain_count(i32):Number of domains in the domain list.
id(String):ID of the domain list.
name(String):Name of the domain list.
status(CrResourceStatus):Creation status of the domain list.
updated_at(DateTime):The time and date the domain list was updated.
- On failure, responds with
SdkError<CreateFirewallDomainListError>
Source§impl Client
impl Client
Sourcepub fn create_firewall_rule(&self) -> CreateFirewallRuleFluentBuilder
pub fn create_firewall_rule(&self) -> CreateFirewallRuleFluentBuilder
Constructs a fluent builder for the CreateFirewallRule operation.
- The fluent builder is configurable:
action(FirewallRuleAction)/set_action(Option<FirewallRuleAction>):
required: trueThe 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 CloudWatch. -
BLOCK- Disallow the request. This option requires additional details in the rule’sBlockResponse.
-
block_override_dns_type(BlockOverrideDnsQueryType)/set_block_override_dns_type(Option<BlockOverrideDnsQueryType>):
required: falseThe DNS record’s type. This determines the format of the record value that you provided in
BlockOverrideDomain. Used for the rule actionBLOCKwith aBlockResponsesetting ofOVERRIDE.This setting is required if the
BlockResponsesetting isOVERRIDE.block_override_domain(impl Into<String>)/set_block_override_domain(Option<String>):
required: falseThe custom DNS record to send back in response to the query. Used for the rule action
BLOCKwith aBlockResponsesetting ofOVERRIDE.This setting is required if the
BlockResponsesetting isOVERRIDE.block_override_ttl(i32)/set_block_override_ttl(Option<i32>):
required: falseThe recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action
BLOCKwith aBlockResponsesetting ofOVERRIDE.This setting is required if the
BlockResponsesetting isOVERRIDE.block_response(FirewallBlockResponse)/set_block_response(Option<FirewallBlockResponse>):
required: falseThe response to return when the action is BLOCK. Valid values are NXDOMAIN (domain does not exist), NODATA (domain exists but no records), or OVERRIDE (return custom response).
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure idempotency. This means that making the same request multiple times with the same
clientTokenhas the same result every time.confidence_threshold(ConfidenceThreshold)/set_confidence_threshold(Option<ConfidenceThreshold>):
required: falseThe confidence threshold for advanced threat detection. Valid values are HIGH, MEDIUM, or LOW, indicating the accuracy level required for threat detection.
description(impl Into<String>)/set_description(Option<String>):
required: falseAn optional description for the firewall rule.
dns_advanced_protection(DnsAdvancedProtection)/set_dns_advanced_protection(Option<DnsAdvancedProtection>):
required: falseWhether to enable advanced DNS threat protection for this rule. Advanced protection can detect and block DNS tunneling and Domain Generation Algorithm (DGA) threats.
firewall_domain_list_id(impl Into<String>)/set_firewall_domain_list_id(Option<String>):
required: falseThe ID of the firewall domain list to use in this rule.
name(impl Into<String>)/set_name(Option<String>):
required: trueA descriptive name for the firewall rule.
priority(i64)/set_priority(Option<i64>):
required: falseThe priority of this rule. Rules are evaluated in priority order, with lower numbers having higher priority. When a DNS query matches multiple rules, the rule with the highest priority (lowest number) is applied.
dns_view_id(impl Into<String>)/set_dns_view_id(Option<String>):
required: trueThe ID of the DNS view to associate with this firewall rule.
q_type(impl Into<String>)/set_q_type(Option<String>):
required: falseThe DNS query type to match for this rule. Examples include A (IPv4 address), AAAA (IPv6 address), MX (mail exchange), or TXT (text record).
- On success, responds with
CreateFirewallRuleOutputwith field(s):action(FirewallRuleAction):The action that DNS Firewall takes on DNS queries that match this rule.
block_override_dns_type(Option<BlockOverrideDnsQueryType>):The DNS record type for the custom response when blockResponse is OVERRIDE.
block_override_domain(Option<String>):The custom domain to return when the action is BLOCK and blockResponse is OVERRIDE.
block_override_ttl(Option<i32>):The time-to-live (TTL) value for the custom response when blockResponse is OVERRIDE.
block_response(Option<FirewallBlockResponse>):The response to return when the action is BLOCK.
confidence_threshold(Option<ConfidenceThreshold>):The confidence threshold for advanced threat detection.
created_at(DateTime):The date and time when the firewall rule was created.
description(Option<String>):The description of the firewall rule.
dns_advanced_protection(Option<DnsAdvancedProtection>):Whether advanced DNS threat protection is enabled for this rule.
firewall_domain_list_id(Option<String>):The ID of the firewall domain list used in this rule.
id(String):The unique identifier for the firewall rule.
name(String):The name of the firewall rule.
priority(i64):The priority of the firewall rule.
dns_view_id(String):The ID of the DNS view associated with this firewall rule.
query_type(Option<String>):The DNS query type that this rule matches.
status(CrResourceStatus):The operational status of the firewall rule.
updated_at(DateTime):The date and time when the firewall rule was last updated.
- On failure, responds with
SdkError<CreateFirewallRuleError>
Source§impl Client
impl Client
Sourcepub fn create_global_resolver(&self) -> CreateGlobalResolverFluentBuilder
pub fn create_global_resolver(&self) -> CreateGlobalResolverFluentBuilder
Constructs a fluent builder for the CreateGlobalResolver operation.
- The fluent builder is configurable:
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique string that identifies the request and ensures idempotency. If you make multiple requests with the same client token, only one Route 53 Global Resolver is created.
description(impl Into<String>)/set_description(Option<String>):
required: falseAn optional description for the Route 53 Global Resolver instance. Maximum length of 1024 characters.
name(impl Into<String>)/set_name(Option<String>):
required: trueA descriptive name for the Route 53 Global Resolver instance. Maximum length of 64 characters.
observability_region(impl Into<String>)/set_observability_region(Option<String>):
required: falseThe AWS region where query resolution logs and metrics will be aggregated and delivered. If not specified, logging is not enabled.
regions(impl Into<String>)/set_regions(Option<Vec::<String>>):
required: trueList of AWS regions where the Route 53 Global Resolver will operate. The resolver will be distributed across these regions to provide global availability and low-latency DNS resolution.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseTags to associate with the Route 53 Global Resolver. Tags are key-value pairs that help you organize and identify your resources.
- On success, responds with
CreateGlobalResolverOutputwith field(s):id(String):The unique identifier for the Route 53 Global Resolver.
arn(String):The Amazon Resource Name (ARN) of the Route 53 Global Resolver.
client_token(String):The unique string that identifies the request and ensures idempotency.
created_at(DateTime):The date and time when the Route 53 Global Resolver was created.
description(Option<String>):The description of the Route 53 Global Resolver.
dns_name(String):The hostname that DNS clients should use for TLS certificate validation when connecting to the Route 53 Global Resolver. This value resolves to the global anycast IP addresses for the resolver.
ipv4_addresses(Vec::<String>):The global anycast IPv4 addresses associated with the Route 53 Global Resolver. DNS clients can send queries to these addresses from anywhere on the internet.
name(String):The name of the Route 53 Global Resolver.
observability_region(Option<String>):The AWS Region where observability data for the Route 53 Global Resolver is stored.
regions(Vec::<String>):The AWS Regions where the Route 53 Global Resolver is deployed and operational.
status(CrResourceStatus):The current status of the Route 53 Global Resolver. Possible values are CREATING (being provisioned), UPDATING (being modified), OPERATIONAL (ready to serve queries), or DELETING (being removed).
updated_at(DateTime):The date and time when the Route 53 Global Resolver was last updated.
- On failure, responds with
SdkError<CreateGlobalResolverError>
Source§impl Client
impl Client
Sourcepub fn delete_access_source(&self) -> DeleteAccessSourceFluentBuilder
pub fn delete_access_source(&self) -> DeleteAccessSourceFluentBuilder
Constructs a fluent builder for the DeleteAccessSource operation.
- The fluent builder is configurable:
access_source_id(impl Into<String>)/set_access_source_id(Option<String>):
required: trueThe unique identifier of the access source to delete.
- On success, responds with
DeleteAccessSourceOutputwith field(s):arn(String):The Amazon Resource Name (ARN) of the deleted access source.
cidr(String):The IP address or CIDR range of the deleted access source.
created_at(DateTime):The date and time when the access source was originally created.
id(String):The unique identifier of the deleted access source.
ip_address_type(IpAddressType):The IP address type of the deleted access source (IPv4 or IPv6).
name(Option<String>):The name of the deleted access source.
dns_view_id(String):The ID of the DNS view that was associated with the deleted access source.
protocol(DnsProtocol):The DNS protocol that was permitted for the deleted access source.
status(CrResourceStatus):The final status of the deleted access source.
updated_at(DateTime):The date and time when the access source was last updated before deletion.
- On failure, responds with
SdkError<DeleteAccessSourceError>
Source§impl Client
impl Client
Sourcepub fn delete_access_token(&self) -> DeleteAccessTokenFluentBuilder
pub fn delete_access_token(&self) -> DeleteAccessTokenFluentBuilder
Constructs a fluent builder for the DeleteAccessToken operation.
- The fluent builder is configurable:
access_token_id(impl Into<String>)/set_access_token_id(Option<String>):
required: trueThe unique identifier of the access token to delete.
- On success, responds with
DeleteAccessTokenOutputwith field(s):id(String):The unique identifier of the deleted access token.
status(TokenStatus):The final status of the deleted access token.
deleted_at(DateTime):The date and time when the access token was deleted.
- On failure, responds with
SdkError<DeleteAccessTokenError>
Source§impl Client
impl Client
Sourcepub fn delete_dns_view(&self) -> DeleteDNSViewFluentBuilder
pub fn delete_dns_view(&self) -> DeleteDNSViewFluentBuilder
Constructs a fluent builder for the DeleteDNSView operation.
- The fluent builder is configurable:
dns_view_id(impl Into<String>)/set_dns_view_id(Option<String>):
required: trueThe unique identifier of the DNS view to delete.
- On success, responds with
DeleteDnsViewOutputwith field(s):id(String):The unique identifier of the deleted DNS view.
arn(String):The Amazon Resource Name (ARN) of the deleted DNS view.
client_token(Option<String>):The unique string that identifies the request and ensures idempotency.
dnssec_validation(DnsSecValidationType):Whether DNSSEC validation was enabled for the deleted DNS view.
edns_client_subnet(EdnsClientSubnetType):Whether EDNS Client Subnet injection was enabled for the deleted DNS view.
firewall_rules_fail_open(FirewallRulesFailOpenType):The firewall rules fail-open behavior that was configured for the deleted DNS view.
name(String):The name of the deleted DNS view.
description(Option<String>):The description of the deleted DNS view.
global_resolver_id(String):The ID of the Route 53 Global Resolver that the deleted DNS view was associated with.
created_at(DateTime):The date and time when the DNS view was originally created.
updated_at(DateTime):The date and time when the DNS view was last updated before deletion.
status(ProfileResourceStatus):The final status of the deleted DNS view.
- On failure, responds with
SdkError<DeleteDNSViewError>
Source§impl Client
impl Client
Sourcepub fn delete_firewall_domain_list(
&self,
) -> DeleteFirewallDomainListFluentBuilder
pub fn delete_firewall_domain_list( &self, ) -> DeleteFirewallDomainListFluentBuilder
Constructs a fluent builder for the DeleteFirewallDomainList operation.
- The fluent builder is configurable:
firewall_domain_list_id(impl Into<String>)/set_firewall_domain_list_id(Option<String>):
required: trueThe unique identifier of the firewall domain list to delete.
- On success, responds with
DeleteFirewallDomainListOutputwith field(s):arn(String):The Amazon Resource Name (ARN) of the deleted firewall domain list.
id(String):The unique identifier of the deleted firewall domain list.
name(String):The name of the deleted firewall domain list.
status(CrResourceStatus):The final status of the deleted firewall domain list.
- On failure, responds with
SdkError<DeleteFirewallDomainListError>
Source§impl Client
impl Client
Sourcepub fn delete_firewall_rule(&self) -> DeleteFirewallRuleFluentBuilder
pub fn delete_firewall_rule(&self) -> DeleteFirewallRuleFluentBuilder
Constructs a fluent builder for the DeleteFirewallRule operation.
- The fluent builder is configurable:
firewall_rule_id(impl Into<String>)/set_firewall_rule_id(Option<String>):
required: trueThe unique identifier of the firewall rule to delete.
- On success, responds with
DeleteFirewallRuleOutputwith field(s):action(FirewallRuleAction):The action that was configured for the deleted firewall rule.
block_override_dns_type(Option<BlockOverrideDnsQueryType>):The DNS record type that was configured for the deleted firewall rule’s custom response.
block_override_domain(Option<String>):The custom domain that was configured for the deleted firewall rule’s BLOCK response.
block_override_ttl(Option<i32>):The TTL value that was configured for the deleted firewall rule’s custom response.
block_response(Option<FirewallBlockResponse>):The block response type that was configured for the deleted firewall rule.
confidence_threshold(Option<ConfidenceThreshold>):The confidence threshold that was configured for the deleted firewall rule’s advanced threat detection.
created_at(DateTime):The date and time when the firewall rule was originally created.
description(Option<String>):The description of the deleted firewall rule.
dns_advanced_protection(Option<DnsAdvancedProtection>):Whether advanced DNS threat protection was enabled for the deleted firewall rule.
firewall_domain_list_id(Option<String>):The ID of the firewall domain list that was associated with the deleted firewall rule.
id(String):The unique identifier of the deleted firewall rule.
name(String):The name of the deleted firewall rule.
priority(i64):The priority that was configured for the deleted firewall rule.
dns_view_id(String):The ID of the DNS view that was associated with the deleted firewall rule.
query_type(Option<String>):The DNS query type that the deleted firewall rule was configured to match.
status(CrResourceStatus):The final status of the deleted firewall rule.
updated_at(DateTime):The date and time when the firewall rule was last updated before deletion.
- On failure, responds with
SdkError<DeleteFirewallRuleError>
Source§impl Client
impl Client
Sourcepub fn delete_global_resolver(&self) -> DeleteGlobalResolverFluentBuilder
pub fn delete_global_resolver(&self) -> DeleteGlobalResolverFluentBuilder
Constructs a fluent builder for the DeleteGlobalResolver operation.
- The fluent builder is configurable:
global_resolver_id(impl Into<String>)/set_global_resolver_id(Option<String>):
required: trueThe unique identifier of the Route 53 Global Resolver to delete.
- On success, responds with
DeleteGlobalResolverOutputwith field(s):id(String):The unique identifier of the deleted Route 53 Global Resolver.
arn(String):The Amazon Resource Name (ARN) of the deleted Route 53 Global Resolver.
client_token(String):The unique string that identifies the request and ensures idempotency.
dns_name(String):The hostname that DNS clients used for TLS certificate validation when connecting to the deleted Route 53 Global Resolver.
observability_region(Option<String>):The AWS Region where observability data for the deleted Route 53 Global Resolver was stored.
name(String):The name of the deleted Route 53 Global Resolver.
description(Option<String>):The description of the deleted Route 53 Global Resolver.
regions(Vec::<String>):The AWS Regions where the deleted Route 53 Global Resolver was deployed and operational.
created_at(DateTime):The date and time when the Route 53 Global Resolver was originally created.
updated_at(DateTime):The date and time when the Route 53 Global Resolver was last updated before deletion.
status(CrResourceStatus):The final status of the deleted Route 53 Global Resolver.
ipv4_addresses(Vec::<String>):The global anycast IPv4 addresses that were associated with the deleted Route 53 Global Resolver.
- On failure, responds with
SdkError<DeleteGlobalResolverError>
Source§impl Client
impl Client
Sourcepub fn disable_dns_view(&self) -> DisableDNSViewFluentBuilder
pub fn disable_dns_view(&self) -> DisableDNSViewFluentBuilder
Constructs a fluent builder for the DisableDNSView operation.
- The fluent builder is configurable:
dns_view_id(impl Into<String>)/set_dns_view_id(Option<String>):
required: trueThe unique identifier of the DNS view to disable.
- On success, responds with
DisableDnsViewOutputwith field(s):id(String):The unique identifier of the disabled DNS view.
arn(String):The Amazon Resource Name (ARN) of the disabled DNS view.
client_token(Option<String>):The unique string that identifies the request and ensures idempotency.
dnssec_validation(DnsSecValidationType):Whether DNSSEC validation is enabled for the disabled DNS view.
edns_client_subnet(EdnsClientSubnetType):Whether EDNS Client Subnet injection is enabled for the disabled DNS view.
firewall_rules_fail_open(FirewallRulesFailOpenType):The firewall rules fail-open behavior configured for the disabled DNS view.
name(String):The name of the disabled DNS view.
description(Option<String>):The description of the disabled DNS view.
global_resolver_id(String):The ID of the Route 53 Global Resolver that the disabled DNS view is associated with.
created_at(DateTime):The date and time when the DNS view was originally created.
updated_at(DateTime):The date and time when the DNS view was last updated.
status(ProfileResourceStatus):The current status of the disabled DNS view.
- On failure, responds with
SdkError<DisableDNSViewError>
Source§impl Client
impl Client
Sourcepub fn disassociate_hosted_zone(&self) -> DisassociateHostedZoneFluentBuilder
pub fn disassociate_hosted_zone(&self) -> DisassociateHostedZoneFluentBuilder
Constructs a fluent builder for the DisassociateHostedZone operation.
- The fluent builder is configurable:
hosted_zone_id(impl Into<String>)/set_hosted_zone_id(Option<String>):
required: trueThe ID of the Route 53 private hosted zone to disassociate.
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the Route 53 Global Resolver resource to disassociate the hosted zone from.
- On success, responds with
DisassociateHostedZoneOutputwith field(s):id(String):The unique identifier of the disassociation.
resource_arn(String):The Amazon Resource Name (ARN) of the Route 53 Global Resolver resource that the hosted zone was disassociated from.
hosted_zone_id(String):The ID of the Route 53 private hosted zone that was disassociated.
hosted_zone_name(String):The name of the Route 53 private hosted zone that was disassociated.
name(String):The name of the association that was removed.
created_at(DateTime):The date and time when the association was originally created.
updated_at(DateTime):The date and time when the association was last updated before disassociation.
status(HostedZoneAssociationStatus):The final status of the disassociation.
- On failure, responds with
SdkError<DisassociateHostedZoneError>
Source§impl Client
impl Client
Sourcepub fn enable_dns_view(&self) -> EnableDNSViewFluentBuilder
pub fn enable_dns_view(&self) -> EnableDNSViewFluentBuilder
Constructs a fluent builder for the EnableDNSView operation.
- The fluent builder is configurable:
dns_view_id(impl Into<String>)/set_dns_view_id(Option<String>):
required: trueThe unique identifier of the DNS view to enable.
- On success, responds with
EnableDnsViewOutputwith field(s):id(String):The unique identifier of the enabled DNS view.
arn(String):The Amazon Resource Name (ARN) of the enabled DNS view.
client_token(Option<String>):The unique string that identifies the request and ensures idempotency.
dnssec_validation(DnsSecValidationType):Whether DNSSEC validation is enabled for the enabled DNS view.
edns_client_subnet(EdnsClientSubnetType):Whether EDNS Client Subnet injection is enabled for the enabled DNS view.
firewall_rules_fail_open(FirewallRulesFailOpenType):The firewall rules fail-open behavior configured for the enabled DNS view.
name(String):The name of the enabled DNS view.
description(Option<String>):The description of the enabled DNS view.
global_resolver_id(String):The ID of the Route 53 Global Resolver that the enabled DNS view is associated with.
created_at(DateTime):The date and time when the DNS view was originally created.
updated_at(DateTime):The date and time when the DNS view was last updated.
status(ProfileResourceStatus):The current status of the enabled DNS view.
- On failure, responds with
SdkError<EnableDNSViewError>
Source§impl Client
impl Client
Sourcepub fn get_access_source(&self) -> GetAccessSourceFluentBuilder
pub fn get_access_source(&self) -> GetAccessSourceFluentBuilder
Constructs a fluent builder for the GetAccessSource operation.
- The fluent builder is configurable:
access_source_id(impl Into<String>)/set_access_source_id(Option<String>):
required: trueThe unique identifier of the access source to retrieve.
- On success, responds with
GetAccessSourceOutputwith field(s):arn(String):The Amazon Resource Name (ARN) of the access source.
cidr(String):The IP range for the rule’s parameters in CIDR notation.
created_at(DateTime):The time and date the rule was created.
id(String):ID for the rule.
ip_address_type(IpAddressType):The IP address type.
name(Option<String>):Name for the access source.
dns_view_id(String):ID for the DNS view that the rule is associated to.
protocol(DnsProtocol):The protocol determines how data is transmitted to a Global Resolver instance.
status(CrResourceStatus):Information about the status of the rule.
updated_at(DateTime):The time and date the access source was updated.
- On failure, responds with
SdkError<GetAccessSourceError>
Source§impl Client
impl Client
Sourcepub fn get_access_token(&self) -> GetAccessTokenFluentBuilder
pub fn get_access_token(&self) -> GetAccessTokenFluentBuilder
Constructs a fluent builder for the GetAccessToken operation.
- The fluent builder is configurable:
access_token_id(impl Into<String>)/set_access_token_id(Option<String>):
required: trueID of the token.
- On success, responds with
GetAccessTokenOutputwith field(s):id(String):ID of the token.
arn(String):The Amazon Resource Name (ARN) of the token.
client_token(Option<String>):A unique, case-sensitive identifier to ensure idempotency. This means that making the same request multiple times with the same
clientTokenhas the same result every time.created_at(DateTime):The time and date the token was created.
dns_view_id(String):ID of the DNS view the token is associated to.
expires_at(DateTime):The token’s expiration time and date.
global_resolver_id(String):ID of the Global Resolver.
name(Option<String>):Name of the token.
status(TokenStatus):The operational status of the token.
updated_at(DateTime):The time and date the token was created.
value(String):The value of the token.
- On failure, responds with
SdkError<GetAccessTokenError>
Source§impl Client
impl Client
Sourcepub fn get_dns_view(&self) -> GetDNSViewFluentBuilder
pub fn get_dns_view(&self) -> GetDNSViewFluentBuilder
Constructs a fluent builder for the GetDNSView operation.
- The fluent builder is configurable:
dns_view_id(impl Into<String>)/set_dns_view_id(Option<String>):
required: trueThe ID of the DNS view to retrieve information about.
- On success, responds with
GetDnsViewOutputwith field(s):id(String):ID of the DNS view.
arn(String):Amazon Resource Name (ARN) of the DNS view.
client_token(Option<String>):A unique, case-sensitive identifier to ensure idempotency. This means that making the same request multiple times with the same
clientTokenhas the same result every time.dnssec_validation(DnsSecValidationType):Specifies whether DNSSEC is enabled or disabled for the DNS view.
edns_client_subnet(EdnsClientSubnetType):Specifies whether edns0 client subnet is enabled.
firewall_rules_fail_open(FirewallRulesFailOpenType):Specifies the DNS Firewall failure mode configuration. When enabled, the DNS Firewall allows DNS queries to proceed if it’s unable to properly evaluate them. When disabled, the DNS Firewall blocks DNS queries it’s unable to evaluate.
name(String):Name of the DNS view.
description(Option<String>):Description of the DNS view.
global_resolver_id(String):ID of the Global Resolver the DNS view is associated to.
created_at(DateTime):The time and date the DNS view was creates on.
updated_at(DateTime):The time and date the DNS view was updated on.
status(ProfileResourceStatus):Operational status of the DNS view.
- On failure, responds with
SdkError<GetDNSViewError>
Source§impl Client
impl Client
Sourcepub fn get_firewall_domain_list(&self) -> GetFirewallDomainListFluentBuilder
pub fn get_firewall_domain_list(&self) -> GetFirewallDomainListFluentBuilder
Constructs a fluent builder for the GetFirewallDomainList operation.
- The fluent builder is configurable:
firewall_domain_list_id(impl Into<String>)/set_firewall_domain_list_id(Option<String>):
required: trueID of the domain list.
- On success, responds with
GetFirewallDomainListOutputwith field(s):arn(String):Amazon Resource Name (ARN) of the domain list.
global_resolver_id(String):ID of the Global Resolver that the domain list is associated to.
client_token(Option<String>):A unique, case-sensitive identifier to ensure idempotency. This means that making the same request multiple times with the same
clientTokenhas the same result every time.created_at(DateTime):The time and date the domain list was created.
description(Option<String>):The description of the domain list.
domain_count(i32):Number of domains in the domain list.
id(String):ID of the domain list.
name(String):Name of the domain list.
status(CrResourceStatus):Operational status of the domain list.
status_message(Option<String>):Additional information about the status of the domain list.
updated_at(DateTime):The date and time the domain list was updated.
- On failure, responds with
SdkError<GetFirewallDomainListError>
Source§impl Client
impl Client
Sourcepub fn get_firewall_rule(&self) -> GetFirewallRuleFluentBuilder
pub fn get_firewall_rule(&self) -> GetFirewallRuleFluentBuilder
Constructs a fluent builder for the GetFirewallRule operation.
- The fluent builder is configurable:
firewall_rule_id(impl Into<String>)/set_firewall_rule_id(Option<String>):
required: trueID of the DNS Firewall rule.
- On success, responds with
GetFirewallRuleOutputwith field(s):action(FirewallRuleAction):The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule’s domain list, or a threat in a DNS Firewall Advanced rule.
block_override_dns_type(Option<BlockOverrideDnsQueryType>):The DNS record’s type. This determines the format of the record value that you provided in
BlockOverrideDomain. Used for the rule actionBLOCKwith aBlockResponsesetting ofOVERRIDE.block_override_domain(Option<String>):The custom DNS record to send back in response to the query. Used for the rule action
BLOCKwith aBlockResponsesetting ofOVERRIDE.block_override_ttl(Option<i32>):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
BLOCKwith aBlockResponsesetting ofOVERRIDE.block_response(Option<FirewallBlockResponse>):The way that you want DNS Firewall to block the request. Used for the rule action setting
BLOCK.confidence_threshold(Option<ConfidenceThreshold>):The confidence threshold for DNS Firewall Advanced. You must provide this value when you create a DNS Firewall Advanced rule.
created_at(DateTime):The time and date the DNS Firewall rule was created.
description(Option<String>):The description of the DNS Firewall rule.
dns_advanced_protection(Option<DnsAdvancedProtection>):The type of the DNS Firewall Advanced rule. Valid values are DGA and DNS_TUNNELING.
firewall_domain_list_id(Option<String>):The ID of a DNS Firewall domain list.
id(String):ID of the DNS Firewall rule.
name(String):The name of the DNS Firewall rule.
priority(i64):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.
dns_view_id(String):The DNS view ID the DNS Firewall is associated with.
query_type(Option<String>):The DNS query type you want the rule to evaluate.
status(CrResourceStatus):The operational status of the DNS Firewall rule.
updated_at(DateTime):The date and time the DNS Firewall rule was updated.
- On failure, responds with
SdkError<GetFirewallRuleError>
Source§impl Client
impl Client
Sourcepub fn get_global_resolver(&self) -> GetGlobalResolverFluentBuilder
pub fn get_global_resolver(&self) -> GetGlobalResolverFluentBuilder
Constructs a fluent builder for the GetGlobalResolver operation.
- The fluent builder is configurable:
global_resolver_id(impl Into<String>)/set_global_resolver_id(Option<String>):
required: trueThe ID of the Route 53 Global Resolver to retrieve information about.
- On success, responds with
GetGlobalResolverOutputwith field(s):id(String):The ID of the Global Resolver.
arn(String):The Amazon Resource Name (ARN) of the Global Resolver.
client_token(String):A unique, case-sensitive identifier to ensure idempotency. This means that making the same request multiple times with the same
clientTokenhas the same result every time.dns_name(String):The hostname used by the customers’ DNS clients for certification validation.
observability_region(Option<String>):The AWS Regions in which the users’ Global Resolver query resolution logs will be propagated.
name(String):The name of the Global Resolver.
description(Option<String>):The description of the Global Resolver.
regions(Vec::<String>):The AWS Regions in which the Global Resolver operate.
created_at(DateTime):The date and time the Global Resolver was created.
updated_at(DateTime):The date and time the Global Resolver was updated.
status(CrResourceStatus):The operational status of the Global Resolver.
ipv4_addresses(Vec::<String>):List of anycast IPv4 addresses associated with the Global Resolver instance.
- On failure, responds with
SdkError<GetGlobalResolverError>
Source§impl Client
impl Client
Sourcepub fn get_hosted_zone_association(
&self,
) -> GetHostedZoneAssociationFluentBuilder
pub fn get_hosted_zone_association( &self, ) -> GetHostedZoneAssociationFluentBuilder
Constructs a fluent builder for the GetHostedZoneAssociation operation.
- The fluent builder is configurable:
hosted_zone_association_id(impl Into<String>)/set_hosted_zone_association_id(Option<String>):
required: trueID of the private hosted zone association.
- On success, responds with
GetHostedZoneAssociationOutputwith field(s):id(String):ID of the private hosted zone association.
resource_arn(String):Amazon Resource Name (ARN) of the DNS view the private hosted zone is associated to.
hosted_zone_id(String):ID of the hosted zone associated to the DNS view.
hosted_zone_name(String):Name of the domain associated with the private hosted zone.
name(String):Name of the private hosted zone association.
created_at(DateTime):The time and date the private hosted zone association was created.
updated_at(DateTime):The time and date the private hosted zone association was updated.
status(HostedZoneAssociationStatus):The operational status of the private hosted zone association.
- On failure, responds with
SdkError<GetHostedZoneAssociationError>
Source§impl Client
impl Client
Sourcepub fn get_managed_firewall_domain_list(
&self,
) -> GetManagedFirewallDomainListFluentBuilder
pub fn get_managed_firewall_domain_list( &self, ) -> GetManagedFirewallDomainListFluentBuilder
Constructs a fluent builder for the GetManagedFirewallDomainList operation.
- The fluent builder is configurable:
managed_firewall_domain_list_id(impl Into<String>)/set_managed_firewall_domain_list_id(Option<String>):
required: trueID of the Managed Domain List.
- On success, responds with
GetManagedFirewallDomainListOutputwith field(s):description(Option<String>):Description of the Managed Domain List.
id(String):ID of the Managed Domain List.
name(String):Name of the Managed Domain List.
managed_list_type(String):Type of the managed category. This is either
THREATorCONTENT.
- On failure, responds with
SdkError<GetManagedFirewallDomainListError>
Source§impl Client
impl Client
Sourcepub fn import_firewall_domains(&self) -> ImportFirewallDomainsFluentBuilder
pub fn import_firewall_domains(&self) -> ImportFirewallDomainsFluentBuilder
Constructs a fluent builder for the ImportFirewallDomains operation.
- The fluent builder is configurable:
domain_file_url(impl Into<String>)/set_domain_file_url(Option<String>):
required: trueThe fully qualified URL of the file in Amazon S3 that contains the list of domains to import. The file should contain one domain per line.
firewall_domain_list_id(impl Into<String>)/set_firewall_domain_list_id(Option<String>):
required: trueID of the DNS Firewall domain list that you want to import the domain list to.
operation(impl Into<String>)/set_operation(Option<String>):
required: trueThis value is
REPLACE, and it updates the domain list to match the list of domains in the imported file.
- On success, responds with
ImportFirewallDomainsOutputwith field(s):id(String):ID of the DNS Firewall domain list that you imported the domain list to.
name(String):Name of the DNS Firewall domain list.
status(CrResourceStatus):Operational status of the DNS Firewall domain list.
- On failure, responds with
SdkError<ImportFirewallDomainsError>
Source§impl Client
impl Client
Sourcepub fn list_access_sources(&self) -> ListAccessSourcesFluentBuilder
pub fn list_access_sources(&self) -> ListAccessSourcesFluentBuilder
Constructs a fluent builder for the ListAccessSources operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to retrieve in a single call.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseA pagination token used for large sets of results that can’t be returned in a single response.
filters(impl Into<String>, Vec::<String>)/set_filters(Option<HashMap::<String, Vec::<String>>>):
required: falseValues to filter the results.
- On success, responds with
ListAccessSourcesOutputwith field(s):next_token(Option<String>):A pagination token used for large sets of results that can’t be returned in a single response. Provide this token in the next call to get the results not returned in this call.
access_sources(Vec::<AccessSourcesItem>):An array containing information about the access sources, such as the ID, CIDR etc.
- On failure, responds with
SdkError<ListAccessSourcesError>
Source§impl Client
impl Client
Sourcepub fn list_access_tokens(&self) -> ListAccessTokensFluentBuilder
pub fn list_access_tokens(&self) -> ListAccessTokensFluentBuilder
Constructs a fluent builder for the ListAccessTokens operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to retrieve in a single call.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseA pagination token used for large sets of results that can’t be returned in a single response.
dns_view_id(impl Into<String>)/set_dns_view_id(Option<String>):
required: trueThe ID of the DNS view to list the tokens for.
filters(impl Into<String>, Vec::<String>)/set_filters(Option<HashMap::<String, Vec::<String>>>):
required: falseFiltering parameters.
- On success, responds with
ListAccessTokensOutputwith field(s):next_token(Option<String>):A pagination token used for large sets of results that can’t be returned in a single response. Provide this token in the next call to get the results not returned in this call.
access_tokens(Option<Vec::<AccessTokenItem>>):List of the tokens.
- On failure, responds with
SdkError<ListAccessTokensError>
Source§impl Client
impl Client
Sourcepub fn list_dns_views(&self) -> ListDNSViewsFluentBuilder
pub fn list_dns_views(&self) -> ListDNSViewsFluentBuilder
Constructs a fluent builder for the ListDNSViews operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to retrieve in a single call.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseA pagination token used for large sets of results that can’t be returned in a single response.
global_resolver_id(impl Into<String>)/set_global_resolver_id(Option<String>):
required: trueThe Global Resolver ID.
- On success, responds with
ListDnsViewsOutputwith field(s):next_token(Option<String>):A pagination token used for large sets of results that can’t be returned in a single response. Provide this token in the next call to get the results not returned in this call.
dns_views(Vec::<DnsViewSummary>):An array of information about the DNS views, such as whether DNSSEC is enabled, creation time, etc.
- On failure, responds with
SdkError<ListDNSViewsError>
Source§impl Client
impl Client
Sourcepub fn list_firewall_domain_lists(&self) -> ListFirewallDomainListsFluentBuilder
pub fn list_firewall_domain_lists(&self) -> ListFirewallDomainListsFluentBuilder
Constructs a fluent builder for the ListFirewallDomainLists operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to retrieve in a single call.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseA pagination token used for large sets of results that can’t be returned in a single response.
global_resolver_id(impl Into<String>)/set_global_resolver_id(Option<String>):
required: falseThe ID of the Global Resolver that contains the DNS view the domain lists are associated to.
- On success, responds with
ListFirewallDomainListsOutputwith field(s):next_token(Option<String>):A pagination token used for large sets of results that can’t be returned in a single response. Provide this token in the next call to get the results not returned in this call.
firewall_domain_lists(Vec::<FirewallDomainListsItem>):List of the DNS Firewall domain lists.
- On failure, responds with
SdkError<ListFirewallDomainListsError>
Source§impl Client
impl Client
Sourcepub fn list_firewall_domains(&self) -> ListFirewallDomainsFluentBuilder
pub fn list_firewall_domains(&self) -> ListFirewallDomainsFluentBuilder
Constructs a fluent builder for the ListFirewallDomains operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to retrieve in a single call.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseA pagination token used for large sets of results that can’t be returned in a single response.
firewall_domain_list_id(impl Into<String>)/set_firewall_domain_list_id(Option<String>):
required: trueID of the DNS Firewall domain list.
- On success, responds with
ListFirewallDomainsOutputwith field(s):next_token(Option<String>):A pagination token used for large sets of results that can’t be returned in a single response. Provide this token in the next call to get the results not returned in this call.
domains(Vec::<String>):List of domains in the specified domain list.
- On failure, responds with
SdkError<ListFirewallDomainsError>
Source§impl Client
impl Client
Sourcepub fn list_firewall_rules(&self) -> ListFirewallRulesFluentBuilder
pub fn list_firewall_rules(&self) -> ListFirewallRulesFluentBuilder
Constructs a fluent builder for the ListFirewallRules operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to retrieve in a single call.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseA pagination token used for large sets of results that can’t be returned in a single response.
dns_view_id(impl Into<String>)/set_dns_view_id(Option<String>):
required: trueID of the DNS view.
filters(impl Into<String>, Vec::<String>)/set_filters(Option<HashMap::<String, Vec::<String>>>):
required: falseValues to filter the results.
- On success, responds with
ListFirewallRulesOutputwith field(s):next_token(Option<String>):A pagination token used for large sets of results that can’t be returned in a single response. Provide this token in the next call to get the results not returned in this call.
firewall_rules(Vec::<FirewallRulesItem>):List of the firewall rules and information about them.
- On failure, responds with
SdkError<ListFirewallRulesError>
Source§impl Client
impl Client
Sourcepub fn list_global_resolvers(&self) -> ListGlobalResolversFluentBuilder
pub fn list_global_resolvers(&self) -> ListGlobalResolversFluentBuilder
Constructs a fluent builder for the ListGlobalResolvers operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of Route 53 Global Resolver instances to return in the response. Valid range is 1-100.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token for the next page of results. This value is returned in the response if there are more results to retrieve.
- On success, responds with
ListGlobalResolversOutputwith field(s):next_token(Option<String>):A pagination token used for large sets of results that can’t be returned in a single response. Provide this token in the next call to get the results not returned in this call.
global_resolvers(Vec::<GlobalResolversItem>):Paginated list of Global Resolvers.
- On failure, responds with
SdkError<ListGlobalResolversError>
Source§impl Client
impl Client
Sourcepub fn list_hosted_zone_associations(
&self,
) -> ListHostedZoneAssociationsFluentBuilder
pub fn list_hosted_zone_associations( &self, ) -> ListHostedZoneAssociationsFluentBuilder
Constructs a fluent builder for the ListHostedZoneAssociations operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to retrieve in a single call.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseA pagination token used for large sets of results that can’t be returned in a single response.
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueAmazon Resource Name (ARN) of the DNS view.
- On success, responds with
ListHostedZoneAssociationsOutputwith field(s):next_token(Option<String>):A pagination token used for large sets of results that can’t be returned in a single response. Provide this token in the next call to get the results not returned in this call.
hosted_zone_associations(Vec::<HostedZoneAssociationSummary>):List of the private hosted zone associations.
- On failure, responds with
SdkError<ListHostedZoneAssociationsError>
Source§impl Client
impl Client
Sourcepub fn list_managed_firewall_domain_lists(
&self,
) -> ListManagedFirewallDomainListsFluentBuilder
pub fn list_managed_firewall_domain_lists( &self, ) -> ListManagedFirewallDomainListsFluentBuilder
Constructs a fluent builder for the ListManagedFirewallDomainLists operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to retrieve in a single call.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseA pagination token used for large sets of results that can’t be returned in a single response.
managed_firewall_domain_list_type(impl Into<String>)/set_managed_firewall_domain_list_type(Option<String>):
required: trueThe category of the Manage DNS list either
THREATorCONTENT.
- On success, responds with
ListManagedFirewallDomainListsOutputwith field(s):next_token(Option<String>):A pagination token used for large sets of results that can’t be returned in a single response. Provide this token in the next call to get the results not returned in this call.
managed_firewall_domain_lists(Vec::<ManagedFirewallDomainListsItem>):List of the Managed Domain Lists.
- On failure, responds with
SdkError<ListManagedFirewallDomainListsError>
Source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueAmazon Resource Name (ARN) for the resource.
- On success, responds with
ListTagsForResourceOutputwith field(s):tags(Option<HashMap::<String, String>>):An array of user-defined keys and optional values. These tags can be used for categorization and organization.
- On failure, responds with
SdkError<ListTagsForResourceError>
Source§impl Client
impl Client
Sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueAmazon Resource Name (ARN) of the resource to be tagged.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: trueAn array of user-defined keys and optional values. These tags can be used for categorization and organization.
- On success, responds with
TagResourceOutput - On failure, responds with
SdkError<TagResourceError>
Source§impl Client
impl Client
Sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueAmazon Resource Name (ARN) of the resource.
tag_keys(impl Into<String>)/set_tag_keys(Option<Vec::<String>>):
required: trueThe tag keys associated with the resource.
- On success, responds with
UntagResourceOutput - On failure, responds with
SdkError<UntagResourceError>
Source§impl Client
impl Client
Sourcepub fn update_access_source(&self) -> UpdateAccessSourceFluentBuilder
pub fn update_access_source(&self) -> UpdateAccessSourceFluentBuilder
Constructs a fluent builder for the UpdateAccessSource operation.
- The fluent builder is configurable:
access_source_id(impl Into<String>)/set_access_source_id(Option<String>):
required: trueThe unique identifier of the access source to update.
cidr(impl Into<String>)/set_cidr(Option<String>):
required: falseThe CIDR block for the access source.
ip_address_type(IpAddressType)/set_ip_address_type(Option<IpAddressType>):
required: falseThe IP address type for the access source.
name(impl Into<String>)/set_name(Option<String>):
required: falseThe name of the access source.
protocol(DnsProtocol)/set_protocol(Option<DnsProtocol>):
required: falseThe protocol for the access source.
- On success, responds with
UpdateAccessSourceOutputwith field(s):arn(String):The Amazon Resource Name (ARN) of the updated access source.
cidr(String):The CIDR block of the updated access source.
created_at(DateTime):The date and time when the access source was originally created.
id(String):The unique identifier of the updated access source.
ip_address_type(IpAddressType):The IP address type of the updated access source.
name(Option<String>):The name of the updated access source.
dns_view_id(String):The ID of the DNS view associated with the updated access source.
protocol(DnsProtocol):The protocol of the updated access source.
status(CrResourceStatus):The current status of the updated access source.
updated_at(DateTime):The date and time when the access source was last updated.
- On failure, responds with
SdkError<UpdateAccessSourceError>
Source§impl Client
impl Client
Sourcepub fn update_access_token(&self) -> UpdateAccessTokenFluentBuilder
pub fn update_access_token(&self) -> UpdateAccessTokenFluentBuilder
Constructs a fluent builder for the UpdateAccessToken operation.
- The fluent builder is configurable:
access_token_id(impl Into<String>)/set_access_token_id(Option<String>):
required: trueThe ID of the token.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe new name of the token.
- On success, responds with
UpdateAccessTokenOutputwith field(s):id(String):The ID of the token.
name(String):The name of the token.
- On failure, responds with
SdkError<UpdateAccessTokenError>
Source§impl Client
impl Client
Sourcepub fn update_dns_view(&self) -> UpdateDNSViewFluentBuilder
pub fn update_dns_view(&self) -> UpdateDNSViewFluentBuilder
Constructs a fluent builder for the UpdateDNSView operation.
- The fluent builder is configurable:
dns_view_id(impl Into<String>)/set_dns_view_id(Option<String>):
required: trueThe unique identifier of the DNS view to update.
name(impl Into<String>)/set_name(Option<String>):
required: falseThe name of the DNS view.
description(impl Into<String>)/set_description(Option<String>):
required: falseA description of the DNS view.
dnssec_validation(DnsSecValidationType)/set_dnssec_validation(Option<DnsSecValidationType>):
required: falseWhether to enable DNSSEC validation for the DNS view.
edns_client_subnet(EdnsClientSubnetType)/set_edns_client_subnet(Option<EdnsClientSubnetType>):
required: falseWhether to enable EDNS Client Subnet injection for the DNS view.
firewall_rules_fail_open(FirewallRulesFailOpenType)/set_firewall_rules_fail_open(Option<FirewallRulesFailOpenType>):
required: falseWhether firewall rules should fail open when they cannot be evaluated.
- On success, responds with
UpdateDnsViewOutputwith field(s):id(String):The unique identifier of the updated DNS view.
arn(String):The Amazon Resource Name (ARN) of the updated DNS view.
client_token(Option<String>):The unique string that identifies the request and ensures idempotency.
dnssec_validation(DnsSecValidationType):Whether DNSSEC validation is enabled for the updated DNS view.
edns_client_subnet(EdnsClientSubnetType):Whether EDNS Client Subnet injection is enabled for the updated DNS view.
firewall_rules_fail_open(FirewallRulesFailOpenType):Whether firewall rules fail open when they cannot be evaluated for the updated DNS view.
name(String):The name of the updated DNS view.
description(Option<String>):The description of the updated DNS view.
global_resolver_id(String):The ID of the global resolver associated with the updated DNS view.
created_at(DateTime):The date and time when the DNS view was originally created.
updated_at(DateTime):The date and time when the DNS view was last updated.
status(ProfileResourceStatus):The current status of the updated DNS view.
- On failure, responds with
SdkError<UpdateDNSViewError>
Source§impl Client
impl Client
Sourcepub fn update_firewall_domains(&self) -> UpdateFirewallDomainsFluentBuilder
pub fn update_firewall_domains(&self) -> UpdateFirewallDomainsFluentBuilder
Constructs a fluent builder for the UpdateFirewallDomains operation.
- The fluent builder is configurable:
domains(impl Into<String>)/set_domains(Option<Vec::<String>>):
required: trueA list of the domains. You can add up to 1000 domains per request.
firewall_domain_list_id(impl Into<String>)/set_firewall_domain_list_id(Option<String>):
required: trueThe ID of the DNS Firewall domain list to which you want to add the domains.
operation(impl Into<String>)/set_operation(Option<String>):
required: trueThe operation for updating the domain list. The allowed values are ADD, REMOVE, and REPLACE.
- On success, responds with
UpdateFirewallDomainsOutputwith field(s):id(String):The ID of the DNS Firewall domain list.
name(String):The name of the domain list.
status(CrResourceStatus):The operational status of the domain list.
- On failure, responds with
SdkError<UpdateFirewallDomainsError>
Source§impl Client
impl Client
Sourcepub fn update_firewall_rule(&self) -> UpdateFirewallRuleFluentBuilder
pub fn update_firewall_rule(&self) -> UpdateFirewallRuleFluentBuilder
Constructs a fluent builder for the UpdateFirewallRule operation.
- The fluent builder is configurable:
action(FirewallRuleAction)/set_action(Option<FirewallRuleAction>):
required: falseThe action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule’s domain list, or a threat in a DNS Firewall Advanced rule.
block_override_dns_type(BlockOverrideDnsQueryType)/set_block_override_dns_type(Option<BlockOverrideDnsQueryType>):
required: falseThe DNS record’s type. This determines the format of the record value that you provided in
BlockOverrideDomain. Used for the rule actionBLOCKwith aBlockResponsesetting ofOVERRIDE.block_override_domain(impl Into<String>)/set_block_override_domain(Option<String>):
required: falseThe custom DNS record to send back in response to the query. Used for the rule action
BLOCKwith aBlockResponsesetting ofOVERRIDE.block_override_ttl(i32)/set_block_override_ttl(Option<i32>):
required: falseThe recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action
BLOCKwith aBlockResponsesetting ofOVERRIDE.block_response(FirewallBlockResponse)/set_block_response(Option<FirewallBlockResponse>):
required: falseThe way that you want DNS Firewall to block the request. Used for the rule action setting
BLOCK.client_token(impl Into<String>)/set_client_token(Option<String>):
required: trueA unique, case-sensitive identifier to ensure idempotency. This means that making the same request multiple times with the same
clientTokenhas the same result every time.confidence_threshold(ConfidenceThreshold)/set_confidence_threshold(Option<ConfidenceThreshold>):
required: falseThe confidence threshold for DNS Firewall Advanced. You must provide this value when you create a DNS Firewall Advanced rule.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe description for the Firewall rule.
dns_advanced_protection(DnsAdvancedProtection)/set_dns_advanced_protection(Option<DnsAdvancedProtection>):
required: falseThe type of the DNS Firewall Advanced rule. Valid values are DGA and DNS_TUNNELING.
firewall_rule_id(impl Into<String>)/set_firewall_rule_id(Option<String>):
required: trueThe ID of the DNS Firewall rule.
name(impl Into<String>)/set_name(Option<String>):
required: falseThe name of the DNS Firewall rule.
priority(i64)/set_priority(Option<i64>):
required: falseThe 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.
- On success, responds with
UpdateFirewallRuleOutputwith field(s):action(FirewallRuleAction):The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule’s domain list, or a threat in a DNS Firewall Advanced rule.
block_override_dns_type(Option<BlockOverrideDnsQueryType>):The DNS record’s type. This determines the format of the record value that you provided in
BlockOverrideDomain. Used for the rule actionBLOCKwith aBlockResponsesetting ofOVERRIDE.block_override_domain(Option<String>):The custom DNS record to send back in response to the query. Used for the rule action
BLOCKwith aBlockResponsesetting ofOVERRIDE.block_override_ttl(Option<i32>):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
BLOCKwith aBlockResponsesetting ofOVERRIDE.block_response(Option<FirewallBlockResponse>):The way that you want DNS Firewall to block the request. Used for the rule action setting
BLOCK.confidence_threshold(Option<ConfidenceThreshold>):The confidence threshold for DNS Firewall Advanced. You must provide this value when you create a DNS Firewall Advanced rule.
created_at(DateTime):The time and date the Firewall rule was created.
description(Option<String>):The description of the Firewall rule.
dns_advanced_protection(Option<DnsAdvancedProtection>):The type of the DNS Firewall Advanced rule. Valid values are DGA and DNS_TUNNELING.
firewall_domain_list_id(Option<String>):The ID of the domain list associated with the Firewall rule.
id(String):The ID of the Firewall rule.
name(String):The name of the Firewall rule.
priority(i64):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.
dns_view_id(String):The ID of the DNS view the Firewall rule is associated with.
query_type(Option<String>):The DNS query type you want the rule to evaluate.
status(CrResourceStatus):The operational status of the firewall rule.
updated_at(DateTime):The time and date the rule was updated.
- On failure, responds with
SdkError<UpdateFirewallRuleError>
Source§impl Client
impl Client
Sourcepub fn update_global_resolver(&self) -> UpdateGlobalResolverFluentBuilder
pub fn update_global_resolver(&self) -> UpdateGlobalResolverFluentBuilder
Constructs a fluent builder for the UpdateGlobalResolver operation.
- The fluent builder is configurable:
global_resolver_id(impl Into<String>)/set_global_resolver_id(Option<String>):
required: trueThe ID of the Global Resolver.
name(impl Into<String>)/set_name(Option<String>):
required: falseThe name of the Global Resolver.
observability_region(impl Into<String>)/set_observability_region(Option<String>):
required: falseThe AWS Regions in which the users’ Global Resolver query resolution logs will be propagated.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe description of the Global Resolver.
- On success, responds with
UpdateGlobalResolverOutputwith field(s):id(String):The ID of the Global Resolver.
arn(String):The Amazon Resource Name (ARN) of the Global Resolver.
client_token(String):A unique, case-sensitive identifier to ensure idempotency. This means that making the same request multiple times with the same
clientTokenhas the same result every time.dns_name(String):The hostname to be used by the customers’ DNS clients for certification validation.
observability_region(Option<String>):The AWS Regions in which the users’ Global Resolver query resolution logs will be propagated.
name(String):Name of the Global Resolver.
description(Option<String>):Description of the Global Resolver.
regions(Vec::<String>):The AWS Regions in which the Global Resolver will operate.
created_at(DateTime):The time and date the Global Resolverwas created.
updated_at(DateTime):The time and date the Global Resolver was updated.
status(CrResourceStatus):The operational status of the Global Resolver.
ipv4_addresses(Vec::<String>):List of anycast IPv4 addresses associated with the Global Resolver instance.
- On failure, responds with
SdkError<UpdateGlobalResolverError>
Source§impl Client
impl Client
Sourcepub fn update_hosted_zone_association(
&self,
) -> UpdateHostedZoneAssociationFluentBuilder
pub fn update_hosted_zone_association( &self, ) -> UpdateHostedZoneAssociationFluentBuilder
Constructs a fluent builder for the UpdateHostedZoneAssociation operation.
- The fluent builder is configurable:
hosted_zone_association_id(impl Into<String>)/set_hosted_zone_association_id(Option<String>):
required: trueThe ID of the private hosted zone association.
name(impl Into<String>)/set_name(Option<String>):
required: falseThe name you want to update the hosted zone association to.
- On success, responds with
UpdateHostedZoneAssociationOutputwith field(s):id(String):The ID of the private hosted zone association.
resource_arn(String):The Amazon Resource Name (ARN) of the private hosted zone association.
hosted_zone_id(String):The ID of the private hosted zone.
hosted_zone_name(String):The name of the domain associated with the private hosted zone.
name(String):The name of the private hosted zone association.
created_at(DateTime):The time and date the private hosted zone association was created.
updated_at(DateTime):The time and date the private hosted zone association was updated.
status(HostedZoneAssociationStatus):The operational status of the private hosted zone association.
- On failure, responds with
SdkError<UpdateHostedZoneAssociationError>
Source§impl Client
impl Client
Sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_implconfigured. - Identity caching is enabled without a
sleep_implandtime_sourceconfigured. - No
behavior_versionis provided.
The panic message for each of these will have instructions on how to resolve them.
Source§impl Client
impl Client
Sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_configis missing an async sleep implementation. If you experience this panic, set thesleep_implon the Config passed into this function to fix it. - This method will panic if the
sdk_configis missing an HTTP connector. If you experience this panic, set thehttp_connectoron the Config passed into this function to fix it. - This method will panic if no
BehaviorVersionis provided. If you experience this panic, setbehavior_versionon the Config or enable thebehavior-version-latestCargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);