max_user_session_timeout
Creates, updates, deletes, gets or lists a max_user_session_timeout resource.
Overview
| Name | max_user_session_timeout |
| Type | Resource |
| Id | sumologic.policies.max_user_session_timeout |
Fields
The following fields are returned by SELECT queries:
- getMaxUserSessionTimeoutPolicy
The Max User Session Timeout policy.
| Name | Datatype | Description |
|---|---|---|
maxUserSessionTimeout | string | Maximum web session timeout users are able to configure within their user preferences. Valid values are: 5m, 15m, 30m, 1h, 2h, 6h, 12h, 1d, 2d, 3d, 5d, or 7d (pattern: ^(5m|15m|30m|1h|2h|6h|12h|1d|2d|3d|5d|7d)$, example: 1d, x-pattern-message: must be one of the following: 5m, 15m, 30m, 1h, 2h, 6h, 12h, 1d, 2d, 3d, 5d, or 7d) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
getMaxUserSessionTimeoutPolicy | select | region | Get the Max User Session Timeout policy. When enabled, this policy sets the maximum web session timeout users are able to configure within their user preferences. Users preferences will be updated to match this value only if their current preference is set to a higher value. Learn More | |
setMaxUserSessionTimeoutPolicy | exec | region, maxUserSessionTimeout | Set the Max User Session Timeout policy. When enabled, this policy sets the maximum web session timeout users are able to configure within their user preferences. Users preferences will be updated to match this value only if their current preference is set to a higher value. Learn More |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | SumoLogic region (enum: [us2, au, ca, de, eu, fed, in, jp], default: us2) |
SELECT examples
- getMaxUserSessionTimeoutPolicy
Get the Max User Session Timeout policy. When enabled, this policy sets the maximum web session timeout users are able to configure within their user preferences. Users preferences will be updated to match this value only if their current preference is set to a higher value. Learn More
SELECT
maxUserSessionTimeout
FROM sumologic.policies.max_user_session_timeout
WHERE region = '{{ region }}' -- required
;
Lifecycle Methods
- setMaxUserSessionTimeoutPolicy
Set the Max User Session Timeout policy. When enabled, this policy sets the maximum web session timeout users are able to configure within their user preferences. Users preferences will be updated to match this value only if their current preference is set to a higher value. Learn More
EXEC sumologic.policies.max_user_session_timeout.setMaxUserSessionTimeoutPolicy
@region='{{ region }}' --required
@@json=
'{
"maxUserSessionTimeout": "{{ maxUserSessionTimeout }}"
}'
;