Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. workspacesweb
  5. IpAccessSettings
AWS v6.83.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws

aws.workspacesweb.IpAccessSettings

Explore with Pulumi AI

aws logo
AWS v6.83.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws

    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

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.workspacesweb.IpAccessSettings("example", {
    displayName: "example",
    ipRules: [{
        ipRange: "10.0.0.0/16",
    }],
});

    import pulumi
import pulumi_aws as aws

example = aws.workspacesweb.IpAccessSettings("example",
    display_name="example",
    ip_rules=[{
        "ip_range": "10.0.0.0/16",
    }])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/workspacesweb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := workspacesweb.NewIpAccessSettings(ctx, "example", &workspacesweb.IpAccessSettingsArgs{
			DisplayName: pulumi.String("example"),
			IpRules: workspacesweb.IpAccessSettingsIpRuleArray{
				&workspacesweb.IpAccessSettingsIpRuleArgs{
					IpRange: pulumi.String("10.0.0.0/16"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.WorkSpacesWeb.IpAccessSettings("example", new()
    {
        DisplayName = "example",
        IpRules = new[]
        {
            new Aws.WorkSpacesWeb.Inputs.IpAccessSettingsIpRuleArgs
            {
                IpRange = "10.0.0.0/16",
            },
        },
    });

});

    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.List;
import java.util.ArrayList;
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()
            .displayName("example")
            .ipRules(IpAccessSettingsIpRuleArgs.builder()
                .ipRange("10.0.0.0/16")
                .build())
            .build());

    }
}

    resources:
  example:
    type: aws:workspacesweb:IpAccessSettings
    properties:
      displayName: example
      ipRules:
        - ipRange: 10.0.0.0/16

    With Multiple IP Rules

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.workspacesweb.IpAccessSettings("example", {
    displayName: "example",
    description: "Example IP access settings",
    ipRules: [
        {
            ipRange: "10.0.0.0/16",
            description: "Main office",
        },
        {
            ipRange: "192.168.0.0/24",
            description: "Branch office",
        },
    ],
});

    import pulumi
import pulumi_aws as aws

example = aws.workspacesweb.IpAccessSettings("example",
    display_name="example",
    description="Example IP access settings",
    ip_rules=[
        {
            "ip_range": "10.0.0.0/16",
            "description": "Main office",
        },
        {
            "ip_range": "192.168.0.0/24",
            "description": "Branch office",
        },
    ])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/workspacesweb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := workspacesweb.NewIpAccessSettings(ctx, "example", &workspacesweb.IpAccessSettingsArgs{
			DisplayName: pulumi.String("example"),
			Description: pulumi.String("Example IP access settings"),
			IpRules: workspacesweb.IpAccessSettingsIpRuleArray{
				&workspacesweb.IpAccessSettingsIpRuleArgs{
					IpRange:     pulumi.String("10.0.0.0/16"),
					Description: pulumi.String("Main office"),
				},
				&workspacesweb.IpAccessSettingsIpRuleArgs{
					IpRange:     pulumi.String("192.168.0.0/24"),
					Description: pulumi.String("Branch office"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.WorkSpacesWeb.IpAccessSettings("example", new()
    {
        DisplayName = "example",
        Description = "Example IP access settings",
        IpRules = new[]
        {
            new Aws.WorkSpacesWeb.Inputs.IpAccessSettingsIpRuleArgs
            {
                IpRange = "10.0.0.0/16",
                Description = "Main office",
            },
            new Aws.WorkSpacesWeb.Inputs.IpAccessSettingsIpRuleArgs
            {
                IpRange = "192.168.0.0/24",
                Description = "Branch office",
            },
        },
    });

});

    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.List;
import java.util.ArrayList;
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()
            .displayName("example")
            .description("Example IP access settings")
            .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())
            .build());

    }
}

    resources:
  example:
    type: aws:workspacesweb:IpAccessSettings
    properties:
      displayName: example
      description: Example IP access settings
      ipRules:
        - ipRange: 10.0.0.0/16
          description: Main office
        - ipRange: 192.168.0.0/24
          description: Branch office

    With All Arguments

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.kms.Key("example", {
    description: "KMS key for WorkSpaces Web IP Access Settings",
    deletionWindowInDays: 7,
});
const exampleIpAccessSettings = new aws.workspacesweb.IpAccessSettings("example", {
    displayName: "example",
    description: "Example IP access settings",
    customerManagedKey: example.arn,
    additionalEncryptionContext: {
        Environment: "Production",
    },
    ipRules: [
        {
            ipRange: "10.0.0.0/16",
            description: "Main office",
        },
        {
            ipRange: "192.168.0.0/24",
            description: "Branch office",
        },
    ],
    tags: {
        Name: "example-ip-access-settings",
    },
});

    import pulumi
