Package software.amazon.awscdk.services.ec2

Class CfnFpgaImage

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ec2.CfnFpgaImage
All Implemented Interfaces:
IInspectable, IFpgaImageRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:08.210Z") @Stability(Stable) public class CfnFpgaImage extends CfnResource implements IInspectable, IFpgaImageRef, ITaggableV2
Creates and manages an Amazon FPGA Image (AFI) from a design checkpoint (DCP).

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 CfnFpgaImage cfnFpgaImage = CfnFpgaImage.Builder.create(this, "MyCfnFpgaImage")
         .description("description")
         .inputStorageLocation(StorageLocationProperty.builder()
                 .bucket("bucket")
                 .key("key")
                 .build())
         .logsStorageLocation(StorageLocationProperty.builder()
                 .bucket("bucket")
                 .key("key")
                 .build())
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnFpgaImage

      protected CfnFpgaImage(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnFpgaImage

      protected CfnFpgaImage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnFpgaImage

      @Stability(Stable) public CfnFpgaImage(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnFpgaImageProps props)
      Create a new AWS::EC2::FpgaImage.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnFpgaImage

      @Stability(Stable) public CfnFpgaImage(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::EC2::FpgaImage.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • arnForFpgaImage

      @Stability(Stable) @NotNull public static String arnForFpgaImage(@NotNull IFpgaImageRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnFpgaImage

      @Stability(Stable) @NotNull public static Boolean isCfnFpgaImage(@NotNull Object x)
      Checks whether the given object is a CfnFpgaImage.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the FPGA image.

    • getAttrCreateTime

      @Stability(Stable) @NotNull public String getAttrCreateTime()
      The date and time the AFI was created.

    • getAttrDataRetentionSupport

      @Stability(Stable) @NotNull public IResolvable getAttrDataRetentionSupport()
      Indicates whether data retention support is enabled for the AFI.

    • getAttrFpgaImageGlobalId

      @Stability(Stable) @NotNull public String getAttrFpgaImageGlobalId()
      The global FPGA image identifier (AGFI ID).

    • getAttrFpgaImageId

      @Stability(Stable) @NotNull public String getAttrFpgaImageId()
      The FPGA image identifier (AFI ID).

    • getAttrOwnerId

      @Stability(Stable) @NotNull public String getAttrOwnerId()
      The ID of the AWS account that owns the AFI.

    • getAttrPublic

      @Stability(Stable) @NotNull public IResolvable getAttrPublic()
      Indicates whether the AFI is public.

    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()
      The state of the AFI (pending | available | failed | unavailable).

    • getAttrUpdateTime

      @Stability(Stable) @NotNull public String getAttrUpdateTime()
      The time of the most recent update to the AFI.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getFpgaImageRef

      @Stability(Stable) @NotNull public FpgaImageReference getFpgaImageRef()
      A reference to a FpgaImage resource.
      Specified by:
      getFpgaImageRef in interface IFpgaImageRef

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description for the AFI.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description for the AFI.

    • getInputStorageLocation

      @Stability(Stable) @Nullable public Object getInputStorageLocation()
      Describes a storage location in Amazon S3.

      Returns union: either IResolvable or CfnFpgaImage.StorageLocationProperty

    • setInputStorageLocation

      @Stability(Stable) public void setInputStorageLocation(@Nullable IResolvable value)
      Describes a storage location in Amazon S3.

    • setInputStorageLocation

      @Stability(Stable) public void setInputStorageLocation(@Nullable CfnFpgaImage.StorageLocationProperty value)
      Describes a storage location in Amazon S3.

    • getLogsStorageLocation

      @Stability(Stable) @Nullable public Object getLogsStorageLocation()
      Describes a storage location in Amazon S3.

      Returns union: either IResolvable or CfnFpgaImage.StorageLocationProperty

    • setLogsStorageLocation

      @Stability(Stable) public void setLogsStorageLocation(@Nullable IResolvable value)
      Describes a storage location in Amazon S3.

    • setLogsStorageLocation

      @Stability(Stable) public void setLogsStorageLocation(@Nullable CfnFpgaImage.StorageLocationProperty value)
      Describes a storage location in Amazon S3.

    • getName

      @Stability(Stable) @Nullable public String getName()
      A name for the AFI.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      A name for the AFI.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags assigned to the FPGA image.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags assigned to the FPGA image.