amazonka-route53-0.3.2: Amazon Route 53 SDK.

Safe HaskellNone
LanguageHaskell2010

Network.AWS.Route53.Types

Contents

Synopsis

Service

data Route53 Source

Version 2013-04-01 of the Amazon Route 53 service.

Instances

AWSService Route53 
type Sg Route53 = V4 
type Er Route53 = RESTError 

Error

data RESTError :: *

Instances

Eq RESTError 
Show RESTError 
Generic RESTError 
FromXML RESTError 
AWSErrorCode RESTError 
type Rep RESTError = D1 D1RESTError (C1 C1_0RESTError ((:*:) ((:*:) (S1 S1_0_0RESTError (Rec0 Text)) (S1 S1_0_1RESTError (Rec0 (Maybe ErrorType)))) ((:*:) (S1 S1_0_2RESTError (Rec0 ErrorCode)) (S1 S1_0_3RESTError (Rec0 Text))))) 

XML

ns :: Text Source

AliasTarget

data AliasTarget Source

Instances

aliasTarget Source

Arguments

:: Text

atHostedZoneId

-> Text

atDNSName

-> Bool

atEvaluateTargetHealth

-> AliasTarget 

AliasTarget constructor.

The fields accessible through corresponding lenses are:

atDNSName :: Lens' AliasTarget Text Source

Alias resource record sets only: The external DNS name associated with the AWS Resource.

For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide

.

atEvaluateTargetHealth :: Lens' AliasTarget Bool Source

Alias resource record sets only: A boolean value that indicates whether this Resource Record Set should respect the health status of any health checks associated with the ALIAS target record which it is linked to.

For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide

.

atHostedZoneId :: Lens' AliasTarget Text Source

Alias resource record sets only: The value of the hosted zone ID for the AWS resource.

For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide

.

ResourceRecord

data ResourceRecord Source

Instances

resourceRecord Source

Arguments

:: Text

rrValue

-> ResourceRecord 

ResourceRecord constructor.

The fields accessible through corresponding lenses are:

rrValue :: Lens' ResourceRecord Text Source

The value of the Value element for the current resource record set.

Tag

data Tag Source

Instances

Eq Tag 
Ord Tag 
Read Tag 
Show Tag 
ToXML Tag 
FromXML Tag 

tag :: Tag Source

Tag constructor.

The fields accessible through corresponding lenses are:

tagKey :: Lens' Tag (Maybe Text) Source

The key for a Tag.

tagValue :: Lens' Tag (Maybe Text) Source

The value for a Tag.

GeoLocationDetails

data GeoLocationDetails Source

Instances

geoLocationDetails :: GeoLocationDetails Source

GeoLocationDetails constructor.

The fields accessible through corresponding lenses are:

gldContinentCode :: Lens' GeoLocationDetails (Maybe Text) Source

The code for a continent geo location. Note: only continent locations have a continent code.

gldContinentName :: Lens' GeoLocationDetails (Maybe Text) Source

The name of the continent. This element is only present if ContinentCode is also present.

gldCountryCode :: Lens' GeoLocationDetails (Maybe Text) Source

The code for a country geo location. The default location uses * for the country code and will match all locations that are not matched by a geo location.

The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

gldCountryName :: Lens' GeoLocationDetails (Maybe Text) Source

The name of the country. This element is only present if CountryCode is also present.

gldSubdivisionCode :: Lens' GeoLocationDetails (Maybe Text) Source

The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.

gldSubdivisionName :: Lens' GeoLocationDetails (Maybe Text) Source

The name of the subdivision. This element is only present if SubdivisionCode is also present.

HealthCheck

data HealthCheck Source

Instances

healthCheck Source

Arguments

:: Text

hcId

-> Text

hcCallerReference

-> HealthCheckConfig

hcHealthCheckConfig

-> Natural

hcHealthCheckVersion

-> HealthCheck 

HealthCheck constructor.

The fields accessible through corresponding lenses are:

hcCallerReference :: Lens' HealthCheck Text Source

A unique string that identifies the request to create the health check.

hcHealthCheckConfig :: Lens' HealthCheck HealthCheckConfig Source

A complex type that contains the health check configuration.

hcHealthCheckVersion :: Lens' HealthCheck Natural Source

The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check.

hcId :: Lens' HealthCheck Text Source

The ID of the specified health check.

VPCRegion

data VPCRegion Source

Constructors

ApNortheast1

ap-northeast-1

ApSoutheast1

