Class: DeleteBundleParameters

Inherits:
S3ToolParameters show all
Defined in:
lib/ec2/amitools/deletebundleparameters.rb

Overview

——————————————————————————#

Constant Summary collapse

MANIFEST_DESCRIPTION = 
"The path to the unencrypted manifest file."
PREFIX_DESCRIPTION = 
"The bundled AMI part filename prefix."
RETRY_DESCRIPTION = 
"Automatically retry failed deletes. Use with caution."
YES_DESCRIPTION = 
"Automatically answer 'y' without asking."
CLEAR_DESCRIPTION = 
"Delete the bucket if empty. Not done by default."

Constants inherited from S3ToolParameters

S3ToolParameters::BUCKET_DESCRIPTION, S3ToolParameters::DEFAULT_REGION, S3ToolParameters::DEFAULT_URL, S3ToolParameters::DELEGATION_TOKEN_DESCRIPTION, S3ToolParameters::PROFILE_HOST, S3ToolParameters::PROFILE_PATH, S3ToolParameters::REGION_DESCRIPTION, S3ToolParameters::REGION_MAP, S3ToolParameters::SIGV2_DESCRIPTION, S3ToolParameters::URL_DESCRIPTION, S3ToolParameters::VALID_SIGV

Constants inherited from ParametersBase

ParametersBase::BATCH_DESCRIPTION, ParametersBase::DEBUG_DESCRIPTION, ParametersBase::HELP_DESCRIPTION, ParametersBase::MANUAL_DESCRIPTION, ParametersBase::PASS_DESCRIPTION, ParametersBase::USER_ACCOUNT_DESCRIPTION, ParametersBase::USER_CERT_PATH_DESCRIPTION, ParametersBase::USER_DESCRIPTION, ParametersBase::USER_PK_PATH_DESCRIPTION, ParametersBase::VERSION_DESCRIPTION

Instance Attribute Summary collapse

Attributes inherited from S3ToolParameters

#bucket, #keyprefix, #pass, #region, #sigv, #url, #user

Attributes inherited from ParametersBase

#batch_mode, #debug, #manual, #show_help, #version

Instance Method Summary collapse

Methods inherited from S3ToolParameters

#get_creds_from_instance_profile, #split_container

Methods inherited from ParametersBase

#assert_directory_exists, #assert_exists, #assert_file_executable, #assert_file_exists, #assert_glob_expands, #assert_good_key, #assert_option_in, #common_params, #early_exit?, #initialize, #interactive?, #version_copyright_string

Constructor Details

This class inherits a constructor from ParametersBase

Instance Attribute Details

#clear ⇒ Object

Returns the value of attribute clear.



23
24
25
 
# File 'lib/ec2/amitools/deletebundleparameters.rb', line 23

def clear
  @clear
end

#manifest ⇒ Object

Returns the value of attribute manifest.



23
24
25
 
# File 'lib/ec2/amitools/deletebundleparameters.rb', line 23

def manifest
  @manifest
end

#prefix ⇒ Object

Returns the value of attribute prefix.



23
24
25
 
# File 'lib/ec2/amitools/deletebundleparameters.rb', line 23

def prefix
  @prefix
end

#retry ⇒ Object

Returns the value of attribute retry.



23
24
25
 
# File 'lib/ec2/amitools/deletebundleparameters.rb', line 23

def retry
  @retry
end

#yes ⇒ Object

Returns the value of attribute yes.



23
24
25
 
# File 'lib/ec2/amitools/deletebundleparameters.rb', line 23

def yes
  @yes
end

Instance Method Details

#mandatory_params ⇒ Object

—————————————————————————-#



31
32
33
 
# File 'lib/ec2/amitools/deletebundleparameters.rb', line 31

def mandatory_params()
  super()
end

#optional_params ⇒ Object

—————————————————————————-#



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/ec2/amitools/deletebundleparameters.rb', line 37

def optional_params()
  super()
  
  on('-m', '--manifest PATH', String, MANIFEST_DESCRIPTION) do |manifest|
    assert_file_exists(manifest, '--manifest')
    @manifest = manifest
  end
  
  on('-p', '--prefix PREFIX', String, PREFIX_DESCRIPTION) do |prefix|
    assert_good_key(prefix, '--prefix')
    @prefix = prefix
  end
  
  on('--clear', CLEAR_DESCRIPTION) do
    @clear = true
  end
  
  on('--retry', RETRY_DESCRIPTION) do
    @retry = true
  end
  
  on('-y', '--yes', YES_DESCRIPTION) do
    @yes = true
  end
end

#set_defaults ⇒ Object

—————————————————————————-#



73
74
75
76
 
# File 'lib/ec2/amitools/deletebundleparameters.rb', line 73

def set_defaults()
  super()
  @clear ||= false
end

#validate_params ⇒ Object

—————————————————————————-#

Raises:



65
66
67
68
69
 
# File 'lib/ec2/amitools/deletebundleparameters.rb', line 65

def validate_params()
  super()
  raise MissingMandatory.new('--manifest or --prefix') unless @manifest or @prefix
  raise InvalidCombination.new('--prefix', '--manifest') if (@prefix and @manifest)
end