assets

Creates, updates, deletes, gets or lists an assets resource.

Overview

Name	assets
Type	Resource
Id	aws.outposts.assets

Fields

The following fields are returned by SELECT queries:

list_assets

Name	Datatype	Description
asset_id	string	The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration. (pattern: <code>^(\w+)$</code>)
asset_location	object	The position of an asset in a rack.
asset_type	string	The type of the asset. (COMPUTE, STORAGE, POWERSHELF, SWITCH, NETWORKING)
compute_attributes	object	Information about compute hardware assets.
rack_id	string	The rack ID of the asset. (pattern: <code>^[\S \n]+$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_assets	select	outpost_id, region	HostIdFilter, MaxResults, NextToken, StatusFilter, AssetTypeFilter	Lists the hardware assets for the specified Outpost. 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.
start_connection	exec	region, AssetId, ClientPublicKey, NetworkInterfaceDeviceIndex		Amazon Web Services uses this action to install Outpost servers. Starts the connection required for Outpost server installation. Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.

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
outpost_id	string	The ID or the Amazon Resource Name (ARN) of the Outpost.
region	string	AWS region (default: us-east-1)
AssetTypeFilter	array	Filters the results by asset type. COMPUTE - Server asset used for customer compute STORAGE - Server asset used by storage services POWERSHELF - Powershelf assets SWITCH - Switch assets NETWORKING - Asset managed by Amazon Web Services for networking purposes
HostIdFilter	array	Filters the results by the host ID of a Dedicated Host.
MaxResults	integer
NextToken	string
StatusFilter	array	Filters the results by state.

SELECT examples

list_assets

Lists the hardware assets for the specified Outpost. 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
asset_id,
asset_location,
asset_type,
compute_attributes,
rack_id
FROM aws.outposts.assets
WHERE outpost_id = '{{ outpost_id }}' -- required
AND region = '{{ region }}' -- required
AND HostIdFilter = '{{ HostIdFilter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND StatusFilter = '{{ StatusFilter }}'
AND AssetTypeFilter = '{{ AssetTypeFilter }}'
;

Lifecycle Methods

start_connection

Amazon Web Services uses this action to install Outpost servers. Starts the connection required for Outpost server installation. Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.

EXEC aws.outposts.assets.start_connection 
@region='{{ region }}' --required 
@@json=
'{
"DeviceSerialNumber": "{{ DeviceSerialNumber }}", 
"AssetId": "{{ AssetId }}", 
"ClientPublicKey": "{{ ClientPublicKey }}", 
"NetworkInterfaceDeviceIndex": {{ NetworkInterfaceDeviceIndex }}
}'
;