Package software.amazon.awscdk.services.workspaces

Class CfnWorkspaceIpGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.workspaces.CfnWorkspaceIpGroup
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IWorkspaceIpGroupRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-08-10T14:51:13.865Z") @Stability(Stable) public class CfnWorkspaceIpGroup extends CfnResource implements IInspectable, IWorkspaceIpGroupRef, ITaggableV2
Resource type definition for an IP access control group for Amazon WorkSpaces.

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.*;
 CfnWorkspaceIpGroup cfnWorkspaceIpGroup = CfnWorkspaceIpGroup.Builder.create(this, "MyCfnWorkspaceIpGroup")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnWorkspaceIpGroup

      protected CfnWorkspaceIpGroup(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnWorkspaceIpGroup

      protected CfnWorkspaceIpGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnWorkspaceIpGroup

      @Stability(Stable) public CfnWorkspaceIpGroup(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnWorkspaceIpGroupProps props)
      Create a new AWS::WorkSpaces::WorkspaceIpGroup.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForWorkspaceIpGroup

      @Stability(Stable) @NotNull public static String arnForWorkspaceIpGroup(@NotNull IWorkspaceIpGroupRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnWorkspaceIpGroup

      @Stability(Stable) @NotNull public static Boolean isCfnWorkspaceIpGroup(@NotNull Object x)
      Checks whether the given object is a CfnWorkspaceIpGroup.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the IP access control group.

    • getAttrGroupId

      @Stability(Stable) @NotNull public String getAttrGroupId()
      The identifier of the IP access control group.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getWorkspaceIpGroupRef

      @Stability(Stable) @NotNull public WorkspaceIpGroupReference getWorkspaceIpGroupRef()
      A reference to a WorkspaceIpGroup resource.
      Specified by:
      getWorkspaceIpGroupRef in interface IWorkspaceIpGroupRef

    • getGroupName

      @Stability(Stable) @NotNull public String getGroupName()
      The name of the group.

    • setGroupName

      @Stability(Stable) public void setGroupName(@NotNull String value)
      The name of the group.

    • getGroupDesc

      @Stability(Stable) @Nullable public String getGroupDesc()
      The description of the group.

    • setGroupDesc

      @Stability(Stable) public void setGroupDesc(@Nullable String value)
      The description of the group.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags for the IP access control group.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags for the IP access control group.

    • getUserRules

      @Stability(Stable) @Nullable public Object getUserRules()
      The rules for the IP access control group.

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

    • setUserRules

      @Stability(Stable) public void setUserRules(@Nullable IResolvable value)
      The rules for the IP access control group.

    • setUserRules

      @Stability(Stable) public void setUserRules(@Nullable List<Object> value)
      The rules for the IP access control group.