Package com.pulumi.aws.quicksight

Class IpRestriction

  • public class IpRestriction
extends com.pulumi.resources.CustomResource
    Manages the content and status of IP rules. > Deletion of this resource clears all IP restrictions from a QuickSight account. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.quicksight.IpRestriction;
 import com.pulumi.aws.quicksight.IpRestrictionArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new IpRestriction("example", IpRestrictionArgs.builder()
             .enabled(true)
             .ipRestrictionRuleMap(Map.of("108.56.166.202/32", "Allow self"))
             .vpcIdRestrictionRuleMap(Map.of(exampleAwsVpc.id(), "Main VPC"))
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import QuickSight IP restriction using the AWS account ID. For example: ```sh $ pulumi import aws:quicksight/ipRestriction:IpRestriction example "012345678901" ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> awsAccountId()  
      com.pulumi.core.Output<java.lang.Boolean> enabled()  
      static IpRestriction get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, IpRestrictionState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> ipRestrictionRuleMap()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> vpcEndpointIdRestrictionRuleMap()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> vpcIdRestrictionRuleMap()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • IpRestriction

        public IpRestriction​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • IpRestriction

        public IpRestriction​(java.lang.String name,
                     IpRestrictionArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • IpRestriction

        public IpRestriction​(java.lang.String name,
                     IpRestrictionArgs args,
                     @Nullable
                     com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • awsAccountId

        public com.pulumi.core.Output<java.lang.String> awsAccountId()
        Returns:
        AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.

      • enabled

        public com.pulumi.core.Output<java.lang.Boolean> enabled()
        Returns:
        Whether IP rules are turned on.

      • ipRestrictionRuleMap

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> ipRestrictionRuleMap()
        Returns:
        Map of allowed IPv4 CIDR ranges and descriptions.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • vpcEndpointIdRestrictionRuleMap

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> vpcEndpointIdRestrictionRuleMap()
        Returns:
        Map of allowed VPC endpoint IDs and descriptions.

      • vpcIdRestrictionRuleMap

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> vpcIdRestrictionRuleMap()
        Returns:
        Map of VPC IDs and descriptions. Traffic from all VPC endpoints that are present in the specified VPC is allowed.

      • get

        public static IpRestriction get​(java.lang.String name,
                                com.pulumi.core.Output<java.lang.String> id,
                                @Nullable
                                IpRestrictionState state,
                                @Nullable
                                com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.