[ aws . outposts ]

create-site

Description

Creates a site for an Outpost.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-site
--name <value>
[--description <value>]
[--notes <value>]
[--tags <value>]
[--operating-address <value>]
[--shipping-address <value>]
[--rack-physical-properties <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the site.

--description (string)

The description of the site.

--notes (string)

Additional information that you provide about site access requirements, electrician scheduling, personal protective equipment, or regulation of equipment materials that could affect your installation process.

--tags (map)

The tags to apply to a site.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--operating-address (structure)

The location to install and power on the hardware. This address might be different from the shipping address.

ContactName -> (string)

The name of the contact.

ContactPhoneNumber -> (string)

The phone number of the contact.

AddressLine1 -> (string)

The first line of the address.

AddressLine2 -> (string)

The second line of the address.

AddressLine3 -> (string)

The third line of the address.

City -> (string)

The city for the address.

StateOrRegion -> (string)

The state for the address.

DistrictOrCounty -> (string)

The district or county for the address.

PostalCode -> (string)

The postal code for the address.

CountryCode -> (string)

The ISO-3166 two-letter country code for the address.

Municipality -> (string)

The municipality for the address.

Shorthand Syntax:

ContactName=string,ContactPhoneNumber=string,AddressLine1=string,AddressLine2=string,AddressLine3=string,City=string,StateOrRegion=string,DistrictOrCounty=string,PostalCode=string,CountryCode=string,Municipality=string

JSON Syntax:

{
  "ContactName": "string",
  "ContactPhoneNumber": "string",
  "AddressLine1": "string",
  "AddressLine2": "string",
  "AddressLine3": "string",
  "City": "string",
  "StateOrRegion": "string",
  "DistrictOrCounty": "string",
  "PostalCode": "string",
  "CountryCode": "string",
  "Municipality": "string"
}

--shipping-address (structure)

The location to ship the hardware. This address might be different from the operating address.

ContactName -> (string)

The name of the contact.

ContactPhoneNumber -> (string)

The phone number of the contact.

AddressLine1 -> (string)

The first line of the address.

AddressLine2 -> (string)

The second line of the address.

AddressLine3 -> (string)

The third line of the address.

City -> (string)

The city for the address.

StateOrRegion -> (string)

The state for the address.

DistrictOrCounty -> (string)

The district or county for the address.

PostalCode -> (string)

The postal code for the address.

CountryCode -> (string)

The ISO-3166 two-letter country code for the address.

Municipality -> (string)

The municipality for the address.

Shorthand Syntax:

ContactName=string,ContactPhoneNumber=string,AddressLine1=string,AddressLine2=string,AddressLine3=string,City=string,StateOrRegion=string,DistrictOrCounty=string,PostalCode=string,CountryCode=string,Municipality=string

JSON Syntax:

{
  "ContactName": "string",
  "ContactPhoneNumber": "string",
  "AddressLine1": "string",
  "AddressLine2": "string",
  "AddressLine3": "string",
  "City": "string",
  "StateOrRegion": "string",
  "DistrictOrCounty": "string",
  "PostalCode": "string",
  "CountryCode": "string",
  "Municipality": "string"
}

--rack-physical-properties (structure)

Information about the physical and logistical details for the rack at this site. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide.

PowerDrawKva -> (string)

The power draw available at the hardware placement position for the rack.

PowerPhase -> (string)

The power option that you can provide for hardware.

PowerConnector -> (string)

The power connector for the hardware.

PowerFeedDrop -> (string)

The position of the power feed.

UplinkGbps -> (string)

The uplink speed the rack supports for the connection to the Region.

UplinkCount -> (string)

The number of uplinks each Outpost network device.

FiberOpticCableType -> (string)

The type of fiber used to attach the Outpost to the network.

OpticalStandard -> (string)

The type of optical standard used to attach the Outpost to the network. This field is dependent on uplink speed, fiber type, and distance to the upstream device. For more information about networking requirements for racks, see Network in the Amazon Web Services Outposts User Guide.

MaximumSupportedWeightLbs -> (string)

The maximum rack weight that this site can support. NO_LIMIT is over 2000 lbs (907 kg).

Shorthand Syntax:

PowerDrawKva=string,PowerPhase=string,PowerConnector=string,PowerFeedDrop=string,UplinkGbps=string,UplinkCount=string,FiberOpticCableType=string,OpticalStandard=string,MaximumSupportedWeightLbs=string

JSON Syntax:

{
  "PowerDrawKva": "POWER_5_KVA"|"POWER_10_KVA"|"POWER_15_KVA",
  "PowerPhase": "SINGLE_PHASE"|"THREE_PHASE",
  "PowerConnector": "L6_30P"|"IEC309"|"AH530P7W"|"AH532P6W",
  "PowerFeedDrop": "ABOVE_RACK"|"BELOW_RACK",
  "UplinkGbps": "UPLINK_1G"|"UPLINK_10G"|"UPLINK_40G"|"UPLINK_100G",
  "UplinkCount": "UPLINK_COUNT_1"|"UPLINK_COUNT_2"|"UPLINK_COUNT_3"|"UPLINK_COUNT_4"|"UPLINK_COUNT_5"|"UPLINK_COUNT_6"|"UPLINK_COUNT_7"|"UPLINK_COUNT_8"|"UPLINK_COUNT_12"|"UPLINK_COUNT_16",
  "FiberOpticCableType": "SINGLE_MODE"|"MULTI_MODE",
  "OpticalStandard": "OPTIC_10GBASE_SR"|"OPTIC_10GBASE_IR"|"OPTIC_10GBASE_LR"|"OPTIC_40GBASE_SR"|"OPTIC_40GBASE_ESR"|"OPTIC_40GBASE_IR4_LR4L"|"OPTIC_40GBASE_LR4"|"OPTIC_100GBASE_SR4"|"OPTIC_100GBASE_CWDM4"|"OPTIC_100GBASE_LR4"|"OPTIC_100G_PSM4_MSA"|"OPTIC_1000BASE_LX"|"OPTIC_1000BASE_SX",
  "MaximumSupportedWeightLbs": "NO_LIMIT"|"MAX_1400_LBS"|"MAX_1600_LBS"|"MAX_1800_LBS"|"MAX_2000_LBS"
}

--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

Site -> (structure)

Information about a site.

SiteId -> (string)

The ID of the site.

AccountId -> (string)

The ID of the Amazon Web Services account.

Name -> (string)

The name of the site.

Description -> (string)

The description of the site.

Tags -> (map)

The site tags.

key -> (string)

value -> (string)

SiteArn -> (string)

The Amazon Resource Name (ARN) of the site.

Notes -> (string)

Notes about a site.

OperatingAddressCountryCode -> (string)

The ISO-3166 two-letter country code where the hardware is installed and powered on.

OperatingAddressStateOrRegion -> (string)

State or region where the hardware is installed and powered on.

OperatingAddressCity -> (string)

City where the hardware is installed and powered on.

RackPhysicalProperties -> (structure)

Information about the physical and logistical details for a rack at the site.

PowerDrawKva -> (string)

The power draw available at the hardware placement position for the rack.

PowerPhase -> (string)

The power option that you can provide for hardware.

PowerConnector -> (string)

The power connector for the hardware.

PowerFeedDrop -> (string)

The position of the power feed.

UplinkGbps -> (string)

The uplink speed the rack supports for the connection to the Region.

UplinkCount -> (string)

The number of uplinks each Outpost network device.

FiberOpticCableType -> (string)

The type of fiber used to attach the Outpost to the network.

OpticalStandard -> (string)

The type of optical standard used to attach the Outpost to the network. This field is dependent on uplink speed, fiber type, and distance to the upstream device. For more information about networking requirements for racks, see Network in the Amazon Web Services Outposts User Guide.

MaximumSupportedWeightLbs -> (string)

The maximum rack weight that this site can support. NO_LIMIT is over 2000 lbs (907 kg).