Client

route53

R Documentation

Amazon Route 53¶

Description¶

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

You can use Route 53 to:

Register domain names.

For more information, see How domain registration works.
Route internet traffic to the resources for your domain

For more information, see How internet traffic is routed to your website or web application.
Check the health of your resources.

For more information, see How Route 53 checks the health of your resources.

Usage¶

route53(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- route53(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

activate_key_signing_key: Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC
associate_vpc_with_hosted_zone: Associates an Amazon VPC with a private hosted zone
change_cidr_collection: Creates, changes, or deletes CIDR blocks within a collection
change_resource_record_sets: Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name
change_tags_for_resource: Adds, edits, or deletes tags for a health check or a hosted zone
create_cidr_collection: Creates a CIDR collection in the current Amazon Web Services account
create_health_check: Creates a new health check
create_hosted_zone: Creates a new public or private hosted zone
create_key_signing_key: Creates a new key-signing key (KSK) associated with a hosted zone
create_query_logging_config: Creates a configuration for DNS query logging
create_reusable_delegation_set: Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones that were created by the same Amazon Web Services account
create_traffic_policy: Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example
create_traffic_policy_instance: Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version
create_traffic_policy_version: Creates a new version of an existing traffic policy
create_vpc_association_authorization: Authorizes the Amazon Web Services 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
deactivate_key_signing_key: Deactivates a key-signing key (KSK) so that it will not be used for signing by DNSSEC
delete_cidr_collection: Deletes a CIDR collection in the current Amazon Web Services account
delete_health_check: Deletes a health check
delete_hosted_zone: Deletes a hosted zone
delete_key_signing_key: Deletes a key-signing key (KSK)
delete_query_logging_config: Deletes a configuration for DNS query logging
delete_reusable_delegation_set: Deletes a reusable delegation set
delete_traffic_policy: Deletes a traffic policy
delete_traffic_policy_instance: Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance
delete_vpc_association_authorization: Removes authorization to submit an AssociateVPCWithHostedZone request to associate a specified VPC with a hosted zone that was created by a different account
disable_hosted_zone_dnssec: Disables DNSSEC signing in a specific hosted zone
disassociate_vpc_from_hosted_zone: Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53 private hosted zone
enable_hosted_zone_dnssec: Enables DNSSEC signing in a specific hosted zone
get_account_limit: Gets the specified limit for the current account, for example, the maximum number of health checks that you can create using the account
get_change: Returns the current status of a change batch request
get_checker_ip_ranges: Route 53 does not perform authorization for this API because it retrieves information that is already available to the public
get_dnssec: Returns information about DNSSEC for a specific hosted zone, including the key-signing keys (KSKs) in the hosted zone
get_geo_location: Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets
get_health_check: Gets information about a specified health check
get_health_check_count: Retrieves the number of health checks that are associated with the current Amazon Web Services account
get_health_check_last_failure_reason: Gets the reason that a specified health check failed most recently
get_health_check_status: Gets status of a specified health check
get_hosted_zone: Gets information about a specified hosted zone including the four name servers assigned to the hosted zone
get_hosted_zone_count: Retrieves the number of hosted zones that are associated with the current Amazon Web Services account
get_hosted_zone_limit: Gets the specified limit for a specified hosted zone, for example, the maximum number of records that you can create in the hosted zone
get_query_logging_config: Gets information about a specified configuration for DNS query logging
get_reusable_delegation_set: Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set
get_reusable_delegation_set_limit: Gets the maximum number of hosted zones that you can associate with the specified reusable delegation set
get_traffic_policy: Gets information about a specific traffic policy version
get_traffic_policy_instance: Gets information about a specified traffic policy instance
get_traffic_policy_instance_count: Gets the number of traffic policy instances that are associated with the current Amazon Web Services account
list_cidr_blocks: Returns a paginated list of location objects and their CIDR blocks
list_cidr_collections: Returns a paginated list of CIDR collections in the Amazon Web Services account (metadata only)
list_cidr_locations: Returns a paginated list of CIDR locations for the given collection (metadata only, does not include CIDR blocks)
list_geo_locations: Retrieves a list of supported geographic locations
list_health_checks: Retrieve a list of the health checks that are associated with the current Amazon Web Services account
list_hosted_zones: Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services account
list_hosted_zones_by_name: Retrieves a list of your hosted zones in lexicographic order
list_hosted_zones_by_vpc: Lists all the private hosted zones that a specified VPC is associated with, regardless of which Amazon Web Services account or Amazon Web Services service owns the hosted zones
list_query_logging_configs: Lists the configurations for DNS query logging that are associated with the current Amazon Web Services account or the configuration that is associated with a specified hosted zone
list_resource_record_sets: Lists the resource record sets in a specified hosted zone
list_reusable_delegation_sets: Retrieves a list of the reusable delegation sets that are associated with the current Amazon Web Services account
list_tags_for_resource: Lists tags for one health check or hosted zone
list_tags_for_resources: Lists tags for up to 10 health checks or hosted zones
list_traffic_policies: Gets information about the latest version for every traffic policy that is associated with the current Amazon Web Services account
list_traffic_policy_instances: Gets information about the traffic policy instances that you created by using the current Amazon Web Services account; Gets information about the traffic policy instances that you created in a specified hosted zone; Gets information about the traffic policy instances that you created by using a specify traffic policy version
list_traffic_policy_versions: Gets information about all of the versions for a specified traffic policy
list_vpc_association_authorizations: 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
test_dns_answer: Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type
update_health_check: Updates an existing health check
update_hosted_zone_comment: Updates the comment for a specified hosted zone
update_traffic_policy_comment: Updates the comment for a specified traffic policy version
update_traffic_policy_instance: After you submit a UpdateTrafficPolicyInstance request, there's a brief delay while Route 53 creates the resource record sets that are specified in the traffic policy definition

Examples¶

## Not run: 
svc <- route53()
# The following example associates the VPC with ID vpc-1a2b3c4d with the
# hosted zone with ID Z3M3LMPEXAMPLE.
svc$associate_vpc_with_hosted_zone(
  Comment = "",
  HostedZoneId = "Z3M3LMPEXAMPLE",
  VPC = list(
    VPCId = "vpc-1a2b3c4d",
    VPCRegion = "us-east-2"
  )
)

## End(Not run)