Package com.pulumi.aws.workspacesweb

Class IpAccessSettings

  • public class IpAccessSettings
extends com.pulumi.resources.CustomResource
    Resource for managing an AWS WorkSpaces Web IP Access Settings resource. Once associated with a web portal, IP access settings control which IP addresses users can connect from. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.workspacesweb.IpAccessSettings;
 import com.pulumi.aws.workspacesweb.IpAccessSettingsArgs;
 import com.pulumi.aws.workspacesweb.inputs.IpAccessSettingsIpRuleArgs;
 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 IpAccessSettings("example", IpAccessSettingsArgs.builder()
             .ipRules(IpAccessSettingsIpRuleArgs.builder()
                 .ipRange("10.0.0.0/16")
                 .build())
             .displayName("example")
             .build());
 
     }
 }
    ### With Multiple IP Rules 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.workspacesweb.IpAccessSettings;
 import com.pulumi.aws.workspacesweb.IpAccessSettingsArgs;
 import com.pulumi.aws.workspacesweb.inputs.IpAccessSettingsIpRuleArgs;
 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 IpAccessSettings("example", IpAccessSettingsArgs.builder()
             .ipRules(            
                 IpAccessSettingsIpRuleArgs.builder()
                     .ipRange("10.0.0.0/16")
                     .description("Main office")
                     .build(),
                 IpAccessSettingsIpRuleArgs.builder()
                     .ipRange("192.168.0.0/24")
                     .description("Branch office")
                     .build())
             .displayName("example")
             .description("Example IP access settings")
             .build());
 
     }
 }
    ### With All Arguments 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.kms.Key;
 import com.pulumi.aws.kms.KeyArgs;
 import com.pulumi.aws.workspacesweb.IpAccessSettings;
 import com.pulumi.aws.workspacesweb.IpAccessSettingsArgs;
 import com.pulumi.aws.workspacesweb.inputs.IpAccessSettingsIpRuleArgs;
 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 Key("example", KeyArgs.builder()
             .description("KMS key for WorkSpaces Web IP Access Settings")
             .deletionWindowInDays(7)
             .build());
 
         var exampleIpAccessSettings = new IpAccessSettings("exampleIpAccessSettings", IpAccessSettingsArgs.builder()
             .ipRules(            
                 IpAccessSettingsIpRuleArgs.builder()
                     .ipRange("10.0.0.0/16")
                     .description("Main office")
                     .build(),
                 IpAccessSettingsIpRuleArgs.builder()
                     .ipRange("192.168.0.0/24")
                     .description("Branch office")
                     .build())
             .displayName("example")
             .description("Example IP access settings")
             .customerManagedKey(example.arn())
             .additionalEncryptionContext(Map.of("Environment", "Production"))
             .tags(Map.of("Name", "example-ip-access-settings"))
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import WorkSpaces Web IP Access Settings using the `ipAccessSettingsArn`. For example: ```sh $ pulumi import aws:workspacesweb/ipAccessSettings:IpAccessSettings example arn:aws:workspaces-web:us-west-2:123456789012:ipAccessSettings/abcdef12345 ```

    • 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.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> additionalEncryptionContext()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> associatedPortalArns()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> customerManagedKey()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.lang.String> displayName()  
      static IpAccessSettings get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, IpAccessSettingsState 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.lang.String> ipAccessSettingsArn()  
      com.pulumi.core.Output<java.util.List<IpAccessSettingsIpRule>> ipRules()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  

      • 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

      • IpAccessSettings

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

      • IpAccessSettings

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

      • IpAccessSettings

        public IpAccessSettings​(java.lang.String name,
                        IpAccessSettingsArgs 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

      • additionalEncryptionContext

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> additionalEncryptionContext()
        Returns:
        Additional encryption context for the IP access settings.

      • associatedPortalArns

        public com.pulumi.core.Output<java.util.List<java.lang.String>> associatedPortalArns()
        Returns:
        List of web portal ARNs that this IP access settings resource is associated with.

      • customerManagedKey

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> customerManagedKey()
        Returns:
        ARN of the customer managed KMS key.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        The description of the IP access settings.

      • displayName

        public com.pulumi.core.Output<java.lang.String> displayName()
        Returns:
        The display name of the IP access settings.

      • ipAccessSettingsArn

        public com.pulumi.core.Output<java.lang.String> ipAccessSettingsArn()
        Returns:
        ARN of the IP access settings resource.

      • ipRules

        public com.pulumi.core.Output<java.util.List<IpAccessSettingsIpRule>> ipRules()
        Returns:
        The IP rules of the IP access settings. See IP Rule below. The following arguments are optional:

      • 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.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags assigned to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • get

        public static IpAccessSettings get​(java.lang.String name,
                                   com.pulumi.core.Output<java.lang.String> id,
                                   @Nullable
                                   IpAccessSettingsState 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.