Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . workspaces-web ]

create-network-settings

Description

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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-network-settings
[--client-token <value>]
--security-group-ids <value>
--subnet-ids <value>
[--tags <value>]
--vpc-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

--security-group-ids (list)

One or more security groups used to control access from streaming instances to your VPC.

(string)

Syntax:

"string" "string" ...

--subnet-ids (list)

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.

(string)

Syntax:

"string" "string" ...

--tags (list)

The tags to add to the network settings resource. A tag is a key-value pair.

(structure)

The tag.

Key -> (string)

The key of the tag.

Value -> (string)

The value of the tag

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--vpc-id (string)

The VPC that streaming instances will connect to.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

networkSettingsArn -> (string)

The ARN of the network settings.