Class: MintPress::Aws::EC2::ImageAttribute

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

Properties (Read/Write)

  • #block_device_mappings ⇒ Array of ⇒ [MintPress::Aws::EC2::BlockDeviceMapping]
    'The block device mapping entries.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "Types::ImageAttribute"
    • orig_name ⇒ 'block_device_mappings'
    

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

property :block_device_mappings, disposition: :attribute, description: 'The block device mapping entries.', source: "Types::ImageAttribute", orig_name: 'block_device_mappings', type: [MintPress::Aws::EC2::BlockDeviceMapping], array: true
  • #description ⇒ [String]
    'A new description for the AMI.'
    Property Attributes
    • source ⇒ "modify_image_attribute"
    • orig_name ⇒ 'description'
    • modify_image_attribute_prop ⇒ "description.value"
    • read_only ⇒ false
    

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

property :description, description: 'A new description for the AMI.', source: "modify_image_attribute", orig_name: 'description', type: [String], modify_image_attribute_prop: "description.value", read_only: false
  • #launch_permissions ⇒ Array of ⇒ [MintPress::Aws::EC2::LaunchPermission]
    'The launch permissions.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "Types::ImageAttribute"
    • orig_name ⇒ 'launch_permissions'
    

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

property :launch_permissions, disposition: :attribute, description: 'The launch permissions.', source: "Types::ImageAttribute", orig_name: 'launch_permissions', type: [MintPress::Aws::EC2::LaunchPermission], array: true
  • #product_codes ⇒ Array of ⇒ [String]
    'The DevPay product codes. After you add a product code to an AMI, it can"t be removed.'
    Property Attributes
    • source ⇒ "modify_image_attribute"
    • orig_name ⇒ 'product_codes'
    • modify_image_attribute_prop ⇒ 'product_codes'
    • read_only ⇒ false
    

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

property :product_codes, description: 'The DevPay product codes. After you add a product code to an AMI, it
can"t be removed.', source: "modify_image_attribute", orig_name: 'product_codes', type: [String], array: true, modify_image_attribute_prop: 'product_codes', read_only: false
  • #sriov_net_support ⇒ [MintPress::Aws::EC2::AttributeValue] (Default Value: MintPress::Aws::EC2::AttributeValue.new)
    'Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "Types::ImageAttribute"
    • orig_name ⇒ 'sriov_net_support'
    • default ⇒ MintPress::Aws::EC2::AttributeValue.new
    

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

property :sriov_net_support, disposition: :attribute, description: 'Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.', source: "Types::ImageAttribute", orig_name: 'sriov_net_support', type: [MintPress::Aws::EC2::AttributeValue], default: MintPress::Aws::EC2::AttributeValue.new
  • #attribute ⇒ [String]
    'The name of the attribute to modify. The valid values are description, launchPermission, and productCodes.'
    Property Attributes
    • describe_image_attribute_prop ⇒ 'attribute'
    • source ⇒ "modify_image_attribute"
    • modify_image_attribute_prop ⇒ 'attribute'
    • read_only ⇒ false
    

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

property :attribute, describe_image_attribute_prop: 'attribute', type: [String], source: "modify_image_attribute", description: 'The name of the attribute to modify. The valid values are
description, launchPermission, and productCodes.', modify_image_attribute_prop: 'attribute', read_only: false
  • #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
    • describe_image_attribute_prop ⇒ 'dry_run'
    • source ⇒ "modify_image_attribute"
    • modify_image_attribute_prop ⇒ 'dry_run'
    • read_only ⇒ false
    

33
34
35
36
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/image_attribute.rb', line 33

property :dry_run, describe_image_attribute_prop: 'dry_run', type: [TrueClass,FalseClass], source: "modify_image_attribute", 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.', modify_image_attribute_prop: 'dry_run', read_only: false
  • #launch_permission ⇒ [MintPress::Aws::EC2::LaunchPermissionModification] (Default Value: MintPress::Aws::EC2::LaunchPermissionModification.new)
    'A new launch permission for the AMI.'
    Property Attributes
    • modify_image_attribute_prop ⇒ 'launch_permission'
    • default ⇒ MintPress::Aws::EC2::LaunchPermissionModification.new
    • read_only ⇒ false
    • source ⇒ "modify_image_attribute"
    

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

