network_settings

Creates, updates, deletes, gets or lists a network_settings resource.

Overview

Name	network_settings
Type	Resource
Id	aws.workspaces_web.network_settings

Fields

The following fields are returned by SELECT queries:

get_network_settings

Name	Datatype	Description
associated_portal_arns	array	A list of web portal ARNs that this network settings is associated with.
network_settings_arn	string	The ARN of the network settings. (pattern: <code>arn:[\w+=/,.@-]+:[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(/[a-fA-F0-9-]{36})+</code>)
security_group_ids	array	One or more security groups used to control access from streaming instances to your VPC.
subnet_ids	array	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.
vpc_id	string	The VPC that streaming instances will connect to. (pattern: <code>vpc-[0-9a-z]*</code>)

list_network_settings

Name	Datatype	Description
network_settings	array	The network settings.
next_token	string	The pagination token used to retrieve the next page of results for this operation. (pattern: <code>\S+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_network_settings	select	network_settings_arn, region		Gets the network settings.
list_network_settings	select	region	nextToken, maxResults	Retrieves a list of network settings.
create_network_settings	insert	region, vpcId, subnetIds, securityGroupIds		Creates a network settings resource 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.
associate_network_settings	update	portal_arn, networkSettingsArn, region		Associates a network settings resource with a web portal.
disassociate_network_settings	update	portal_arn, region		Disassociates network settings from a web portal.
update_network_settings	update	network_settings_arn, region		Updates network settings.
delete_network_settings	delete	network_settings_arn, region		Deletes network settings.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
networkSettingsArn	string	The ARN of the network settings.
network_settings_arn	string	The ARN of the network settings.
portal_arn	string	The ARN of the web portal.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to be included in the next page.
nextToken	string	The pagination token used to retrieve the next page of results for this operation.

SELECT examples

get_network_settings

Gets the network settings.

SELECT
associated_portal_arns,
network_settings_arn,
security_group_ids,
subnet_ids,
vpc_id
FROM aws.workspaces_web.network_settings
WHERE network_settings_arn = '{{ network_settings_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_network_settings

Retrieves a list of network settings.

SELECT
network_settings,
next_token
FROM aws.workspaces_web.network_settings
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_network_settings

Creates a network settings resource 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.

INSERT INTO aws.workspaces_web.network_settings (
vpcId,
subnetIds,
securityGroupIds,
tags,
clientToken,
region
)
SELECT 
'{{ vpcId }}' /* required */,
'{{ subnetIds }}' /* required */,
'{{ securityGroupIds }}' /* required */,
'{{ tags }}',
'{{ clientToken }}',
'{{ region }}'
RETURNING
network_settings_arn
;

Manifest

# Description fields are for documentation purposes
- name: network_settings
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the network_settings resource.
  - name: vpcId
    value: "{{ vpcId }}"
  - name: subnetIds
    value:
      - "{{ subnetIds }}"
  - name: securityGroupIds
    value:
      - "{{ securityGroupIds }}"
  - name: tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: clientToken
    value: "{{ clientToken }}"

UPDATE examples

associate_network_settings

Associates a network settings resource with a web portal.

UPDATE aws.workspaces_web.network_settings
SET 
-- No updatable properties
WHERE 
portal_arn = '{{ portal_arn }}' --required
AND networkSettingsArn = '{{ networkSettingsArn }}' --required
AND region = '{{ region }}' --required
RETURNING
network_settings_arn,
portal_arn;

disassociate_network_settings

Disassociates network settings from a web portal.

UPDATE aws.workspaces_web.network_settings
SET 
-- No updatable properties
WHERE 
portal_arn = '{{ portal_arn }}' --required
AND region = '{{ region }}' --required;

update_network_settings

Updates network settings.

UPDATE aws.workspaces_web.network_settings
SET 
vpcId = '{{ vpcId }}',
subnetIds = '{{ subnetIds }}',
securityGroupIds = '{{ securityGroupIds }}',
clientToken = '{{ clientToken }}'
WHERE 
network_settings_arn = '{{ network_settings_arn }}' --required
AND region = '{{ region }}' --required
RETURNING
network_settings;

DELETE examples

delete_network_settings

Deletes network settings.

DELETE FROM aws.workspaces_web.network_settings
WHERE network_settings_arn = '{{ network_settings_arn }}' --required
AND region = '{{ region }}' --required
;