This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::WorkSpacesWeb::NetworkSettings
<a name="aws-resource-workspacesweb-networksettings"></a>

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](https://docs.aws.amazon.com/workspaces-web/latest/adminguide/availability-zones.html).

## Syntax
<a name="aws-resource-workspacesweb-networksettings-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-workspacesweb-networksettings-syntax.json"></a>

```
{
  "Type" : "AWS::WorkSpacesWeb::NetworkSettings",
  "Properties" : {
      "[SecurityGroupIds](#cfn-workspacesweb-networksettings-securitygroupids)" : [ String, ... ],
      "[SubnetIds](#cfn-workspacesweb-networksettings-subnetids)" : [ String, ... ],
      "[Tags](#cfn-workspacesweb-networksettings-tags)" : [ Tag, ... ],
      "[VpcId](#cfn-workspacesweb-networksettings-vpcid)" : String
    }
}
```

### YAML
<a name="aws-resource-workspacesweb-networksettings-syntax.yaml"></a>

```
Type: AWS::WorkSpacesWeb::NetworkSettings
Properties:
  [SecurityGroupIds](#cfn-workspacesweb-networksettings-securitygroupids): 
    - String
  [SubnetIds](#cfn-workspacesweb-networksettings-subnetids): 
    - String
  [Tags](#cfn-workspacesweb-networksettings-tags): 
    - Tag
  [VpcId](#cfn-workspacesweb-networksettings-vpcid): String
```

## Properties
<a name="aws-resource-workspacesweb-networksettings-properties"></a>

`SecurityGroupIds`  <a name="cfn-workspacesweb-networksettings-securitygroupids"></a>
One or more security groups used to control access from streaming instances to your VPC.  
*Pattern*: `^[\w+\-]+$`  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1 | 1`  
*Maximum*: `128 | 5`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SubnetIds`  <a name="cfn-workspacesweb-networksettings-subnetids"></a>
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})$`  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1 | 2`  
*Maximum*: `32 | 3`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-workspacesweb-networksettings-tags"></a>
The tags to add to the network settings resource. A tag is a key-value pair.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-workspacesweb-networksettings-tag.md)  
*Minimum*: `0`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VpcId`  <a name="cfn-workspacesweb-networksettings-vpcid"></a>
The VPC that streaming instances will connect to.  
*Pattern*: `^vpc-[0-9a-z]*$`  
*Required*: Yes  
*Type*: String  
*Pattern*: `^vpc-[0-9a-z]*$`  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-workspacesweb-networksettings-return-values"></a>

### Ref
<a name="aws-resource-workspacesweb-networksettings-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource's Amazon Resource Name (ARN).

For more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-workspacesweb-networksettings-return-values-fn--getatt"></a>

#### 
<a name="aws-resource-workspacesweb-networksettings-return-values-fn--getatt-fn--getatt"></a>

`AssociatedPortalArns`  <a name="AssociatedPortalArns-fn::getatt"></a>
A list of web portal ARNs that this network settings is associated with.

`NetworkSettingsArn`  <a name="NetworkSettingsArn-fn::getatt"></a>
The ARN of the network settings.

# AWS::WorkSpacesWeb::NetworkSettings Tag
<a name="aws-properties-workspacesweb-networksettings-tag"></a>

The tag.

## Syntax
<a name="aws-properties-workspacesweb-networksettings-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-workspacesweb-networksettings-tag-syntax.json"></a>

```
{
  "[Key](#cfn-workspacesweb-networksettings-tag-key)" : String,
  "[Value](#cfn-workspacesweb-networksettings-tag-value)" : String
}
```

### YAML
<a name="aws-properties-workspacesweb-networksettings-tag-syntax.yaml"></a>

```
  [Key](#cfn-workspacesweb-networksettings-tag-key): String
  [Value](#cfn-workspacesweb-networksettings-tag-value): String
```

## Properties
<a name="aws-properties-workspacesweb-networksettings-tag-properties"></a>

`Key`  <a name="cfn-workspacesweb-networksettings-tag-key"></a>
The key of the tag.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-workspacesweb-networksettings-tag-value"></a>
The value of the tag  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)