Route53 class

Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web service.

Constructors

Route53({String? region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

activateKeySigningKey({required String hostedZoneId, required String name}) → Future<ActivateKeySigningKeyResponse>

Activates a key signing key (KSK) so that it can be used for signing by DNSSEC. This operation changes the KSK status to ACTIVE.

associateVPCWithHostedZone({required String hostedZoneId, required VPC vpc, String? comment}) → Future<AssociateVPCWithHostedZoneResponse>

Associates an Amazon VPC with a private hosted zone.

changeResourceRecordSets({required ChangeBatch changeBatch, required String hostedZoneId}) → Future<ChangeResourceRecordSetsResponse>

Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name. For example, you can use ChangeResourceRecordSets to create a resource record set that routes traffic for test.example.com to a web server that has an IP address of 192.0.2.44.

changeTagsForResource({required String resourceId, required TagResourceType resourceType, List<Tag>? addTags, List<String>? removeTagKeys}) → Future<void>

Adds, edits, or deletes tags for a health check or a hosted zone.

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

createHealthCheck({required String callerReference, required HealthCheckConfig healthCheckConfig}) → Future<CreateHealthCheckResponse>

Creates a new health check.

createHostedZone({required String callerReference, required String name, String? delegationSetId, HostedZoneConfig? hostedZoneConfig, VPC? vpc}) → Future<CreateHostedZoneResponse>

Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs). For more information about charges for hosted zones, see Amazon Route 53 Pricing.

createKeySigningKey({required String callerReference, required String hostedZoneId, required String keyManagementServiceArn, required String name, required String status}) → Future<CreateKeySigningKeyResponse>

Creates a new key signing key (KSK) associated with a hosted zone. You can only have two KSKs per hosted zone.

createQueryLoggingConfig({required String cloudWatchLogsLogGroupArn, required String hostedZoneId}) → Future<CreateQueryLoggingConfigResponse>

Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.

createReusableDelegationSet({required String callerReference, String? hostedZoneId}) → Future<CreateReusableDelegationSetResponse>

Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones that were created by the same AWS account.

createTrafficPolicy({required String document, required String name, String? comment}) → Future<CreateTrafficPolicyResponse>

Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com).

createTrafficPolicyInstance({required String hostedZoneId, required String name, required int ttl, required String trafficPolicyId, required int trafficPolicyVersion}) → Future<CreateTrafficPolicyInstanceResponse>

Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version. In addition, CreateTrafficPolicyInstance associates the resource record sets with a specified domain name (such as example.com) or subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for the domain or subdomain name by using the resource record sets that CreateTrafficPolicyInstance created.

createTrafficPolicyVersion({required String document, required String id, String? comment}) → Future<CreateTrafficPolicyVersionResponse>

Creates a new version of an existing traffic policy. When you create a new version of a traffic policy, you specify the ID of the traffic policy that you want to update and a JSON-formatted document that describes the new version. You use traffic policies to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com). You can create a maximum of 1000 versions of a traffic policy. If you reach the limit and need to create another version, you'll need to start a new traffic policy.

createVPCAssociationAuthorization({required String hostedZoneId, required VPC vpc}) → Future<CreateVPCAssociationAuthorizationResponse>

Authorizes the AWS account that created a specified VPC to submit an AssociateVPCWithHostedZone request to associate the VPC with a specified hosted zone that was created by a different account. To submit a CreateVPCAssociationAuthorization request, you must use the account that created the hosted zone. After you authorize the association, use the account that created the VPC to submit an AssociateVPCWithHostedZone request.

deactivateKeySigningKey({required String hostedZoneId, required String name}) → Future<DeactivateKeySigningKeyResponse>

Deactivates a key signing key (KSK) so that it will not be used for signing by DNSSEC. This operation changes the KSK status to INACTIVE.

deleteHealthCheck({required String healthCheckId}) → Future<void>

Deletes a health check. If you're using AWS Cloud Map and you configured Cloud Map to create a Route 53 health check when you register an instance, you can't use the Route 53 DeleteHealthCheck command to delete the health check. The health check is deleted automatically when you deregister the instance; there can be a delay of several hours before the health check is deleted from Route 53.

deleteHostedZone({required String id}) → Future<DeleteHostedZoneResponse>

Deletes a hosted zone.

deleteKeySigningKey({required String hostedZoneId, required String name}) → Future<DeleteKeySigningKeyResponse>

Deletes a key signing key (KSK). Before you can delete a KSK, you must deactivate it. The KSK must be deactived before you can delete it regardless of whether the hosted zone is enabled for DNSSEC signing.

deleteQueryLoggingConfig({required String id}) → Future<void>

Deletes a configuration for DNS query logging. If you delete a configuration, Amazon Route 53 stops sending query logs to CloudWatch Logs. Route 53 doesn't delete any logs that are already in CloudWatch Logs.

deleteReusableDelegationSet({required String id}) → Future<void>

