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	awscc.workspacesweb.network_settings

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
network_settings_arn	string
region	string	AWS region.

For more information, see AWS::WorkSpacesWeb::NetworkSettings.

Methods

Name	Resource	Accessible by	Required Params
create_resource	network_settings	INSERT	SecurityGroupIds, SubnetIds, VpcId, region
delete_resource	network_settings	DELETE	Identifier, region
update_resource	network_settings	UPDATE	Identifier, PatchDocument, region
list_resources	network_settings_list_only	SELECT	region
get_resource	network_settings	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.workspacesweb.network_settings
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ network_settings_arn }}';

list (identifiers only)

Lists all network_settings in a region.

SELECT
  region,
  network_settings_arn
FROM awscc.workspacesweb.network_settings_list_only
WHERE
  region = 'us-east-1';

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 awscc.workspacesweb.network_settings (
  SecurityGroupIds,
  SubnetIds,
  VpcId,
  region
)
SELECT
  '{{ security_group_ids }}',
  '{{ subnet_ids }}',
  '{{ vpc_id }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.workspacesweb.network_settings (
  SecurityGroupIds,
  SubnetIds,
  Tags,
  VpcId,
  region
)
SELECT
  '{{ security_group_ids }}',
  '{{ subnet_ids }}',
  '{{ tags }}',
  '{{ vpc_id }}',
  '{{ 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: security_group_ids
        value:
          - '{{ security_group_ids[0] }}'
      - name: subnet_ids
        value:
          - '{{ subnet_ids[0] }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: vpc_id
        value: '{{ vpc_id }}'

UPDATE example

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

/*+ update */
UPDATE awscc.workspacesweb.network_settings
SET PatchDocument = string('{{ {
    "SecurityGroupIds": security_group_ids,
    "SubnetIds": subnet_ids,
    "Tags": tags,
    "VpcId": vpc_id
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ network_settings_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.workspacesweb.network_settings
WHERE
  Identifier = '{{ network_settings_arn }}' 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