network_settings

Creates, updates, deletes or gets a network_setting resource or lists network_settings in a region

Overview

Name	network_settings
Type	Resource
Description	Definition of AWS::WorkSpacesWeb::NetworkSettings Resource Type
Id	aws.workspacesweb.network_settings

Fields

Name	Datatype	Description
associated_portal_arns	array
network_settings_arn	string
security_group_ids	array
subnet_ids	array
tags	array
vpc_id	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	SecurityGroupIds, SubnetIds, VpcId, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all network_settings in a region.

SELECT
region,
associated_portal_arns,
network_settings_arn,
security_group_ids,
subnet_ids,
tags,
vpc_id
FROM aws.workspacesweb.network_settings
WHERE region = 'us-east-1';

Gets all properties from an individual network_setting.

SELECT
region,
associated_portal_arns,
network_settings_arn,
security_group_ids,
subnet_ids,
tags,
vpc_id
FROM aws.workspacesweb.network_settings
WHERE region = 'us-east-1' AND data__Identifier = '<NetworkSettingsArn>';

INSERT example

Use the following StackQL query and manifest file to create a new network_setting resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.workspacesweb.network_settings (
 SecurityGroupIds,
 SubnetIds,
 VpcId,
 region
)
SELECT 
'{{ SecurityGroupIds }}',
 '{{ SubnetIds }}',
 '{{ VpcId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.workspacesweb.network_settings (
 SecurityGroupIds,
 SubnetIds,
 Tags,
 VpcId,
 region
)
SELECT 
 '{{ SecurityGroupIds }}',
 '{{ SubnetIds }}',
 '{{ Tags }}',
 '{{ VpcId }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: network_setting
    props:
      - name: SecurityGroupIds
        value:
          - '{{ SecurityGroupIds[0] }}'
      - name: SubnetIds
        value:
          - '{{ SubnetIds[0] }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: VpcId
        value: '{{ VpcId }}'

DELETE example

/*+ delete */
DELETE FROM aws.workspacesweb.network_settings
WHERE data__Identifier = '<NetworkSettingsArn>'
AND region = 'us-east-1';

Permissions

To operate on the network_settings resource, the following permissions are required:

Create

workspaces-web:CreateNetworkSettings,
workspaces-web:GetNetworkSettings,
workspaces-web:ListTagsForResource,
workspaces-web:TagResource

Read

workspaces-web:GetNetworkSettings,
workspaces-web:ListTagsForResource

Update

workspaces-web:UpdateNetworkSettings,
workspaces-web:UpdateResource,
workspaces-web:TagResource,
workspaces-web:UntagResource,
workspaces-web:GetNetworkSettings,
workspaces-web:ListTagsForResource

Delete

workspaces-web:GetNetworkSettings,
workspaces-web:DeleteNetworkSettings

List

workspaces-web:ListNetworkSettings