Package software.amazon.awscdk.services.workspacesweb

Class CfnNetworkSettings

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.workspacesweb.CfnNetworkSettings
All Implemented Interfaces:
IInspectable, IEnvironmentAware, INetworkSettingsRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:19.639Z") @Stability(Stable) public class CfnNetworkSettings extends CfnResource implements IInspectable, INetworkSettingsRef, ITaggableV2
This resource specifies network settings that can be associated with a web portal.

Once associated with a web portal, network settings define how streaming instances will connect with your specified VPC.

The VPC must have default tenancy. VPCs with dedicated tenancy are not supported.

For availability consideration, you must have at least two subnets created in two different Availability Zones. WorkSpaces Secure Browser is available in a subset of the Availability Zones for each supported Region. For more information, see Supported Availability Zones .

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.workspacesweb.*;
 CfnNetworkSettings cfnNetworkSettings = CfnNetworkSettings.Builder.create(this, "MyCfnNetworkSettings")
         .securityGroupIds(List.of("securityGroupIds"))
         .subnetIds(List.of("subnetIds"))
         .vpcId("vpcId")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .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

    • CfnNetworkSettings

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

    • CfnNetworkSettings

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

    • CfnNetworkSettings

      @Stability(Stable) public CfnNetworkSettings(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnNetworkSettingsProps props)
      Create a new AWS::WorkSpacesWeb::NetworkSettings.

      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

    • arnForNetworkSettings

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

    • isCfnNetworkSettings

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

      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.

    • getAttrAssociatedPortalArns

      @Stability(Stable) @NotNull public List<String> getAttrAssociatedPortalArns()
      A list of web portal ARNs that this network settings is associated with.

    • getAttrNetworkSettingsArn

      @Stability(Stable) @NotNull public String getAttrNetworkSettingsArn()
      The ARN of the network settings.

    • 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

    • getNetworkSettingsRef

      @Stability(Stable) @NotNull public NetworkSettingsReference getNetworkSettingsRef()
      A reference to a NetworkSettings resource.
      Specified by:
      getNetworkSettingsRef in interface INetworkSettingsRef

    • getSecurityGroupIds

      @Stability(Stable) @NotNull public List<String> getSecurityGroupIds()
      One or more security groups used to control access from streaming instances to your VPC.

    • setSecurityGroupIds

      @Stability(Stable) public void setSecurityGroupIds(@NotNull List<String> value)
      One or more security groups used to control access from streaming instances to your VPC.

    • getSubnetIds

      @Stability(Stable) @NotNull public List<String> getSubnetIds()
      The subnets in which network interfaces are created to connect streaming instances to your VPC.

    • setSubnetIds

      @Stability(Stable) public void setSubnetIds(@NotNull List<String> value)
      The subnets in which network interfaces are created to connect streaming instances to your VPC.

    • getVpcId

      @Stability(Stable) @NotNull public String getVpcId()
      The VPC that streaming instances will connect to.

    • setVpcId

      @Stability(Stable) public void setVpcId(@NotNull String value)
      The VPC that streaming instances will connect to.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags to add to the network settings resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags to add to the network settings resource.