property :launch_permission, modify_image_attribute_prop: 'launch_permission', type: [MintPress::Aws::EC2::LaunchPermissionModification], default: MintPress::Aws::EC2::LaunchPermissionModification.new, read_only: false, source: "modify_image_attribute", description: 'A new launch permission for the AMI.'
  • #operation_type ⇒ [String]
    'The operation type. This parameter can be used only when the Attribute parameter is launchPermission.'
    Property Attributes
    • modify_image_attribute_prop ⇒ 'operation_type'
    • read_only ⇒ false
    • source ⇒ "modify_image_attribute"
    

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

property :operation_type, modify_image_attribute_prop: 'operation_type', type: [String], read_only: false, source: "modify_image_attribute", description: 'The operation type. This parameter can be used only when the
Attribute parameter is launchPermission.'
  • #user_groups ⇒ Array of ⇒ [String]
    'The user groups. This parameter can be used only when the Attribute parameter is launchPermission.'
    Property Attributes
    • modify_image_attribute_prop ⇒ 'user_groups'
    • read_only ⇒ false
    • source ⇒ "modify_image_attribute"
    

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

property :user_groups, modify_image_attribute_prop: 'user_groups', type: [String], array: true, read_only: false, source: "modify_image_attribute", description: 'The user groups. This parameter can be used only when the Attribute
parameter is launchPermission.'
  • #value ⇒ [String]
    'The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or productCodes.'
    Property Attributes
    • modify_image_attribute_prop ⇒ 'value'
    • read_only ⇒ false
    • source ⇒ "modify_image_attribute"
    

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

property :value, modify_image_attribute_prop: 'value', type: [String], read_only: false, source: "modify_image_attribute", description: 'The value of the attribute being modified. This parameter can be used
only when the Attribute parameter is description or
productCodes.'
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'The ID of the AMI.'
    Property Attributes
    • source ⇒ "modify_image_attribute"
    • orig_name ⇒ 'image_id'
    • describe_image_attribute_prop ⇒ 'image_id'
    • modify_image_attribute_prop ⇒ 'image_id'
    • read_only ⇒ false
    • default ⇒ Proc.new { self.name }
    

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

property :id, description: 'The ID of the AMI.', source: "modify_image_attribute", orig_name: 'image_id', type: [String], describe_image_attribute_prop: 'image_id', modify_image_attribute_prop: 'image_id', read_only: false, array: false, hash: false, default: Proc.new { self.name }
  • #kernel ⇒ [MintPress::Aws::EC2::AttributeValue] (Default Value: MintPress::Aws::EC2::AttributeValue.new)
    'The kernel ID.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "Types::ImageAttribute"
    • orig_name ⇒ 'kernel_id'
    • default ⇒ MintPress::Aws::EC2::AttributeValue.new
    

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

property :kernel, disposition: :attribute, description: 'The kernel ID.', source: "Types::ImageAttribute", orig_name: 'kernel_id', type: [MintPress::Aws::EC2::AttributeValue], default: MintPress::Aws::EC2::AttributeValue.new
  • #ramdisk ⇒ [MintPress::Aws::EC2::AttributeValue] (Default Value: MintPress::Aws::EC2::AttributeValue.new)
    'The RAM disk ID.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "Types::ImageAttribute"
    • orig_name ⇒ 'ramdisk_id'
    • default ⇒ MintPress::Aws::EC2::AttributeValue.new
    

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

property :ramdisk, disposition: :attribute, description: 'The RAM disk ID.', source: "Types::ImageAttribute", orig_name: 'ramdisk_id', type: [MintPress::Aws::EC2::AttributeValue], default: MintPress::Aws::EC2::AttributeValue.new
  • #users ⇒ Array of ⇒ [String]
    'The AWS account IDs. This parameter can be used only when the Attribute parameter is launchPermission.'
    Property Attributes
    • modify_image_attribute_prop ⇒ 'user_ids'
    • read_only ⇒ false
    • source ⇒ "modify_image_attribute"
    

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

property :users, modify_image_attribute_prop: 'user_ids', type: [String], array: true, read_only: false, source: "modify_image_attribute", description: 'The AWS account IDs. This parameter can be used only when the
Attribute parameter is launchPermission.'
  • #name ⇒ String

    Property Attributes 
    

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

property :name, type: String
  • #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 
    

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

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
    

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

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 = {}) ⇒ ImageAttribute

Returns a new instance of ImageAttribute.

Instance Method Details

#describe ⇒ Object

#modify ⇒ Object