sites

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

Overview

Name	`sites`
Type	Resource
Id	`aws.outposts.sites`

Fields

The following fields are returned by SELECT queries:

get_site
list_sites

Name	Datatype	Description
`account_id`	`string`	The ID of the Amazon Web Services account. (pattern: <code>\d{12}</code>)
`description`	`string`	The description of the site. (pattern: <code>^[\S ]+$</code>)
`name`	`string`	The name of the site. (pattern: <code>^[\S ]+$</code>)
`notes`	`string`	Notes about a site. (pattern: <code>^[\S \n]+$</code>)
`operating_address_city`	`string`	City where the hardware is installed and powered on. (pattern: <code>^\S[\S ]*$</code>)
`operating_address_country_code`	`string`	The ISO-3166 two-letter country code where the hardware is installed and powered on. (pattern: <code>^[A-Z]{2}$</code>)
`operating_address_state_or_region`	`string`	State or region where the hardware is installed and powered on. (pattern: <code>^\S[\S ]*$</code>)
`rack_physical_properties`	`object`	Information about the physical and logistical details for racks at sites. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide.
`site_arn`	`string`	The Amazon Resource Name (ARN) of the site. (pattern: <code>^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/(os-[a-f0-9]{17})$</code>)
`site_id`	`string`	The ID of the site. (pattern: <code>^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/)?(os-[a-f0-9]{17})$</code>)
`tags`	`object`	The site tags.

