site_address

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

Overview

Name	site_address
Type	Resource
Id	aws.outposts.site_address

Fields

The following fields are returned by SELECT queries:

get_site_address

Name	Datatype	Description
address	object	Information about an address.
address_type	string	The type of the address you receive. (SHIPPING_ADDRESS, OPERATING_ADDRESS)
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>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_site_address	select	site_id, AddressType, region		Gets the site address of the specified site.
update_site_address	update	site_id, region, AddressType		Updates the address of the specified site. You can't update a site address if there is an order in progress. You must wait for the order to complete or cancel the order. You can update the operating address before you place an order at the site, or after all Outposts that belong to the site have been deactivated.

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
AddressType	string	The type of the address you request.
region	string	AWS region (default: us-east-1)
site_id	string	The ID or the Amazon Resource Name (ARN) of the site.

SELECT examples

get_site_address

Gets the site address of the specified site.

SELECT
address,
address_type,
site_id
FROM aws.outposts.site_address
WHERE site_id = '{{ site_id }}' -- required
AND AddressType = '{{ AddressType }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_site_address

Updates the address of the specified site. You can't update a site address if there is an order in progress. You must wait for the order to complete or cancel the order. You can update the operating address before you place an order at the site, or after all Outposts that belong to the site have been deactivated.

UPDATE aws.outposts.site_address
SET 
AddressType = '{{ AddressType }}',
Address = '{{ Address }}'
WHERE 
site_id = '{{ site_id }}' --required
AND region = '{{ region }}' --required
AND AddressType = '{{ AddressType }}' --required
RETURNING
address,
address_type;