ip_restrictions

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

Overview

Name	ip_restrictions
Type	Resource
Id	aws.quicksight.ip_restrictions

Fields

The following fields are returned by SELECT queries:

describe_ip_restriction

Name	Datatype	Description
aws_account_id	string	The ID of the Amazon Web Services account that contains the IP rules. (pattern: <code>^[0-9]{12}$</code>)
enabled	boolean	A value that specifies whether IP rules are turned on.
ip_restriction_rule_map	object	A map that describes the IP rules with CIDR range and description.
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.
vpc_endpoint_id_restriction_rule_map	object	A map of allowed VPC endpoint IDs and their rule descriptions.
vpc_id_restriction_rule_map	object	A map of allowed VPC IDs and their rule descriptions.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_ip_restriction	select	aws_account_id, region		Provides a summary and status of IP rules.
update_ip_restriction	update	aws_account_id, region		Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the IpRestrictionRule, VpcIdRestrictionRule, or VpcEndpointIdRestrictionRule. To use this operation, you must provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.

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
aws_account_id	string	The ID of the Amazon Web Services account that contains the IP rules.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_ip_restriction

Provides a summary and status of IP rules.

SELECT
aws_account_id,
enabled,
ip_restriction_rule_map,
request_id,
status,
vpc_endpoint_id_restriction_rule_map,
vpc_id_restriction_rule_map
FROM aws.quicksight.ip_restrictions
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_ip_restriction

Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the IpRestrictionRule, VpcIdRestrictionRule, or VpcEndpointIdRestrictionRule. To use this operation, you must provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.

UPDATE aws.quicksight.ip_restrictions
SET 
IpRestrictionRuleMap = '{{ IpRestrictionRuleMap }}',
VpcIdRestrictionRuleMap = '{{ VpcIdRestrictionRuleMap }}',
VpcEndpointIdRestrictionRuleMap = '{{ VpcEndpointIdRestrictionRuleMap }}',
Enabled = {{ Enabled }}
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND region = '{{ region }}' --required
RETURNING
aws_account_id,
request_id,
status;