Package org.jclouds.route53.features

Interface HostedZoneApi

public interface HostedZoneApi
See Also:

  • Method Details

    • createWithReference

      @Named("CreateHostedZone") @POST @Produces("application/xml") @Path("/hostedzone") NewHostedZone createWithReference(String name, String callerReference)
      This action creates a new hosted zone.

      Note

      You cannot create a hosted zone for a top-level domain (TLD).
      Parameters:
      name - The name of the domain. ex. www.example.com. The trailing dot is optional.
      callerReference - A unique string that identifies the request and allows safe retries. ex. MyDNSMigration_01
      Returns:
      the new zone in progress, in
      invalid reference 
      Status#PENDING
      .

    • createWithReferenceAndComment

      @Named("CreateHostedZone") @POST @Produces("application/xml") @Path("/hostedzone") NewHostedZone createWithReferenceAndComment(String name, String callerReference, String comment)
      like createWithReference(String, String), except you can specify a comment.

    • list

      @Named("ListHostedZones") @GET @Path("/hostedzone") PagedIterable<HostedZone> list()
      returns all zones in order.

    • listFirstPage

      @Named("ListHostedZones") @GET @Path("/hostedzone") IterableWithMarker<HostedZone> listFirstPage()
      retrieves up to 100 zones in order.

    • listAt

      @Named("ListHostedZones") @GET @Path("/hostedzone") IterableWithMarker<HostedZone> listAt(@QueryParam("marker") String nextMarker)
      retrieves up to 100 zones in order, starting at nextMarker

    • get

      @Named("GetHostedZone") @GET @Path("/hostedzone/{zoneId}") @Nullable HostedZoneAndNameServers get(@PathParam("zoneId") String zoneId)
      Retrieves information about the specified zone, including its nameserver configuration
      Parameters:
      id - id of the zone to get information about. ex Z1PA6795UKMFR9
      Returns:
      null if not found

    • delete

      @Named("DeleteHostedZone") @DELETE @Path("/hostedzone/{zoneId}") @Nullable Change delete(@PathParam("zoneId") String zoneId)
      This action deletes a hosted zone.
      Parameters:
      id - id of the zone to delete. ex Z1PA6795UKMFR9
      Returns:
      null if not found or the change in progress