Class: MintPress::Aws::EC2::SnapshotAttribute

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

Properties (Read/Write)

  • #attribute ⇒ [String]
    'The snapshot attribute to modify. Only volume creation permissions can be modified.'
    Property Attributes
    • describe_snapshot_attribute_prop ⇒ 'attribute'
    • source ⇒ "modify_snapshot_attribute"
    • modify_snapshot_attribute_prop ⇒ 'attribute'
    • read_only ⇒ false
    

20
21
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/snapshot_attribute.rb', line 20

property :attribute, describe_snapshot_attribute_prop: 'attribute', type: [String], source: "modify_snapshot_attribute", description: 'The snapshot attribute to modify. Only volume creation permissions can
be modified.', modify_snapshot_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_snapshot_attribute_prop ⇒ 'dry_run'
    • source ⇒ "modify_snapshot_attribute"
    • modify_snapshot_attribute_prop ⇒ 'dry_run'
    • read_only ⇒ false
    

22
23
24
25
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/snapshot_attribute.rb', line 22

property :dry_run, describe_snapshot_attribute_prop: 'dry_run', type: [TrueClass,FalseClass], source: "modify_snapshot_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_snapshot_attribute_prop: 'dry_run', read_only: false
  • #create_volume_permission ⇒ [MintPress::Aws::EC2::CreateVolumePermissionModification] (Default Value: MintPress::Aws::EC2::CreateVolumePermissionModification.new)
    'A JSON representation of the snapshot attribute modification.'
    Property Attributes
    • modify_snapshot_attribute_prop ⇒ 'create_volume_permission'
    • default ⇒ MintPress::Aws::EC2::CreateVolumePermissionModification.new
    • read_only ⇒ false
    • source ⇒ "modify_snapshot_attribute"
    

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

property :create_volume_permission, modify_snapshot_attribute_prop: 'create_volume_permission', type: [MintPress::Aws::EC2::CreateVolumePermissionModification], default: MintPress::Aws::EC2::CreateVolumePermissionModification.new, read_only: false, source: "modify_snapshot_attribute", description: 'A JSON representation of the snapshot attribute modification.'
  • #group_names ⇒ Array of ⇒ [String]
    'The group to modify for the snapshot.'
    Property Attributes
    • modify_snapshot_attribute_prop ⇒ 'group_names'
    • read_only ⇒ false
    • source ⇒ "modify_snapshot_attribute"
    

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

property :group_names, modify_snapshot_attribute_prop: 'group_names', type: [String], array: true, read_only: false, source: "modify_snapshot_attribute", description: 'The group to modify for the snapshot.'
  • #operation_type ⇒ [String]
    'The type of operation to perform to the attribute.'
    Property Attributes
    • modify_snapshot_attribute_prop ⇒ 'operation_type'
    • read_only ⇒ false
    • source ⇒ "modify_snapshot_attribute"
    

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

property :operation_type, modify_snapshot_attribute_prop: 'operation_type', type: [String], read_only: false, source: "modify_snapshot_attribute", description: 'The type of operation to perform to the attribute.'
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'The ID of the snapshot.'
    Property Attributes
    • describe_snapshot_attribute_prop ⇒ 'snapshot_id'
    • source ⇒ "modify_snapshot_attribute"
    • modify_snapshot_attribute_prop ⇒ 'snapshot_id'
    • read_only ⇒ false
    • default ⇒ Proc.new { self.name }
    

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

property :id, describe_snapshot_attribute_prop: 'snapshot_id', type: [String], source: "modify_snapshot_attribute", description: 'The ID of the snapshot.', modify_snapshot_attribute_prop: 'snapshot_id', read_only: false, array: false, hash: false, default: Proc.new { self.name }
  • #users ⇒ Array of ⇒ [String]
    'The account ID to modify for the snapshot.'
    Property Attributes
    • modify_snapshot_attribute_prop ⇒ 'user_ids'
    • read_only ⇒ false
    • source ⇒ "modify_snapshot_attribute"
    

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

property :users, modify_snapshot_attribute_prop: 'user_ids', type: [String], array: true, read_only: false, source: "modify_snapshot_attribute", description: 'The account ID to modify for the snapshot.'
  • #name ⇒ String

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Returns a new instance of SnapshotAttribute.

Instance Method Details

#describe ⇒ Object

#modify ⇒ Object