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 |
Synopsis
- data ResourceSet = ResourceSet' {
- description :: Maybe Text
- id :: Maybe Text
- lastUpdateTime :: Maybe POSIX
- updateToken :: Maybe Text
- name :: Text
- resourceTypeList :: [Text]
- newResourceSet :: Text -> ResourceSet
- resourceSet_description :: Lens' ResourceSet (Maybe Text)
- resourceSet_id :: Lens' ResourceSet (Maybe Text)
- resourceSet_lastUpdateTime :: Lens' ResourceSet (Maybe UTCTime)
- resourceSet_updateToken :: Lens' ResourceSet (Maybe Text)
- resourceSet_name :: Lens' ResourceSet Text
- resourceSet_resourceTypeList :: Lens' ResourceSet [Text]
Documentation
data ResourceSet Source #
A set of resources to include in a policy.
See: newResourceSet
smart constructor.
ResourceSet' | |
|
Instances
Create a value of ResourceSet
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:description:ResourceSet'
, resourceSet_description
- A description of the resource set.
$sel:id:ResourceSet'
, resourceSet_id
- A unique identifier for the resource set. This ID is returned in the
responses to create and list commands. You provide it to operations like
update and delete.
$sel:lastUpdateTime:ResourceSet'
, resourceSet_lastUpdateTime
- The last time that the resource set was changed.
$sel:updateToken:ResourceSet'
, resourceSet_updateToken
- An optional token that you can use for optimistic locking. Firewall
Manager returns a token to your requests that access the resource set.
The token marks the state of the resource set resource at the time of
the request. Update tokens are not allowed when creating a resource set.
After creation, each subsequent update call to the resource set requires
the update token.
To make an unconditional change to the resource set, omit the token in your update request. Without the token, Firewall Manager performs your updates regardless of whether the resource set has changed since you last retrieved it.
To make a conditional change to the resource set, provide the token in
your update request. Firewall Manager uses the token to ensure that the
resource set hasn't changed since you last retrieved it. If it has
changed, the operation fails with an InvalidTokenException
. If this
happens, retrieve the resource set again to get a current copy of it
with a new token. Reapply your changes as needed, then try the operation
again using the new token.
$sel:name:ResourceSet'
, resourceSet_name
- The descriptive name of the resource set. You can't change the name of
a resource set after you create it.
$sel:resourceTypeList:ResourceSet'
, resourceSet_resourceTypeList
- Determines the resources that can be associated to the resource set.
Depending on your setting for max results and the number of resource
sets, a single call might not return the full list.
resourceSet_description :: Lens' ResourceSet (Maybe Text) Source #
A description of the resource set.
resourceSet_id :: Lens' ResourceSet (Maybe Text) Source #
A unique identifier for the resource set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
resourceSet_lastUpdateTime :: Lens' ResourceSet (Maybe UTCTime) Source #
The last time that the resource set was changed.
resourceSet_updateToken :: Lens' ResourceSet (Maybe Text) Source #
An optional token that you can use for optimistic locking. Firewall Manager returns a token to your requests that access the resource set. The token marks the state of the resource set resource at the time of the request. Update tokens are not allowed when creating a resource set. After creation, each subsequent update call to the resource set requires the update token.
To make an unconditional change to the resource set, omit the token in your update request. Without the token, Firewall Manager performs your updates regardless of whether the resource set has changed since you last retrieved it.
To make a conditional change to the resource set, provide the token in
your update request. Firewall Manager uses the token to ensure that the
resource set hasn't changed since you last retrieved it. If it has
changed, the operation fails with an InvalidTokenException
. If this
happens, retrieve the resource set again to get a current copy of it
with a new token. Reapply your changes as needed, then try the operation
again using the new token.
resourceSet_name :: Lens' ResourceSet Text Source #
The descriptive name of the resource set. You can't change the name of a resource set after you create it.
resourceSet_resourceTypeList :: Lens' ResourceSet [Text] Source #
Determines the resources that can be associated to the resource set. Depending on your setting for max results and the number of resource sets, a single call might not return the full list.