Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. workspaces
  5. IpGroup
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

aws.workspaces.IpGroup

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

Provides an IP access control group in AWS WorkSpaces Service

Example Usage

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

const contractors = new aws.workspaces.IpGroup("contractors", {
    name: "Contractors",
    description: "Contractors IP access control group",
    rules: [
        {
            source: "150.24.14.0/24",
            description: "NY",
        },
        {
            source: "125.191.14.85/32",
            description: "LA",
        },
        {
            source: "44.98.100.0/24",
            description: "STL",
        },
    ],
});
Copy
import pulumi
import pulumi_aws as aws

contractors = aws.workspaces.IpGroup("contractors",
    name="Contractors",
    description="Contractors IP access control group",
    rules=[
        {
            "source": "150.24.14.0/24",
            "description": "NY",
        },
        {
            "source": "125.191.14.85/32",
            "description": "LA",
        },
        {
            "source": "44.98.100.0/24",
            "description": "STL",
        },
    ])
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := workspaces.NewIpGroup(ctx, "contractors", &workspaces.IpGroupArgs{
			Name:        pulumi.String("Contractors"),
			Description: pulumi.String("Contractors IP access control group"),
			Rules: workspaces.IpGroupRuleArray{
				&workspaces.IpGroupRuleArgs{
					Source:      pulumi.String("150.24.14.0/24"),
					Description: pulumi.String("NY"),
				},
				&workspaces.IpGroupRuleArgs{
					Source:      pulumi.String("125.191.14.85/32"),
					Description: pulumi.String("LA"),
				},
				&workspaces.IpGroupRuleArgs{
					Source:      pulumi.String("44.98.100.0/24"),
					Description: pulumi.String("STL"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var contractors = new Aws.Workspaces.IpGroup("contractors", new()
    {
        Name = "Contractors",
        Description = "Contractors IP access control group",
        Rules = new[]
        {
            new Aws.Workspaces.Inputs.IpGroupRuleArgs
            {
                Source = "150.24.14.0/24",
                Description = "NY",
            },
            new Aws.Workspaces.Inputs.IpGroupRuleArgs
            {
                Source = "125.191.14.85/32",
                Description = "LA",
            },
            new Aws.Workspaces.Inputs.IpGroupRuleArgs
            {
                Source = "44.98.100.0/24",
                Description = "STL",
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.workspaces.IpGroup;
import com.pulumi.aws.workspaces.IpGroupArgs;
import com.pulumi.aws.workspaces.inputs.IpGroupRuleArgs;
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 contractors = new IpGroup("contractors", IpGroupArgs.builder()
            .name("Contractors")
            .description("Contractors IP access control group")
            .rules(            
                IpGroupRuleArgs.builder()
                    .source("150.24.14.0/24")
                    .description("NY")
                    .build(),
                IpGroupRuleArgs.builder()
                    .source("125.191.14.85/32")
                    .description("LA")
                    .build(),
                IpGroupRuleArgs.builder()
                    .source("44.98.100.0/24")
                    .description("STL")
                    .build())
            .build());

    }
}
Copy
resources:
  contractors:
    type: aws:workspaces:IpGroup
    properties:
      name: Contractors
      description: Contractors IP access control group
      rules:
        - source: 150.24.14.0/24
          description: NY
        - source: 125.191.14.85/32
          description: LA
        - source: 44.98.100.0/24
          description: STL
Copy

Create IpGroup Resource

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

Constructor syntax

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

@overload
def IpGroup(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            rules: Optional[Sequence[IpGroupRuleArgs]] = None,
            tags: Optional[Mapping[str, str]] = None)
func NewIpGroup(ctx *Context, name string, args *IpGroupArgs, opts ...ResourceOption) (*IpGroup, error)
public IpGroup(string name, IpGroupArgs? args = null, CustomResourceOptions? opts = null)
public IpGroup(String name, IpGroupArgs args)
public IpGroup(String name, IpGroupArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args IpGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args IpGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args IpGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args IpGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. IpGroupArgs
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 ipGroupResource = new Aws.Workspaces.IpGroup("ipGroupResource", new()
{
    Description = "string",
    Name = "string",
    Rules = new[]
    {
        new Aws.Workspaces.Inputs.IpGroupRuleArgs
        {
            Source = "string",
            Description = "string",
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := workspaces.NewIpGroup(ctx, "ipGroupResource", &workspaces.IpGroupArgs{
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Rules: workspaces.IpGroupRuleArray{
		&workspaces.IpGroupRuleArgs{
			Source:      pulumi.String("string"),
			Description: pulumi.String("string"),
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var ipGroupResource = new IpGroup("ipGroupResource", IpGroupArgs.builder()
    .description("string")
    .name("string")
    .rules(IpGroupRuleArgs.builder()
        .source("string")
        .description("string")
        .build())
    .tags(Map.of("string", "string"))
    .build());
Copy
ip_group_resource = aws.workspaces.IpGroup("ipGroupResource",
    description="string",
    name="string",
    rules=[{
        "source": "string",
        "description": "string",
    }],
    tags={
        "string": "string",
    })
Copy
const ipGroupResource = new aws.workspaces.IpGroup("ipGroupResource", {
    description: "string",
    name: "string",
    rules: [{
        source: "string",
        description: "string",
    }],
    tags: {
        string: "string",
    },
});
Copy
type: aws:workspaces:IpGroup
properties:
    description: string
    name: string
    rules:
        - description: string
          source: string
    tags:
        string: string
Copy

IpGroup 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 IpGroup resource accepts the following input properties:

Description Changes to this property will trigger replacement. string
The description of the IP group.
Name Changes to this property will trigger replacement. string
The name of the IP group.
Rules List<IpGroupRule>
One or more pairs specifying the IP group rule (in CIDR format) from which web requests originate.
Tags Dictionary<string, string>
A map of tags assigned to the WorkSpaces directory. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Description Changes to this property will trigger replacement. string
The description of the IP group.
Name Changes to this property will trigger replacement. string
The name of the IP group.
Rules []IpGroupRuleArgs
One or more pairs specifying the IP group rule (in CIDR format) from which web requests originate.
Tags map[string]string
A map of tags assigned to the WorkSpaces directory. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
description Changes to this property will trigger replacement. String
The description of the IP group.
name Changes to this property will trigger replacement. String
The name of the IP group.
rules List<IpGroupRule>
One or more pairs specifying the IP group rule (in CIDR format) from which web requests originate.
tags Map<String,String>
A map of tags assigned to the WorkSpaces directory. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
description Changes to this property will trigger replacement. string
The description of the IP group.
name Changes to this property will trigger replacement. string
The name of the IP group.
rules IpGroupRule[]
One or more pairs specifying the IP group rule (in CIDR format) from which web requests originate.
tags {[key: string]: string}
A map of tags assigned to the WorkSpaces directory. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
description Changes to this property will trigger replacement. str
The description of the IP group.
name Changes to this property will trigger replacement. str
The name of the IP group.
rules Sequence[IpGroupRuleArgs]
One or more pairs specifying the IP group rule (in CIDR format) from which web requests originate.
tags Mapping[str, str]
A map of tags assigned to the WorkSpaces directory. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
description Changes to this property will trigger replacement. String
The description of the IP group.
name Changes to this property will trigger replacement. String
The name of the IP group.
rules List<Property Map>
One or more pairs specifying the IP group rule (in CIDR format) from which web requests originate.
tags Map<String>
A map of tags assigned to the WorkSpaces directory. 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 IpGroup resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Id string
The provider-assigned unique ID for this managed resource.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

id string
The provider-assigned unique ID for this managed resource.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

id str
The provider-assigned unique ID for this managed resource.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String>
A 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 IpGroup Resource

Get an existing IpGroup 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?: IpGroupState, opts?: CustomResourceOptions): IpGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        rules: Optional[Sequence[IpGroupRuleArgs]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> IpGroup
func GetIpGroup(ctx *Context, name string, id IDInput, state *IpGroupState, opts ...ResourceOption) (*IpGroup, error)
public static IpGroup Get(string name, Input<string> id, IpGroupState? state, CustomResourceOptions? opts = null)
public static IpGroup get(String name, Output<String> id, IpGroupState state, CustomResourceOptions options)
resources:  _:    type: aws:workspaces:IpGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Description Changes to this property will trigger replacement. string
The description of the IP group.
Name Changes to this property will trigger replacement. string
The name of the IP group.
Rules List<IpGroupRule>
One or more pairs specifying the IP group rule (in CIDR format) from which web requests originate.
Tags Dictionary<string, string>
A map of tags assigned to the WorkSpaces directory. 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>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Description Changes to this property will trigger replacement. string
The description of the IP group.
Name Changes to this property will trigger replacement. string
The name of the IP group.
Rules []IpGroupRuleArgs
One or more pairs specifying the IP group rule (in CIDR format) from which web requests originate.
Tags map[string]string
A map of tags assigned to the WorkSpaces directory. 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
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

description Changes to this property will trigger replacement. String
The description of the IP group.
name Changes to this property will trigger replacement. String
The name of the IP group.
rules List<IpGroupRule>
One or more pairs specifying the IP group rule (in CIDR format) from which web requests originate.
tags Map<String,String>
A map of tags assigned to the WorkSpaces directory. 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>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

description Changes to this property will trigger replacement. string
The description of the IP group.
name Changes to this property will trigger replacement. string
The name of the IP group.
rules IpGroupRule[]
One or more pairs specifying the IP group rule (in CIDR format) from which web requests originate.
tags {[key: string]: string}
A map of tags assigned to the WorkSpaces directory. 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}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

description Changes to this property will trigger replacement. str
The description of the IP group.
name Changes to this property will trigger replacement. str
The name of the IP group.
rules Sequence[IpGroupRuleArgs]
One or more pairs specifying the IP group rule (in CIDR format) from which web requests originate.
tags Mapping[str, str]
A map of tags assigned to the WorkSpaces directory. 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]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

description Changes to this property will trigger replacement. String
The description of the IP group.
name Changes to this property will trigger replacement. String
The name of the IP group.
rules List<Property Map>
One or more pairs specifying the IP group rule (in CIDR format) from which web requests originate.
tags Map<String>
A map of tags assigned to the WorkSpaces directory. 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>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Supporting Types

IpGroupRule
, IpGroupRuleArgs

Source This property is required. string
The IP address range, in CIDR notation, e.g., 10.0.0.0/16
Description string
The description of the IP group.
Source This property is required. string
The IP address range, in CIDR notation, e.g., 10.0.0.0/16
Description string
The description of the IP group.
source This property is required. String
The IP address range, in CIDR notation, e.g., 10.0.0.0/16
description String
The description of the IP group.
source This property is required. string
The IP address range, in CIDR notation, e.g., 10.0.0.0/16
description string
The description of the IP group.
source This property is required. str
The IP address range, in CIDR notation, e.g., 10.0.0.0/16
description str
The description of the IP group.
source This property is required. String
The IP address range, in CIDR notation, e.g., 10.0.0.0/16
description String
The description of the IP group.

Import

Using pulumi import, import WorkSpaces IP groups using their GroupID. For example:

$ pulumi import aws:workspaces/ipGroup:IpGroup example wsipg-488lrtl3k
Copy

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 v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws