Docs Home
AWS v7.7.0 published on Friday, Sep 5, 2025 by Pulumi
aws.workspacesweb.IpAccessSettingsAssociation
Explore with Pulumi AI
Resource for managing an AWS WorkSpaces Web IP Access Settings Association.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.workspacesweb.Portal("example", {displayName: "example"});
const exampleIpAccessSettings = new aws.workspacesweb.IpAccessSettings("example", {
displayName: "example",
ipRules: [{
ipRange: "10.0.0.0/16",
}],
});
const exampleIpAccessSettingsAssociation = new aws.workspacesweb.IpAccessSettingsAssociation("example", {
ipAccessSettingsArn: exampleIpAccessSettings.ipAccessSettingsArn,
portalArn: example.portalArn,
});
import pulumi
import pulumi_aws as aws
example = aws.workspacesweb.Portal("example", display_name="example")
example_ip_access_settings = aws.workspacesweb.IpAccessSettings("example",
display_name="example",
ip_rules=[{
"ip_range": "10.0.0.0/16",
}])
example_ip_access_settings_association = aws.workspacesweb.IpAccessSettingsAssociation("example",
ip_access_settings_arn=example_ip_access_settings.ip_access_settings_arn,
portal_arn=example.portal_arn)
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/workspacesweb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := workspacesweb.NewPortal(ctx, "example", &workspacesweb.PortalArgs{
DisplayName: pulumi.String("example"),
})
if err != nil {
return err
}
exampleIpAccessSettings, 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
}
_, err = workspacesweb.NewIpAccessSettingsAssociation(ctx, "example", &workspacesweb.IpAccessSettingsAssociationArgs{
IpAccessSettingsArn: exampleIpAccessSettings.IpAccessSettingsArn,
PortalArn: example.PortalArn,
})
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.Portal("example", new()
{
DisplayName = "example",
});
var exampleIpAccessSettings = new Aws.WorkSpacesWeb.IpAccessSettings("example", new()
{
DisplayName = "example",
IpRules = new[]
{
new Aws.WorkSpacesWeb.Inputs.IpAccessSettingsIpRuleArgs
{
IpRange = "10.0.0.0/16",
},
},
});
var exampleIpAccessSettingsAssociation = new Aws.WorkSpacesWeb.IpAccessSettingsAssociation("example", new()
{
IpAccessSettingsArn = exampleIpAccessSettings.IpAccessSettingsArn,
PortalArn = example.PortalArn,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.workspacesweb.Portal;
import com.pulumi.aws.workspacesweb.PortalArgs;
import com.pulumi.aws.workspacesweb.IpAccessSettings;
import com.pulumi.aws.workspacesweb.IpAccessSettingsArgs;
import com.pulumi.aws.workspacesweb.inputs.IpAccessSettingsIpRuleArgs;
import com.pulumi.aws.workspacesweb.IpAccessSettingsAssociation;
import com.pulumi.aws.workspacesweb.IpAccessSettingsAssociationArgs;
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 Portal("example", PortalArgs.builder()
.displayName("example")
.build());
var exampleIpAccessSettings = new IpAccessSettings("exampleIpAccessSettings", IpAccessSettingsArgs.builder()
.displayName("example")
.ipRules(IpAccessSettingsIpRuleArgs.builder()
.ipRange("10.0.0.0/16")
.build())
.build());
var exampleIpAccessSettingsAssociation = new IpAccessSettingsAssociation("exampleIpAccessSettingsAssociation", IpAccessSettingsAssociationArgs.builder()
.ipAccessSettingsArn(exampleIpAccessSettings.ipAccessSettingsArn())
.portalArn(example.portalArn())
.build());
}
}
resources:
example:
type: aws:workspacesweb:Portal
properties:
displayName: example
exampleIpAccessSettings:
type: aws:workspacesweb:IpAccessSettings
name: example
properties:
displayName: example
ipRules:
- ipRange: 10.0.0.0/16
exampleIpAccessSettingsAssociation:
type: aws:workspacesweb:IpAccessSettingsAssociation
name: example
properties:
ipAccessSettingsArn: ${exampleIpAccessSettings.ipAccessSettingsArn}
portalArn: ${example.portalArn}
Create IpAccessSettingsAssociation Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new IpAccessSettingsAssociation(name: string, args: IpAccessSettingsAssociationArgs, opts?: CustomResourceOptions);@overload
def IpAccessSettingsAssociation(resource_name: str,
args: IpAccessSettingsAssociationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def IpAccessSettingsAssociation(resource_name: str,
opts: Optional[ResourceOptions] = None,
ip_access_settings_arn: Optional[str] = None,
portal_arn: Optional[str] = None,
region: Optional[str] = None)func NewIpAccessSettingsAssociation(ctx *Context, name string, args IpAccessSettingsAssociationArgs, opts ...ResourceOption) (*IpAccessSettingsAssociation, error)public IpAccessSettingsAssociation(string name, IpAccessSettingsAssociationArgs args, CustomResourceOptions? opts = null)
public IpAccessSettingsAssociation(String name, IpAccessSettingsAssociationArgs args)
public IpAccessSettingsAssociation(String name, IpAccessSettingsAssociationArgs args, CustomResourceOptions options)
type: aws:workspacesweb:IpAccessSettingsAssociation
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 IpAccessSettingsAssociationArgs
- 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 IpAccessSettingsAssociationArgs
- 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 IpAccessSettingsAssociationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IpAccessSettingsAssociationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IpAccessSettingsAssociationArgs
- 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 ipAccessSettingsAssociationResource = new Aws.WorkSpacesWeb.IpAccessSettingsAssociation("ipAccessSettingsAssociationResource", new()
{
IpAccessSettingsArn = "string",
PortalArn = "string",
Region = "string",
});
example, err := workspacesweb.NewIpAccessSettingsAssociation(ctx, "ipAccessSettingsAssociationResource", &workspacesweb.IpAccessSettingsAssociationArgs{
IpAccessSettingsArn: pulumi.String("string"),
PortalArn: pulumi.String("string"),
Region: pulumi.String("string"),
})
var ipAccessSettingsAssociationResource = new IpAccessSettingsAssociation("ipAccessSettingsAssociationResource", IpAccessSettingsAssociationArgs.builder()
.ipAccessSettingsArn("string")
.portalArn("string")
.region("string")
.build());
ip_access_settings_association_resource = aws.workspacesweb.IpAccessSettingsAssociation("ipAccessSettingsAssociationResource",
ip_access_settings_arn="string",
portal_arn="string",
region="string")
const ipAccessSettingsAssociationResource = new aws.workspacesweb.IpAccessSettingsAssociation("ipAccessSettingsAssociationResource", {
ipAccessSettingsArn: "string",
portalArn: "string",
region: "string",
});
type: aws:workspacesweb:IpAccessSettingsAssociation
properties:
ipAccessSettingsArn: string
portalArn: string
region: string
IpAccessSettingsAssociation 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 IpAccessSettingsAssociation resource accepts the following input properties:
- Ip
Access stringSettings Arn - ARN of the IP access settings to associate with the portal. Forces replacement if changed.
- Portal
Arn string ARN of the portal to associate with the IP access settings. Forces replacement if changed.
The following arguments are optional:
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Ip
Access stringSettings Arn - ARN of the IP access settings to associate with the portal. Forces replacement if changed.
- Portal
Arn string ARN of the portal to associate with the IP access settings. Forces replacement if changed.
The following arguments are optional:
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- ip
Access StringSettings Arn - ARN of the IP access settings to associate with the portal. Forces replacement if changed.
- portal
Arn String ARN of the portal to associate with the IP access settings. Forces replacement if changed.
The following arguments are optional:
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- ip
Access stringSettings Arn - ARN of the IP access settings to associate with the portal. Forces replacement if changed.
- portal
Arn string ARN of the portal to associate with the IP access settings. Forces replacement if changed.
The following arguments are optional:
- region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- ip_
access_ strsettings_ arn - ARN of the IP access settings to associate with the portal. Forces replacement if changed.
- portal_
arn str ARN of the portal to associate with the IP access settings. Forces replacement if changed.
The following arguments are optional:
- region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- ip
Access StringSettings Arn - ARN of the IP access settings to associate with the portal. Forces replacement if changed.
- portal
Arn String ARN of the portal to associate with the IP access settings. Forces replacement if changed.
The following arguments are optional:
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
Outputs
All input properties are implicitly available as output properties. Additionally, the IpAccessSettingsAssociation resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing IpAccessSettingsAssociation Resource
Get an existing IpAccessSettingsAssociation 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?: IpAccessSettingsAssociationState, opts?: CustomResourceOptions): IpAccessSettingsAssociation@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
ip_access_settings_arn: Optional[str] = None,
portal_arn: Optional[str] = None,
region: Optional[str] = None) -> IpAccessSettingsAssociationfunc GetIpAccessSettingsAssociation(ctx *Context, name string, id IDInput, state *IpAccessSettingsAssociationState, opts ...ResourceOption) (*IpAccessSettingsAssociation, error)public static IpAccessSettingsAssociation Get(string name, Input<string> id, IpAccessSettingsAssociationState? state, CustomResourceOptions? opts = null)public static IpAccessSettingsAssociation get(String name, Output<String> id, IpAccessSettingsAssociationState state, CustomResourceOptions options)resources: _: type: aws:workspacesweb:IpAccessSettingsAssociation 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.
- Ip
Access stringSettings Arn - ARN of the IP access settings to associate with the portal. Forces replacement if changed.
- Portal
Arn string ARN of the portal to associate with the IP access settings. Forces replacement if changed.
The following arguments are optional:
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Ip
Access stringSettings Arn - ARN of the IP access settings to associate with the portal. Forces replacement if changed.
- Portal
Arn string ARN of the portal to associate with the IP access settings. Forces replacement if changed.
The following arguments are optional:
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- ip
Access StringSettings Arn - ARN of the IP access settings to associate with the portal. Forces replacement if changed.
- portal
Arn String ARN of the portal to associate with the IP access settings. Forces replacement if changed.
The following arguments are optional:
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- ip
Access stringSettings Arn - ARN of the IP access settings to associate with the portal. Forces replacement if changed.
- portal
Arn string ARN of the portal to associate with the IP access settings. Forces replacement if changed.
The following arguments are optional:
- region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- ip_
access_ strsettings_ arn - ARN of the IP access settings to associate with the portal. Forces replacement if changed.
- portal_
arn str ARN of the portal to associate with the IP access settings. Forces replacement if changed.
The following arguments are optional:
- region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- ip
Access StringSettings Arn - ARN of the IP access settings to associate with the portal. Forces replacement if changed.
- portal
Arn String ARN of the portal to associate with the IP access settings. Forces replacement if changed.
The following arguments are optional:
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.
