/AWS1/CL_FMSRESOURCESET¶
A set of resources to include in a policy.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
IV_NAME TYPE /AWS1/FMSNAME /AWS1/FMSNAME¶
The descriptive name of the resource set. You can't change the name of a resource set after you create it.
IT_RESOURCETYPELIST TYPE /AWS1/CL_FMSRESOURCETYPELIST_W=>TT_RESOURCETYPELIST TT_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.
Optional arguments:¶
IV_ID TYPE /AWS1/FMSBASE62ID /AWS1/FMSBASE62ID¶
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.
IV_DESCRIPTION TYPE /AWS1/FMSDESCRIPTION /AWS1/FMSDESCRIPTION¶
A description of the resource set.
IV_UPDATETOKEN TYPE /AWS1/FMSUPDATETOKEN /AWS1/FMSUPDATETOKEN¶
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.
IV_LASTUPDATETIME TYPE /AWS1/FMSTIMESTAMP /AWS1/FMSTIMESTAMP¶
The last time that the resource set was changed.
IV_RESOURCESETSTATUS TYPE /AWS1/FMSRESOURCESETSTATUS /AWS1/FMSRESOURCESETSTATUS¶
Indicates whether the resource set is in or out of an admin's Region scope.
ACTIVE- The administrator can manage and delete the resource set.
OUT_OF_ADMIN_SCOPE- The administrator can view the resource set, but they can't edit or delete the resource set. Existing protections stay in place. Any new resource that come into scope of the resource set won't be protected.
Queryable Attributes¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ID() |
Getter for ID, with configurable default |
ASK_ID() |
Getter for ID w/ exceptions if field has no value |
HAS_ID() |
Determine if ID has a value |
Name¶
The descriptive name of the resource set. You can't change the name of a resource set after you create it.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
Description¶
A description of the resource set.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_UPDATETOKEN() |
Getter for UPDATETOKEN, with configurable default |
ASK_UPDATETOKEN() |
Getter for UPDATETOKEN w/ exceptions if field has no value |
HAS_UPDATETOKEN() |
Determine if UPDATETOKEN has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCETYPELIST() |
Getter for RESOURCETYPELIST, with configurable default |
ASK_RESOURCETYPELIST() |
Getter for RESOURCETYPELIST w/ exceptions if field has no va |
HAS_RESOURCETYPELIST() |
Determine if RESOURCETYPELIST has a value |
LastUpdateTime¶
The last time that the resource set was changed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTUPDATETIME() |
Getter for LASTUPDATETIME, with configurable default |
ASK_LASTUPDATETIME() |
Getter for LASTUPDATETIME w/ exceptions if field has no valu |
HAS_LASTUPDATETIME() |
Determine if LASTUPDATETIME has a value |
ResourceSetStatus¶
Indicates whether the resource set is in or out of an admin's Region scope.
ACTIVE- The administrator can manage and delete the resource set.
OUT_OF_ADMIN_SCOPE- The administrator can view the resource set, but they can't edit or delete the resource set. Existing protections stay in place. Any new resource that come into scope of the resource set won't be protected.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCESETSTATUS() |
Getter for RESOURCESETSTATUS, with configurable default |
ASK_RESOURCESETSTATUS() |
Getter for RESOURCESETSTATUS w/ exceptions if field has no v |
HAS_RESOURCESETSTATUS() |
Determine if RESOURCESETSTATUS has a value |