Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Creates, changes, or deletes CIDR blocks within a collection. Contains authoritative IP information mapping blocks to one or multiple locations.
A change request can update multiple locations in a collection at a time, which is helpful if you want to move one or more CIDR blocks from one location to another in one transaction, without downtime.
Limits
The max number of CIDR blocks included in the request is 1000. As a result, big updates require multiple API calls.
PUT and DELETE_IF_EXISTS
Use ChangeCidrCollection
to perform the following actions:
PUT
: Create a CIDR block within the specified collection.DELETE_IF_EXISTS
: Delete an existing CIDR block from the collection.
Synopsis
- data ChangeCidrCollection = ChangeCidrCollection' {}
- newChangeCidrCollection :: Text -> NonEmpty CidrCollectionChange -> ChangeCidrCollection
- changeCidrCollection_collectionVersion :: Lens' ChangeCidrCollection (Maybe Natural)
- changeCidrCollection_id :: Lens' ChangeCidrCollection Text
- changeCidrCollection_changes :: Lens' ChangeCidrCollection (NonEmpty CidrCollectionChange)
- data ChangeCidrCollectionResponse = ChangeCidrCollectionResponse' {
- httpStatus :: Int
- id :: Text
- newChangeCidrCollectionResponse :: Int -> Text -> ChangeCidrCollectionResponse
- changeCidrCollectionResponse_httpStatus :: Lens' ChangeCidrCollectionResponse Int
- changeCidrCollectionResponse_id :: Lens' ChangeCidrCollectionResponse Text
Creating a Request
data ChangeCidrCollection Source #
See: newChangeCidrCollection
smart constructor.
ChangeCidrCollection' | |
|
Instances
newChangeCidrCollection Source #
Create a value of ChangeCidrCollection
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:collectionVersion:ChangeCidrCollection'
, changeCidrCollection_collectionVersion
- A sequential counter that Amazon Route 53 sets to 1 when you create a
collection and increments it by 1 each time you update the collection.
We recommend that you use ListCidrCollection
to get the current value
of CollectionVersion
for the collection that you want to update, and
then include that value with the change request. This prevents Route 53
from overwriting an intervening update:
- If the value in the request matches the value of
CollectionVersion
in the collection, Route 53 updates the collection. - If the value of
CollectionVersion
in the collection is greater than the value in the request, the collection was changed after you got the version number. Route 53 does not update the collection, and it returns aCidrCollectionVersionMismatch
error.
ChangeCidrCollection
, changeCidrCollection_id
- The UUID of the CIDR collection to update.
ChangeCidrCollection
, changeCidrCollection_changes
- Information about changes to a CIDR collection.
Request Lenses
changeCidrCollection_collectionVersion :: Lens' ChangeCidrCollection (Maybe Natural) Source #
A sequential counter that Amazon Route 53 sets to 1 when you create a collection and increments it by 1 each time you update the collection.
We recommend that you use ListCidrCollection
to get the current value
of CollectionVersion
for the collection that you want to update, and
then include that value with the change request. This prevents Route 53
from overwriting an intervening update:
- If the value in the request matches the value of
CollectionVersion
in the collection, Route 53 updates the collection. - If the value of
CollectionVersion
in the collection is greater than the value in the request, the collection was changed after you got the version number. Route 53 does not update the collection, and it returns aCidrCollectionVersionMismatch
error.
changeCidrCollection_id :: Lens' ChangeCidrCollection Text Source #
The UUID of the CIDR collection to update.
changeCidrCollection_changes :: Lens' ChangeCidrCollection (NonEmpty CidrCollectionChange) Source #
Information about changes to a CIDR collection.
Destructuring the Response
data ChangeCidrCollectionResponse Source #
See: newChangeCidrCollectionResponse
smart constructor.
ChangeCidrCollectionResponse' | |
|
Instances
newChangeCidrCollectionResponse Source #
:: Int | |
-> Text | |
-> ChangeCidrCollectionResponse |
Create a value of ChangeCidrCollectionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:ChangeCidrCollectionResponse'
, changeCidrCollectionResponse_httpStatus
- The response's http status code.
ChangeCidrCollection
, changeCidrCollectionResponse_id
- The ID that is returned by ChangeCidrCollection
. You can use it as
input to GetChange
to see if a CIDR collection change has propagated
or not.
Response Lenses
changeCidrCollectionResponse_httpStatus :: Lens' ChangeCidrCollectionResponse Int Source #
The response's http status code.
changeCidrCollectionResponse_id :: Lens' ChangeCidrCollectionResponse Text Source #
The ID that is returned by ChangeCidrCollection
. You can use it as
input to GetChange
to see if a CIDR collection change has propagated
or not.