Skip to main content

ip_rules

Creates, updates, deletes, gets or lists an ip_rules resource.

Overview

Nameip_rules
TypeResource
Idaws.workspaces.ip_rules

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
authorize_ip_rulesupdateregion, GroupId, UserRulesAdds one or more rules to the specified IP access control group. This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.
revoke_ip_rulesexecregion, GroupId, UserRulesRemoves one or more rules from the specified IP access control group.

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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

UPDATE examples

Adds one or more rules to the specified IP access control group. This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.

UPDATE aws.workspaces.ip_rules
SET
GroupId = '{{ GroupId }}',
UserRules = '{{ UserRules }}'
WHERE
region = '{{ region }}' --required
AND GroupId = '{{ GroupId }}' --required
AND UserRules = '{{ UserRules }}' --required;

Lifecycle Methods

Removes one or more rules from the specified IP access control group.

EXEC aws.workspaces.ip_rules.revoke_ip_rules
@region='{{ region }}' --required
@@json=
'{
"GroupId": "{{ GroupId }}",
"UserRules": "{{ UserRules }}"
}'
;