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:
- get
The Max User Session Timeout policy.
| Name | Datatype | Description |
|---|---|---|
max_user_session_timeout | 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: <code>^(5m|15m|30m|1h|2h|6h|12h|1d|2d|3d|5d|7d)$</code>, example: 1d, x-pattern-message: must be one of the following: 5m, 15m, 30m, 1h, 2h, 6h, 12h, 1d, 2d, 3d, 5d, or 7d) (wire: maxUserSessionTimeout) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | 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](https:​//help.sumologic.com/Manage/Security/Set_a_Maximum_Web_Session_Timeout) | |
update | update | region, max_user_session_timeout | 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](https:​//help.sumologic.com/Manage/Security/Set_a_Maximum_Web_Session_Timeout) |
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 | Sumo Logic deployment (au, ca, ch, de, eu, fed, in, jp, kr, us1, us2). Resolved from the SUMOLOGIC_ENVIRONMENT environment variable when it is set (x-stackQL-envVar, the same variable the Terraform provider reads); otherwise defaults to us2. A WHERE region = '...' value always takes precedence. (enum: [au, ca, ch, de, eu, fed, in, jp, kr, us1, us2], default: us2, x-stackQL-envVar: SUMOLOGIC_ENVIRONMENT) |
SELECT examples​
- get
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
max_user_session_timeout
FROM sumologic.policies.max_user_session_timeout
WHERE region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;
UPDATE examples​
- update
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
UPDATE sumologic.policies.max_user_session_timeout
SET
max_user_session_timeout = '{{ max_user_session_timeout }}'
WHERE
region = '{{ region }}' --required unless SUMOLOGIC_ENVIRONMENT is set
AND max_user_session_timeout = '{{ max_user_session_timeout }}' --required
RETURNING
max_user_session_timeout;