| Copyright | (c) 2015-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.Google.DNS
Contents
- Service Configuration
- OAuth Scopes
- API Declaration
- Resources
- dns.changes.create
- dns.changes.get
- dns.changes.list
- dns.dnsKeys.get
- dns.dnsKeys.list
- dns.managedZoneOperations.get
- dns.managedZoneOperations.list
- dns.managedZones.create
- dns.managedZones.delete
- dns.managedZones.get
- dns.managedZones.list
- dns.managedZones.patch
- dns.managedZones.update
- dns.projects.get
- dns.resourceRecordSets.list
- Types
- DNSKeySpecAlgorithm
- ManagedZoneDNSSecConfigNonExistence
- OperationDNSKeyContext
- DNSKeysListResponse
- ChangesListResponse
- ManagedZoneDNSSecConfigState
- Project
- Operation
- DNSKeySpec
- ChangesListSortBy
- DNSKeyDigestType
- Change
- DNSKey
- OperationStatus
- OperationManagedZoneContext
- DNSKeyAlgorithm
- ResponseHeader
- DNSKeySpecKeyType
- ManagedZoneOperationsListResponse
- ResourceRecordSetsListResponse
- ChangeStatus
- ManagedZoneDNSSecConfig
- ResourceRecordSet
- ManagedZone
- ManagedZoneLabels
- Quota
- DNSKeyType
- DNSKeyDigest
- ManagedZoneOperationsListSortBy
- ManagedZonesListResponse
Description
Configures and serves authoritative DNS records.
Synopsis
- dNSService :: ServiceConfig
- ndevClouddnsReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/ndev.clouddns.readonly"]
- cloudPlatformReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform.read-only"]
- ndevClouddnsReadwriteScope :: Proxy '["https://www.googleapis.com/auth/ndev.clouddns.readwrite"]
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- type DNSAPI = DNSKeysListResource :<|> (DNSKeysGetResource :<|> (ChangesListResource :<|> (ChangesGetResource :<|> (ChangesCreateResource :<|> (ResourceRecordSetsListResource :<|> (ManagedZoneOperationsListResource :<|> (ManagedZoneOperationsGetResource :<|> (ManagedZonesListResource :<|> (ManagedZonesPatchResource :<|> (ManagedZonesGetResource :<|> (ManagedZonesCreateResource :<|> (ManagedZonesDeleteResource :<|> (ManagedZonesUpdateResource :<|> ProjectsGetResource)))))))))))))
- module Network.Google.Resource.DNS.Changes.Create
- module Network.Google.Resource.DNS.Changes.Get
- module Network.Google.Resource.DNS.Changes.List
- module Network.Google.Resource.DNS.DNSKeys.Get
- module Network.Google.Resource.DNS.DNSKeys.List
- module Network.Google.Resource.DNS.ManagedZoneOperations.Get
- module Network.Google.Resource.DNS.ManagedZoneOperations.List
- module Network.Google.Resource.DNS.ManagedZones.Create
- module Network.Google.Resource.DNS.ManagedZones.Delete
- module Network.Google.Resource.DNS.ManagedZones.Get
- module Network.Google.Resource.DNS.ManagedZones.List
- module Network.Google.Resource.DNS.ManagedZones.Patch
- module Network.Google.Resource.DNS.ManagedZones.Update
- module Network.Google.Resource.DNS.Projects.Get
- module Network.Google.Resource.DNS.ResourceRecordSets.List
- data DNSKeySpecAlgorithm
- data ManagedZoneDNSSecConfigNonExistence
- data OperationDNSKeyContext
- operationDNSKeyContext :: OperationDNSKeyContext
- odkcOldValue :: Lens' OperationDNSKeyContext (Maybe DNSKey)
- odkcNewValue :: Lens' OperationDNSKeyContext (Maybe DNSKey)
- data DNSKeysListResponse
- dnsKeysListResponse :: DNSKeysListResponse
- dklrNextPageToken :: Lens' DNSKeysListResponse (Maybe Text)
- dklrDNSKeys :: Lens' DNSKeysListResponse [DNSKey]
- dklrKind :: Lens' DNSKeysListResponse Text
- dklrHeader :: Lens' DNSKeysListResponse (Maybe ResponseHeader)
- data ChangesListResponse
- changesListResponse :: ChangesListResponse
- clrNextPageToken :: Lens' ChangesListResponse (Maybe Text)
- clrChanges :: Lens' ChangesListResponse [Change]
- clrKind :: Lens' ChangesListResponse Text
- clrHeader :: Lens' ChangesListResponse (Maybe ResponseHeader)
- data ManagedZoneDNSSecConfigState
- data Project
- project :: Project
- pKind :: Lens' Project Text
- pId :: Lens' Project (Maybe Text)
- pNumber :: Lens' Project (Maybe Word64)
- pQuota :: Lens' Project (Maybe Quota)
- data Operation
- operation :: Operation
- oStatus :: Lens' Operation (Maybe OperationStatus)
- oStartTime :: Lens' Operation (Maybe Text)
- oKind :: Lens' Operation Text
- oUser :: Lens' Operation (Maybe Text)
- oId :: Lens' Operation (Maybe Text)
- oType :: Lens' Operation (Maybe Text)
- oZoneContext :: Lens' Operation (Maybe OperationManagedZoneContext)
- oDNSKeyContext :: Lens' Operation (Maybe OperationDNSKeyContext)
- data DNSKeySpec
- dnsKeySpec :: DNSKeySpec
- dksKeyType :: Lens' DNSKeySpec (Maybe DNSKeySpecKeyType)
- dksKind :: Lens' DNSKeySpec Text
- dksAlgorithm :: Lens' DNSKeySpec (Maybe DNSKeySpecAlgorithm)
- dksKeyLength :: Lens' DNSKeySpec (Maybe Word32)
- data ChangesListSortBy = ChangeSequence
- data DNSKeyDigestType
- data Change
- change :: Change
- cStatus :: Lens' Change (Maybe ChangeStatus)
- cAdditions :: Lens' Change [ResourceRecordSet]
- cStartTime :: Lens' Change (Maybe Text)
- cKind :: Lens' Change Text
- cDeletions :: Lens' Change [ResourceRecordSet]
- cId :: Lens' Change (Maybe Text)
- cIsServing :: Lens' Change (Maybe Bool)
- data DNSKey
- dnsKey :: DNSKey
- dkCreationTime :: Lens' DNSKey (Maybe Text)
- dkKeyTag :: Lens' DNSKey (Maybe Int32)
- dkKind :: Lens' DNSKey Text
- dkDigests :: Lens' DNSKey [DNSKeyDigest]
- dkPublicKey :: Lens' DNSKey (Maybe Text)
- dkAlgorithm :: Lens' DNSKey (Maybe DNSKeyAlgorithm)
- dkId :: Lens' DNSKey (Maybe Text)
- dkType :: Lens' DNSKey (Maybe DNSKeyType)
- dkKeyLength :: Lens' DNSKey (Maybe Word32)
- dkIsActive :: Lens' DNSKey (Maybe Bool)
- dkDescription :: Lens' DNSKey (Maybe Text)
- data OperationStatus
- data OperationManagedZoneContext
- operationManagedZoneContext :: OperationManagedZoneContext
- omzcOldValue :: Lens' OperationManagedZoneContext (Maybe ManagedZone)
- omzcNewValue :: Lens' OperationManagedZoneContext (Maybe ManagedZone)
- data DNSKeyAlgorithm
- data ResponseHeader
- responseHeader :: ResponseHeader
- rhOperationId :: Lens' ResponseHeader (Maybe Text)
- data DNSKeySpecKeyType
- data ManagedZoneOperationsListResponse
- managedZoneOperationsListResponse :: ManagedZoneOperationsListResponse
- mzolrNextPageToken :: Lens' ManagedZoneOperationsListResponse (Maybe Text)
- mzolrKind :: Lens' ManagedZoneOperationsListResponse Text
- mzolrHeader :: Lens' ManagedZoneOperationsListResponse (Maybe ResponseHeader)
- mzolrOperations :: Lens' ManagedZoneOperationsListResponse [Operation]
- data ResourceRecordSetsListResponse
- resourceRecordSetsListResponse :: ResourceRecordSetsListResponse
- rrslrNextPageToken :: Lens' ResourceRecordSetsListResponse (Maybe Text)
- rrslrKind :: Lens' ResourceRecordSetsListResponse Text
- rrslrHeader :: Lens' ResourceRecordSetsListResponse (Maybe ResponseHeader)
- rrslrRrSets :: Lens' ResourceRecordSetsListResponse [ResourceRecordSet]
- data ChangeStatus
- data ManagedZoneDNSSecConfig
- managedZoneDNSSecConfig :: ManagedZoneDNSSecConfig
- mzdscState :: Lens' ManagedZoneDNSSecConfig (Maybe ManagedZoneDNSSecConfigState)
- mzdscKind :: Lens' ManagedZoneDNSSecConfig Text
- mzdscDefaultKeySpecs :: Lens' ManagedZoneDNSSecConfig [DNSKeySpec]
- mzdscNonExistence :: Lens' ManagedZoneDNSSecConfig (Maybe ManagedZoneDNSSecConfigNonExistence)
- data ResourceRecordSet
- resourceRecordSet :: ResourceRecordSet
- rrsTtl :: Lens' ResourceRecordSet (Maybe Int32)
- rrsKind :: Lens' ResourceRecordSet Text
- rrsSignatureRrDatas :: Lens' ResourceRecordSet [Text]
- rrsName :: Lens' ResourceRecordSet (Maybe Text)
- rrsType :: Lens' ResourceRecordSet (Maybe Text)
- rrsRrDatas :: Lens' ResourceRecordSet [Text]
- data ManagedZone
- managedZone :: ManagedZone
- mzCreationTime :: Lens' ManagedZone (Maybe Text)
- mzKind :: Lens' ManagedZone Text
- mzNameServerSet :: Lens' ManagedZone (Maybe Text)
- mzName :: Lens' ManagedZone (Maybe Text)
- mzId :: Lens' ManagedZone (Maybe Word64)
- mzLabels :: Lens' ManagedZone (Maybe ManagedZoneLabels)
- mzDNSName :: Lens' ManagedZone (Maybe Text)
- mzDescription :: Lens' ManagedZone (Maybe Text)
- mzDNSsecConfig :: Lens' ManagedZone (Maybe ManagedZoneDNSSecConfig)
- mzNameServers :: Lens' ManagedZone [Text]
- data ManagedZoneLabels
- managedZoneLabels :: HashMap Text Text -> ManagedZoneLabels
- mzlAddtional :: Lens' ManagedZoneLabels (HashMap Text Text)
- data Quota
- quota :: Quota
- qRrSetDeletionsPerChange :: Lens' Quota (Maybe Int32)
- qWhiteListedKeySpecs :: Lens' Quota [DNSKeySpec]
- qRrSetsPerManagedZone :: Lens' Quota (Maybe Int32)
- qKind :: Lens' Quota Text
- qResourceRecordsPerRrSet :: Lens' Quota (Maybe Int32)
- qRrSetAdditionsPerChange :: Lens' Quota (Maybe Int32)
- qManagedZones :: Lens' Quota (Maybe Int32)
- qTotalRrDataSizePerChange :: Lens' Quota (Maybe Int32)
- qDNSKeysPerManagedZone :: Lens' Quota (Maybe Int32)
- data DNSKeyType
- data DNSKeyDigest
- dnsKeyDigest :: DNSKeyDigest
- dkdDigest :: Lens' DNSKeyDigest (Maybe Text)
- dkdType :: Lens' DNSKeyDigest (Maybe DNSKeyDigestType)
- data ManagedZoneOperationsListSortBy
- data ManagedZonesListResponse
- managedZonesListResponse :: ManagedZonesListResponse
- mzlrNextPageToken :: Lens' ManagedZonesListResponse (Maybe Text)
- mzlrKind :: Lens' ManagedZonesListResponse Text
- mzlrHeader :: Lens' ManagedZonesListResponse (Maybe ResponseHeader)
- mzlrManagedZones :: Lens' ManagedZonesListResponse [ManagedZone]
Service Configuration
dNSService :: ServiceConfig Source #
Default request referring to version v2beta1 of the Google Cloud DNS API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
ndevClouddnsReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/ndev.clouddns.readonly"] Source #
View your DNS records hosted by Google Cloud DNS
cloudPlatformReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform.read-only"] Source #
View your data across Google Cloud Platform services
ndevClouddnsReadwriteScope :: Proxy '["https://www.googleapis.com/auth/ndev.clouddns.readwrite"] Source #
View and manage your DNS records hosted by Google Cloud DNS
cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"] Source #
View and manage your data across Google Cloud Platform services
API Declaration
type DNSAPI = DNSKeysListResource :<|> (DNSKeysGetResource :<|> (ChangesListResource :<|> (ChangesGetResource :<|> (ChangesCreateResource :<|> (ResourceRecordSetsListResource :<|> (ManagedZoneOperationsListResource :<|> (ManagedZoneOperationsGetResource :<|> (ManagedZonesListResource :<|> (ManagedZonesPatchResource :<|> (ManagedZonesGetResource :<|> (ManagedZonesCreateResource :<|> (ManagedZonesDeleteResource :<|> (ManagedZonesUpdateResource :<|> ProjectsGetResource))))))))))))) Source #
Represents the entirety of the methods and resources available for the Google Cloud DNS API service.
Resources
dns.changes.create
dns.changes.get
dns.changes.list
dns.dnsKeys.get
dns.dnsKeys.list
dns.managedZoneOperations.get
dns.managedZoneOperations.list
dns.managedZones.create
dns.managedZones.delete
dns.managedZones.get
dns.managedZones.list
dns.managedZones.patch
dns.managedZones.update
dns.projects.get
dns.resourceRecordSets.list
Types
DNSKeySpecAlgorithm
data DNSKeySpecAlgorithm Source #
String mnemonic specifying the DNSSEC algorithm of this key.
Constructors
| ECDSAP256SHA256 | ECDSAP256SHA256 |
| ECDSAP384SHA384 | ECDSAP384SHA384 |
| RSASHA1 | RSASHA1 |
| RSASHA256 | RSASHA256 |
| RSASHA512 | RSASHA512 |
Instances
ManagedZoneDNSSecConfigNonExistence
data ManagedZoneDNSSecConfigNonExistence Source #
Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
Instances
OperationDNSKeyContext
data OperationDNSKeyContext Source #
Instances
operationDNSKeyContext :: OperationDNSKeyContext Source #
Creates a value of OperationDNSKeyContext with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
odkcOldValue :: Lens' OperationDNSKeyContext (Maybe DNSKey) Source #
The pre-operation DnsKey resource.
odkcNewValue :: Lens' OperationDNSKeyContext (Maybe DNSKey) Source #
The post-operation DnsKey resource.
DNSKeysListResponse
data DNSKeysListResponse Source #
The response to a request to enumerate DnsKeys in a ManagedZone.
See: dnsKeysListResponse smart constructor.
Instances
dnsKeysListResponse :: DNSKeysListResponse Source #
Creates a value of DNSKeysListResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dklrNextPageToken :: Lens' DNSKeysListResponse (Maybe Text) Source #
The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a "snapshot" of collections larger than the maximum page size.
dklrDNSKeys :: Lens' DNSKeysListResponse [DNSKey] Source #
The requested resources.
ChangesListResponse
data ChangesListResponse Source #
The response to a request to enumerate Changes to a ResourceRecordSets collection.
See: changesListResponse smart constructor.
Instances
changesListResponse :: ChangesListResponse Source #
Creates a value of ChangesListResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
clrNextPageToken :: Lens' ChangesListResponse (Maybe Text) Source #
The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a "snapshot" of collections larger than the maximum page size.
clrChanges :: Lens' ChangesListResponse [Change] Source #
The requested changes.
ManagedZoneDNSSecConfigState
data ManagedZoneDNSSecConfigState Source #
Specifies whether DNSSEC is enabled, and what mode it is in.
Instances
Project
A project resource. The project is a top level container for resources including Cloud DNS ManagedZones. Projects can be created only in the APIs console.
See: project smart constructor.
Instances
| Eq Project Source # | |
| Data Project Source # | |
Defined in Network.Google.DNS.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Project -> c Project # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Project # toConstr :: Project -> Constr # dataTypeOf :: Project -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Project) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Project) # gmapT :: (forall b. Data b => b -> b) -> Project -> Project # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Project -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Project -> r # gmapQ :: (forall d. Data d => d -> u) -> Project -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Project -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Project -> m Project # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Project -> m Project # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Project -> m Project # | |
| Show Project Source # | |
| Generic Project Source # | |
| ToJSON Project Source # | |
Defined in Network.Google.DNS.Types.Product | |
| FromJSON Project Source # | |
| type Rep Project Source # | |
Defined in Network.Google.DNS.Types.Product type Rep Project = D1 (MetaData "Project" "Network.Google.DNS.Types.Product" "gogol-dns-0.4.0-FGL4N5c1W6oLe6JT83PCEl" False) (C1 (MetaCons "Project'" PrefixI True) ((S1 (MetaSel (Just "_pKind") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_pId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_pNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word64))) :*: S1 (MetaSel (Just "_pQuota") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Quota))))) | |
pKind :: Lens' Project Text Source #
Identifies what kind of resource this is. Value: the fixed string "dns#project".
pId :: Lens' Project (Maybe Text) Source #
User assigned unique identifier for the resource (output only).
pNumber :: Lens' Project (Maybe Word64) Source #
Unique numeric identifier for the resource; defined by the server (output only).
Operation
An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id.
See: operation smart constructor.
Instances
operation :: Operation Source #
Creates a value of Operation with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
oStatus :: Lens' Operation (Maybe OperationStatus) Source #
Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only).
oStartTime :: Lens' Operation (Maybe Text) Source #
The time that this operation was started by the server. This is in RFC3339 text format (output only).
oKind :: Lens' Operation Text Source #
Identifies what kind of resource this is. Value: the fixed string "dns#operation".
oUser :: Lens' Operation (Maybe Text) Source #
User who requested the operation, for example: user'example.com. cloud-dns-system for operations automatically done by the system. (output only)
oId :: Lens' Operation (Maybe Text) Source #
Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only)
oType :: Lens' Operation (Maybe Text) Source #
Type of the operation. Operations include insert, update, and delete (output only).
oZoneContext :: Lens' Operation (Maybe OperationManagedZoneContext) Source #
Only populated if the operation targeted a ManagedZone (output only).
oDNSKeyContext :: Lens' Operation (Maybe OperationDNSKeyContext) Source #
Only populated if the operation targeted a DnsKey (output only).
DNSKeySpec
data DNSKeySpec Source #
Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
See: dnsKeySpec smart constructor.
Instances
dnsKeySpec :: DNSKeySpec Source #
Creates a value of DNSKeySpec with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dksKeyType :: Lens' DNSKeySpec (Maybe DNSKeySpecKeyType) Source #
One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
dksKind :: Lens' DNSKeySpec Text Source #
Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
dksAlgorithm :: Lens' DNSKeySpec (Maybe DNSKeySpecAlgorithm) Source #
String mnemonic specifying the DNSSEC algorithm of this key.
dksKeyLength :: Lens' DNSKeySpec (Maybe Word32) Source #
Length of the keys in bits.
ChangesListSortBy
data ChangesListSortBy Source #
Sorting criterion. The only supported value is change sequence.
Constructors
| ChangeSequence | CHANGE_SEQUENCE |
Instances
DNSKeyDigestType
data DNSKeyDigestType Source #
Specifies the algorithm used to calculate this digest.
Instances
Change
An atomic update to a collection of ResourceRecordSets.
See: change smart constructor.
Instances
Creates a value of Change with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cAdditions :: Lens' Change [ResourceRecordSet] Source #
Which ResourceRecordSets to add?
cStartTime :: Lens' Change (Maybe Text) Source #
The time that this operation was started by the server (output only). This is in RFC3339 text format.
cKind :: Lens' Change Text Source #
Identifies what kind of resource this is. Value: the fixed string "dns#change".
cDeletions :: Lens' Change [ResourceRecordSet] Source #
Which ResourceRecordSets to remove? Must match existing data exactly.
cId :: Lens' Change (Maybe Text) Source #
Unique identifier for the resource; defined by the server (output only).
DNSKey
A DNSSEC key pair.
See: dnsKey smart constructor.
Instances
Creates a value of DNSKey with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dkCreationTime :: Lens' DNSKey (Maybe Text) Source #
The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
dkKeyTag :: Lens' DNSKey (Maybe Int32) Source #
The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
dkKind :: Lens' DNSKey Text Source #
Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".
dkDigests :: Lens' DNSKey [DNSKeyDigest] Source #
Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
dkPublicKey :: Lens' DNSKey (Maybe Text) Source #
Base64 encoded public half of this key. Output only.
dkAlgorithm :: Lens' DNSKey (Maybe DNSKeyAlgorithm) Source #
String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
dkId :: Lens' DNSKey (Maybe Text) Source #
Unique identifier for the resource; defined by the server (output only).
dkType :: Lens' DNSKey (Maybe DNSKeyType) Source #
One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
dkKeyLength :: Lens' DNSKey (Maybe Word32) Source #
Length of the key in bits. Specified at creation time then immutable.
dkIsActive :: Lens' DNSKey (Maybe Bool) Source #
Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
dkDescription :: Lens' DNSKey (Maybe Text) Source #
A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
OperationStatus
data OperationStatus Source #
Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only).
Instances
OperationManagedZoneContext
data OperationManagedZoneContext Source #
Instances
operationManagedZoneContext :: OperationManagedZoneContext Source #
Creates a value of OperationManagedZoneContext with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
omzcOldValue :: Lens' OperationManagedZoneContext (Maybe ManagedZone) Source #
The pre-operation ManagedZone resource.
omzcNewValue :: Lens' OperationManagedZoneContext (Maybe ManagedZone) Source #
The post-operation ManagedZone resource.
DNSKeyAlgorithm
data DNSKeyAlgorithm Source #
String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
Constructors
| DKAECDSAP256SHA256 | ECDSAP256SHA256 |
| DKAECDSAP384SHA384 | ECDSAP384SHA384 |
| DKARSASHA1 | RSASHA1 |
| DKARSASHA256 | RSASHA256 |
| DKARSASHA512 | RSASHA512 |
Instances
ResponseHeader
data ResponseHeader Source #
Elements common to every response.
See: responseHeader smart constructor.
Instances
responseHeader :: ResponseHeader Source #
Creates a value of ResponseHeader with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rhOperationId :: Lens' ResponseHeader (Maybe Text) Source #
For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only).
DNSKeySpecKeyType
data DNSKeySpecKeyType Source #
One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
Constructors
| KeySigning | KEY_SIGNING |
| ZoneSigning | ZONE_SIGNING |
Instances
ManagedZoneOperationsListResponse
data ManagedZoneOperationsListResponse Source #
Instances
managedZoneOperationsListResponse :: ManagedZoneOperationsListResponse Source #
Creates a value of ManagedZoneOperationsListResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mzolrNextPageToken :: Lens' ManagedZoneOperationsListResponse (Maybe Text) Source #
The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size.
mzolrOperations :: Lens' ManagedZoneOperationsListResponse [Operation] Source #
The operation resources.
ResourceRecordSetsListResponse
data ResourceRecordSetsListResponse Source #
Instances
resourceRecordSetsListResponse :: ResourceRecordSetsListResponse Source #
Creates a value of ResourceRecordSetsListResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rrslrNextPageToken :: Lens' ResourceRecordSetsListResponse (Maybe Text) Source #
The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size.
rrslrRrSets :: Lens' ResourceRecordSetsListResponse [ResourceRecordSet] Source #
The resource record set resources.
ChangeStatus
data ChangeStatus Source #
Status of the operation (output only).
Instances
ManagedZoneDNSSecConfig
data ManagedZoneDNSSecConfig Source #
Instances
managedZoneDNSSecConfig :: ManagedZoneDNSSecConfig Source #
Creates a value of ManagedZoneDNSSecConfig with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mzdscState :: Lens' ManagedZoneDNSSecConfig (Maybe ManagedZoneDNSSecConfigState) Source #
Specifies whether DNSSEC is enabled, and what mode it is in.
mzdscKind :: Lens' ManagedZoneDNSSecConfig Text Source #
Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
mzdscDefaultKeySpecs :: Lens' ManagedZoneDNSSecConfig [DNSKeySpec] Source #
Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
mzdscNonExistence :: Lens' ManagedZoneDNSSecConfig (Maybe ManagedZoneDNSSecConfigNonExistence) Source #
Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
ResourceRecordSet
data ResourceRecordSet Source #
A unit of data that will be returned by the DNS servers.
See: resourceRecordSet smart constructor.
Instances
resourceRecordSet :: ResourceRecordSet Source #
Creates a value of ResourceRecordSet with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rrsTtl :: Lens' ResourceRecordSet (Maybe Int32) Source #
Number of seconds that this ResourceRecordSet can be cached by resolvers.
rrsKind :: Lens' ResourceRecordSet Text Source #
Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
rrsSignatureRrDatas :: Lens' ResourceRecordSet [Text] Source #
As defined in RFC 4034 (section 3.2).
rrsType :: Lens' ResourceRecordSet (Maybe Text) Source #
The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
rrsRrDatas :: Lens' ResourceRecordSet [Text] Source #
As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
ManagedZone
data ManagedZone Source #
A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
See: managedZone smart constructor.
Instances
managedZone :: ManagedZone Source #
Creates a value of ManagedZone with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mzCreationTime :: Lens' ManagedZone (Maybe Text) Source #
The time that this resource was created on the server. This is in RFC3339 text format. Output only.
mzKind :: Lens' ManagedZone Text Source #
Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
mzNameServerSet :: Lens' ManagedZone (Maybe Text) Source #
Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
mzName :: Lens' ManagedZone (Maybe Text) Source #
User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
mzId :: Lens' ManagedZone (Maybe Word64) Source #
Unique identifier for the resource; defined by the server (output only)
mzLabels :: Lens' ManagedZone (Maybe ManagedZoneLabels) Source #
User labels.
mzDNSName :: Lens' ManagedZone (Maybe Text) Source #
The DNS name of this managed zone, for instance "example.com.".
mzDescription :: Lens' ManagedZone (Maybe Text) Source #
A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
mzDNSsecConfig :: Lens' ManagedZone (Maybe ManagedZoneDNSSecConfig) Source #
DNSSEC configuration.
mzNameServers :: Lens' ManagedZone [Text] Source #
Delegate your managed_zone to these virtual name servers; defined by the server (output only)
ManagedZoneLabels
data ManagedZoneLabels Source #
User labels.
See: managedZoneLabels smart constructor.
Instances
Arguments
| :: HashMap Text Text | |
| -> ManagedZoneLabels |
Creates a value of ManagedZoneLabels with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Quota
Limits associated with a Project.
See: quota smart constructor.
Instances
Creates a value of Quota with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qRrSetDeletionsPerChange :: Lens' Quota (Maybe Int32) Source #
Maximum allowed number of ResourceRecordSets to delete per ChangesCreateRequest.
qWhiteListedKeySpecs :: Lens' Quota [DNSKeySpec] Source #
DNSSEC algorithm and key length types that can be used for DnsKeys.
qRrSetsPerManagedZone :: Lens' Quota (Maybe Int32) Source #
Maximum allowed number of ResourceRecordSets per zone in the project.
qKind :: Lens' Quota Text Source #
Identifies what kind of resource this is. Value: the fixed string "dns#quota".
qResourceRecordsPerRrSet :: Lens' Quota (Maybe Int32) Source #
Maximum allowed number of ResourceRecords per ResourceRecordSet.
qRrSetAdditionsPerChange :: Lens' Quota (Maybe Int32) Source #
Maximum allowed number of ResourceRecordSets to add per ChangesCreateRequest.
qManagedZones :: Lens' Quota (Maybe Int32) Source #
Maximum allowed number of managed zones in the project.
qTotalRrDataSizePerChange :: Lens' Quota (Maybe Int32) Source #
Maximum allowed size for total rrdata in one ChangesCreateRequest in bytes.
qDNSKeysPerManagedZone :: Lens' Quota (Maybe Int32) Source #
Maximum allowed number of DnsKeys per ManagedZone.
DNSKeyType
data DNSKeyType Source #
One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
Constructors
| DKTKeySigning | KEY_SIGNING |
| DKTZoneSigning | ZONE_SIGNING |
Instances
DNSKeyDigest
data DNSKeyDigest Source #
Instances
dnsKeyDigest :: DNSKeyDigest Source #
Creates a value of DNSKeyDigest with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dkdDigest :: Lens' DNSKeyDigest (Maybe Text) Source #
The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
dkdType :: Lens' DNSKeyDigest (Maybe DNSKeyDigestType) Source #
Specifies the algorithm used to calculate this digest.
ManagedZoneOperationsListSortBy
data ManagedZoneOperationsListSortBy Source #
Sorting criterion. The only supported values are START_TIME and ID.
Instances
ManagedZonesListResponse
data ManagedZonesListResponse Source #
Instances
managedZonesListResponse :: ManagedZonesListResponse Source #
Creates a value of ManagedZonesListResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mzlrNextPageToken :: Lens' ManagedZonesListResponse (Maybe Text) Source #
The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size.
mzlrManagedZones :: Lens' ManagedZonesListResponse [ManagedZone] Source #
The managed zone resources.