fpga_images

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

Overview

Name	fpga_images
Type	Resource
Id	aws.ec2.fpga_images

Fields

The following fields are returned by SELECT queries:

describe_fpga_images

Name	Datatype	Description
create_time	string	The date and time the AFI was created.
data_retention_support	boolean	Indicates whether data retention support is enabled for the AFI.
description	string	The description of the AFI.
fpga_image_global_id	string	The global FPGA image identifier (AGFI ID).
fpga_image_id	string	The FPGA image identifier (AFI ID).
instance_types	string	The instance types supported by the AFI.
name	string	The name of the AFI.
owner_alias	string	The alias of the AFI owner. Possible values include self, amazon, and aws-marketplace.
owner_id	string	The ID of the Amazon Web Services account that owns the AFI.
pci_id	string	Information about the PCI bus.
product_codes	string	The product codes for the AFI.
public	boolean	Indicates whether the AFI is public.
shell_version	string	The version of the Amazon Web Services Shell that was used to create the bitstream.
state	string	Information about the state of the AFI.
tags	string	Any tags assigned to the AFI.
update_time	string	The time of the most recent update to the AFI.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_fpga_images	select	region	DryRun, FpgaImageId, Owner, Filter, NextToken, MaxResults	Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs, private AFIs that you own, and AFIs owned by other Amazon Web Services accounts for which you have load permissions.
create_fpga_image	insert	InputStorageLocation, region	DryRun, LogsStorageLocation, Description, Name, ClientToken, TagSpecification	Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP). The create operation is asynchronous. To verify that the AFI was successfully created and is ready for use, check the output logs. An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the Amazon Web Services FPGA Hardware Development Kit.
delete_fpga_image	delete	FpgaImageId, region	DryRun	Deletes the specified Amazon FPGA Image (AFI).
reset_fpga_image_attribute	exec	FpgaImageId, region	DryRun, Attribute	Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute.

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
FpgaImageId	string	The ID of the AFI.
InputStorageLocation	object	The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.
region	string	AWS region (default: us-east-1)
Attribute	string	The attribute.
ClientToken	string	Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Description	string	A description for the AFI.
DryRun	boolean	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Filter	array	The filters. create-time - The creation time of the AFI. fpga-image-id - The FPGA image identifier (AFI ID). fpga-image-global-id - The global FPGA image identifier (AGFI ID). name - The name of the AFI. owner-id - The Amazon Web Services account ID of the AFI owner. product-code - The product code. shell-version - The version of the Amazon Web Services Shell that was used to create the bitstream. state - The state of the AFI (pending | failed | available | unavailable). tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. update-time - The time of the most recent update.
FpgaImageId	array	The AFI IDs.
LogsStorageLocation	object	The location in Amazon S3 for the output logs.
MaxResults	integer	The maximum number of results to return in a single call.
Name	string	A name for the AFI.
NextToken	string	The token to retrieve the next page of results.
Owner	array	Filters the AFI by owner. Specify an Amazon Web Services account ID, self (owner is the sender of the request), or an Amazon Web Services owner alias (valid values are amazon | aws-marketplace).
TagSpecification	array	The tags to apply to the FPGA image during creation.

SELECT examples

describe_fpga_images

Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs, private AFIs that you own, and AFIs owned by other Amazon Web Services accounts for which you have load permissions.

SELECT
create_time,
data_retention_support,
description,
fpga_image_global_id,
fpga_image_id,
instance_types,
name,
owner_alias,
owner_id,
pci_id,
product_codes,
public,
shell_version,
state,
tags,
update_time
FROM aws.ec2.fpga_images
WHERE region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND FpgaImageId = '{{ FpgaImageId }}'
AND Owner = '{{ Owner }}'
AND Filter = '{{ Filter }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
;

INSERT examples

create_fpga_image

Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP). The create operation is asynchronous. To verify that the AFI was successfully created and is ready for use, check the output logs. An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the Amazon Web Services FPGA Hardware Development Kit.

INSERT INTO aws.ec2.fpga_images (
InputStorageLocation,
region,
DryRun,
LogsStorageLocation,
Description,
Name,
ClientToken,
TagSpecification
)
SELECT 
'{{ InputStorageLocation }}',
'{{ region }}',
'{{ DryRun }}',
'{{ LogsStorageLocation }}',
'{{ Description }}',
'{{ Name }}',
'{{ ClientToken }}',
'{{ TagSpecification }}'
RETURNING
fpga_image_global_id,
fpga_image_id
;

Manifest

# Description fields are for documentation purposes
- name: fpga_images
props:
  - name: InputStorageLocation
    value: "{{ InputStorageLocation }}"
    description: Required parameter for the fpga_images resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the fpga_images resource.
  - name: DryRun
    value: {{ DryRun }}
    description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
    description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
  - name: LogsStorageLocation
    value: "{{ LogsStorageLocation }}"
    description: The location in Amazon S3 for the output logs.
    description: The location in Amazon S3 for the output logs.
  - name: Description
    value: "{{ Description }}"
    description: A description for the AFI.
    description: A description for the AFI.
  - name: Name
    value: "{{ Name }}"
    description: A name for the AFI.
    description: A name for the AFI.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
    description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: The tags to apply to the FPGA image during creation.
    description: The tags to apply to the FPGA image during creation.

DELETE examples

delete_fpga_image

Deletes the specified Amazon FPGA Image (AFI).

DELETE FROM aws.ec2.fpga_images
WHERE FpgaImageId = '{{ FpgaImageId }}' --required
AND region = '{{ region }}' --required
AND DryRun = '{{ DryRun }}'
;

Lifecycle Methods

reset_fpga_image_attribute

Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute.

EXEC aws.ec2.fpga_images.reset_fpga_image_attribute 
@FpgaImageId='{{ FpgaImageId }}' --required, 
@region='{{ region }}' --required, 
@DryRun={{ DryRun }}, 
@Attribute='{{ Attribute }}'
;