ap-southeast-1

ApSoutheast2

ap-southeast-2

CnNorth1

cn-north-1

EuCentral1

eu-central-1

EuWest1

eu-west-1

SaEast1

sa-east-1

UsEast1

us-east-1

UsWest1

us-west-1

UsWest2

us-west-2

Instances

Enum VPCRegion 
Eq VPCRegion 
Ord VPCRegion 
Read VPCRegion 
Show VPCRegion 
Generic VPCRegion 
ToXML VPCRegion 
ToText VPCRegion 
ToByteString VPCRegion 
Hashable VPCRegion 
FromXML VPCRegion 
FromText VPCRegion 
ToQuery VPCRegion 
ToHeader VPCRegion 
type Rep VPCRegion 

RecordType

data RecordType Source

Constructors

A

A

AAAA

AAAA

CNAME

CNAME

MX

MX

NS

NS

PTR

PTR

SOA

SOA

SPF

SPF

SRV

SRV

TXT

TXT

Instances

ChangeAction

data ChangeAction Source

Constructors

Create

CREATE

Delete'

DELETE

Upsert

UPSERT

Instances

TagResourceType

data TagResourceType Source

Constructors

Healthcheck

healthcheck

Hostedzone

hostedzone

Instances

HealthCheckConfig

data HealthCheckConfig Source

Instances

healthCheckConfig Source

Arguments

:: HealthCheckType

hccType

-> HealthCheckConfig 

HealthCheckConfig constructor.

The fields accessible through corresponding lenses are:

hccFailureThreshold :: Lens' HealthCheckConfig (Maybe Natural) Source

The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.

Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.

hccFullyQualifiedDomainName :: Lens' HealthCheckConfig (Maybe Text) Source

Fully qualified domain name of the instance to be health checked.

hccIPAddress :: Lens' HealthCheckConfig (Maybe Text) Source

IP Address of the instance being checked.

hccPort :: Lens' HealthCheckConfig (Maybe Natural) Source

Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.

hccRequestInterval :: Lens' HealthCheckConfig (Maybe Natural) Source

The number of seconds between the time that Route 53 gets a response from your endpoint and the time that it sends the next health-check request.

Each Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.

hccResourcePath :: Lens' HealthCheckConfig (Maybe Text) Source

Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks, HTTP request is issued to the instance on the given port and path.

hccSearchString :: Lens' HealthCheckConfig (Maybe Text) Source

A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.

hccType :: Lens' HealthCheckConfig HealthCheckType Source

The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.

Change

data Change Source

Instances

Eq Change 
Read Change 
Show Change 
ToXML Change 
FromXML Change 

change Source

Arguments

:: ChangeAction

cAction

-> ResourceRecordSet

cResourceRecordSet

-> Change 

Change constructor.

The fields accessible through corresponding lenses are:

cAction :: Lens' Change ChangeAction Source

The action to perform.

Valid values: CREATE | DELETE | UPSERT

cResourceRecordSet :: Lens' Change ResourceRecordSet Source

Information about the resource record set to create or delete.

Failover

data Failover Source

Constructors

Primary

PRIMARY

Secondary

SECONDARY

Instances

Enum Failover 
Eq Failover 
Ord Failover 
Read Failover 
Show Failover 
Generic Failover 
ToXML Failover 
ToText Failover 
ToByteString Failover 
Hashable Failover 
FromXML Failover 
FromText Failover 
ToQuery Failover 
ToHeader Failover 
type Rep Failover 

HostedZone

data HostedZone Source

Instances

hostedZone Source

Arguments

:: Text

hzId

-> Text

hzName

-> Text

hzCallerReference

-> HostedZone 

HostedZone constructor.

The fields accessible through corresponding lenses are:

hzCallerReference :: Lens' HostedZone Text Source

A unique string that identifies the request to create the hosted zone.

hzConfig :: Lens' HostedZone (Maybe HostedZoneConfig) Source

A complex type that contains the Comment element.

hzId :: Lens' HostedZone Text Source

The ID of the specified hosted zone.

hzName :: Lens' HostedZone Text Source

The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; 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.

This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet.

hzResourceRecordSetCount :: Lens' HostedZone (Maybe Integer) Source

Total number of resource record sets in the hosted zone.

ResourceTagSet

data ResourceTagSet Source

Instances

resourceTagSet Source

Arguments

:: NonEmpty Tag

rtsTags

-> ResourceTagSet 

ResourceTagSet constructor.

