Package software.amazon.awscdk.services.workspaces

Interface CfnWorkspaceIpGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkspaceIpGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-08-10T14:51:13.867Z")
@Stability(Stable)
public interface CfnWorkspaceIpGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnWorkspaceIpGroup.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.workspaces.*;
 CfnWorkspaceIpGroupProps cfnWorkspaceIpGroupProps = CfnWorkspaceIpGroupProps.builder()
         .groupName("groupName")
         // the properties below are optional
         .groupDesc("groupDesc")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .userRules(List.of(IpRuleItemProperty.builder()
                 .ipRule("ipRule")
                 // the properties below are optional
                 .ruleDesc("ruleDesc")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspaceipgroup.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWorkspaceIpGroupProps.Builder	A builder for CfnWorkspaceIpGroupProps
static final class	CfnWorkspaceIpGroupProps.Jsii$Proxy	An implementation for CfnWorkspaceIpGroupProps

Method Summary

Modifier and Type	Method	Description
static CfnWorkspaceIpGroupProps.Builder	builder()
default String	getGroupDesc()	The description of the group.
String	getGroupName()	The name of the group.
default List<CfnTag>	getTags()	The tags for the IP access control group.
default Object	getUserRules()	The rules for the IP access control group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getGroupName

@Stability(Stable)
@NotNull
String getGroupName()

The name of the group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspaceipgroup.html#cfn-workspaces-workspaceipgroup-groupname

getGroupDesc

@Stability(Stable)
@Nullable
default String getGroupDesc()

The description of the group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspaceipgroup.html#cfn-workspaces-workspaceipgroup-groupdesc

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags for the IP access control group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspaceipgroup.html#cfn-workspaces-workspaceipgroup-tags

getUserRules

@Stability(Stable)
@Nullable
default Object getUserRules()

The rules for the IP access control group.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnWorkspaceIpGroup.IpRuleItemProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspaceipgroup.html#cfn-workspaces-workspaceipgroup-userrules

builder

@Stability(Stable)
static CfnWorkspaceIpGroupProps.Builder builder()

Returns:

a CfnWorkspaceIpGroupProps.Builder of CfnWorkspaceIpGroupProps