[ aws . privatenetworks ]

create-network-site

Description

Creates a network site.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-network-site
[--availability-zone <value>]
[--availability-zone-id <value>]
[--client-token <value>]
[--description <value>]
--network-arn <value>
--network-site-name <value>
[--pending-plan <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--availability-zone (string)

The Availability Zone that is the parent of this site. You can’t change the Availability Zone after you create the site.

--availability-zone-id (string)

The ID of the Availability Zone that is the parent of this site. You can’t change the Availability Zone after you create the site.

--client-token (string)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency .

--description (string)

The description of the site.

--network-arn (string)

The Amazon Resource Name (ARN) of the network.

--network-site-name (string)

The name of the site. You can’t change the name after you create the site.

--pending-plan (structure)

Information about the pending plan for this site.

options -> (list)

The options of the plan.

(structure)

Information about a name/value pair.

name -> (string)

The name of the pair.

value -> (string)

The value of the pair.

resourceDefinitions -> (list)

The resource definitions of the plan.

(structure)

Information about a network resource definition.

count -> (integer)

The count in the network resource definition.

options -> (list)

The options in the network resource definition.

(structure)

Information about a name/value pair.

name -> (string)

The name of the pair.

value -> (string)

The value of the pair.

type -> (string)

The type in the network resource definition.

JSON Syntax:

{
  "options": [
    {
      "name": "string",
      "value": "string"
    }
    ...
  ],
  "resourceDefinitions": [
    {
      "count": integer,
      "options": [
        {
          "name": "string",
          "value": "string"
        }
        ...
      ],
      "type": "RADIO_UNIT"|"DEVICE_IDENTIFIER"
    }
    ...
  ]
}

--tags (map)

The tags to apply to the network site.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

networkSite -> (structure)

Information about the network site.

availabilityZone -> (string)

The parent Availability Zone for the network site.

availabilityZoneId -> (string)

The parent Availability Zone ID for the network site.

createdAt -> (timestamp)

The creation time of the network site.

currentPlan -> (structure)

The current plan of the network site.

options -> (list)

The options of the plan.

(structure)

Information about a name/value pair.

name -> (string)

The name of the pair.

value -> (string)

The value of the pair.

resourceDefinitions -> (list)

The resource definitions of the plan.

(structure)

Information about a network resource definition.

count -> (integer)

The count in the network resource definition.

options -> (list)

The options in the network resource definition.

(structure)

Information about a name/value pair.

name -> (string)

The name of the pair.

value -> (string)

The value of the pair.

type -> (string)

The type in the network resource definition.

description -> (string)

The description of the network site.

networkArn -> (string)

The Amazon Resource Name (ARN) of the network to which the network site belongs.

networkSiteArn -> (string)

The Amazon Resource Name (ARN) of the network site.

networkSiteName -> (string)

The name of the network site.

pendingPlan -> (structure)

The pending plan of the network site.

options -> (list)

The options of the plan.

(structure)

Information about a name/value pair.

name -> (string)

The name of the pair.

value -> (string)

The value of the pair.

resourceDefinitions -> (list)

The resource definitions of the plan.

(structure)

Information about a network resource definition.

count -> (integer)

The count in the network resource definition.

options -> (list)

The options in the network resource definition.

(structure)

Information about a name/value pair.

name -> (string)

The name of the pair.

value -> (string)

The value of the pair.

type -> (string)

The type in the network resource definition.

status -> (string)

The status of the network site.

statusReason -> (string)

The status reason of the network site.

tags -> (map)

The network site tags.

key -> (string)

value -> (string)