Name	Datatype	Description
`account_id`	`string`	The ID of the Amazon Web Services account. (pattern: <code>\d{12}</code>)
`description`	`string`	The description of the site. (pattern: <code>^[\S ]+$</code>)
`name`	`string`	The name of the site. (pattern: <code>^[\S ]+$</code>)
`notes`	`string`	Notes about a site. (pattern: <code>^[\S \n]+$</code>)
`operating_address_city`	`string`	City where the hardware is installed and powered on. (pattern: <code>^\S[\S ]*$</code>)
`operating_address_country_code`	`string`	The ISO-3166 two-letter country code where the hardware is installed and powered on. (pattern: <code>^[A-Z]{2}$</code>)
`operating_address_state_or_region`	`string`	State or region where the hardware is installed and powered on. (pattern: <code>^\S[\S ]*$</code>)
`rack_physical_properties`	`object`	Information about the physical and logistical details for racks at sites. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide.
`site_arn`	`string`	The Amazon Resource Name (ARN) of the site. (pattern: <code>^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/(os-[a-f0-9]{17})$</code>)
`site_id`	`string`	The ID of the site. (pattern: <code>^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/)?(os-[a-f0-9]{17})$</code>)
`tags`	`object`	The site tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get_site`	`select`	`site_id`, `region`		Gets information about the specified Outpost site.
`list_sites`	`select`	`region`	`NextToken`, `MaxResults`, `OperatingAddressCountryCodeFilter`, `OperatingAddressStateOrRegionFilter`, `OperatingAddressCityFilter`	Lists the Outpost sites for your Amazon Web Services account. Use filters to return specific results. Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.
`create_site`	`insert`	`region`		Creates a site for an Outpost.
`update_site`	`update`	`site_id`, `region`		Updates the specified site.
`delete_site`	`delete`	`site_id`, `region`		Deletes the specified site.
`update_site_rack_physical_properties`	`exec`	`site_id`, `region`		Update the physical and logistical details for a rack at a site. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide. To update a rack at a site with an order of IN_PROGRESS, you must wait for the order to complete or cancel the order.

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
`region`	`string`	AWS region (default: us-east-1)
`site_id`	`string`	The ID or the Amazon Resource Name (ARN) of the site.
`MaxResults`	`integer`
`NextToken`	`string`
`OperatingAddressCityFilter`	`array`	Filters the results by city.
`OperatingAddressCountryCodeFilter`	`array`	Filters the results by country code.
`OperatingAddressStateOrRegionFilter`	`array`	Filters the results by state or region.

`SELECT` examples

get_site
list_sites

Gets information about the specified Outpost site.

SELECT
account_id,
description,
name,
notes,
operating_address_city,
operating_address_country_code,
operating_address_state_or_region,
rack_physical_properties,
site_arn,
site_id,
tags
FROM aws.outposts.sites
WHERE site_id = '{{ site_id }}' -- required
AND region = '{{ region }}' -- required
;

Lists the Outpost sites for your Amazon Web Services account. Use filters to return specific results. Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

SELECT
account_id,
description,
name,
notes,
operating_address_city,
operating_address_country_code,
operating_address_state_or_region,
rack_physical_properties,
site_arn,
site_id,
tags
FROM aws.outposts.sites
WHERE region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
AND OperatingAddressCountryCodeFilter = '{{ OperatingAddressCountryCodeFilter }}'
AND OperatingAddressStateOrRegionFilter = '{{ OperatingAddressStateOrRegionFilter }}'
AND OperatingAddressCityFilter = '{{ OperatingAddressCityFilter }}'
;

`INSERT` examples

create_site
Manifest

Creates a site for an Outpost.

INSERT INTO aws.outposts.sites (
Name,
Description,
Notes,
Tags,
OperatingAddress,
ShippingAddress,
RackPhysicalProperties,
region
)
SELECT 
'{{ Name }}',
'{{ Description }}',
'{{ Notes }}',
'{{ Tags }}',
'{{ OperatingAddress }}',
'{{ ShippingAddress }}',
'{{ RackPhysicalProperties }}',
'{{ region }}'
RETURNING
site
;

# Description fields are for documentation purposes
- name: sites
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the sites resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      The name of the site.
  - name: Description
    value: "{{ Description }}"
    description: |
      The description of the site.
  - name: Notes
    value: "{{ Notes }}"
  - name: Tags
    value: "{{ Tags }}"
  - name: OperatingAddress
    description: |
      Information about an address.
    value:
      ContactName: "{{ ContactName }}"
      ContactPhoneNumber: "{{ ContactPhoneNumber }}"
      AddressLine1: "{{ AddressLine1 }}"
      AddressLine2: "{{ AddressLine2 }}"
      AddressLine3: "{{ AddressLine3 }}"
      City: "{{ City }}"
      StateOrRegion: "{{ StateOrRegion }}"
      DistrictOrCounty: "{{ DistrictOrCounty }}"
      PostalCode: "{{ PostalCode }}"
      CountryCode: "{{ CountryCode }}"
      Municipality: "{{ Municipality }}"
  - name: ShippingAddress
    description: |
      Information about an address.
    value:
      ContactName: "{{ ContactName }}"
      ContactPhoneNumber: "{{ ContactPhoneNumber }}"
      AddressLine1: "{{ AddressLine1 }}"
      AddressLine2: "{{ AddressLine2 }}"
      AddressLine3: "{{ AddressLine3 }}"
      City: "{{ City }}"
      StateOrRegion: "{{ StateOrRegion }}"
      DistrictOrCounty: "{{ DistrictOrCounty }}"
      PostalCode: "{{ PostalCode }}"
      CountryCode: "{{ CountryCode }}"
      Municipality: "{{ Municipality }}"
  - name: RackPhysicalProperties
    description: |
      Information about the physical and logistical details for racks at sites. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide.
    value:
      PowerDrawKva: "{{ PowerDrawKva }}"
      PowerPhase: "{{ PowerPhase }}"
      PowerConnector: "{{ PowerConnector }}"
      PowerFeedDrop: "{{ PowerFeedDrop }}"
      UplinkGbps: "{{ UplinkGbps }}"
      UplinkCount: "{{ UplinkCount }}"
      FiberOpticCableType: "{{ FiberOpticCableType }}"
      OpticalStandard: "{{ OpticalStandard }}"
      MaximumSupportedWeightLbs: "{{ MaximumSupportedWeightLbs }}"

`UPDATE` examples

update_site

Updates the specified site.

UPDATE aws.outposts.sites
SET 
Name = '{{ Name }}',
Description = '{{ Description }}',
Notes = '{{ Notes }}'
WHERE 
site_id = '{{ site_id }}' --required
AND region = '{{ region }}' --required
RETURNING
site;

`DELETE` examples

delete_site

Deletes the specified site.

DELETE FROM aws.outposts.sites
WHERE site_id = '{{ site_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

update_site_rack_physical_properties

Update the physical and logistical details for a rack at a site. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide. To update a rack at a site with an order of IN_PROGRESS, you must wait for the order to complete or cancel the order.

EXEC aws.outposts.sites.update_site_rack_physical_properties 
@site_id='{{ site_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"PowerDrawKva": "{{ PowerDrawKva }}", 
"PowerPhase": "{{ PowerPhase }}", 
"PowerConnector": "{{ PowerConnector }}", 
"PowerFeedDrop": "{{ PowerFeedDrop }}", 
"UplinkGbps": "{{ UplinkGbps }}", 
"UplinkCount": "{{ UplinkCount }}", 
"FiberOpticCableType": "{{ FiberOpticCableType }}", 
"OpticalStandard": "{{ OpticalStandard }}", 
"MaximumSupportedWeightLbs": "{{ MaximumSupportedWeightLbs }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​