Skip to content

Updates the content and status of IP rules

Description

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 describe_ip_restriction operation to get the current rule map.

Usage

quicksight_update_ip_restriction(AwsAccountId, IpRestrictionRuleMap,
  VpcIdRestrictionRuleMap, VpcEndpointIdRestrictionRuleMap, Enabled)

Arguments

  • AwsAccountId

    [required] The ID of the Amazon Web Services account that contains the IP rules.

  • IpRestrictionRuleMap

    A map that describes the updated IP rules with CIDR ranges and descriptions.

  • VpcIdRestrictionRuleMap

    A map of VPC IDs and their corresponding rules. When you configure this parameter, traffic from all VPC endpoints that are present in the specified VPC is allowed.

  • VpcEndpointIdRestrictionRuleMap

    A map of allowed VPC endpoint IDs and their corresponding rule descriptions.

  • Enabled

    A value that specifies whether IP rules are turned on.

Value

A list with the following syntax:

list(
  AwsAccountId = "string",
  RequestId = "string",
  Status = 123
)

Request syntax

svc$update_ip_restriction(
  AwsAccountId = "string",
  IpRestrictionRuleMap = list(
    "string"
  ),
  VpcIdRestrictionRuleMap = list(
    "string"
  ),
  VpcEndpointIdRestrictionRuleMap = list(
    "string"
  ),
  Enabled = TRUE|FALSE
)