fpga_image_attributes

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

Overview

Name	fpga_image_attributes
Type	Resource
Id	aws.ec2.fpga_image_attributes

Fields

The following fields are returned by SELECT queries:

describe_fpga_image_attribute

Name	Datatype	Description
description	string	The description of the AFI.
fpga_image_id	string	The ID of the AFI.
load_permissions	string	The load permissions.
name	string	The name of the AFI.
product_codes	string	The product codes.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_fpga_image_attribute	select	FpgaImageId, Attribute, region	DryRun	Describes the specified attribute of the specified Amazon FPGA Image (AFI).
modify_fpga_image_attribute	update	FpgaImageId, region	DryRun, Attribute, OperationType, UserId, UserGroup, ProductCode, LoadPermission, Description, Name	Modifies the specified attribute of the specified Amazon FPGA Image (AFI).

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
Attribute	string	The AFI attribute.
FpgaImageId	string	The ID of the AFI.
region	string	AWS region (default: us-east-1)
Attribute	string	The name of the attribute.
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.
LoadPermission	object	The load permission for the AFI.
Name	string	A name for the AFI.
OperationType	string	The operation type.
ProductCode	array	The product codes. After you add a product code to an AFI, it can't be removed. This parameter is valid only when modifying the productCodes attribute.
UserGroup	array	The user groups. This parameter is valid only when modifying the loadPermission attribute.
UserId	array	The Amazon Web Services account IDs. This parameter is valid only when modifying the loadPermission attribute.

SELECT examples

describe_fpga_image_attribute

Describes the specified attribute of the specified Amazon FPGA Image (AFI).

SELECT
description,
fpga_image_id,
load_permissions,
name,
product_codes
FROM aws.ec2.fpga_image_attributes
WHERE FpgaImageId = '{{ FpgaImageId }}' -- required
AND Attribute = '{{ Attribute }}' -- required
AND region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
;

UPDATE examples

modify_fpga_image_attribute

Modifies the specified attribute of the specified Amazon FPGA Image (AFI).

UPDATE aws.ec2.fpga_image_attributes
SET 
-- No updatable properties
WHERE 
FpgaImageId = '{{ FpgaImageId }}' --required
AND region = '{{ region }}' --required
AND DryRun = {{ DryRun}}
AND Attribute = '{{ Attribute}}'
AND OperationType = '{{ OperationType}}'
AND UserId = '{{ UserId}}'
AND UserGroup = '{{ UserGroup}}'
AND ProductCode = '{{ ProductCode}}'
AND LoadPermission = '{{ LoadPermission}}'
AND Description = '{{ Description}}'
AND Name = '{{ Name}}'
RETURNING
description,
fpga_image_id,
load_permissions,
name,
product_codes;