Deletes a reusable delegation set. To verify that the reusable delegation set is not associated with any hosted zones, submit a GetReusableDelegationSet request and specify the ID of the reusable delegation set that you want to delete.

deleteTrafficPolicy({required String id, required int version}) → Future<void>

Deletes a traffic policy.

deleteTrafficPolicyInstance({required String id}) → Future<void>

Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance.

deleteVPCAssociationAuthorization({required String hostedZoneId, required VPC vpc}) → Future<void>

Removes authorization to submit an AssociateVPCWithHostedZone request to associate a specified VPC with a hosted zone that was created by a different account. You must use the account that created the hosted zone to submit a DeleteVPCAssociationAuthorization request.

disableHostedZoneDNSSEC({required String hostedZoneId}) → Future<DisableHostedZoneDNSSECResponse>

Disables DNSSEC signing in a specific hosted zone. This action does not deactivate any key signing keys (KSKs) that are active in the hosted zone.

disassociateVPCFromHostedZone({required String hostedZoneId, required VPC vpc, String? comment}) → Future<DisassociateVPCFromHostedZoneResponse>

Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53 private hosted zone. Note the following:

enableHostedZoneDNSSEC({required String hostedZoneId}) → Future<EnableHostedZoneDNSSECResponse>

Enables DNSSEC signing in a specific hosted zone.

getAccountLimit({required AccountLimitType type}) → Future<GetAccountLimitResponse>

Gets the specified limit for the current account, for example, the maximum number of health checks that you can create using the account.

getChange({required String id}) → Future<GetChangeResponse>

Returns the current status of a change batch request. The status is one of the following values:

getCheckerIpRanges() → Future<GetCheckerIpRangesResponse>

getDNSSEC({required String hostedZoneId}) → Future<GetDNSSECResponse>

Returns information about DNSSEC for a specific hosted zone, including the key signing keys (KSKs) and zone signing keys (ZSKs) in the hosted zone.

getGeoLocation({String? continentCode, String? countryCode, String? subdivisionCode}) → Future<GetGeoLocationResponse>

Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets.

getHealthCheck({required String healthCheckId}) → Future<GetHealthCheckResponse>

Gets information about a specified health check.

getHealthCheckCount() → Future<GetHealthCheckCountResponse>

Retrieves the number of health checks that are associated with the current AWS account.

getHealthCheckLastFailureReason({required String healthCheckId}) → Future<GetHealthCheckLastFailureReasonResponse>

Gets the reason that a specified health check failed most recently.

getHealthCheckStatus({required String healthCheckId}) → Future<GetHealthCheckStatusResponse>

Gets status of a specified health check.

getHostedZone({required String id}) → Future<GetHostedZoneResponse>

Gets information about a specified hosted zone including the four name servers assigned to the hosted zone.

getHostedZoneCount() → Future<GetHostedZoneCountResponse>

Retrieves the number of hosted zones that are associated with the current AWS account.

getHostedZoneLimit({required String hostedZoneId, required HostedZoneLimitType type}) → Future<GetHostedZoneLimitResponse>

Gets the specified limit for a specified hosted zone, for example, the maximum number of records that you can create in the hosted zone.

getQueryLoggingConfig({required String id}) → Future<GetQueryLoggingConfigResponse>

Gets information about a specified configuration for DNS query logging.

getReusableDelegationSet({required String id}) → Future<GetReusableDelegationSetResponse>

Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set.

getReusableDelegationSetLimit({required String delegationSetId, required ReusableDelegationSetLimitType type}) → Future<GetReusableDelegationSetLimitResponse>

Gets the maximum number of hosted zones that you can associate with the specified reusable delegation set.

getTrafficPolicy({required String id, required int version}) → Future<GetTrafficPolicyResponse>

Gets information about a specific traffic policy version.

getTrafficPolicyInstance({required String id}) → Future<GetTrafficPolicyInstanceResponse>

Gets information about a specified traffic policy instance.

getTrafficPolicyInstanceCount() → Future<GetTrafficPolicyInstanceCountResponse>

Gets the number of traffic policy instances that are associated with the current AWS account.

listGeoLocations({String? maxItems, String? startContinentCode, String? startCountryCode, String? startSubdivisionCode}) → Future<ListGeoLocationsResponse>

Retrieves a list of supported geographic locations.

listHealthChecks({String? marker, String? maxItems}) → Future<ListHealthChecksResponse>

Retrieve a list of the health checks that are associated with the current AWS account.

listHostedZones({String? delegationSetId, String? marker, String? maxItems}) → Future<ListHostedZonesResponse>

Retrieves a list of the public and private hosted zones that are associated with the current AWS account. The response includes a HostedZones child element for each hosted zone.

listHostedZonesByName({String? dNSName, String? hostedZoneId, String? maxItems}) → Future<ListHostedZonesByNameResponse>

Retrieves a list of your hosted zones in lexicographic order. The response includes a HostedZones child element for each hosted zone created by the current AWS account.