The fields accessible through corresponding lenses are:

rtsResourceId :: Lens' ResourceTagSet (Maybe Text) Source

The ID for the specified resource.

rtsResourceType :: Lens' ResourceTagSet (Maybe TagResourceType) Source

The type of the resource.

  • The resource type for health checks is healthcheck.
  • The resource type for hosted zones is hostedzone.

rtsTags :: Lens' ResourceTagSet (NonEmpty Tag) Source

The tags associated with the specified resource.

ChangeStatus

data ChangeStatus Source

Constructors

Insync

INSYNC

Pending

PENDING

Instances

ChangeBatch

data ChangeBatch Source

Instances

changeBatch Source

Arguments

:: NonEmpty Change

cbChanges

-> ChangeBatch 

ChangeBatch constructor.

The fields accessible through corresponding lenses are:

cbChanges :: Lens' ChangeBatch (NonEmpty Change) Source

A complex type that contains one Change element for each resource record set that you want to create or delete.

cbComment :: Lens' ChangeBatch (Maybe Text) Source

Optional: Any comments you want to include about a change batch request.

StatusReport

data StatusReport Source

Instances

statusReport :: StatusReport Source

StatusReport constructor.

The fields accessible through corresponding lenses are:

srCheckedTime :: Lens' StatusReport (Maybe UTCTime) Source

The date and time the health check status was observed, in the format 'YYYY-MM-DDThh:mm:ssZ', as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC), which is synonymous with Greenwich Mean Time in this context.

srStatus :: Lens' StatusReport (Maybe Text) Source

The observed health check status.

HealthCheckType

data HealthCheckType Source

Constructors

Http

HTTP

HttpStrMatch

HTTP_STR_MATCH

Https

HTTPS

HttpsStrMatch

HTTPS_STR_MATCH

Tcp

TCP

Instances

VPC

data VPC Source

Instances

Eq VPC 
Read VPC 
Show VPC 
ToXML VPC 
FromXML VPC 
ToXMLRoot VPC 

vpc :: VPC Source

VPC constructor.

The fields accessible through corresponding lenses are:

vpcVPCId :: Lens' VPC (Maybe Text) Source

vpcVPCRegion :: Lens' VPC (Maybe VPCRegion) Source

HostedZoneConfig

data HostedZoneConfig Source

Instances

hostedZoneConfig :: HostedZoneConfig Source

HostedZoneConfig constructor.

The fields accessible through corresponding lenses are:

hzcComment :: Lens' HostedZoneConfig (Maybe Text) Source

An optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.

hzcPrivateZone :: Lens' HostedZoneConfig (Maybe Bool) Source

A value that indicates whether this is a private hosted zone. The value is returned in the response; do not specify it in the request.

ResourceRecordSet

data ResourceRecordSet Source

Instances

resourceRecordSet Source

Arguments

:: Text

rrsName

-> RecordType

rrsType

-> NonEmpty ResourceRecord

rrsResourceRecords

-> ResourceRecordSet 

ResourceRecordSet constructor.

The fields accessible through corresponding lenses are:

rrsAliasTarget :: Lens' ResourceRecordSet (Maybe AliasTarget) Source

Alias resource record sets only: Information about the AWS resource to which you are redirecting traffic.

rrsFailover :: Lens' ResourceRecordSet (Maybe Failover) Source

Failover resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that indicates whether the current resource record set is a primary or secondary resource record set. A failover set may contain at most one resource record set marked as primary and one resource record set marked as secondary. A resource record set marked as primary will be returned if any of the following are true: (1) an associated health check is passing, (2) if the resource record set is an alias with the evaluate target health and at least one target resource record set is healthy, (3) both the primary and secondary resource record set are failing health checks or (4) there is no secondary resource record set. A secondary resource record set will be returned if: (1) the primary is failing a health check and either the secondary is passing a health check or has no associated health check, or (2) there is no primary resource record set.

Valid values: PRIMARY | SECONDARY

rrsGeoLocation :: Lens' ResourceRecordSet (Maybe GeoLocation) Source

Geo location resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that specifies the geo location for the current resource record set.

rrsHealthCheckId :: Lens' ResourceRecordSet (Maybe Text) Source

Health Check resource record sets only, not required for alias resourcerecord sets: An identifier that is used to identify health check associated with the resource record set.

rrsName :: Lens' ResourceRecordSet Text Source

The domain name of the current resource record set.

rrsRegion :: Lens' ResourceRecordSet (Maybe Region) Source

