AWS.Route53Profiles — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

With Amazon Route 53 Profiles you can share Route 53 configurations with VPCs and AWS accounts

Sending a Request Using Route53Profiles

var route53profiles = new AWS.Route53Profiles();
route53profiles.associateProfile(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Route53Profiles object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var route53profiles = new AWS.Route53Profiles({apiVersion: '2018-05-10'});

You can also set the API version globally in AWS.config.apiVersions using the route53profiles service identifier:

AWS.config.apiVersions = {
  route53profiles: '2018-05-10',
  // other service API versions
};

var route53profiles = new AWS.Route53Profiles();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Route53Profiles(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

associateProfile(params = {}, callback) ⇒ AWS.Request

associateResourceToProfile(params = {}, callback) ⇒ AWS.Request

Associates a DNS reource configuration to a Route 53 Profile.

createProfile(params = {}, callback) ⇒ AWS.Request

Creates an empty Route 53 Profile.

deleteProfile(params = {}, callback) ⇒ AWS.Request

Deletes the specified Route 53 Profile. Before you can delete a profile, you must first disassociate it from all VPCs.

disassociateProfile(params = {}, callback) ⇒ AWS.Request

Dissociates a specified Route 53 Profile from the specified VPC.

disassociateResourceFromProfile(params = {}, callback) ⇒ AWS.Request

Dissoaciated a specified resource, from the Route 53 Profile.

getProfile(params = {}, callback) ⇒ AWS.Request

Returns information about a specified Route 53 Profile, such as whether whether the Profile is shared, and the current status of the Profile.

getProfileAssociation(params = {}, callback) ⇒ AWS.Request

Retrieves a Route 53 Profile association for a VPC. A VPC can have only one Profile association, but a Profile can be associated with up to 5000 VPCs.

getProfileResourceAssociation(params = {}, callback) ⇒ AWS.Request

Returns information about a specified Route 53 Profile resource association.

listProfileAssociations(params = {}, callback) ⇒ AWS.Request

Lists all the VPCs that the specified Route 53 Profile is associated with.

listProfileResourceAssociations(params = {}, callback) ⇒ AWS.Request

Lists all the resource associations for the specified Route 53 Profile.

listProfiles(params = {}, callback) ⇒ AWS.Request

Lists all the Route 53 Profiles associated with your Amazon Web Services account.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists the tags that you associated with the specified resource.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds one or more tags to a specified resource.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes one or more tags from a specified resource.

updateProfileResourceAssociation(params = {}, callback) ⇒ AWS.Request

Updates the specified Route 53 Profile resourse association.