listHostedZonesByVPC({required String vPCId, required VPCRegion vPCRegion, String? maxItems, String? nextToken}) → Future<ListHostedZonesByVPCResponse>

Lists all the private hosted zones that a specified VPC is associated with, regardless of which AWS account or AWS service owns the hosted zones. The HostedZoneOwner structure in the response contains one of the following values:

listQueryLoggingConfigs({String? hostedZoneId, String? maxResults, String? nextToken}) → Future<ListQueryLoggingConfigsResponse>

Lists the configurations for DNS query logging that are associated with the current AWS account or the configuration that is associated with a specified hosted zone.

listResourceRecordSets({required String hostedZoneId, String? maxItems, String? startRecordIdentifier, String? startRecordName, RRType? startRecordType}) → Future<ListResourceRecordSetsResponse>

Lists the resource record sets in a specified hosted zone.

listReusableDelegationSets({String? marker, String? maxItems}) → Future<ListReusableDelegationSetsResponse>

Retrieves a list of the reusable delegation sets that are associated with the current AWS account.

listTagsForResource({required String resourceId, required TagResourceType resourceType}) → Future<ListTagsForResourceResponse>

Lists tags for one health check or hosted zone.

listTagsForResources({required List<String> resourceIds, required TagResourceType resourceType}) → Future<ListTagsForResourcesResponse>

Lists tags for up to 10 health checks or hosted zones.

listTrafficPolicies({String? maxItems, String? trafficPolicyIdMarker}) → Future<ListTrafficPoliciesResponse>

Gets information about the latest version for every traffic policy that is associated with the current AWS account. Policies are listed in the order that they were created in.

listTrafficPolicyInstances({String? hostedZoneIdMarker, String? maxItems, String? trafficPolicyInstanceNameMarker, RRType? trafficPolicyInstanceTypeMarker}) → Future<ListTrafficPolicyInstancesResponse>

Gets information about the traffic policy instances that you created by using the current AWS account. Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.

listTrafficPolicyInstancesByHostedZone({required String hostedZoneId, String? maxItems, String? trafficPolicyInstanceNameMarker, RRType? trafficPolicyInstanceTypeMarker}) → Future<ListTrafficPolicyInstancesByHostedZoneResponse>

Gets information about the traffic policy instances that you created in a specified hosted zone. Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.

listTrafficPolicyInstancesByPolicy({required String trafficPolicyId, required int trafficPolicyVersion, String? hostedZoneIdMarker, String? maxItems, String? trafficPolicyInstanceNameMarker, RRType? trafficPolicyInstanceTypeMarker}) → Future<ListTrafficPolicyInstancesByPolicyResponse>

Gets information about the traffic policy instances that you created by using a specify traffic policy version. Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.

listTrafficPolicyVersions({required String id, String? maxItems, String? trafficPolicyVersionMarker}) → Future<ListTrafficPolicyVersionsResponse>

Gets information about all of the versions for a specified traffic policy.

listVPCAssociationAuthorizations({required String hostedZoneId, String? maxResults, String? nextToken}) → Future<ListVPCAssociationAuthorizationsResponse>

Gets a list of the VPCs that were created by other accounts and that can be associated with a specified hosted zone because you've submitted one or more CreateVPCAssociationAuthorization requests.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

testDNSAnswer({required String hostedZoneId, required String recordName, required RRType recordType, String? eDNS0ClientSubnetIP, String? eDNS0ClientSubnetMask, String? resolverIP}) → Future<TestDNSAnswerResponse>

Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type. You can optionally specify the IP address of a DNS resolver, an EDNS0 client subnet IP address, and a subnet mask.

toString() → String

A string representation of this object.

inherited

updateHealthCheck({required String healthCheckId, AlarmIdentifier? alarmIdentifier, List<String>? childHealthChecks, bool? disabled, bool? enableSNI, int? failureThreshold, String? fullyQualifiedDomainName, int? healthCheckVersion, int? healthThreshold, String? iPAddress, InsufficientDataHealthStatus? insufficientDataHealthStatus, bool? inverted, int? port, List<HealthCheckRegion>? regions, List<ResettableElementName>? resetElements, String? resourcePath, String? searchString}) → Future<UpdateHealthCheckResponse>

Updates an existing health check. Note that some values can't be updated.

updateHostedZoneComment({required String id, String? comment}) → Future<UpdateHostedZoneCommentResponse>

Updates the comment for a specified hosted zone.

updateTrafficPolicyComment({required String comment, required String id, required int version}) → Future<UpdateTrafficPolicyCommentResponse>

Updates the comment for a specified traffic policy version.

updateTrafficPolicyInstance({required String id, required int ttl, required String trafficPolicyId, required int trafficPolicyVersion}) → Future<UpdateTrafficPolicyInstanceResponse>

Updates the resource record sets in a specified hosted zone that were created based on the settings in a specified traffic policy version.

Operators

operator ==(Object other) → bool

The equality operator.

inherited