pub struct Client { /* private fields */ }
Expand description
Client for Amazon Route 53
Client for invoking operations on Amazon Route 53. Each operation on Amazon Route 53 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_route53::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_route53::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 ActivateKeySigningKey
operation has
a Client::activate_key_signing_key
, 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.activate_key_signing_key()
.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.
§Waiters
This client provides wait_until
methods behind the Waiters
trait.
To use them, simply import the trait, and then call one of the wait_until
methods. This will
return a waiter fluent builder that takes various parameters, which are documented on the builder
type. Once parameters have been provided, the wait
method can be called to initiate waiting.
For example, if there was a wait_until_thing
method, it could look like:
let result = client.wait_until_thing()
.thing_id("someId")
.wait(Duration::from_secs(120))
.await;
Implementations§
Source§impl Client
impl Client
Sourcepub fn activate_key_signing_key(&self) -> ActivateKeySigningKeyFluentBuilder
pub fn activate_key_signing_key(&self) -> ActivateKeySigningKeyFluentBuilder
Constructs a fluent builder for the ActivateKeySigningKey
operation.
- The fluent builder is configurable:
hosted_zone_id(impl Into<String>)
/set_hosted_zone_id(Option<String>)
:
required: trueA unique string used to identify a hosted zone.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueA string used to identify a key-signing key (KSK).
Name
can include numbers, letters, and underscores (_).Name
must be unique for each key-signing key in the same hosted zone.
- On success, responds with
ActivateKeySigningKeyOutput
with field(s):change_info(Option<ChangeInfo>)
:A complex type that describes change information about changes made to your hosted zone.
- On failure, responds with
SdkError<ActivateKeySigningKeyError>
Source§impl Client
impl Client
Sourcepub fn associate_vpc_with_hosted_zone(
&self,
) -> AssociateVPCWithHostedZoneFluentBuilder
pub fn associate_vpc_with_hosted_zone( &self, ) -> AssociateVPCWithHostedZoneFluentBuilder
Constructs a fluent builder for the AssociateVPCWithHostedZone
operation.
- The fluent builder is configurable:
hosted_zone_id(impl Into<String>)
/set_hosted_zone_id(Option<String>)
:
required: trueThe ID of the private hosted zone that you want to associate an Amazon VPC with.
Note that you can’t associate a VPC with a hosted zone that doesn’t have an existing VPC association.
vpc(Vpc)
/set_vpc(Option<Vpc>)
:
required: trueA complex type that contains information about the VPC that you want to associate with a private hosted zone.
comment(impl Into<String>)
/set_comment(Option<String>)
:
required: falseOptional: A comment about the association request.
- On success, responds with
AssociateVpcWithHostedZoneOutput
with field(s):change_info(Option<ChangeInfo>)
:A complex type that describes the changes made to your hosted zone.
- On failure, responds with
SdkError<AssociateVPCWithHostedZoneError>
Source§impl Client
impl Client
Sourcepub fn change_cidr_collection(&self) -> ChangeCidrCollectionFluentBuilder
pub fn change_cidr_collection(&self) -> ChangeCidrCollectionFluentBuilder
Constructs a fluent builder for the ChangeCidrCollection
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe UUID of the CIDR collection to update.
collection_version(i64)
/set_collection_version(Option<i64>)
:
required: falseA sequential counter that Amazon Route 53 sets to 1 when you create a collection and increments it by 1 each time you update the collection.
We recommend that you use
ListCidrCollection
to get the current value ofCollectionVersion
for the collection that you want to update, and then include that value with the change request. This prevents Route 53 from overwriting an intervening update:-
If the value in the request matches the value of
CollectionVersion
in the collection, Route 53 updates the collection. -
If the value of
CollectionVersion
in the collection is greater than the value in the request, the collection was changed after you got the version number. Route 53 does not update the collection, and it returns aCidrCollectionVersionMismatch
error.
-
changes(CidrCollectionChange)
/set_changes(Option<Vec::<CidrCollectionChange>>)
:
required: trueInformation about changes to a CIDR collection.
- On success, responds with
ChangeCidrCollectionOutput
with field(s):id(String)
:The ID that is returned by
ChangeCidrCollection
. You can use it as input toGetChange
to see if a CIDR collection change has propagated or not.
- On failure, responds with
SdkError<ChangeCidrCollectionError>
Source§impl Client
impl Client
Sourcepub fn change_resource_record_sets(
&self,
) -> ChangeResourceRecordSetsFluentBuilder
pub fn change_resource_record_sets( &self, ) -> ChangeResourceRecordSetsFluentBuilder
Constructs a fluent builder for the ChangeResourceRecordSets
operation.
- The fluent builder is configurable:
hosted_zone_id(impl Into<String>)
/set_hosted_zone_id(Option<String>)
:
required: trueThe ID of the hosted zone that contains the resource record sets that you want to change.
change_batch(ChangeBatch)
/set_change_batch(Option<ChangeBatch>)
:
required: trueA complex type that contains an optional comment and the
Changes
element.
- On success, responds with
ChangeResourceRecordSetsOutput
with field(s):change_info(Option<ChangeInfo>)
:A complex type that contains information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
- On failure, responds with
SdkError<ChangeResourceRecordSetsError>
Source§impl Client
impl Client
Constructs a fluent builder for the ChangeTagsForResource
operation.
- The fluent builder is configurable:
resource_type(TagResourceType)
/set_resource_type(Option<TagResourceType>)
:
required: trueThe type of the resource.
-
The resource type for health checks is
healthcheck
. -
The resource type for hosted zones is
hostedzone
.
-
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe ID of the resource for which you want to add, change, or delete tags.
add_tags(Tag)
/set_add_tags(Option<Vec::<Tag>>)
:
required: falseA complex type that contains a list of the tags that you want to add to the specified health check or hosted zone and/or the tags that you want to edit
Value
for.You can add a maximum of 10 tags to a health check or a hosted zone.
remove_tag_keys(impl Into<String>)
/set_remove_tag_keys(Option<Vec::<String>>)
:
required: falseA complex type that contains a list of the tags that you want to delete from the specified health check or hosted zone. You can specify up to 10 keys.
- On success, responds with
ChangeTagsForResourceOutput
- On failure, responds with
SdkError<ChangeTagsForResourceError>
Source§impl Client
impl Client
Sourcepub fn create_cidr_collection(&self) -> CreateCidrCollectionFluentBuilder
pub fn create_cidr_collection(&self) -> CreateCidrCollectionFluentBuilder
Constructs a fluent builder for the CreateCidrCollection
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueA unique identifier for the account that can be used to reference the collection from other API calls.
caller_reference(impl Into<String>)
/set_caller_reference(Option<String>)
:
required: trueA client-specific token that allows requests to be securely retried so that the intended outcome will only occur once, retries receive a similar response, and there are no additional edge cases to handle.
- On success, responds with
CreateCidrCollectionOutput
with field(s):collection(Option<CidrCollection>)
:A complex type that contains information about the CIDR collection.
location(Option<String>)
:A unique URL that represents the location for the CIDR collection.
- On failure, responds with
SdkError<CreateCidrCollectionError>
Source§impl Client
impl Client
Sourcepub fn create_health_check(&self) -> CreateHealthCheckFluentBuilder
pub fn create_health_check(&self) -> CreateHealthCheckFluentBuilder
Constructs a fluent builder for the CreateHealthCheck
operation.
- The fluent builder is configurable:
caller_reference(impl Into<String>)
/set_caller_reference(Option<String>)
:
required: trueA unique string that identifies the request and that allows you to retry a failed
CreateHealthCheck
request without the risk of creating two identical health checks:-
If you send a
CreateHealthCheck
request with the sameCallerReference
and settings as a previous request, and if the health check doesn’t exist, Amazon Route 53 creates the health check. If the health check does exist, Route 53 returns the settings for the existing health check. -
If you send a
CreateHealthCheck
request with the sameCallerReference
as a deleted health check, regardless of the settings, Route 53 returns aHealthCheckAlreadyExists
error. -
If you send a
CreateHealthCheck
request with the sameCallerReference
as an existing health check but with different settings, Route 53 returns aHealthCheckAlreadyExists
error. -
If you send a
CreateHealthCheck
request with a uniqueCallerReference
but settings identical to an existing health check, Route 53 creates the health check.
Route 53 does not store the
CallerReference
for a deleted health check indefinitely. TheCallerReference
for a deleted health check will be deleted after a number of days.-
health_check_config(HealthCheckConfig)
/set_health_check_config(Option<HealthCheckConfig>)
:
required: trueA complex type that contains settings for a new health check.
- On success, responds with
CreateHealthCheckOutput
with field(s):health_check(Option<HealthCheck>)
:A complex type that contains identifying information about the health check.
location(String)
:The unique URL representing the new health check.
- On failure, responds with
SdkError<CreateHealthCheckError>
Source§impl Client
impl Client
Sourcepub fn create_hosted_zone(&self) -> CreateHostedZoneFluentBuilder
pub fn create_hosted_zone(&self) -> CreateHostedZoneFluentBuilder
Constructs a fluent builder for the CreateHostedZone
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the domain. Specify a fully qualified domain name, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
If you’re creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of
NameServers
thatCreateHostedZone
returns inDelegationSet
.vpc(Vpc)
/set_vpc(Option<Vpc>)
:
required: false(Private hosted zones only) A complex type that contains information about the Amazon VPC that you’re associating with this hosted zone.
You can specify only one Amazon VPC when you create a private hosted zone. If you are associating a VPC with a hosted zone with this request, the paramaters
VPCId
andVPCRegion
are also required.To associate additional Amazon VPCs with the hosted zone, use AssociateVPCWithHostedZone after you create a hosted zone.
caller_reference(impl Into<String>)
/set_caller_reference(Option<String>)
:
required: trueA unique string that identifies the request and that allows failed
CreateHostedZone
requests to be retried without the risk of executing the operation twice. You must use a uniqueCallerReference
string every time you submit aCreateHostedZone
request.CallerReference
can be any unique string, for example, a date/time stamp.hosted_zone_config(HostedZoneConfig)
/set_hosted_zone_config(Option<HostedZoneConfig>)
:
required: false(Optional) A complex type that contains the following optional values:
-
For public and private hosted zones, an optional comment
-
For private hosted zones, an optional
PrivateZone
element
If you don’t specify a comment or the
PrivateZone
element, omitHostedZoneConfig
and the other elements.-
delegation_set_id(impl Into<String>)
/set_delegation_set_id(Option<String>)
:
required: falseIf you want to associate a reusable delegation set with this hosted zone, the ID that Amazon Route 53 assigned to the reusable delegation set when you created it. For more information about reusable delegation sets, see CreateReusableDelegationSet.
If you are using a reusable delegation set to create a public hosted zone for a subdomain, make sure that the parent hosted zone doesn’t use one or more of the same name servers. If you have overlapping nameservers, the operation will cause a
ConflictingDomainsExist
error.
- On success, responds with
CreateHostedZoneOutput
with field(s):hosted_zone(Option<HostedZone>)
:A complex type that contains general information about the hosted zone.
change_info(Option<ChangeInfo>)
:A complex type that contains information about the
CreateHostedZone
request.delegation_set(Option<DelegationSet>)
:A complex type that describes the name servers for this hosted zone.
vpc(Option<Vpc>)
:A complex type that contains information about an Amazon VPC that you associated with this hosted zone.
location(String)
:The unique URL representing the new hosted zone.
- On failure, responds with
SdkError<CreateHostedZoneError>
Source§impl Client
impl Client
Sourcepub fn create_key_signing_key(&self) -> CreateKeySigningKeyFluentBuilder
pub fn create_key_signing_key(&self) -> CreateKeySigningKeyFluentBuilder
Constructs a fluent builder for the CreateKeySigningKey
operation.
- The fluent builder is configurable:
caller_reference(impl Into<String>)
/set_caller_reference(Option<String>)
:
required: trueA unique string that identifies the request.
hosted_zone_id(impl Into<String>)
/set_hosted_zone_id(Option<String>)
:
required: trueThe unique string (ID) used to identify a hosted zone.
key_management_service_arn(impl Into<String>)
/set_key_management_service_arn(Option<String>)
:
required: trueThe Amazon resource name (ARN) for a customer managed key in Key Management Service (KMS). The
KeyManagementServiceArn
must be unique for each key-signing key (KSK) in a single hosted zone. To see an example ofKeyManagementServiceArn
that grants the correct permissions for DNSSEC, scroll down to Example.You must configure the customer managed customer managed key as follows:
- Status
-
Enabled
- Key spec
-
ECC_NIST_P256
- Key usage
-
Sign and verify
- Key policy
-
The key policy must give permission for the following actions:
-
DescribeKey
-
GetPublicKey
-
Sign
The key policy must also include the Amazon Route 53 service in the principal for your account. Specify the following:
-
“Service”: “dnssec-route53.amazonaws.com”
-
For more information about working with a customer managed key in KMS, see Key Management Service concepts.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueA string used to identify a key-signing key (KSK).
Name
can include numbers, letters, and underscores (_).Name
must be unique for each key-signing key in the same hosted zone.status(impl Into<String>)
/set_status(Option<String>)
:
required: trueA string specifying the initial status of the key-signing key (KSK). You can set the value to
ACTIVE
orINACTIVE
.
- On success, responds with
CreateKeySigningKeyOutput
with field(s):change_info(Option<ChangeInfo>)
:A complex type that describes change information about changes made to your hosted zone.
key_signing_key(Option<KeySigningKey>)
:The key-signing key (KSK) that the request creates.
location(String)
:The unique URL representing the new key-signing key (KSK).
- On failure, responds with
SdkError<CreateKeySigningKeyError>
Source§impl Client
impl Client
Sourcepub fn create_query_logging_config(
&self,
) -> CreateQueryLoggingConfigFluentBuilder
pub fn create_query_logging_config( &self, ) -> CreateQueryLoggingConfigFluentBuilder
Constructs a fluent builder for the CreateQueryLoggingConfig
operation.
- The fluent builder is configurable:
hosted_zone_id(impl Into<String>)
/set_hosted_zone_id(Option<String>)
:
required: trueThe ID of the hosted zone that you want to log queries for. You can log queries only for public hosted zones.
cloud_watch_logs_log_group_arn(impl Into<String>)
/set_cloud_watch_logs_log_group_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to send query logs to. This is the format of the ARN:
arn:aws:logs:region:account-id:log-group:log_group_name
To get the ARN for a log group, you can use the CloudWatch console, the DescribeLogGroups API action, the describe-log-groups command, or the applicable command in one of the Amazon Web Services SDKs.
- On success, responds with
CreateQueryLoggingConfigOutput
with field(s):query_logging_config(Option<QueryLoggingConfig>)
:A complex type that contains the ID for a query logging configuration, the ID of the hosted zone that you want to log queries for, and the ARN for the log group that you want Amazon Route 53 to send query logs to.
location(String)
:The unique URL representing the new query logging configuration.
- On failure, responds with
SdkError<CreateQueryLoggingConfigError>
Source§impl Client
impl Client
Sourcepub fn create_reusable_delegation_set(
&self,
) -> CreateReusableDelegationSetFluentBuilder
pub fn create_reusable_delegation_set( &self, ) -> CreateReusableDelegationSetFluentBuilder
Constructs a fluent builder for the CreateReusableDelegationSet
operation.
- The fluent builder is configurable:
caller_reference(impl Into<String>)
/set_caller_reference(Option<String>)
:
required: trueA unique string that identifies the request, and that allows you to retry failed
CreateReusableDelegationSet
requests without the risk of executing the operation twice. You must use a uniqueCallerReference
string every time you submit aCreateReusableDelegationSet
request.CallerReference
can be any unique string, for example a date/time stamp.hosted_zone_id(impl Into<String>)
/set_hosted_zone_id(Option<String>)
:
required: falseIf you want to mark the delegation set for an existing hosted zone as reusable, the ID for that hosted zone.
- On success, responds with
CreateReusableDelegationSetOutput
with field(s):delegation_set(Option<DelegationSet>)
:A complex type that contains name server information.
location(String)
:The unique URL representing the new reusable delegation set.
- On failure, responds with
SdkError<CreateReusableDelegationSetError>
Source§impl Client
impl Client
Sourcepub fn create_traffic_policy(&self) -> CreateTrafficPolicyFluentBuilder
pub fn create_traffic_policy(&self) -> CreateTrafficPolicyFluentBuilder
Constructs a fluent builder for the CreateTrafficPolicy
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the traffic policy.
document(impl Into<String>)
/set_document(Option<String>)
:
required: trueThe definition of this traffic policy in JSON format. For more information, see Traffic Policy Document Format.
comment(impl Into<String>)
/set_comment(Option<String>)
:
required: false(Optional) Any comments that you want to include about the traffic policy.
- On success, responds with
CreateTrafficPolicyOutput
with field(s):traffic_policy(Option<TrafficPolicy>)
:A complex type that contains settings for the new traffic policy.
location(String)
:A unique URL that represents a new traffic policy.
- On failure, responds with
SdkError<CreateTrafficPolicyError>
Source§impl Client
impl Client
Sourcepub fn create_traffic_policy_instance(
&self,
) -> CreateTrafficPolicyInstanceFluentBuilder
pub fn create_traffic_policy_instance( &self, ) -> CreateTrafficPolicyInstanceFluentBuilder
Constructs a fluent builder for the CreateTrafficPolicyInstance
operation.
- The fluent builder is configurable:
hosted_zone_id(impl Into<String>)
/set_hosted_zone_id(Option<String>)
:
required: trueThe ID of the hosted zone that you want Amazon Route 53 to create resource record sets in by using the configuration in a traffic policy.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe domain name (such as example.com) or subdomain name (such as www.example.com) for which Amazon Route 53 responds to DNS queries by using the resource record sets that Route 53 creates for this traffic policy instance.
ttl(i64)
/set_ttl(Option<i64>)
:
required: true(Optional) The TTL that you want Amazon Route 53 to assign to all of the resource record sets that it creates in the specified hosted zone.
traffic_policy_id(impl Into<String>)
/set_traffic_policy_id(Option<String>)
:
required: trueThe ID of the traffic policy that you want to use to create resource record sets in the specified hosted zone.
traffic_policy_version(i32)
/set_traffic_policy_version(Option<i32>)
:
required: trueThe version of the traffic policy that you want to use to create resource record sets in the specified hosted zone.
- On success, responds with
CreateTrafficPolicyInstanceOutput
with field(s):traffic_policy_instance(Option<TrafficPolicyInstance>)
:A complex type that contains settings for the new traffic policy instance.
location(String)
:A unique URL that represents a new traffic policy instance.
- On failure, responds with
SdkError<CreateTrafficPolicyInstanceError>
Source§impl Client
impl Client
Sourcepub fn create_traffic_policy_version(
&self,
) -> CreateTrafficPolicyVersionFluentBuilder
pub fn create_traffic_policy_version( &self, ) -> CreateTrafficPolicyVersionFluentBuilder
Constructs a fluent builder for the CreateTrafficPolicyVersion
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the traffic policy for which you want to create a new version.
document(impl Into<String>)
/set_document(Option<String>)
:
required: trueThe definition of this version of the traffic policy, in JSON format. You specified the JSON in the
CreateTrafficPolicyVersion
request. For more information about the JSON format, see CreateTrafficPolicy.comment(impl Into<String>)
/set_comment(Option<String>)
:
required: falseThe comment that you specified in the
CreateTrafficPolicyVersion
request, if any.
- On success, responds with
CreateTrafficPolicyVersionOutput
with field(s):traffic_policy(Option<TrafficPolicy>)
:A complex type that contains settings for the new version of the traffic policy.
location(String)
:A unique URL that represents a new traffic policy version.
- On failure, responds with
SdkError<CreateTrafficPolicyVersionError>
Source§impl Client
impl Client
Constructs a fluent builder for the CreateVPCAssociationAuthorization
operation.
- The fluent builder is configurable:
hosted_zone_id(impl Into<String>)
/set_hosted_zone_id(Option<String>)
:
required: trueThe ID of the private hosted zone that you want to authorize associating a VPC with.
vpc(Vpc)
/set_vpc(Option<Vpc>)
:
required: trueA complex type that contains the VPC ID and region for the VPC that you want to authorize associating with your hosted zone.
- On success, responds with
CreateVpcAssociationAuthorizationOutput
with field(s):hosted_zone_id(String)
:The ID of the hosted zone that you authorized associating a VPC with.
vpc(Option<Vpc>)
:The VPC that you authorized associating with a hosted zone.
- On failure, responds with
SdkError<CreateVPCAssociationAuthorizationError>
Source§impl Client
impl Client
Sourcepub fn deactivate_key_signing_key(&self) -> DeactivateKeySigningKeyFluentBuilder
pub fn deactivate_key_signing_key(&self) -> DeactivateKeySigningKeyFluentBuilder
Constructs a fluent builder for the DeactivateKeySigningKey
operation.
- The fluent builder is configurable:
hosted_zone_id(impl Into<String>)
/set_hosted_zone_id(Option<String>)
:
required: trueA unique string used to identify a hosted zone.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueA string used to identify a key-signing key (KSK).
- On success, responds with
DeactivateKeySigningKeyOutput
with field(s):change_info(Option<ChangeInfo>)
:A complex type that describes change information about changes made to your hosted zone.
- On failure, responds with
SdkError<DeactivateKeySigningKeyError>
Source§impl Client
impl Client
Sourcepub fn delete_cidr_collection(&self) -> DeleteCidrCollectionFluentBuilder
pub fn delete_cidr_collection(&self) -> DeleteCidrCollectionFluentBuilder
Constructs a fluent builder for the DeleteCidrCollection
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe UUID of the collection to delete.
- On success, responds with
DeleteCidrCollectionOutput
- On failure, responds with
SdkError<DeleteCidrCollectionError>
Source§impl Client
impl Client
Sourcepub fn delete_health_check(&self) -> DeleteHealthCheckFluentBuilder
pub fn delete_health_check(&self) -> DeleteHealthCheckFluentBuilder
Constructs a fluent builder for the DeleteHealthCheck
operation.
- The fluent builder is configurable:
health_check_id(impl Into<String>)
/set_health_check_id(Option<String>)
:
required: trueThe ID of the health check that you want to delete.
- On success, responds with
DeleteHealthCheckOutput
- On failure, responds with
SdkError<DeleteHealthCheckError>
Source§impl Client
impl Client
Sourcepub fn delete_hosted_zone(&self) -> DeleteHostedZoneFluentBuilder
pub fn delete_hosted_zone(&self) -> DeleteHostedZoneFluentBuilder
Constructs a fluent builder for the DeleteHostedZone
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the hosted zone you want to delete.
- On success, responds with
DeleteHostedZoneOutput
with field(s):change_info(Option<ChangeInfo>)
:A complex type that contains the ID, the status, and the date and time of a request to delete a hosted zone.
- On failure, responds with
SdkError<DeleteHostedZoneError>
Source§impl Client
impl Client
Sourcepub fn delete_key_signing_key(&self) -> DeleteKeySigningKeyFluentBuilder
pub fn delete_key_signing_key(&self) -> DeleteKeySigningKeyFluentBuilder
Constructs a fluent builder for the DeleteKeySigningKey
operation.
- The fluent builder is configurable:
hosted_zone_id(impl Into<String>)
/set_hosted_zone_id(Option<String>)
:
required: trueA unique string used to identify a hosted zone.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueA string used to identify a key-signing key (KSK).
- On success, responds with
DeleteKeySigningKeyOutput
with field(s):change_info(Option<ChangeInfo>)
:A complex type that describes change information about changes made to your hosted zone.
- On failure, responds with
SdkError<DeleteKeySigningKeyError>
Source§impl Client
impl Client
Sourcepub fn delete_query_logging_config(
&self,
) -> DeleteQueryLoggingConfigFluentBuilder
pub fn delete_query_logging_config( &self, ) -> DeleteQueryLoggingConfigFluentBuilder
Constructs a fluent builder for the DeleteQueryLoggingConfig
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the configuration that you want to delete.
- On success, responds with
DeleteQueryLoggingConfigOutput
- On failure, responds with
SdkError<DeleteQueryLoggingConfigError>
Source§impl Client
impl Client
Sourcepub fn delete_reusable_delegation_set(
&self,
) -> DeleteReusableDelegationSetFluentBuilder
pub fn delete_reusable_delegation_set( &self, ) -> DeleteReusableDelegationSetFluentBuilder
Constructs a fluent builder for the DeleteReusableDelegationSet
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the reusable delegation set that you want to delete.
- On success, responds with
DeleteReusableDelegationSetOutput
- On failure, responds with
SdkError<DeleteReusableDelegationSetError>
Source§impl Client
impl Client
Sourcepub fn delete_traffic_policy(&self) -> DeleteTrafficPolicyFluentBuilder
pub fn delete_traffic_policy(&self) -> DeleteTrafficPolicyFluentBuilder
Constructs a fluent builder for the DeleteTrafficPolicy
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the traffic policy that you want to delete.
version(i32)
/set_version(Option<i32>)
:
required: trueThe version number of the traffic policy that you want to delete.
- On success, responds with
DeleteTrafficPolicyOutput
- On failure, responds with
SdkError<DeleteTrafficPolicyError>
Source§impl Client
impl Client
Sourcepub fn delete_traffic_policy_instance(
&self,
) -> DeleteTrafficPolicyInstanceFluentBuilder
pub fn delete_traffic_policy_instance( &self, ) -> DeleteTrafficPolicyInstanceFluentBuilder
Constructs a fluent builder for the DeleteTrafficPolicyInstance
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the traffic policy instance that you want to delete.
When you delete a traffic policy instance, Amazon Route 53 also deletes all of the resource record sets that were created when you created the traffic policy instance.
- On success, responds with
DeleteTrafficPolicyInstanceOutput
- On failure, responds with
SdkError<DeleteTrafficPolicyInstanceError>
Source§impl Client
impl Client
Constructs a fluent builder for the DeleteVPCAssociationAuthorization
operation.
- The fluent builder is configurable:
hosted_zone_id(impl Into<String>)
/set_hosted_zone_id(Option<String>)
:
required: trueWhen removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account, the ID of the hosted zone.
vpc(Vpc)
/set_vpc(Option<Vpc>)
:
required: trueWhen removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account, a complex type that includes the ID and region of the VPC.
- On success, responds with
DeleteVpcAssociationAuthorizationOutput
- On failure, responds with
SdkError<DeleteVPCAssociationAuthorizationError>
Source§impl Client
impl Client
Sourcepub fn disable_hosted_zone_dnssec(&self) -> DisableHostedZoneDNSSECFluentBuilder
pub fn disable_hosted_zone_dnssec(&self) -> DisableHostedZoneDNSSECFluentBuilder
Constructs a fluent builder for the DisableHostedZoneDNSSEC
operation.
- The fluent builder is configurable:
hosted_zone_id(impl Into<String>)
/set_hosted_zone_id(Option<String>)
:
required: trueA unique string used to identify a hosted zone.
- On success, responds with
DisableHostedZoneDnssecOutput
with field(s):change_info(Option<ChangeInfo>)
:A complex type that describes change information about changes made to your hosted zone.
- On failure, responds with
SdkError<DisableHostedZoneDNSSECError>
Source§impl Client
impl Client
Sourcepub fn disassociate_vpc_from_hosted_zone(
&self,
) -> DisassociateVPCFromHostedZoneFluentBuilder
pub fn disassociate_vpc_from_hosted_zone( &self, ) -> DisassociateVPCFromHostedZoneFluentBuilder
Constructs a fluent builder for the DisassociateVPCFromHostedZone
operation.
- The fluent builder is configurable:
hosted_zone_id(impl Into<String>)
/set_hosted_zone_id(Option<String>)
:
required: trueThe ID of the private hosted zone that you want to disassociate a VPC from.
vpc(Vpc)
/set_vpc(Option<Vpc>)
:
required: trueA complex type that contains information about the VPC that you’re disassociating from the specified hosted zone.
comment(impl Into<String>)
/set_comment(Option<String>)
:
required: falseOptional: A comment about the disassociation request.
- On success, responds with
DisassociateVpcFromHostedZoneOutput
with field(s):change_info(Option<ChangeInfo>)
:A complex type that describes the changes made to the specified private hosted zone.
- On failure, responds with
SdkError<DisassociateVPCFromHostedZoneError>
Source§impl Client
impl Client
Sourcepub fn enable_hosted_zone_dnssec(&self) -> EnableHostedZoneDNSSECFluentBuilder
pub fn enable_hosted_zone_dnssec(&self) -> EnableHostedZoneDNSSECFluentBuilder
Constructs a fluent builder for the EnableHostedZoneDNSSEC
operation.
- The fluent builder is configurable:
hosted_zone_id(impl Into<String>)
/set_hosted_zone_id(Option<String>)
:
required: trueA unique string used to identify a hosted zone.
- On success, responds with
EnableHostedZoneDnssecOutput
with field(s):change_info(Option<ChangeInfo>)
:A complex type that describes change information about changes made to your hosted zone.
- On failure, responds with
SdkError<EnableHostedZoneDNSSECError>
Source§impl Client
impl Client
Sourcepub fn get_account_limit(&self) -> GetAccountLimitFluentBuilder
pub fn get_account_limit(&self) -> GetAccountLimitFluentBuilder
Constructs a fluent builder for the GetAccountLimit
operation.
- The fluent builder is configurable:
r#type(AccountLimitType)
/set_type(Option<AccountLimitType>)
:
required: trueThe limit that you want to get. Valid values include the following:
-
MAX_HEALTH_CHECKS_BY_OWNER: The maximum number of health checks that you can create using the current account.
-
MAX_HOSTED_ZONES_BY_OWNER: The maximum number of hosted zones that you can create using the current account.
-
MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The maximum number of reusable delegation sets that you can create using the current account.
-
MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum number of traffic policies that you can create using the current account.
-
MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: The maximum number of traffic policy instances that you can create using the current account. (Traffic policy instances are referred to as traffic flow policy records in the Amazon Route 53 console.)
-
- On success, responds with
GetAccountLimitOutput
with field(s):limit(Option<AccountLimit>)
:The current setting for the specified limit. For example, if you specified
MAX_HEALTH_CHECKS_BY_OWNER
for the value ofType
in the request, the value ofLimit
is the maximum number of health checks that you can create using the current account.count(i64)
:The current number of entities that you have created of the specified type. For example, if you specified
MAX_HEALTH_CHECKS_BY_OWNER
for the value ofType
in the request, the value ofCount
is the current number of health checks that you have created using the current account.
- On failure, responds with
SdkError<GetAccountLimitError>
Source§impl Client
impl Client
Sourcepub fn get_change(&self) -> GetChangeFluentBuilder
pub fn get_change(&self) -> GetChangeFluentBuilder
Constructs a fluent builder for the GetChange
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the change batch request. The value that you specify here is the value that
ChangeResourceRecordSets
returned in theId
element when you submitted the request.
- On success, responds with
GetChangeOutput
with field(s):change_info(Option<ChangeInfo>)
:A complex type that contains information about the specified change batch.
- On failure, responds with
SdkError<GetChangeError>
Source§impl Client
impl Client
Sourcepub fn get_checker_ip_ranges(&self) -> GetCheckerIpRangesFluentBuilder
pub fn get_checker_ip_ranges(&self) -> GetCheckerIpRangesFluentBuilder
Constructs a fluent builder for the GetCheckerIpRanges
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
GetCheckerIpRangesOutput
with field(s):checker_ip_ranges(Vec::<String>)
:A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route 53 health checkers.
- On failure, responds with
SdkError<GetCheckerIpRangesError>
Source§impl Client
impl Client
Sourcepub fn get_dnssec(&self) -> GetDNSSECFluentBuilder
pub fn get_dnssec(&self) -> GetDNSSECFluentBuilder
Constructs a fluent builder for the GetDNSSEC
operation.
- The fluent builder is configurable:
hosted_zone_id(impl Into<String>)
/set_hosted_zone_id(Option<String>)
:
required: trueA unique string used to identify a hosted zone.
- On success, responds with
GetDnssecOutput
with field(s):status(Option<DnssecStatus>)
:A string representing the status of DNSSEC.
key_signing_keys(Vec::<KeySigningKey>)
:The key-signing keys (KSKs) in your account.
- On failure, responds with
SdkError<GetDNSSECError>
Source§impl Client
impl Client
Sourcepub fn get_geo_location(&self) -> GetGeoLocationFluentBuilder
pub fn get_geo_location(&self) -> GetGeoLocationFluentBuilder
Constructs a fluent builder for the GetGeoLocation
operation.
- The fluent builder is configurable:
continent_code(impl Into<String>)
/set_continent_code(Option<String>)
:
required: falseFor geolocation resource record sets, a two-letter abbreviation that identifies a continent. Amazon Route 53 supports the following continent codes:
-
AF: Africa
-
AN: Antarctica
-
AS: Asia
-
EU: Europe
-
OC: Oceania
-
NA: North America
-
SA: South America
-
country_code(impl Into<String>)
/set_country_code(Option<String>)
:
required: falseAmazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.
Route 53 also supports the country code UA for Ukraine.
subdivision_code(impl Into<String>)
/set_subdivision_code(Option<String>)
:
required: falseThe code for the subdivision, such as a particular state within the United States. For a list of US state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United States Postal Service website. For a list of all supported subdivision codes, use the ListGeoLocations API.
- On success, responds with
GetGeoLocationOutput
with field(s):geo_location_details(Option<GeoLocationDetails>)
:A complex type that contains the codes and full continent, country, and subdivision names for the specified geolocation code.
- On failure, responds with
SdkError<GetGeoLocationError>
Source§impl Client
impl Client
Sourcepub fn get_health_check(&self) -> GetHealthCheckFluentBuilder
pub fn get_health_check(&self) -> GetHealthCheckFluentBuilder
Constructs a fluent builder for the GetHealthCheck
operation.
- The fluent builder is configurable:
health_check_id(impl Into<String>)
/set_health_check_id(Option<String>)
:
required: trueThe identifier that Amazon Route 53 assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long.
- On success, responds with
GetHealthCheckOutput
with field(s):health_check(Option<HealthCheck>)
:A complex type that contains information about one health check that is associated with the current Amazon Web Services account.
- On failure, responds with
SdkError<GetHealthCheckError>
Source§impl Client
impl Client
Sourcepub fn get_health_check_count(&self) -> GetHealthCheckCountFluentBuilder
pub fn get_health_check_count(&self) -> GetHealthCheckCountFluentBuilder
Constructs a fluent builder for the GetHealthCheckCount
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
GetHealthCheckCountOutput
with field(s):health_check_count(i64)
:The number of health checks associated with the current Amazon Web Services account.
- On failure, responds with
SdkError<GetHealthCheckCountError>
Source§impl Client
impl Client
Sourcepub fn get_health_check_last_failure_reason(
&self,
) -> GetHealthCheckLastFailureReasonFluentBuilder
pub fn get_health_check_last_failure_reason( &self, ) -> GetHealthCheckLastFailureReasonFluentBuilder
Constructs a fluent builder for the GetHealthCheckLastFailureReason
operation.
- The fluent builder is configurable:
health_check_id(impl Into<String>)
/set_health_check_id(Option<String>)
:
required: trueThe ID for the health check for which you want the last failure reason. When you created the health check,
CreateHealthCheck
returned the ID in the response, in theHealthCheckId
element.If you want to get the last failure reason for a calculated health check, you must use the Amazon Route 53 console or the CloudWatch console. You can’t use
GetHealthCheckLastFailureReason
for a calculated health check.
- On success, responds with
GetHealthCheckLastFailureReasonOutput
with field(s):health_check_observations(Vec::<HealthCheckObservation>)
:A list that contains one
Observation
element for each Amazon Route 53 health checker that is reporting a last failure reason.
- On failure, responds with
SdkError<GetHealthCheckLastFailureReasonError>
Source§impl Client
impl Client
Sourcepub fn get_health_check_status(&self) -> GetHealthCheckStatusFluentBuilder
pub fn get_health_check_status(&self) -> GetHealthCheckStatusFluentBuilder
Constructs a fluent builder for the GetHealthCheckStatus
operation.
- The fluent builder is configurable:
health_check_id(impl Into<String>)
/set_health_check_id(Option<String>)
:
required: trueThe ID for the health check that you want the current status for. When you created the health check,
CreateHealthCheck
returned the ID in the response, in theHealthCheckId
element.If you want to check the status of a calculated health check, you must use the Amazon Route 53 console or the CloudWatch console. You can’t use
GetHealthCheckStatus
to get the status of a calculated health check.
- On success, responds with
GetHealthCheckStatusOutput
with field(s):health_check_observations(Vec::<HealthCheckObservation>)
:A list that contains one
HealthCheckObservation
element for each Amazon Route 53 health checker that is reporting a status about the health check endpoint.
- On failure, responds with
SdkError<GetHealthCheckStatusError>
Source§impl Client
impl Client
Sourcepub fn get_hosted_zone(&self) -> GetHostedZoneFluentBuilder
pub fn get_hosted_zone(&self) -> GetHostedZoneFluentBuilder
Constructs a fluent builder for the GetHostedZone
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the hosted zone that you want to get information about.
- On success, responds with
GetHostedZoneOutput
with field(s):hosted_zone(Option<HostedZone>)
:A complex type that contains general information about the specified hosted zone.
delegation_set(Option<DelegationSet>)
:A complex type that lists the Amazon Route 53 name servers for the specified hosted zone.
vpcs(Option<Vec::<Vpc>>)
:A complex type that contains information about the VPCs that are associated with the specified hosted zone.
- On failure, responds with
SdkError<GetHostedZoneError>
Source§impl Client
impl Client
Sourcepub fn get_hosted_zone_count(&self) -> GetHostedZoneCountFluentBuilder
pub fn get_hosted_zone_count(&self) -> GetHostedZoneCountFluentBuilder
Constructs a fluent builder for the GetHostedZoneCount
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
GetHostedZoneCountOutput
with field(s):hosted_zone_count(i64)
:The total number of public and private hosted zones that are associated with the current Amazon Web Services account.
- On failure, responds with
SdkError<GetHostedZoneCountError>
Source§impl Client
impl Client
Sourcepub fn get_hosted_zone_limit(&self) -> GetHostedZoneLimitFluentBuilder
pub fn get_hosted_zone_limit(&self) -> GetHostedZoneLimitFluentBuilder
Constructs a fluent builder for the GetHostedZoneLimit
operation.
- The fluent builder is configurable:
r#type(HostedZoneLimitType)
/set_type(Option<HostedZoneLimitType>)
:
required: trueThe limit that you want to get. Valid values include the following:
-
MAX_RRSETS_BY_ZONE: The maximum number of records that you can create in the specified hosted zone.
-
MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum number of Amazon VPCs that you can associate with the specified private hosted zone.
-
hosted_zone_id(impl Into<String>)
/set_hosted_zone_id(Option<String>)
:
required: trueThe ID of the hosted zone that you want to get a limit for.
- On success, responds with
GetHostedZoneLimitOutput
with field(s):limit(Option<HostedZoneLimit>)
:The current setting for the specified limit. For example, if you specified
MAX_RRSETS_BY_ZONE
for the value ofType
in the request, the value ofLimit
is the maximum number of records that you can create in the specified hosted zone.count(i64)
:The current number of entities that you have created of the specified type. For example, if you specified
MAX_RRSETS_BY_ZONE
for the value ofType
in the request, the value ofCount
is the current number of records that you have created in the specified hosted zone.
- On failure, responds with
SdkError<GetHostedZoneLimitError>
Source§impl Client
impl Client
Sourcepub fn get_query_logging_config(&self) -> GetQueryLoggingConfigFluentBuilder
pub fn get_query_logging_config(&self) -> GetQueryLoggingConfigFluentBuilder
Constructs a fluent builder for the GetQueryLoggingConfig
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the configuration for DNS query logging that you want to get information about.
- On success, responds with
GetQueryLoggingConfigOutput
with field(s):query_logging_config(Option<QueryLoggingConfig>)
:A complex type that contains information about the query logging configuration that you specified in a GetQueryLoggingConfig request.
- On failure, responds with
SdkError<GetQueryLoggingConfigError>
Source§impl Client
impl Client
Sourcepub fn get_reusable_delegation_set(
&self,
) -> GetReusableDelegationSetFluentBuilder
pub fn get_reusable_delegation_set( &self, ) -> GetReusableDelegationSetFluentBuilder
Constructs a fluent builder for the GetReusableDelegationSet
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the reusable delegation set that you want to get a list of name servers for.
- On success, responds with
GetReusableDelegationSetOutput
with field(s):delegation_set(Option<DelegationSet>)
:A complex type that contains information about the reusable delegation set.
- On failure, responds with
SdkError<GetReusableDelegationSetError>
Source§impl Client
impl Client
Sourcepub fn get_reusable_delegation_set_limit(
&self,
) -> GetReusableDelegationSetLimitFluentBuilder
pub fn get_reusable_delegation_set_limit( &self, ) -> GetReusableDelegationSetLimitFluentBuilder
Constructs a fluent builder for the GetReusableDelegationSetLimit
operation.
- The fluent builder is configurable:
r#type(ReusableDelegationSetLimitType)
/set_type(Option<ReusableDelegationSetLimitType>)
:
required: trueSpecify
MAX_ZONES_BY_REUSABLE_DELEGATION_SET
to get the maximum number of hosted zones that you can associate with the specified reusable delegation set.delegation_set_id(impl Into<String>)
/set_delegation_set_id(Option<String>)
:
required: trueThe ID of the delegation set that you want to get the limit for.
- On success, responds with
GetReusableDelegationSetLimitOutput
with field(s):limit(Option<ReusableDelegationSetLimit>)
:The current setting for the limit on hosted zones that you can associate with the specified reusable delegation set.
count(i64)
:The current number of hosted zones that you can associate with the specified reusable delegation set.
- On failure, responds with
SdkError<GetReusableDelegationSetLimitError>
Source§impl Client
impl Client
Sourcepub fn get_traffic_policy(&self) -> GetTrafficPolicyFluentBuilder
pub fn get_traffic_policy(&self) -> GetTrafficPolicyFluentBuilder
Constructs a fluent builder for the GetTrafficPolicy
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the traffic policy that you want to get information about.
version(i32)
/set_version(Option<i32>)
:
required: trueThe version number of the traffic policy that you want to get information about.
- On success, responds with
GetTrafficPolicyOutput
with field(s):traffic_policy(Option<TrafficPolicy>)
:A complex type that contains settings for the specified traffic policy.
- On failure, responds with
SdkError<GetTrafficPolicyError>
Source§impl Client
impl Client
Sourcepub fn get_traffic_policy_instance(
&self,
) -> GetTrafficPolicyInstanceFluentBuilder
pub fn get_traffic_policy_instance( &self, ) -> GetTrafficPolicyInstanceFluentBuilder
Constructs a fluent builder for the GetTrafficPolicyInstance
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the traffic policy instance that you want to get information about.
- On success, responds with
GetTrafficPolicyInstanceOutput
with field(s):traffic_policy_instance(Option<TrafficPolicyInstance>)
:A complex type that contains settings for the traffic policy instance.
- On failure, responds with
SdkError<GetTrafficPolicyInstanceError>
Source§impl Client
impl Client
Sourcepub fn get_traffic_policy_instance_count(
&self,
) -> GetTrafficPolicyInstanceCountFluentBuilder
pub fn get_traffic_policy_instance_count( &self, ) -> GetTrafficPolicyInstanceCountFluentBuilder
Constructs a fluent builder for the GetTrafficPolicyInstanceCount
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
GetTrafficPolicyInstanceCountOutput
with field(s):traffic_policy_instance_count(i32)
:The number of traffic policy instances that are associated with the current Amazon Web Services account.
- On failure, responds with
SdkError<GetTrafficPolicyInstanceCountError>
Source§impl Client
impl Client
Sourcepub fn list_cidr_blocks(&self) -> ListCidrBlocksFluentBuilder
pub fn list_cidr_blocks(&self) -> ListCidrBlocksFluentBuilder
Constructs a fluent builder for the ListCidrBlocks
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
collection_id(impl Into<String>)
/set_collection_id(Option<String>)
:
required: trueThe UUID of the CIDR collection.
location_name(impl Into<String>)
/set_location_name(Option<String>)
:
required: falseThe name of the CIDR collection location.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseAn opaque pagination token to indicate where the service is to begin enumerating results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseMaximum number of results you want returned.
- On success, responds with
ListCidrBlocksOutput
with field(s):next_token(Option<String>)
:An opaque pagination token to indicate where the service is to begin enumerating results.
If no value is provided, the listing of results starts from the beginning.
cidr_blocks(Option<Vec::<CidrBlockSummary>>)
:A complex type that contains information about the CIDR blocks.
- On failure, responds with
SdkError<ListCidrBlocksError>
Source§impl Client
impl Client
Sourcepub fn list_cidr_collections(&self) -> ListCidrCollectionsFluentBuilder
pub fn list_cidr_collections(&self) -> ListCidrCollectionsFluentBuilder
Constructs a fluent builder for the ListCidrCollections
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseAn opaque pagination token to indicate where the service is to begin enumerating results.
If no value is provided, the listing of results starts from the beginning.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of CIDR collections to return in the response.
- On success, responds with
ListCidrCollectionsOutput
with field(s):next_token(Option<String>)
:An opaque pagination token to indicate where the service is to begin enumerating results.
If no value is provided, the listing of results starts from the beginning.
cidr_collections(Option<Vec::<CollectionSummary>>)
:A complex type with information about the CIDR collection.
- On failure, responds with
SdkError<ListCidrCollectionsError>
Source§impl Client
impl Client
Sourcepub fn list_cidr_locations(&self) -> ListCidrLocationsFluentBuilder
pub fn list_cidr_locations(&self) -> ListCidrLocationsFluentBuilder
Constructs a fluent builder for the ListCidrLocations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
collection_id(impl Into<String>)
/set_collection_id(Option<String>)
:
required: trueThe CIDR collection ID.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseAn opaque pagination token to indicate where the service is to begin enumerating results.
If no value is provided, the listing of results starts from the beginning.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of CIDR collection locations to return in the response.
- On success, responds with
ListCidrLocationsOutput
with field(s):next_token(Option<String>)
:An opaque pagination token to indicate where the service is to begin enumerating results.
If no value is provided, the listing of results starts from the beginning.
cidr_locations(Option<Vec::<LocationSummary>>)
:A complex type that contains information about the list of CIDR locations.
- On failure, responds with
SdkError<ListCidrLocationsError>
Source§impl Client
impl Client
Sourcepub fn list_geo_locations(&self) -> ListGeoLocationsFluentBuilder
pub fn list_geo_locations(&self) -> ListGeoLocationsFluentBuilder
Constructs a fluent builder for the ListGeoLocations
operation.
- The fluent builder is configurable:
start_continent_code(impl Into<String>)
/set_start_continent_code(Option<String>)
:
required: falseThe code for the continent with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has already returned a page or more of results, if
IsTruncated
is true, and ifNextContinentCode
from the previous response has a value, enter that value instartcontinentcode
to return the next page of results.Include
startcontinentcode
only if you want to list continents. Don’t includestartcontinentcode
when you’re listing countries or countries with their subdivisions.start_country_code(impl Into<String>)
/set_start_country_code(Option<String>)
:
required: falseThe code for the country with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has already returned a page or more of results, if
IsTruncated
istrue
, and ifNextCountryCode
from the previous response has a value, enter that value instartcountrycode
to return the next page of results.start_subdivision_code(impl Into<String>)
/set_start_subdivision_code(Option<String>)
:
required: falseThe code for the state of the United States with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has already returned a page or more of results, if
IsTruncated
istrue
, and ifNextSubdivisionCode
from the previous response has a value, enter that value instartsubdivisioncode
to return the next page of results.To list subdivisions (U.S. states), you must include both
startcountrycode
andstartsubdivisioncode
.max_items(i32)
/set_max_items(Option<i32>)
:
required: false(Optional) The maximum number of geolocations to be included in the response body for this request. If more than
maxitems
geolocations remain to be listed, then the value of theIsTruncated
element in the response istrue
.
- On success, responds with
ListGeoLocationsOutput
with field(s):geo_location_details_list(Vec::<GeoLocationDetails>)
:A complex type that contains one
GeoLocationDetails
element for each location that Amazon Route 53 supports for geolocation.is_truncated(bool)
:A value that indicates whether more locations remain to be listed after the last location in this response. If so, the value of
IsTruncated
istrue
. To get more values, submit another request and include the values ofNextContinentCode
,NextCountryCode
, andNextSubdivisionCode
in thestartcontinentcode
,startcountrycode
, andstartsubdivisioncode
, as applicable.next_continent_code(Option<String>)
:If
IsTruncated
istrue
, you can make a follow-up request to display more locations. Enter the value ofNextContinentCode
in thestartcontinentcode
parameter in anotherListGeoLocations
request.next_country_code(Option<String>)
:If
IsTruncated
istrue
, you can make a follow-up request to display more locations. Enter the value ofNextCountryCode
in thestartcountrycode
parameter in anotherListGeoLocations
request.next_subdivision_code(Option<String>)
:If
IsTruncated
istrue
, you can make a follow-up request to display more locations. Enter the value ofNextSubdivisionCode
in thestartsubdivisioncode
parameter in anotherListGeoLocations
request.max_items(i32)
:The value that you specified for
MaxItems
in the request.
- On failure, responds with
SdkError<ListGeoLocationsError>
Source§impl Client
impl Client
Sourcepub fn list_health_checks(&self) -> ListHealthChecksFluentBuilder
pub fn list_health_checks(&self) -> ListHealthChecksFluentBuilder
Constructs a fluent builder for the ListHealthChecks
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseIf the value of
IsTruncated
in the previous response wastrue
, you have more health checks. To get another group, submit anotherListHealthChecks
request.For the value of
marker
, specify the value ofNextMarker
from the previous response, which is the ID of the first health check that Amazon Route 53 will return if you submit another request.If the value of
IsTruncated
in the previous response wasfalse
, there are no more health checks to get.max_items(i32)
/set_max_items(Option<i32>)
:
required: falseThe maximum number of health checks that you want
ListHealthChecks
to return in response to the current request. Amazon Route 53 returns a maximum of 1000 items. If you setMaxItems
to a value greater than 1000, Route 53 returns only the first 1000 health checks.
- On success, responds with
ListHealthChecksOutput
with field(s):health_checks(Vec::<HealthCheck>)
:A complex type that contains one
HealthCheck
element for each health check that is associated with the current Amazon Web Services account.marker(String)
:For the second and subsequent calls to
ListHealthChecks
,Marker
is the value that you specified for themarker
parameter in the previous request.is_truncated(bool)
:A flag that indicates whether there are more health checks to be listed. If the response was truncated, you can get the next group of health checks by submitting another
ListHealthChecks
request and specifying the value ofNextMarker
in themarker
parameter.next_marker(Option<String>)
:If
IsTruncated
istrue
, the value ofNextMarker
identifies the first health check that Amazon Route 53 returns if you submit anotherListHealthChecks
request and specify the value ofNextMarker
in themarker
parameter.max_items(i32)
:The value that you specified for the
maxitems
parameter in the call toListHealthChecks
that produced the current response.
- On failure, responds with
SdkError<ListHealthChecksError>
Source§impl Client
impl Client
Sourcepub fn list_hosted_zones(&self) -> ListHostedZonesFluentBuilder
pub fn list_hosted_zones(&self) -> ListHostedZonesFluentBuilder
Constructs a fluent builder for the ListHostedZones
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseIf the value of
IsTruncated
in the previous response wastrue
, you have more hosted zones. To get more hosted zones, submit anotherListHostedZones
request.For the value of
marker
, specify the value ofNextMarker
from the previous response, which is the ID of the first hosted zone that Amazon Route 53 will return if you submit another request.If the value of
IsTruncated
in the previous response wasfalse
, there are no more hosted zones to get.max_items(i32)
/set_max_items(Option<i32>)
:
required: false(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If you have more than
maxitems
hosted zones, the value ofIsTruncated
in the response istrue
, and the value ofNextMarker
is the hosted zone ID of the first hosted zone that Route 53 will return if you submit another request.delegation_set_id(impl Into<String>)
/set_delegation_set_id(Option<String>)
:
required: falseIf you’re using reusable delegation sets and you want to list all of the hosted zones that are associated with a reusable delegation set, specify the ID of that reusable delegation set.
hosted_zone_type(HostedZoneType)
/set_hosted_zone_type(Option<HostedZoneType>)
:
required: false(Optional) Specifies if the hosted zone is private.
- On success, responds with
ListHostedZonesOutput
with field(s):hosted_zones(Vec::<HostedZone>)
:A complex type that contains general information about the hosted zone.
marker(String)
:For the second and subsequent calls to
ListHostedZones
,Marker
is the value that you specified for themarker
parameter in the request that produced the current response.is_truncated(bool)
:A flag indicating whether there are more hosted zones to be listed. If the response was truncated, you can get more hosted zones by submitting another
ListHostedZones
request and specifying the value ofNextMarker
in themarker
parameter.next_marker(Option<String>)
:If
IsTruncated
istrue
, the value ofNextMarker
identifies the first hosted zone in the next group of hosted zones. Submit anotherListHostedZones
request, and specify the value ofNextMarker
from the response in themarker
parameter.This element is present only if
IsTruncated
istrue
.max_items(i32)
:The value that you specified for the
maxitems
parameter in the call toListHostedZones
that produced the current response.
- On failure, responds with
SdkError<ListHostedZonesError>
Source§impl Client
impl Client
Sourcepub fn list_hosted_zones_by_name(&self) -> ListHostedZonesByNameFluentBuilder
pub fn list_hosted_zones_by_name(&self) -> ListHostedZonesByNameFluentBuilder
Constructs a fluent builder for the ListHostedZonesByName
operation.
- The fluent builder is configurable:
dns_name(impl Into<String>)
/set_dns_name(Option<String>)
:
required: false(Optional) For your first request to
ListHostedZonesByName
, include thednsname
parameter only if you want to specify the name of the first hosted zone in the response. If you don’t include thednsname
parameter, Amazon Route 53 returns all of the hosted zones that were created by the current Amazon Web Services account, in ASCII order. For subsequent requests, include bothdnsname
andhostedzoneid
parameters. Fordnsname
, specify the value ofNextDNSName
from the previous response.hosted_zone_id(impl Into<String>)
/set_hosted_zone_id(Option<String>)
:
required: false(Optional) For your first request to
ListHostedZonesByName
, do not include thehostedzoneid
parameter.If you have more hosted zones than the value of
maxitems
,ListHostedZonesByName
returns only the firstmaxitems
hosted zones. To get the next group ofmaxitems
hosted zones, submit another request toListHostedZonesByName
and include bothdnsname
andhostedzoneid
parameters. For the value ofhostedzoneid
, specify the value of theNextHostedZoneId
element from the previous response.max_items(i32)
/set_max_items(Option<i32>)
:
required: falseThe maximum number of hosted zones to be included in the response body for this request. If you have more than
maxitems
hosted zones, then the value of theIsTruncated
element in the response is true, and the values ofNextDNSName
andNextHostedZoneId
specify the first hosted zone in the next group ofmaxitems
hosted zones.
- On success, responds with
ListHostedZonesByNameOutput
with field(s):hosted_zones(Vec::<HostedZone>)
:A complex type that contains general information about the hosted zone.
dns_name(Option<String>)
:For the second and subsequent calls to
ListHostedZonesByName
,DNSName
is the value that you specified for thednsname
parameter in the request that produced the current response.hosted_zone_id(Option<String>)
:The ID that Amazon Route 53 assigned to the hosted zone when you created it.
is_truncated(bool)
:A flag that indicates whether there are more hosted zones to be listed. If the response was truncated, you can get the next group of
maxitems
hosted zones by callingListHostedZonesByName
again and specifying the values ofNextDNSName
andNextHostedZoneId
elements in thednsname
andhostedzoneid
parameters.next_dns_name(Option<String>)
:If
IsTruncated
is true, the value ofNextDNSName
is the name of the first hosted zone in the next group ofmaxitems
hosted zones. CallListHostedZonesByName
again and specify the value ofNextDNSName
andNextHostedZoneId
in thednsname
andhostedzoneid
parameters, respectively.This element is present only if
IsTruncated
istrue
.next_hosted_zone_id(Option<String>)
:If
IsTruncated
istrue
, the value ofNextHostedZoneId
identifies the first hosted zone in the next group ofmaxitems
hosted zones. CallListHostedZonesByName
again and specify the value ofNextDNSName
andNextHostedZoneId
in thednsname
andhostedzoneid
parameters, respectively.This element is present only if
IsTruncated
istrue
.max_items(i32)
:The value that you specified for the
maxitems
parameter in the call toListHostedZonesByName
that produced the current response.
- On failure, responds with
SdkError<ListHostedZonesByNameError>
Source§impl Client
impl Client
Sourcepub fn list_hosted_zones_by_vpc(&self) -> ListHostedZonesByVPCFluentBuilder
pub fn list_hosted_zones_by_vpc(&self) -> ListHostedZonesByVPCFluentBuilder
Constructs a fluent builder for the ListHostedZonesByVPC
operation.
- The fluent builder is configurable:
vpc_id(impl Into<String>)
/set_vpc_id(Option<String>)
:
required: trueThe ID of the Amazon VPC that you want to list hosted zones for.
vpc_region(VpcRegion)
/set_vpc_region(Option<VpcRegion>)
:
required: trueFor the Amazon VPC that you specified for
VPCId
, the Amazon Web Services Region that you created the VPC in.max_items(i32)
/set_max_items(Option<i32>)
:
required: false(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If the specified VPC is associated with more than
MaxItems
hosted zones, the response includes aNextToken
element.NextToken
contains an encrypted token that identifies the first hosted zone that Route 53 will return if you submit another request.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf the previous response included a
NextToken
element, the specified VPC is associated with more hosted zones. To get more hosted zones, submit anotherListHostedZonesByVPC
request.For the value of
NextToken
, specify the value ofNextToken
from the previous response.If the previous response didn’t include a
NextToken
element, there are no more hosted zones to get.
- On success, responds with
ListHostedZonesByVpcOutput
with field(s):hosted_zone_summaries(Vec::<HostedZoneSummary>)
:A list that contains one
HostedZoneSummary
element for each hosted zone that the specified Amazon VPC is associated with. EachHostedZoneSummary
element contains the hosted zone name and ID, and information about who owns the hosted zone.max_items(i32)
:The value that you specified for
MaxItems
in the most recentListHostedZonesByVPC
request.next_token(Option<String>)
:The value that you will use for
NextToken
in the nextListHostedZonesByVPC
request.
- On failure, responds with
SdkError<ListHostedZonesByVPCError>
Source§impl Client
impl Client
Sourcepub fn list_query_logging_configs(&self) -> ListQueryLoggingConfigsFluentBuilder
pub fn list_query_logging_configs(&self) -> ListQueryLoggingConfigsFluentBuilder
Constructs a fluent builder for the ListQueryLoggingConfigs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
hosted_zone_id(impl Into<String>)
/set_hosted_zone_id(Option<String>)
:
required: false(Optional) If you want to list the query logging configuration that is associated with a hosted zone, specify the ID in
HostedZoneId
.If you don’t specify a hosted zone ID,
ListQueryLoggingConfigs
returns all of the configurations that are associated with the current Amazon Web Services account.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false(Optional) If the current Amazon Web Services account has more than
MaxResults
query logging configurations, useNextToken
to get the second and subsequent pages of results.For the first
ListQueryLoggingConfigs
request, omit this value.For the second and subsequent requests, get the value of
NextToken
from the previous response and specify that value forNextToken
in the request.max_results(i32)
/set_max_results(Option<i32>)
:
required: false(Optional) The maximum number of query logging configurations that you want Amazon Route 53 to return in response to the current request. If the current Amazon Web Services account has more than
MaxResults
configurations, use the value of NextToken in the response to get the next page of results.If you don’t specify a value for
MaxResults
, Route 53 returns up to 100 configurations.
- On success, responds with
ListQueryLoggingConfigsOutput
with field(s):query_logging_configs(Vec::<QueryLoggingConfig>)
:An array that contains one QueryLoggingConfig element for each configuration for DNS query logging that is associated with the current Amazon Web Services account.
next_token(Option<String>)
:If a response includes the last of the query logging configurations that are associated with the current Amazon Web Services account,
NextToken
doesn’t appear in the response.If a response doesn’t include the last of the configurations, you can get more configurations by submitting another ListQueryLoggingConfigs request. Get the value of
NextToken
that Amazon Route 53 returned in the previous response and include it inNextToken
in the next request.
- On failure, responds with
SdkError<ListQueryLoggingConfigsError>
Source§impl Client
impl Client
Sourcepub fn list_resource_record_sets(&self) -> ListResourceRecordSetsFluentBuilder
pub fn list_resource_record_sets(&self) -> ListResourceRecordSetsFluentBuilder
Constructs a fluent builder for the ListResourceRecordSets
operation.
- The fluent builder is configurable:
hosted_zone_id(impl Into<String>)
/set_hosted_zone_id(Option<String>)
:
required: trueThe ID of the hosted zone that contains the resource record sets that you want to list.
start_record_name(impl Into<String>)
/set_start_record_name(Option<String>)
:
required: falseThe first name in the lexicographic ordering of resource record sets that you want to list. If the specified record name doesn’t exist, the results begin with the first resource record set that has a name greater than the value of
name
.start_record_type(RrType)
/set_start_record_type(Option<RrType>)
:
required: falseThe type of resource record set to begin the record listing from.
Valid values for basic resource record sets:
A
|AAAA
|CAA
|CNAME
|MX
|NAPTR
|NS
|PTR
|SOA
|SPF
|SRV
|TXT
Values for weighted, latency, geolocation, and failover resource record sets:
A
|AAAA
|CAA
|CNAME
|MX
|NAPTR
|PTR
|SPF
|SRV
|TXT
Values for alias resource record sets:
-
API Gateway custom regional API or edge-optimized API: A
-
CloudFront distribution: A or AAAA
-
Elastic Beanstalk environment that has a regionalized subdomain: A
-
Elastic Load Balancing load balancer: A | AAAA
-
S3 bucket: A
-
VPC interface VPC endpoint: A
-
Another resource record set in this hosted zone: The type of the resource record set that the alias references.
Constraint: Specifying
type
without specifyingname
returns anInvalidInput
error.-
start_record_identifier(impl Into<String>)
/set_start_record_identifier(Option<String>)
:
required: falseResource record sets that have a routing policy other than simple: If results were truncated for a given DNS name and type, specify the value of
NextRecordIdentifier
from the previous response to get the next resource record set that has the current DNS name and type.max_items(i32)
/set_max_items(Option<i32>)
:
required: false(Optional) The maximum number of resource records sets to include in the response body for this request. If the response includes more than
maxitems
resource record sets, the value of theIsTruncated
element in the response istrue
, and the values of theNextRecordName
andNextRecordType
elements in the response identify the first resource record set in the next group ofmaxitems
resource record sets.
- On success, responds with
ListResourceRecordSetsOutput
with field(s):resource_record_sets(Vec::<ResourceRecordSet>)
:Information about multiple resource record sets.
is_truncated(bool)
:A flag that indicates whether more resource record sets remain to be listed. If your results were truncated, you can make a follow-up pagination request by using the
NextRecordName
element.next_record_name(Option<String>)
:If the results were truncated, the name of the next record in the list.
This element is present only if
IsTruncated
is true.next_record_type(Option<RrType>)
:If the results were truncated, the type of the next record in the list.
This element is present only if
IsTruncated
is true.next_record_identifier(Option<String>)
:Resource record sets that have a routing policy other than simple: If results were truncated for a given DNS name and type, the value of
SetIdentifier
for the next resource record set that has the current DNS name and type.For information about routing policies, see Choosing a Routing Policy in the Amazon Route 53 Developer Guide.
max_items(i32)
:The maximum number of records you requested.
- On failure, responds with
SdkError<ListResourceRecordSetsError>
Source§impl Client
impl Client
Sourcepub fn list_reusable_delegation_sets(
&self,
) -> ListReusableDelegationSetsFluentBuilder
pub fn list_reusable_delegation_sets( &self, ) -> ListReusableDelegationSetsFluentBuilder
Constructs a fluent builder for the ListReusableDelegationSets
operation.
- The fluent builder is configurable:
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseIf the value of
IsTruncated
in the previous response wastrue
, you have more reusable delegation sets. To get another group, submit anotherListReusableDelegationSets
request.For the value of
marker
, specify the value ofNextMarker
from the previous response, which is the ID of the first reusable delegation set that Amazon Route 53 will return if you submit another request.If the value of
IsTruncated
in the previous response wasfalse
, there are no more reusable delegation sets to get.max_items(i32)
/set_max_items(Option<i32>)
:
required: falseThe number of reusable delegation sets that you want Amazon Route 53 to return in the response to this request. If you specify a value greater than 100, Route 53 returns only the first 100 reusable delegation sets.
- On success, responds with
ListReusableDelegationSetsOutput
with field(s):delegation_sets(Vec::<DelegationSet>)
:A complex type that contains one
DelegationSet
element for each reusable delegation set that was created by the current Amazon Web Services account.marker(String)
:For the second and subsequent calls to
ListReusableDelegationSets
,Marker
is the value that you specified for themarker
parameter in the request that produced the current response.is_truncated(bool)
:A flag that indicates whether there are more reusable delegation sets to be listed.
next_marker(Option<String>)
:If
IsTruncated
istrue
, the value ofNextMarker
identifies the next reusable delegation set that Amazon Route 53 will return if you submit anotherListReusableDelegationSets
request and specify the value ofNextMarker
in themarker
parameter.max_items(i32)
:The value that you specified for the
maxitems
parameter in the call toListReusableDelegationSets
that produced the current response.
- On failure, responds with
SdkError<ListReusableDelegationSetsError>
Source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_type(TagResourceType)
/set_resource_type(Option<TagResourceType>)
:
required: trueThe type of the resource.
-
The resource type for health checks is
healthcheck
. -
The resource type for hosted zones is
hostedzone
.
-
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe ID of the resource for which you want to retrieve tags.
- On success, responds with
ListTagsForResourceOutput
with field(s):resource_tag_set(Option<ResourceTagSet>)
:A
ResourceTagSet
containing tags associated with the specified resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
Source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResources
operation.
- The fluent builder is configurable:
resource_type(TagResourceType)
/set_resource_type(Option<TagResourceType>)
:
required: trueThe type of the resources.
-
The resource type for health checks is
healthcheck
. -
The resource type for hosted zones is
hostedzone
.
-
resource_ids(impl Into<String>)
/set_resource_ids(Option<Vec::<String>>)
:
required: trueA complex type that contains the ResourceId element for each resource for which you want to get a list of tags.
- On success, responds with
ListTagsForResourcesOutput
with field(s):resource_tag_sets(Vec::<ResourceTagSet>)
:A list of
ResourceTagSet
s containing tags associated with the specified resources.
- On failure, responds with
SdkError<ListTagsForResourcesError>
Source§impl Client
impl Client
Sourcepub fn list_traffic_policies(&self) -> ListTrafficPoliciesFluentBuilder
pub fn list_traffic_policies(&self) -> ListTrafficPoliciesFluentBuilder
Constructs a fluent builder for the ListTrafficPolicies
operation.
- The fluent builder is configurable:
traffic_policy_id_marker(impl Into<String>)
/set_traffic_policy_id_marker(Option<String>)
:
required: false(Conditional) For your first request to
ListTrafficPolicies
, don’t include theTrafficPolicyIdMarker
parameter.If you have more traffic policies than the value of
MaxItems
,ListTrafficPolicies
returns only the firstMaxItems
traffic policies. To get the next group of policies, submit another request toListTrafficPolicies
. For the value ofTrafficPolicyIdMarker
, specify the value ofTrafficPolicyIdMarker
that was returned in the previous response.max_items(i32)
/set_max_items(Option<i32>)
:
required: false(Optional) The maximum number of traffic policies that you want Amazon Route 53 to return in response to this request. If you have more than
MaxItems
traffic policies, the value ofIsTruncated
in the response istrue
, and the value ofTrafficPolicyIdMarker
is the ID of the first traffic policy that Route 53 will return if you submit another request.
- On success, responds with
ListTrafficPoliciesOutput
with field(s):traffic_policy_summaries(Vec::<TrafficPolicySummary>)
:A list that contains one
TrafficPolicySummary
element for each traffic policy that was created by the current Amazon Web Services account.is_truncated(bool)
:A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of traffic policies by submitting another
ListTrafficPolicies
request and specifying the value ofTrafficPolicyIdMarker
in theTrafficPolicyIdMarker
request parameter.traffic_policy_id_marker(String)
:If the value of
IsTruncated
istrue
,TrafficPolicyIdMarker
is the ID of the first traffic policy in the next group ofMaxItems
traffic policies.max_items(i32)
:The value that you specified for the
MaxItems
parameter in theListTrafficPolicies
request that produced the current response.
- On failure, responds with
SdkError<ListTrafficPoliciesError>
Source§impl Client
impl Client
Sourcepub fn list_traffic_policy_instances(
&self,
) -> ListTrafficPolicyInstancesFluentBuilder
pub fn list_traffic_policy_instances( &self, ) -> ListTrafficPolicyInstancesFluentBuilder
Constructs a fluent builder for the ListTrafficPolicyInstances
operation.
- The fluent builder is configurable:
hosted_zone_id_marker(impl Into<String>)
/set_hosted_zone_id_marker(Option<String>)
:
required: falseIf the value of
IsTruncated
in the previous response wastrue
, you have more traffic policy instances. To get more traffic policy instances, submit anotherListTrafficPolicyInstances
request. For the value ofHostedZoneId
, specify the value ofHostedZoneIdMarker
from the previous response, which is the hosted zone ID of the first traffic policy instance in the next group of traffic policy instances.If the value of
IsTruncated
in the previous response wasfalse
, there are no more traffic policy instances to get.traffic_policy_instance_name_marker(impl Into<String>)
/set_traffic_policy_instance_name_marker(Option<String>)
:
required: falseIf the value of
IsTruncated
in the previous response wastrue
, you have more traffic policy instances. To get more traffic policy instances, submit anotherListTrafficPolicyInstances
request. For the value oftrafficpolicyinstancename
, specify the value ofTrafficPolicyInstanceNameMarker
from the previous response, which is the name of the first traffic policy instance in the next group of traffic policy instances.If the value of
IsTruncated
in the previous response wasfalse
, there are no more traffic policy instances to get.traffic_policy_instance_type_marker(RrType)
/set_traffic_policy_instance_type_marker(Option<RrType>)
:
required: falseIf the value of
IsTruncated
in the previous response wastrue
, you have more traffic policy instances. To get more traffic policy instances, submit anotherListTrafficPolicyInstances
request. For the value oftrafficpolicyinstancetype
, specify the value ofTrafficPolicyInstanceTypeMarker
from the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances.If the value of
IsTruncated
in the previous response wasfalse
, there are no more traffic policy instances to get.max_items(i32)
/set_max_items(Option<i32>)
:
required: falseThe maximum number of traffic policy instances that you want Amazon Route 53 to return in response to a
ListTrafficPolicyInstances
request. If you have more thanMaxItems
traffic policy instances, the value of theIsTruncated
element in the response istrue
, and the values ofHostedZoneIdMarker
,TrafficPolicyInstanceNameMarker
, andTrafficPolicyInstanceTypeMarker
represent the first traffic policy instance in the next group ofMaxItems
traffic policy instances.
- On success, responds with
ListTrafficPolicyInstancesOutput
with field(s):traffic_policy_instances(Vec::<TrafficPolicyInstance>)
:A list that contains one
TrafficPolicyInstance
element for each traffic policy instance that matches the elements in the request.hosted_zone_id_marker(Option<String>)
:If
IsTruncated
istrue
,HostedZoneIdMarker
is the ID of the hosted zone of the first traffic policy instance that Route 53 will return if you submit anotherListTrafficPolicyInstances
request.traffic_policy_instance_name_marker(Option<String>)
:If
IsTruncated
istrue
,TrafficPolicyInstanceNameMarker
is the name of the first traffic policy instance that Route 53 will return if you submit anotherListTrafficPolicyInstances
request.traffic_policy_instance_type_marker(Option<RrType>)
:If
IsTruncated
istrue
,TrafficPolicyInstanceTypeMarker
is the DNS type of the resource record sets that are associated with the first traffic policy instance that Amazon Route 53 will return if you submit anotherListTrafficPolicyInstances
request.is_truncated(bool)
:A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get more traffic policy instances by calling
ListTrafficPolicyInstances
again and specifying the values of theHostedZoneIdMarker
,TrafficPolicyInstanceNameMarker
, andTrafficPolicyInstanceTypeMarker
in the corresponding request parameters.max_items(i32)
:The value that you specified for the
MaxItems
parameter in the call toListTrafficPolicyInstances
that produced the current response.
- On failure, responds with
SdkError<ListTrafficPolicyInstancesError>
Source§impl Client
impl Client
Sourcepub fn list_traffic_policy_instances_by_hosted_zone(
&self,
) -> ListTrafficPolicyInstancesByHostedZoneFluentBuilder
pub fn list_traffic_policy_instances_by_hosted_zone( &self, ) -> ListTrafficPolicyInstancesByHostedZoneFluentBuilder
Constructs a fluent builder for the ListTrafficPolicyInstancesByHostedZone
operation.
- The fluent builder is configurable:
hosted_zone_id(impl Into<String>)
/set_hosted_zone_id(Option<String>)
:
required: trueThe ID of the hosted zone that you want to list traffic policy instances for.
traffic_policy_instance_name_marker(impl Into<String>)
/set_traffic_policy_instance_name_marker(Option<String>)
:
required: falseIf the value of
IsTruncated
in the previous response is true, you have more traffic policy instances. To get more traffic policy instances, submit anotherListTrafficPolicyInstances
request. For the value oftrafficpolicyinstancename
, specify the value ofTrafficPolicyInstanceNameMarker
from the previous response, which is the name of the first traffic policy instance in the next group of traffic policy instances.If the value of
IsTruncated
in the previous response wasfalse
, there are no more traffic policy instances to get.traffic_policy_instance_type_marker(RrType)
/set_traffic_policy_instance_type_marker(Option<RrType>)
:
required: falseIf the value of
IsTruncated
in the previous response is true, you have more traffic policy instances. To get more traffic policy instances, submit anotherListTrafficPolicyInstances
request. For the value oftrafficpolicyinstancetype
, specify the value ofTrafficPolicyInstanceTypeMarker
from the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances.If the value of
IsTruncated
in the previous response wasfalse
, there are no more traffic policy instances to get.max_items(i32)
/set_max_items(Option<i32>)
:
required: falseThe maximum number of traffic policy instances to be included in the response body for this request. If you have more than
MaxItems
traffic policy instances, the value of theIsTruncated
element in the response istrue
, and the values ofHostedZoneIdMarker
,TrafficPolicyInstanceNameMarker
, andTrafficPolicyInstanceTypeMarker
represent the first traffic policy instance that Amazon Route 53 will return if you submit another request.
- On success, responds with
ListTrafficPolicyInstancesByHostedZoneOutput
with field(s):traffic_policy_instances(Vec::<TrafficPolicyInstance>)
:A list that contains one
TrafficPolicyInstance
element for each traffic policy instance that matches the elements in the request.traffic_policy_instance_name_marker(Option<String>)
:If
IsTruncated
istrue
,TrafficPolicyInstanceNameMarker
is the name of the first traffic policy instance in the next group of traffic policy instances.traffic_policy_instance_type_marker(Option<RrType>)
:If
IsTruncated
is true,TrafficPolicyInstanceTypeMarker
is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of traffic policy instances.is_truncated(bool)
:A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of traffic policy instances by submitting another
ListTrafficPolicyInstancesByHostedZone
request and specifying the values ofHostedZoneIdMarker
,TrafficPolicyInstanceNameMarker
, andTrafficPolicyInstanceTypeMarker
in the corresponding request parameters.max_items(i32)
:The value that you specified for the
MaxItems
parameter in theListTrafficPolicyInstancesByHostedZone
request that produced the current response.
- On failure, responds with
SdkError<ListTrafficPolicyInstancesByHostedZoneError>
Source§impl Client
impl Client
Sourcepub fn list_traffic_policy_instances_by_policy(
&self,
) -> ListTrafficPolicyInstancesByPolicyFluentBuilder
pub fn list_traffic_policy_instances_by_policy( &self, ) -> ListTrafficPolicyInstancesByPolicyFluentBuilder
Constructs a fluent builder for the ListTrafficPolicyInstancesByPolicy
operation.
- The fluent builder is configurable:
traffic_policy_id(impl Into<String>)
/set_traffic_policy_id(Option<String>)
:
required: trueThe ID of the traffic policy for which you want to list traffic policy instances.
traffic_policy_version(i32)
/set_traffic_policy_version(Option<i32>)
:
required: trueThe version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the traffic policy that is specified by
TrafficPolicyId
.hosted_zone_id_marker(impl Into<String>)
/set_hosted_zone_id_marker(Option<String>)
:
required: falseIf the value of
IsTruncated
in the previous response wastrue
, you have more traffic policy instances. To get more traffic policy instances, submit anotherListTrafficPolicyInstancesByPolicy
request.For the value of
hostedzoneid
, specify the value ofHostedZoneIdMarker
from the previous response, which is the hosted zone ID of the first traffic policy instance that Amazon Route 53 will return if you submit another request.If the value of
IsTruncated
in the previous response wasfalse
, there are no more traffic policy instances to get.traffic_policy_instance_name_marker(impl Into<String>)
/set_traffic_policy_instance_name_marker(Option<String>)
:
required: falseIf the value of
IsTruncated
in the previous response wastrue
, you have more traffic policy instances. To get more traffic policy instances, submit anotherListTrafficPolicyInstancesByPolicy
request.For the value of
trafficpolicyinstancename
, specify the value ofTrafficPolicyInstanceNameMarker
from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.If the value of
IsTruncated
in the previous response wasfalse
, there are no more traffic policy instances to get.traffic_policy_instance_type_marker(RrType)
/set_traffic_policy_instance_type_marker(Option<RrType>)
:
required: falseIf the value of
IsTruncated
in the previous response wastrue
, you have more traffic policy instances. To get more traffic policy instances, submit anotherListTrafficPolicyInstancesByPolicy
request.For the value of
trafficpolicyinstancetype
, specify the value ofTrafficPolicyInstanceTypeMarker
from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.If the value of
IsTruncated
in the previous response wasfalse
, there are no more traffic policy instances to get.max_items(i32)
/set_max_items(Option<i32>)
:
required: falseThe maximum number of traffic policy instances to be included in the response body for this request. If you have more than
MaxItems
traffic policy instances, the value of theIsTruncated
element in the response istrue
, and the values ofHostedZoneIdMarker
,TrafficPolicyInstanceNameMarker
, andTrafficPolicyInstanceTypeMarker
represent the first traffic policy instance that Amazon Route 53 will return if you submit another request.
- On success, responds with
ListTrafficPolicyInstancesByPolicyOutput
with field(s):traffic_policy_instances(Vec::<TrafficPolicyInstance>)
:A list that contains one
TrafficPolicyInstance
element for each traffic policy instance that matches the elements in the request.hosted_zone_id_marker(Option<String>)
:If
IsTruncated
istrue
,HostedZoneIdMarker
is the ID of the hosted zone of the first traffic policy instance in the next group of traffic policy instances.traffic_policy_instance_name_marker(Option<String>)
:If
IsTruncated
istrue
,TrafficPolicyInstanceNameMarker
is the name of the first traffic policy instance in the next group ofMaxItems
traffic policy instances.traffic_policy_instance_type_marker(Option<RrType>)
:If
IsTruncated
istrue
,TrafficPolicyInstanceTypeMarker
is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group ofMaxItems
traffic policy instances.is_truncated(bool)
:A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of traffic policy instances by calling
ListTrafficPolicyInstancesByPolicy
again and specifying the values of theHostedZoneIdMarker
,TrafficPolicyInstanceNameMarker
, andTrafficPolicyInstanceTypeMarker
elements in the corresponding request parameters.max_items(i32)
:The value that you specified for the
MaxItems
parameter in the call toListTrafficPolicyInstancesByPolicy
that produced the current response.
- On failure, responds with
SdkError<ListTrafficPolicyInstancesByPolicyError>
Source§impl Client
impl Client
Sourcepub fn list_traffic_policy_versions(
&self,
) -> ListTrafficPolicyVersionsFluentBuilder
pub fn list_traffic_policy_versions( &self, ) -> ListTrafficPolicyVersionsFluentBuilder
Constructs a fluent builder for the ListTrafficPolicyVersions
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueSpecify the value of
Id
of the traffic policy for which you want to list all versions.traffic_policy_version_marker(impl Into<String>)
/set_traffic_policy_version_marker(Option<String>)
:
required: falseFor your first request to
ListTrafficPolicyVersions
, don’t include theTrafficPolicyVersionMarker
parameter.If you have more traffic policy versions than the value of
MaxItems
,ListTrafficPolicyVersions
returns only the first group ofMaxItems
versions. To get more traffic policy versions, submit anotherListTrafficPolicyVersions
request. For the value ofTrafficPolicyVersionMarker
, specify the value ofTrafficPolicyVersionMarker
in the previous response.max_items(i32)
/set_max_items(Option<i32>)
:
required: falseThe maximum number of traffic policy versions that you want Amazon Route 53 to include in the response body for this request. If the specified traffic policy has more than
MaxItems
versions, the value ofIsTruncated
in the response istrue
, and the value of theTrafficPolicyVersionMarker
element is the ID of the first version that Route 53 will return if you submit another request.
- On success, responds with
ListTrafficPolicyVersionsOutput
with field(s):traffic_policies(Vec::<TrafficPolicy>)
:A list that contains one
TrafficPolicy
element for each traffic policy version that is associated with the specified traffic policy.is_truncated(bool)
:A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of traffic policies by submitting another
ListTrafficPolicyVersions
request and specifying the value ofNextMarker
in themarker
parameter.traffic_policy_version_marker(String)
:If
IsTruncated
istrue
, the value ofTrafficPolicyVersionMarker
identifies the first traffic policy that Amazon Route 53 will return if you submit another request. CallListTrafficPolicyVersions
again and specify the value ofTrafficPolicyVersionMarker
in theTrafficPolicyVersionMarker
request parameter.This element is present only if
IsTruncated
istrue
.max_items(i32)
:The value that you specified for the
maxitems
parameter in theListTrafficPolicyVersions
request that produced the current response.
- On failure, responds with
SdkError<ListTrafficPolicyVersionsError>
Source§impl Client
impl Client
Constructs a fluent builder for the ListVPCAssociationAuthorizations
operation.
- The fluent builder is configurable:
hosted_zone_id(impl Into<String>)
/set_hosted_zone_id(Option<String>)
:
required: trueThe ID of the hosted zone for which you want a list of VPCs that can be associated with the hosted zone.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseOptional: If a response includes a
NextToken
element, there are more VPCs that can be associated with the specified hosted zone. To get the next page of results, submit another request, and include the value ofNextToken
from the response in thenexttoken
parameter in anotherListVPCAssociationAuthorizations
request.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseOptional: An integer that specifies the maximum number of VPCs that you want Amazon Route 53 to return. If you don’t specify a value for
MaxResults
, Route 53 returns up to 50 VPCs per page.
- On success, responds with
ListVpcAssociationAuthorizationsOutput
with field(s):hosted_zone_id(String)
:The ID of the hosted zone that you can associate the listed VPCs with.
next_token(Option<String>)
:When the response includes a
NextToken
element, there are more VPCs that can be associated with the specified hosted zone. To get the next page of VPCs, submit anotherListVPCAssociationAuthorizations
request, and include the value of theNextToken
element from the response in thenexttoken
request parameter.vpcs(Vec::<Vpc>)
:The list of VPCs that are authorized to be associated with the specified hosted zone.
- On failure, responds with
SdkError<ListVPCAssociationAuthorizationsError>
Source§impl Client
impl Client
Sourcepub fn test_dns_answer(&self) -> TestDNSAnswerFluentBuilder
pub fn test_dns_answer(&self) -> TestDNSAnswerFluentBuilder
Constructs a fluent builder for the TestDNSAnswer
operation.
- The fluent builder is configurable:
hosted_zone_id(impl Into<String>)
/set_hosted_zone_id(Option<String>)
:
required: trueThe ID of the hosted zone that you want Amazon Route 53 to simulate a query for.
record_name(impl Into<String>)
/set_record_name(Option<String>)
:
required: trueThe name of the resource record set that you want Amazon Route 53 to simulate a query for.
record_type(RrType)
/set_record_type(Option<RrType>)
:
required: trueThe type of the resource record set.
resolver_ip(impl Into<String>)
/set_resolver_ip(Option<String>)
:
required: falseIf you want to simulate a request from a specific DNS resolver, specify the IP address for that resolver. If you omit this value,
TestDnsAnswer
uses the IP address of a DNS resolver in the Amazon Web Services US East (N. Virginia) Region (us-east-1
).edns0_client_subnet_ip(impl Into<String>)
/set_edns0_client_subnet_ip(Option<String>)
:
required: falseIf the resolver that you specified for resolverip supports EDNS0, specify the IPv4 or IPv6 address of a client in the applicable location, for example,
192.0.2.44
or2001:db8:85a3::8a2e:370:7334
.edns0_client_subnet_mask(impl Into<String>)
/set_edns0_client_subnet_mask(Option<String>)
:
required: falseIf you specify an IP address for
edns0clientsubnetip
, you can optionally specify the number of bits of the IP address that you want the checking tool to include in the DNS query. For example, if you specify192.0.2.44
foredns0clientsubnetip
and24
foredns0clientsubnetmask
, the checking tool will simulate a request from 192.0.2.0/24. The default value is 24 bits for IPv4 addresses and 64 bits for IPv6 addresses.The range of valid values depends on whether
edns0clientsubnetip
is an IPv4 or an IPv6 address:-
IPv4: Specify a value between 0 and 32
-
IPv6: Specify a value between 0 and 128
-
- On success, responds with
TestDnsAnswerOutput
with field(s):nameserver(String)
:The Amazon Route 53 name server used to respond to the request.
record_name(String)
:The name of the resource record set that you submitted a request for.
record_type(RrType)
:The type of the resource record set that you submitted a request for.
record_data(Vec::<String>)
:A list that contains values that Amazon Route 53 returned for this resource record set.
response_code(String)
:A code that indicates whether the request is valid or not. The most common response code is
NOERROR
, meaning that the request is valid. If the response is not valid, Amazon Route 53 returns a response code that describes the error. For a list of possible response codes, see DNS RCODES on the IANA website.protocol(String)
:The protocol that Amazon Route 53 used to respond to the request, either
UDP
orTCP
.
- On failure, responds with
SdkError<TestDNSAnswerError>
Source§impl Client
impl Client
Sourcepub fn update_health_check(&self) -> UpdateHealthCheckFluentBuilder
pub fn update_health_check(&self) -> UpdateHealthCheckFluentBuilder
Constructs a fluent builder for the UpdateHealthCheck
operation.
- The fluent builder is configurable:
health_check_id(impl Into<String>)
/set_health_check_id(Option<String>)
:
required: trueThe ID for the health check for which you want detailed information. When you created the health check,
CreateHealthCheck
returned the ID in the response, in theHealthCheckId
element.health_check_version(i64)
/set_health_check_version(Option<i64>)
:
required: falseA sequential counter that Amazon Route 53 sets to
1
when you create a health check and increments by 1 each time you update settings for the health check.We recommend that you use
GetHealthCheck
orListHealthChecks
to get the current value ofHealthCheckVersion
for the health check that you want to update, and that you include that value in yourUpdateHealthCheck
request. This prevents Route 53 from overwriting an intervening update:-
If the value in the
UpdateHealthCheck
request matches the value ofHealthCheckVersion
in the health check, Route 53 updates the health check with the new settings. -
If the value of
HealthCheckVersion
in the health check is greater, the health check was changed after you got the version number. Route 53 does not update the health check, and it returns aHealthCheckVersionMismatch
error.
-
ip_address(impl Into<String>)
/set_ip_address(Option<String>)
:
required: falseThe IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don’t specify a value for
IPAddress
, Route 53 sends a DNS request to resolve the domain name that you specify inFullyQualifiedDomainName
at the interval that you specify inRequestInterval
. Using an IP address that is returned by DNS, Route 53 then checks the health of the endpoint.Use one of the following formats for the value of
IPAddress
:-
IPv4 address: four values between 0 and 255, separated by periods (.), for example,
192.0.2.44
. -
IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example,
2001:0db8:85a3:0000:0000:abcd:0001:2345
. You can also shorten IPv6 addresses as described in RFC 5952, for example,2001:db8:85a3::abcd:1:2345
.
If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for
IPAddress
. This ensures that the IP address of your instance never changes. For more information, see the applicable documentation:-
Linux: Elastic IP Addresses (EIP) in the Amazon EC2 User Guide for Linux Instances
-
Windows: Elastic IP Addresses (EIP) in the Amazon EC2 User Guide for Windows Instances
If a health check already has a value for
IPAddress
, you can change the value. However, you can’t update an existing health check to add or remove the value ofIPAddress
.For more information, see FullyQualifiedDomainName.
Constraints: Route 53 can’t check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can’t create health checks, see the following documents:
-
port(i32)
/set_port(Option<i32>)
:
required: falseThe port on the endpoint that you want Amazon Route 53 to perform health checks on.
Don’t specify a value for
Port
when you specify a value forType
ofCLOUDWATCH_METRIC
orCALCULATED
.resource_path(impl Into<String>)
/set_resource_path(Option<String>)
:
required: falseThe path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html. You can also include query string parameters, for example,
/welcome.html?language=jp&login=y
.Specify this value only if you want to change it.
fully_qualified_domain_name(impl Into<String>)
/set_fully_qualified_domain_name(Option<String>)
:
required: falseAmazon Route 53 behavior depends on whether you specify a value for
IPAddress
.If a health check already has a value for
IPAddress
, you can change the value. However, you can’t update an existing health check to add or remove the value ofIPAddress
.If you specify a value for
IPAddress
:Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of
FullyQualifiedDomainName
in theHost
header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks.When Route 53 checks the health of an endpoint, here is how it constructs the
Host
header:-
If you specify a value of
80
forPort
andHTTP
orHTTP_STR_MATCH
forType
, Route 53 passes the value ofFullyQualifiedDomainName
to the endpoint in theHost
header. -
If you specify a value of
443
forPort
andHTTPS
orHTTPS_STR_MATCH
forType
, Route 53 passes the value ofFullyQualifiedDomainName
to the endpoint in theHost
header. -
If you specify another value for
Port
and any value exceptTCP
forType
, Route 53 passesFullyQualifiedDomainName
:Port
to the endpoint in theHost
header.
If you don’t specify a value for
FullyQualifiedDomainName
, Route 53 substitutes the value ofIPAddress
in theHost
header in each of the above cases.If you don’t specify a value for
IPAddress
:If you don’t specify a value for
IPAddress
, Route 53 sends a DNS request to the domain that you specify inFullyQualifiedDomainName
at the interval you specify inRequestInterval
. Using an IPv4 address that is returned by DNS, Route 53 then checks the health of the endpoint.If you don’t specify a value for
IPAddress
, you can’t update the health check to remove theFullyQualifiedDomainName
; if you don’t specify a value forIPAddress
on creation, aFullyQualifiedDomainName
is required.If you don’t specify a value for
IPAddress
, Route 53 uses only IPv4 to send health checks to the endpoint. If there’s no resource record set with a type of A for the name that you specify forFullyQualifiedDomainName
, the health check fails with a “DNS resolution failed” error.If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by
FullyQualifiedDomainName
, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value ofFullyQualifiedDomainName
, specify the domain name of the server (such asus-east-2-www.example.com
), not the name of the resource record sets (www.example.com).In this configuration, if the value of
FullyQualifiedDomainName
matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.In addition, if the value of
Type
isHTTP
,HTTPS
,HTTP_STR_MATCH
, orHTTPS_STR_MATCH
, Route 53 passes the value ofFullyQualifiedDomainName
in theHost
header, as it does when you specify a value forIPAddress
. If the value ofType
isTCP
, Route 53 doesn’t pass aHost
header.-
search_string(impl Into<String>)
/set_search_string(Option<String>)
:
required: falseIf the value of
Type
isHTTP_STR_MATCH
orHTTPS_STR_MATCH
, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. (You can’t change the value ofType
when you update a health check.)failure_threshold(i32)
/set_failure_threshold(Option<i32>)
:
required: falseThe number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
If you don’t specify a value for
FailureThreshold
, the default value is three health checks.inverted(bool)
/set_inverted(Option<bool>)
:
required: falseSpecify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.
disabled(bool)
/set_disabled(Option<bool>)
:
required: falseStops Route 53 from performing health checks. When you disable a health check, here’s what happens:
-
Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.
-
Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.
-
Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.
After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.
Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.
-
health_threshold(i32)
/set_health_threshold(Option<i32>)
:
required: falseThe number of child health checks that are associated with a
CALCULATED
health that Amazon Route 53 must consider healthy for theCALCULATED
health check to be considered healthy. To specify the child health checks that you want to associate with aCALCULATED
health check, use theChildHealthChecks
andChildHealthCheck
elements.Note the following:
-
If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.
-
If you specify
0
, Route 53 always considers this health check to be healthy.
-
child_health_checks(impl Into<String>)
/set_child_health_checks(Option<Vec::<String>>)
:
required: falseA complex type that contains one
ChildHealthCheck
element for each health check that you want to associate with aCALCULATED
health check.enable_sni(bool)
/set_enable_sni(Option<bool>)
:
required: falseSpecify whether you want Amazon Route 53 to send the value of
FullyQualifiedDomainName
to the endpoint in theclient_hello
message duringTLS
negotiation. This allows the endpoint to respond toHTTPS
health check requests with the applicable SSL/TLS certificate.Some endpoints require that HTTPS requests include the host name in the
client_hello
message. If you don’t enable SNI, the status of the health check will be SSL alerthandshake_failure
. A health check can also have that status for other reasons. If SNI is enabled and you’re still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.The SSL/TLS certificate on your endpoint includes a domain name in the
Common Name
field and possibly several more in theSubject Alternative Names
field. One of the domain names in the certificate should match the value that you specify forFullyQualifiedDomainName
. If the endpoint responds to theclient_hello
message with a certificate that does not include the domain name that you specified inFullyQualifiedDomainName
, a health checker will retry the handshake. In the second attempt, the health checker will omitFullyQualifiedDomainName
from theclient_hello
message.regions(HealthCheckRegion)
/set_regions(Option<Vec::<HealthCheckRegion>>)
:
required: falseA complex type that contains one
Region
element for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.alarm_identifier(AlarmIdentifier)
/set_alarm_identifier(Option<AlarmIdentifier>)
:
required: falseA complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.
insufficient_data_health_status(InsufficientDataHealthStatus)
/set_insufficient_data_health_status(Option<InsufficientDataHealthStatus>)
:
required: falseWhen CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:
-
Healthy
: Route 53 considers the health check to be healthy. -
Unhealthy
: Route 53 considers the health check to be unhealthy. -
LastKnownStatus
: By default, Route 53 uses the status of the health check from the last time CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the status for the health check is healthy.
-
reset_elements(ResettableElementName)
/set_reset_elements(Option<Vec::<ResettableElementName>>)
:
required: falseA complex type that contains one
ResettableElementName
element for each element that you want to reset to the default value. Valid values forResettableElementName
include the following:-
ChildHealthChecks
: Amazon Route 53 resets ChildHealthChecks to null. -
FullyQualifiedDomainName
: Route 53 resets FullyQualifiedDomainName. to null. -
Regions
: Route 53 resets the Regions list to the default set of regions. -
ResourcePath
: Route 53 resets ResourcePath to null.
-
- On success, responds with
UpdateHealthCheckOutput
with field(s):health_check(Option<HealthCheck>)
:A complex type that contains the response to an
UpdateHealthCheck
request.
- On failure, responds with
SdkError<UpdateHealthCheckError>
Source§impl Client
impl Client
Sourcepub fn update_hosted_zone_comment(&self) -> UpdateHostedZoneCommentFluentBuilder
pub fn update_hosted_zone_comment(&self) -> UpdateHostedZoneCommentFluentBuilder
Constructs a fluent builder for the UpdateHostedZoneComment
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID for the hosted zone that you want to update the comment for.
comment(impl Into<String>)
/set_comment(Option<String>)
:
required: falseThe new comment for the hosted zone. If you don’t specify a value for
Comment
, Amazon Route 53 deletes the existing value of theComment
element, if any.
- On success, responds with
UpdateHostedZoneCommentOutput
with field(s):hosted_zone(Option<HostedZone>)
:A complex type that contains the response to the
UpdateHostedZoneComment
request.
- On failure, responds with
SdkError<UpdateHostedZoneCommentError>
Source§impl Client
impl Client
Sourcepub fn update_traffic_policy_comment(
&self,
) -> UpdateTrafficPolicyCommentFluentBuilder
pub fn update_traffic_policy_comment( &self, ) -> UpdateTrafficPolicyCommentFluentBuilder
Constructs a fluent builder for the UpdateTrafficPolicyComment
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe value of
Id
for the traffic policy that you want to update the comment for.version(i32)
/set_version(Option<i32>)
:
required: trueThe value of
Version
for the traffic policy that you want to update the comment for.comment(impl Into<String>)
/set_comment(Option<String>)
:
required: trueThe new comment for the specified traffic policy and version.
- On success, responds with
UpdateTrafficPolicyCommentOutput
with field(s):traffic_policy(Option<TrafficPolicy>)
:A complex type that contains settings for the specified traffic policy.
- On failure, responds with
SdkError<UpdateTrafficPolicyCommentError>
Source§impl Client
impl Client
Sourcepub fn update_traffic_policy_instance(
&self,
) -> UpdateTrafficPolicyInstanceFluentBuilder
pub fn update_traffic_policy_instance( &self, ) -> UpdateTrafficPolicyInstanceFluentBuilder
Constructs a fluent builder for the UpdateTrafficPolicyInstance
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the traffic policy instance that you want to update.
ttl(i64)
/set_ttl(Option<i64>)
:
required: trueThe TTL that you want Amazon Route 53 to assign to all of the updated resource record sets.
traffic_policy_id(impl Into<String>)
/set_traffic_policy_id(Option<String>)
:
required: trueThe ID of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.
traffic_policy_version(i32)
/set_traffic_policy_version(Option<i32>)
:
required: trueThe version of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.
- On success, responds with
UpdateTrafficPolicyInstanceOutput
with field(s):traffic_policy_instance(Option<TrafficPolicyInstance>)
:A complex type that contains settings for the updated traffic policy instance.
- On failure, responds with
SdkError<UpdateTrafficPolicyInstanceError>
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_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is 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_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Source§impl Waiters for Client
impl Waiters for Client
Source§fn wait_until_resource_record_sets_changed(
&self,
) -> ResourceRecordSetsChangedFluentBuilder
fn wait_until_resource_record_sets_changed( &self, ) -> ResourceRecordSetsChangedFluentBuilder
resource_record_sets_changed
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);