import pulumi_aws as aws

example = aws.kms.Key("example",
    description="KMS key for WorkSpaces Web IP Access Settings",
    deletion_window_in_days=7)
example_ip_access_settings = aws.workspacesweb.IpAccessSettings("example",
    display_name="example",
    description="Example IP access settings",
    customer_managed_key=example.arn,
    additional_encryption_context={
        "Environment": "Production",
    },
    ip_rules=[
        {
            "ip_range": "10.0.0.0/16",
            "description": "Main office",
        },
        {
            "ip_range": "192.168.0.0/24",
            "description": "Branch office",
        },
    ],
    tags={
        "Name": "example-ip-access-settings",
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kms"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/workspacesweb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := kms.NewKey(ctx, "example", &kms.KeyArgs{
			Description:          pulumi.String("KMS key for WorkSpaces Web IP Access Settings"),
			DeletionWindowInDays: pulumi.Int(7),
		})
		if err != nil {
			return err
		}
		_, err = workspacesweb.NewIpAccessSettings(ctx, "example", &workspacesweb.IpAccessSettingsArgs{
			DisplayName:        pulumi.String("example"),
			Description:        pulumi.String("Example IP access settings"),
			CustomerManagedKey: example.Arn,
			AdditionalEncryptionContext: pulumi.StringMap{
				"Environment": pulumi.String("Production"),
			},
			IpRules: workspacesweb.IpAccessSettingsIpRuleArray{
				&workspacesweb.IpAccessSettingsIpRuleArgs{
					IpRange:     pulumi.String("10.0.0.0/16"),
					Description: pulumi.String("Main office"),
				},
				&workspacesweb.IpAccessSettingsIpRuleArgs{
					IpRange:     pulumi.String("192.168.0.0/24"),
					Description: pulumi.String("Branch office"),
				},
			},
			Tags: pulumi.StringMap{
				"Name": pulumi.String("example-ip-access-settings"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Kms.Key("example", new()
    {
        Description = "KMS key for WorkSpaces Web IP Access Settings",
        DeletionWindowInDays = 7,
    });

    var exampleIpAccessSettings = new Aws.WorkSpacesWeb.IpAccessSettings("example", new()
    {
        DisplayName = "example",
        Description = "Example IP access settings",
        CustomerManagedKey = example.Arn,
        AdditionalEncryptionContext = 
        {
            { "Environment", "Production" },
        },
        IpRules = new[]
        {
            new Aws.WorkSpacesWeb.Inputs.IpAccessSettingsIpRuleArgs
            {
                IpRange = "10.0.0.0/16",
                Description = "Main office",
            },
            new Aws.WorkSpacesWeb.Inputs.IpAccessSettingsIpRuleArgs
            {
                IpRange = "192.168.0.0/24",
                Description = "Branch office",
            },
        },
        Tags = 
        {
            { "Name", "example-ip-access-settings" },
        },
    });

});

    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.List;
import java.util.ArrayList;
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()
            .displayName("example")
            .description("Example IP access settings")
            .customerManagedKey(example.arn())
            .additionalEncryptionContext(Map.of("Environment", "Production"))
            .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())
            .tags(Map.of("Name", "example-ip-access-settings"))
            .build());

    }
}

    resources:
  example:
    type: aws:kms:Key
    properties:
      description: KMS key for WorkSpaces Web IP Access Settings
      deletionWindowInDays: 7
  exampleIpAccessSettings:
    type: aws:workspacesweb:IpAccessSettings
    name: example
    properties:
      displayName: example
      description: Example IP access settings
      customerManagedKey: ${example.arn}
      additionalEncryptionContext:
        Environment: Production
      ipRules:
        - ipRange: 10.0.0.0/16
          description: Main office
        - ipRange: 192.168.0.0/24
          description: Branch office
      tags:
        Name: example-ip-access-settings

    Create IpAccessSettings Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new IpAccessSettings(name: string, args: IpAccessSettingsArgs, opts?: CustomResourceOptions);
    @overload