Latency-based resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that specifies the AWS region for the current resource record set.

rrsResourceRecords :: Lens' ResourceRecordSet (NonEmpty ResourceRecord) Source

A complex type that contains the resource records for the current resource record set.

rrsSetIdentifier :: Lens' ResourceRecordSet (Maybe Text) Source

Weighted, Latency, Geo, and Failover resource record sets only: An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type.

rrsTTL :: Lens' ResourceRecordSet (Maybe Natural) Source

The cache time to live for the current resource record set.

rrsType :: Lens' ResourceRecordSet RecordType Source

The type of the current resource record set.

rrsWeight :: Lens' ResourceRecordSet (Maybe Natural) Source

Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines what portion of traffic for the current resource record set is routed to the associated location.

DelegationSet

data DelegationSet Source

Instances

delegationSet Source

Arguments

:: NonEmpty Text

dsNameServers

-> DelegationSet 

DelegationSet constructor.

The fields accessible through corresponding lenses are:

dsCallerReference :: Lens' DelegationSet (Maybe Text) Source

dsId :: Lens' DelegationSet (Maybe Text) Source

dsNameServers :: Lens' DelegationSet (NonEmpty Text) Source

A complex type that contains the authoritative name servers for the hosted zone. Use the method provided by your domain registrar to add an NS record to your domain for each NameServer that is assigned to your hosted zone.

ChangeInfo

data ChangeInfo Source

Instances

changeInfo Source

Arguments

:: Text

ciId

-> ChangeStatus

ciStatus

-> UTCTime

ciSubmittedAt

-> ChangeInfo 

ChangeInfo constructor.

The fields accessible through corresponding lenses are:

ciComment :: Lens' ChangeInfo (Maybe Text) Source

A complex type that describes change 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.

ciId :: Lens' ChangeInfo Text Source

The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.

ciStatus :: Lens' ChangeInfo ChangeStatus Source

The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.

Valid Values: PENDING | INSYNC

ciSubmittedAt :: Lens' ChangeInfo UTCTime Source

The date and time the change was submitted, in the format 'YYYY-MM-DDThh:mm:ssZ' , as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC), which is synonymous with Greenwich Mean Time in this context.

GeoLocation

data GeoLocation Source

Instances

geoLocation :: GeoLocation Source

GeoLocation constructor.

The fields accessible through corresponding lenses are:

glContinentCode :: Lens' GeoLocation (Maybe Text) Source

The code for a continent geo location. Note: only continent locations have a continent code.

Valid values: AF | AN | AS | EU | OC | NA | SA

Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

glCountryCode :: Lens' GeoLocation (Maybe Text) Source

The code for a country geo location. The default location uses * for the country code and will match all locations that are not matched by a geo location.

The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

glSubdivisionCode :: Lens' GeoLocation (Maybe Text) Source

The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.

Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.

HealthCheckObservation

data HealthCheckObservation Source

Instances

healthCheckObservation :: HealthCheckObservation Source

HealthCheckObservation constructor.

The fields accessible through corresponding lenses are:

hcoIPAddress :: Lens' HealthCheckObservation (Maybe Text) Source

The IP address of the Route 53 health checker that performed the health check.

hcoStatusReport :: Lens' HealthCheckObservation (Maybe StatusReport) Source

A complex type that contains information about the health check status for the current observation.

Common

data Region :: *

Constructors

Ireland 
Frankfurt 
Tokyo 
Singapore 
Sydney 
Beijing 
NorthVirginia 
NorthCalifornia 
Oregon 
GovCloud 
GovCloudFIPS 
SaoPaulo 

Instances

Eq Region 
Ord Region 
Read Region 
Show Region 
Generic Region 
ToXML Region 
ToText Region 
ToByteString Region 
ToBuilder Region 
Hashable Region 
FromXML Region 
FromText Region 
Default Region 
type Rep Region = D1 D1Region ((:+:) ((:+:) ((:+:) (C1 C1_0Region U1) ((:+:) (C1 C1_1Region U1) (C1 C1_2Region U1))) ((:+:) (C1 C1_3Region U1) ((:+:) (C1 C1_4Region U1) (C1 C1_5Region U1)))) ((:+:) ((:+:) (C1 C1_6Region U1) ((:+:) (C1 C1_7Region U1) (C1 C1_8Region U1))) ((:+:) (C1 C1_9Region U1) ((:+:) (C1 C1_10Region U1) (C1 C1_11Region U1)))))