Class: MintPress::Aws::EC2::FpgaImage

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fpga_image.rb

Properties (Read/Write)

  • #dry_run ⇒ [TrueClass,FalseClass]
    '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.'
    Property Attributes
    • create_fpga_image_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "describe_fpga_images"
    • delete_fpga_image_prop ⇒ 'dry_run'
    • describe_fpga_images_prop ⇒ 'dry_run'
    

28
29
30
31
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fpga_image.rb', line 28

property :dry_run, create_fpga_image_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "describe_fpga_images", 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.', delete_fpga_image_prop: 'dry_run', describe_fpga_images_prop: 'dry_run'
  • #input_storage_location ⇒ [MintPress::Aws::EC2::StorageLocation] (Default Value: MintPress::Aws::EC2::StorageLocation.new)
    'The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.'
    Property Attributes
    • create_fpga_image_prop ⇒ 'input_storage_location'
    • default ⇒ MintPress::Aws::EC2::StorageLocation.new
    • read_only ⇒ false
    • source ⇒ "create_fpga_image"
    

32
33
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fpga_image.rb', line 32

property :input_storage_location, create_fpga_image_prop: 'input_storage_location', type: [MintPress::Aws::EC2::StorageLocation], default: MintPress::Aws::EC2::StorageLocation.new, read_only: false, source: "create_fpga_image", description: 'The location of the encrypted design checkpoint in Amazon S3. The
input must be a tarball.'
  • #logs_storage_location ⇒ [MintPress::Aws::EC2::StorageLocation] (Default Value: MintPress::Aws::EC2::StorageLocation.new)
    'The location in Amazon S3 for the output logs.'
    Property Attributes
    • create_fpga_image_prop ⇒ 'logs_storage_location'
    • default ⇒ MintPress::Aws::EC2::StorageLocation.new
    • read_only ⇒ false
    • source ⇒ "create_fpga_image"
    

34
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fpga_image.rb', line 34

property :logs_storage_location, create_fpga_image_prop: 'logs_storage_location', type: [MintPress::Aws::EC2::StorageLocation], default: MintPress::Aws::EC2::StorageLocation.new, read_only: false, source: "create_fpga_image", description: 'The location in Amazon S3 for the output logs.'
  • #description ⇒ [String]
    'The description of the AFI.'
    Property Attributes
    • create_fpga_image_prop ⇒ 'description'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::EC2::FpgaImage"
    • orig_name ⇒ 'description'
    

35
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fpga_image.rb', line 35

property :description, create_fpga_image_prop: 'description', type: [String], disposition: :attribute, read_only: false, source: "MintPress::Aws::EC2::FpgaImage", description: 'The description of the AFI.', orig_name: 'description'
  • #name ⇒ [String]
    'The name of the AFI.'
    Property Attributes
    • create_fpga_image_prop ⇒ 'name'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::EC2::FpgaImage"
    • orig_name ⇒ 'name'
    

36
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fpga_image.rb', line 36

property :name, create_fpga_image_prop: 'name', type: [String], disposition: :attribute, read_only: false, source: "MintPress::Aws::EC2::FpgaImage", description: 'The name of the AFI.', orig_name: 'name'
  • #client_token ⇒ [String]
    'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
    Property Attributes
    • create_fpga_image_prop ⇒ 'client_token'
    • read_only ⇒ false
    • source ⇒ "create_fpga_image"
    

37
38
39
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fpga_image.rb', line 37

property :client_token, create_fpga_image_prop: 'client_token', type: [String], read_only: false, source: "create_fpga_image", description: 'Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see Ensuring
Idempotency.'
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'Any tags assigned to the AFI.'
    Property Attributes
    • create_fpga_image_prop ⇒ 'tag_specifications'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::EC2::FpgaImage"
    • orig_name ⇒ 'tags'
    

40
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fpga_image.rb', line 40

property :tags, create_fpga_image_prop: 'tag_specifications', type: [MintPress::Aws::EC2::Tag], array: false, disposition: :attribute, read_only: false, source: "MintPress::Aws::EC2::FpgaImage", description: 'Any tags assigned to the AFI.', orig_name: 'tags', hash: true
  • #create_time ⇒ [Time]
    'The date and time the AFI was created.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::FpgaImage"
    • orig_name ⇒ 'create_time'
    

41
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fpga_image.rb', line 41

property :create_time, disposition: :attribute, description: 'The date and time the AFI was created.', source: "MintPress::Aws::EC2::FpgaImage", orig_name: 'create_time', type: [Time]
  • #data_retention_support ⇒ [TrueClass,FalseClass]
    'Indicates whether data retention support is enabled for the AFI.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::FpgaImage"
    • orig_name ⇒ 'data_retention_support'
    

42
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fpga_image.rb', line 42

property :data_retention_support, disposition: :attribute, description: 'Indicates whether data retention support is enabled for the AFI.', source: "MintPress::Aws::EC2::FpgaImage", orig_name: 'data_retention_support', type: [TrueClass,FalseClass]
  • #owner_alias ⇒ [String]
    'The alias of the AFI owner.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::FpgaImage"
    • orig_name ⇒ 'owner_alias'
    

43
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fpga_image.rb', line 43

property :owner_alias, disposition: :attribute, description: 'The alias of the AFI owner.', source: "MintPress::Aws::EC2::FpgaImage", orig_name: 'owner_alias', type: [String]
  • #product_codes ⇒ Hash of ⇒ [MintPress::Aws::EC2::ProductCode]
    'The product codes for the AFI.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::FpgaImage"
    • orig_name ⇒ 'product_codes'
    

44
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fpga_image.rb', line 44

