amazonka-fms-2.0: Amazon Firewall Management Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.FMS.Types.ResourceSet

Description

 
Synopsis

Documentation

data ResourceSet Source #

A set of resources to include in a policy.

See: newResourceSet smart constructor.

Constructors

ResourceSet' 

Fields

  • description :: Maybe Text

    A description of the resource set.

  • id :: Maybe Text

    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.

  • lastUpdateTime :: Maybe POSIX

    The last time that the resource set was changed.

  • updateToken :: Maybe Text

    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.

  • name :: Text

    The descriptive name of the resource set. You can't change the name of a resource set after you create it.

  • resourceTypeList :: [Text]

    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.

Instances

Instances details
FromJSON ResourceSet Source # 
Instance details

Defined in Amazonka.FMS.Types.ResourceSet

ToJSON ResourceSet Source # 
Instance details

Defined in Amazonka.FMS.Types.ResourceSet

Generic ResourceSet Source # 
Instance details

Defined in Amazonka.FMS.Types.ResourceSet

Associated Types

type Rep ResourceSet :: Type -> Type #

Read ResourceSet Source # 
Instance details

Defined in Amazonka.FMS.Types.ResourceSet

Show ResourceSet Source # 
Instance details

Defined in Amazonka.FMS.Types.ResourceSet

NFData ResourceSet Source # 
Instance details

Defined in Amazonka.FMS.Types.ResourceSet

Methods

rnf :: ResourceSet -> () #

Eq ResourceSet Source # 
Instance details

Defined in Amazonka.FMS.Types.ResourceSet

Hashable ResourceSet Source # 
Instance details

Defined in Amazonka.FMS.Types.ResourceSet

type Rep ResourceSet Source # 
Instance details

Defined in Amazonka.FMS.Types.ResourceSet

type Rep ResourceSet = D1 ('MetaData "ResourceSet" "Amazonka.FMS.Types.ResourceSet" "amazonka-fms-2.0-351knTjuYAjE9GRQTo0ohx" 'False) (C1 ('MetaCons "ResourceSet'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastUpdateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: (S1 ('MetaSel ('Just "updateToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "resourceTypeList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))))

newResourceSet Source #

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.