Skip to content
v2.278.0

CfnNetworkSettingsProps Struct ​

Properties for defining a CfnNetworkSettings.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_workspacesweb as workspacesweb } from 'aws-cdk-lib';
const cfnNetworkSettingsProps: workspacesweb.CfnNetworkSettingsProps = {
  securityGroupIds: ['securityGroupIds'],
  subnetIds: ['subnetIds'],
  vpcId: 'vpcId',

  // the properties below are optional
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_workspacesweb as workspacesweb

cfn_network_settings_props = workspacesweb.CfnNetworkSettingsProps(
    security_group_ids=["securityGroupIds"],
    subnet_ids=["subnetIds"],
    vpc_id="vpcId",

    # the properties below are optional
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
java
// 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.*;

CfnNetworkSettingsProps cfnNetworkSettingsProps = CfnNetworkSettingsProps.builder()
        .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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.WorkSpacesWeb;

var cfnNetworkSettingsProps = new CfnNetworkSettingsProps {
    SecurityGroupIds = new [] { "securityGroupIds" },
    SubnetIds = new [] { "subnetIds" },
    VpcId = "vpcId",

    // the properties below are optional
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnNetworkSettingsProps := &CfnNetworkSettingsProps{
	SecurityGroupIds: []*string{
		jsii.String("securityGroupIds"),
	},
	SubnetIds: []*string{
		jsii.String("subnetIds"),
	},
	VpcId: jsii.String("vpcId"),

	// the properties below are optional
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

securityGroupIdsstring[]security_group_idstyping.List[str]securityGroupIdsList<String>SecurityGroupIdsstring[]SecurityGroupIds*[]*string required #
One or more security groups used to control access from streaming instances to your VPC.

Pattern : ^[\w+\-]+$

subnetIdsstring[]subnet_idstyping.List[str]subnetIdsList<String>SubnetIdsstring[]SubnetIds*[]*string required #
The subnets in which network interfaces are created to connect streaming instances to your VPC.

At least two of these subnets must be in different availability zones.

Pattern : ^subnet-([0-9a-f]{8}|[0-9a-f]{17})$

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #
The tags to add to the network settings resource.

A tag is a key-value pair.

vpcIdstringvpc_idstrvpcIdStringVpcIdstringVpcId*string required #
The VPC that streaming instances will connect to.

Pattern : ^vpc-[0-9a-z]*$