property :product_codes, disposition: :attribute, description: 'The product codes for the AFI.', source: "MintPress::Aws::EC2::FpgaImage", orig_name: 'product_codes', type: [MintPress::Aws::EC2::ProductCode], array: false, hash: true
  • #public ⇒ [TrueClass,FalseClass]
    'Indicates whether the AFI is public.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::FpgaImage"
    • orig_name ⇒ 'public'
    

45
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fpga_image.rb', line 45

property :public, disposition: :attribute, description: 'Indicates whether the AFI is public.', source: "MintPress::Aws::EC2::FpgaImage", orig_name: 'public', type: [TrueClass,FalseClass]
  • #shell_version ⇒ [String]
    'The version of the AWS Shell that was used to create the bitstream.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::FpgaImage"
    • orig_name ⇒ 'shell_version'
    

46
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fpga_image.rb', line 46

property :shell_version, disposition: :attribute, description: 'The version of the AWS Shell that was used to create the bitstream.', source: "MintPress::Aws::EC2::FpgaImage", orig_name: 'shell_version', type: [String]
  • #state ⇒ [MintPress::Aws::EC2::FpgaImageState] (Default Value: MintPress::Aws::EC2::FpgaImageState.new)
    'Information about the state of the AFI.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::FpgaImage"
    • orig_name ⇒ 'state'
    • default ⇒ MintPress::Aws::EC2::FpgaImageState.new
    

47
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fpga_image.rb', line 47

property :state, disposition: :attribute, description: 'Information about the state of the AFI.', source: "MintPress::Aws::EC2::FpgaImage", orig_name: 'state', type: [MintPress::Aws::EC2::FpgaImageState], default: MintPress::Aws::EC2::FpgaImageState.new
  • #update_time ⇒ [Time]
    'The time of the most recent update to the AFI.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::FpgaImage"
    • orig_name ⇒ 'update_time'
    

48
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fpga_image.rb', line 48

property :update_time, disposition: :attribute, description: 'The time of the most recent update to the AFI.', source: "MintPress::Aws::EC2::FpgaImage", orig_name: 'update_time', type: [Time]
  • #owners ⇒ Array of ⇒ [String]
    'Filters the AFI by owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "describe_fpga_images"
    • orig_name ⇒ 'owner_id'
    • describe_fpga_images_prop ⇒ 'owners'
    • from ⇒ String
    

49
50
51
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fpga_image.rb', line 49

property :owners, disposition: :attribute, description: 'Filters the AFI by owner. Specify an AWS account ID, self (owner is
the sender of the request), or an AWS owner alias (valid values are
amazon | aws-marketplace).', source: "describe_fpga_images", orig_name: 'owner_id', type: [String], describe_fpga_images_prop: 'owners', array: true, from: String
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    '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 AWS account ID of the AFI owner. product-code - The product code. shell-version - The version of the AWS Shell that was used to create the bitstream. state - The state of the AFI (pending | failed | available | unavailable). tag: - 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.'
    Property Attributes
    • describe_fpga_images_prop ⇒ 'filters'
    • source ⇒ "describe_fpga_images"
    

52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fpga_image.rb', line 52

property :filters, describe_fpga_images_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_fpga_images", description: '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 AWS account ID of the AFI owner.
product-code - The product code.
shell-version - The version of the AWS 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.', hash: true
  • #max_results ⇒ [Integer]
    'The maximum number of results to return in a single call.'
    Property Attributes
    • describe_fpga_images_prop ⇒ 'max_results'
    • source ⇒ "describe_fpga_images"
    

74
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fpga_image.rb', line 74

property :max_results, describe_fpga_images_prop: 'max_results', type: [Integer], source: "describe_fpga_images", description: 'The maximum number of results to return in a single call.'
  • #id ⇒ [String]
    'The AFI IDs.'
    Property Attributes
    • delete_fpga_image_prop ⇒ 'fpga_image_id'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "describe_fpga_images"
    • orig_name ⇒ 'fpga_image_id'
    • describe_fpga_images_prop ⇒ 'fpga_image_ids'
    

75
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fpga_image.rb', line 75

property :id, delete_fpga_image_prop: 'fpga_image_id', type: [String], disposition: :attribute, read_only: false, source: "describe_fpga_images", description: 'The AFI IDs.', orig_name: 'fpga_image_id', array: false, hash: false, describe_fpga_images_prop: 'fpga_image_ids'
  • #fpga_image_global ⇒ [String]
    'The global FPGA image identifier (AGFI ID).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::FpgaImage"
    • orig_name ⇒ 'fpga_image_global_id'
    

76
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fpga_image.rb', line 76

property :fpga_image_global, disposition: :attribute, description: 'The global FPGA image identifier (AGFI ID).', source: "MintPress::Aws::EC2::FpgaImage", orig_name: 'fpga_image_global_id', type: [String]
  • #pci ⇒ [MintPress::Aws::EC2::PciId] (Default Value: MintPress::Aws::EC2::PciId.new)
    'Information about the PCI bus.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::FpgaImage"
    • orig_name ⇒ 'pci_id'
    • default ⇒ MintPress::Aws::EC2::PciId.new
    

77
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fpga_image.rb', line 77

property :pci, disposition: :attribute, description: 'Information about the PCI bus.', source: "MintPress::Aws::EC2::FpgaImage", orig_name: 'pci_id', type: [MintPress::Aws::EC2::PciId], default: MintPress::Aws::EC2::PciId.new
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

81
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fpga_image.rb', line 81

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

84
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fpga_image.rb', line 84

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ FpgaImage

Returns a new instance of FpgaImage.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object