def IpAccessSettings(resource_name: str,
                     args: IpAccessSettingsArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def IpAccessSettings(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     display_name: Optional[str] = None,
                     additional_encryption_context: Optional[Mapping[str, str]] = None,
                     customer_managed_key: Optional[str] = None,
                     description: Optional[str] = None,
                     ip_rules: Optional[Sequence[IpAccessSettingsIpRuleArgs]] = None,
                     tags: Optional[Mapping[str, str]] = None)
    func NewIpAccessSettings(ctx *Context, name string, args IpAccessSettingsArgs, opts ...ResourceOption) (*IpAccessSettings, error)
    public IpAccessSettings(string name, IpAccessSettingsArgs args, CustomResourceOptions? opts = null)
    public IpAccessSettings(String name, IpAccessSettingsArgs args)
public IpAccessSettings(String name, IpAccessSettingsArgs args, CustomResourceOptions options)

    type: aws:workspacesweb:IpAccessSettings
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args IpAccessSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args IpAccessSettingsArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args IpAccessSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IpAccessSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IpAccessSettingsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var ipAccessSettingsResource = new Aws.WorkSpacesWeb.IpAccessSettings("ipAccessSettingsResource", new()
{
    DisplayName = "string",
    AdditionalEncryptionContext = 
    {
        { "string", "string" },
    },
    CustomerManagedKey = "string",
    Description = "string",
    IpRules = new[]
    {
        new Aws.WorkSpacesWeb.Inputs.IpAccessSettingsIpRuleArgs
        {
            IpRange = "string",
            Description = "string",
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := workspacesweb.NewIpAccessSettings(ctx, "ipAccessSettingsResource", &workspacesweb.IpAccessSettingsArgs{
	DisplayName: pulumi.String("string"),
	AdditionalEncryptionContext: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	CustomerManagedKey: pulumi.String("string"),
	Description:        pulumi.String("string"),
	IpRules: workspacesweb.IpAccessSettingsIpRuleArray{
		&workspacesweb.IpAccessSettingsIpRuleArgs{
			IpRange:     pulumi.String("string"),
			Description: pulumi.String("string"),
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var ipAccessSettingsResource = new IpAccessSettings("ipAccessSettingsResource", IpAccessSettingsArgs.builder()
    .displayName("string")
    .additionalEncryptionContext(Map.of("string", "string"))
    .customerManagedKey("string")
    .description("string")
    .ipRules(IpAccessSettingsIpRuleArgs.builder()
        .ipRange("string")
        .description("string")
        .build())
    .tags(Map.of("string", "string"))
    .build());

    ip_access_settings_resource = aws.workspacesweb.IpAccessSettings("ipAccessSettingsResource",
    display_name="string",
    additional_encryption_context={
        "string": "string",
    },
    customer_managed_key="string",
    description="string",
    ip_rules=[{
        "ip_range": "string",
        "description": "string",
    }],
    tags={
        "string": "string",
    })

    const ipAccessSettingsResource = new aws.workspacesweb.IpAccessSettings("ipAccessSettingsResource", {
    displayName: "string",
    additionalEncryptionContext: {
        string: "string",
    },
    customerManagedKey: "string",
    description: "string",
    ipRules: [{
        ipRange: "string",
        description: "string",
    }],
    tags: {
        string: "string",
    },
});

    type: aws:workspacesweb:IpAccessSettings
properties:
    additionalEncryptionContext:
        string: string
    customerManagedKey: string
    description: string
    displayName: string
    ipRules:
        - description: string
          ipRange: string
    tags:
        string: string

    IpAccessSettings Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The IpAccessSettings resource accepts the following input properties:

    DisplayName string
    The display name of the IP access settings.
    AdditionalEncryptionContext Dictionary<string, string>
    Additional encryption context for the IP access settings.
    CustomerManagedKey string
    ARN of the customer managed KMS key.
    Description string
    The description of the IP access settings.
    IpRules List<IpAccessSettingsIpRule>

    The IP rules of the IP access settings. See IP Rule below.

    The following arguments are optional:

    Tags Dictionary<string, string>
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    DisplayName string
    The display name of the IP access settings.
    AdditionalEncryptionContext map[string]string
    Additional encryption context for the IP access settings.
    CustomerManagedKey string
    ARN of the customer managed KMS key.
    Description string
    The description of the IP access settings.
    IpRules []IpAccessSettingsIpRuleArgs

    The IP rules of the IP access settings. See IP Rule below.

    The following arguments are optional:

    Tags map[string]string
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    displayName String
    The display name of the IP access settings.
    additionalEncryptionContext Map<String,String>
    Additional encryption context for the IP access settings.
    customerManagedKey String
    ARN of the customer managed KMS key.
    description String
    The description of the IP access settings.
    ipRules List<IpAccessSettingsIpRule>

    The IP rules of the IP access settings. See IP Rule below.

    The following arguments are optional:

    tags Map<String,String>
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    displayName string
    The display name of the IP access settings.
    additionalEncryptionContext {[key: string]: string}
    Additional encryption context for the IP access settings.
    customerManagedKey string
    ARN of the customer managed KMS key.
    description string
    The description of the IP access settings.
    ipRules IpAccessSettingsIpRule[]

    The IP rules of the IP access settings. See IP Rule below.

    The following arguments are optional:

    tags {[key: string]: string}
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    display_name str
    The display name of the IP access settings.
    additional_encryption_context Mapping[str, str]
    Additional encryption context for the IP access settings.
    customer_managed_key str
    ARN of the customer managed KMS key.
    description str
    The description of the IP access settings.
    ip_rules Sequence[IpAccessSettingsIpRuleArgs]

    The IP rules of the IP access settings. See IP Rule below.

    The following arguments are optional:

    tags Mapping[str, str]
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    displayName String
    The display name of the IP access settings.
    additionalEncryptionContext Map<String>
    Additional encryption context for the IP access settings.
    customerManagedKey String
    ARN of the customer managed KMS key.
    description String
    The description of the IP access settings.
    ipRules List<Property Map>

    The IP rules of the IP access settings. See IP Rule below.

    The following arguments are optional:

    tags Map<String>
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IpAccessSettings resource produces the following output properties:

    AssociatedPortalArns List<string>
    List of web portal ARNs that this IP access settings resource is associated with.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAccessSettingsArn string
    ARN of the IP access settings resource.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    AssociatedPortalArns []string
    List of web portal ARNs that this IP access settings resource is associated with.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAccessSettingsArn string
    ARN of the IP access settings resource.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    associatedPortalArns List<String>
    List of web portal ARNs that this IP access settings resource is associated with.
    id String
    The provider-assigned unique ID for this managed resource.
    ipAccessSettingsArn String
    ARN of the IP access settings resource.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    associatedPortalArns string[]
    List of web portal ARNs that this IP access settings resource is associated with.
    id string
    The provider-assigned unique ID for this managed resource.
    ipAccessSettingsArn string
    ARN of the IP access settings resource.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    associated_portal_arns Sequence[str]
    List of web portal ARNs that this IP access settings resource is associated with.
    id str
    The provider-assigned unique ID for this managed resource.
    ip_access_settings_arn str
    ARN of the IP access settings resource.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    associatedPortalArns List<String>
    List of web portal ARNs that this IP access settings resource is associated with.
    id String
    The provider-assigned unique ID for this managed resource.
    ipAccessSettingsArn String
    ARN of the IP access settings resource.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing IpAccessSettings Resource

    Get an existing IpAccessSettings resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: IpAccessSettingsState, opts?: CustomResourceOptions): IpAccessSettings
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_encryption_context: Optional[Mapping[str, str]] = None,
        associated_portal_arns: Optional[Sequence[str]] = None,
        customer_managed_key: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        ip_access_settings_arn: Optional[str] = None,
        ip_rules: Optional[Sequence[IpAccessSettingsIpRuleArgs]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> IpAccessSettings
    func GetIpAccessSettings(ctx *Context, name string, id IDInput, state *IpAccessSettingsState, opts ...ResourceOption) (*IpAccessSettings, error)
    public static IpAccessSettings Get(string name, Input<string> id, IpAccessSettingsState? state, CustomResourceOptions? opts = null)
    public static IpAccessSettings get(String name, Output<String> id, IpAccessSettingsState state, CustomResourceOptions options)
    resources:  _:    type: aws:workspacesweb:IpAccessSettings    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AdditionalEncryptionContext Dictionary<string, string>
    Additional encryption context for the IP access settings.
    AssociatedPortalArns List<string>
    List of web portal ARNs that this IP access settings resource is associated with.
    CustomerManagedKey string
    ARN of the customer managed KMS key.
    Description string
    The description of the IP access settings.
    DisplayName string
    The display name of the IP access settings.
    IpAccessSettingsArn string
    ARN of the IP access settings resource.
    IpRules List<IpAccessSettingsIpRule>

    The IP rules of the IP access settings. See IP Rule below.

    The following arguments are optional:

    Tags Dictionary<string, string>
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    AdditionalEncryptionContext map[string]string
    Additional encryption context for the IP access settings.
    AssociatedPortalArns []string
    List of web portal ARNs that this IP access settings resource is associated with.
    CustomerManagedKey string
    ARN of the customer managed KMS key.
    Description string
    The description of the IP access settings.
    DisplayName string
    The display name of the IP access settings.
    IpAccessSettingsArn string
    ARN of the IP access settings resource.
    IpRules []IpAccessSettingsIpRuleArgs

    The IP rules of the IP access settings. See IP Rule below.

    The following arguments are optional:

    Tags map[string]string
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    additionalEncryptionContext Map<String,String>
    Additional encryption context for the IP access settings.
    associatedPortalArns List<String>
    List of web portal ARNs that this IP access settings resource is associated with.
    customerManagedKey String
    ARN of the customer managed KMS key.
    description String
    The description of the IP access settings.
    displayName String
    The display name of the IP access settings.
    ipAccessSettingsArn String
    ARN of the IP access settings resource.
    ipRules List<IpAccessSettingsIpRule>

    The IP rules of the IP access settings. See IP Rule below.

    The following arguments are optional:

    tags Map<String,String>
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    additionalEncryptionContext {[key: string]: string}
    Additional encryption context for the IP access settings.
    associatedPortalArns string[]
    List of web portal ARNs that this IP access settings resource is associated with.
    customerManagedKey string
    ARN of the customer managed KMS key.
    description string
    The description of the IP access settings.
    displayName string
    The display name of the IP access settings.
    ipAccessSettingsArn string
    ARN of the IP access settings resource.
    ipRules IpAccessSettingsIpRule[]

    The IP rules of the IP access settings. See IP Rule below.

    The following arguments are optional:

    tags {[key: string]: string}
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    additional_encryption_context Mapping[str, str]
    Additional encryption context for the IP access settings.
    associated_portal_arns Sequence[str]
    List of web portal ARNs that this IP access settings resource is associated with.
    customer_managed_key str
    ARN of the customer managed KMS key.
    description str
    The description of the IP access settings.
    display_name str
    The display name of the IP access settings.
    ip_access_settings_arn str
    ARN of the IP access settings resource.
    ip_rules Sequence[IpAccessSettingsIpRuleArgs]

    The IP rules of the IP access settings. See IP Rule below.

    The following arguments are optional:

    tags Mapping[str, str]
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    additionalEncryptionContext Map<String>
    Additional encryption context for the IP access settings.
    associatedPortalArns List<String>
    List of web portal ARNs that this IP access settings resource is associated with.
    customerManagedKey String
    ARN of the customer managed KMS key.
    description String
    The description of the IP access settings.
    displayName String
    The display name of the IP access settings.
    ipAccessSettingsArn String
    ARN of the IP access settings resource.
    ipRules List<Property Map>

    The IP rules of the IP access settings. See IP Rule below.

    The following arguments are optional:

    tags Map<String>
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    IpAccessSettingsIpRule, IpAccessSettingsIpRuleArgs

    IpRange string
    The IP range of the IP rule.
    Description string
    The description of the IP access settings.
    IpRange string
    The IP range of the IP rule.
    Description string
    The description of the IP access settings.
    ipRange String
    The IP range of the IP rule.
    description String
    The description of the IP access settings.
    ipRange string
    The IP range of the IP rule.
    description string
    The description of the IP access settings.
    ip_range str
    The IP range of the IP rule.
    description str
    The description of the IP access settings.
    ipRange String
    The IP range of the IP rule.
    description String
    The description of the IP access settings.

    Import

    Using pulumi import, import WorkSpaces Web IP Access Settings using the ip_access_settings_arn. For example:

    $ pulumi import aws:workspacesweb/ipAccessSettings:IpAccessSettings example arn:aws:workspaces-web:us-west-2:123456789012:ipAccessSettings/abcdef12345

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.83.0 published on Monday, Jun 16, 2025 by Pulumi
    pulumi/pulumi-aws