Class: Fog::AWS::RDS::Server

Inherits:
Model
  • Object
show all
Defined in:
lib/fog/aws/models/rds/server.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#parameter_group_nameObject

Returns the value of attribute parameter_group_name.



35
36
37
# File 'lib/fog/aws/models/rds/server.rb', line 35

def parameter_group_name
  @parameter_group_name
end

#passwordObject

Returns the value of attribute password.



35
36
37
# File 'lib/fog/aws/models/rds/server.rb', line 35

def password
  @password
end

#portObject

Returns the value of attribute port.



35
36
37
# File 'lib/fog/aws/models/rds/server.rb', line 35

def port
  @port
end

#security_group_namesObject

Returns the value of attribute security_group_names.



35
36
37
# File 'lib/fog/aws/models/rds/server.rb', line 35

def security_group_names
  @security_group_names
end

Instance Method Details

#add_tags(new_tags) ⇒ Object



70
71
72
73
74
# File 'lib/fog/aws/models/rds/server.rb', line 70

def add_tags(new_tags)
  requires :id
  service.add_tags_to_resource(id, new_tags)
  tags
end

#attributes_to_paramsObject

Converts attributes to a parameter hash suitable for requests



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
# File 'lib/fog/aws/models/rds/server.rb', line 109

def attributes_to_params
  options = {
    'AllocatedStorage'              => allocated_storage,
    'AutoMinorVersionUpgrade'       => auto_minor_version_upgrade,
    'BackupRetentionPeriod'         => backup_retention_period,
    'DBName'                        => db_name,
    'DBParameterGroupName'          => parameter_group_name || attributes['DBParameterGroupName'],
    'DBSecurityGroups'              => security_group_names,
    'DBInstanceIdentifier'          => id,
    'AvailabilityZone'              => availability_zone,
    'DBInstanceClass'               => flavor_id,
    'Port'                          => port || attributes['Port'],
    'Engine'                        => engine,
    'EngineVersion'                 => engine_version,
    'Iops'                          => iops,
    'MasterUsername'                => master_username,
    'MasterUserPassword'            => password || attributes['MasterUserPassword'],
    'PreferredMaintenanceWindow'    => preferred_maintenance_window,
    'PreferredBackupWindow'         => preferred_backup_window,
    'MultiAZ'                       => multi_az,
    'LicenseModel'                  => license_model,
    'DBSubnetGroupName'             => db_subnet_group_name,
    'PubliclyAccessible'            => publicly_accessible,
    'VpcSecurityGroups'             => vpc_security_groups,
  }

  options.delete_if {|key, value| value.nil?}
end

#create_read_replica(replica_id, options = {}) ⇒ Object



37
38
39
40
41
42
# File 'lib/fog/aws/models/rds/server.rb', line 37

def create_read_replica(replica_id, options={})
  options[:security_group_names] ||= options['DBSecurityGroups']
  params = self.class.new(options).attributes_to_params
  service.create_db_instance_read_replica(replica_id, id, params)
  service.servers.get(replica_id)
end

#destroy(snapshot_identifier = nil) ⇒ Object



48
49
50
51
52
# File 'lib/fog/aws/models/rds/server.rb', line 48

def destroy(snapshot_identifier=nil)
  requires :id
  service.delete_db_instance(id, snapshot_identifier, snapshot_identifier.nil?)
  true
end

#modify(immediately, options) ⇒ Object



87
88
89
90
91
92
93
# File 'lib/fog/aws/models/rds/server.rb', line 87

def modify(immediately, options)
  options[:security_group_names] ||= options['DBSecurityGroups']
  params = self.class.new(options).attributes_to_params
  data = service.modify_db_instance(id, immediately, params)
  merge_attributes(data.body['ModifyDBInstanceResult']['DBInstance'])
  true
end

#promote_read_replicaObject



82
83
84
85
# File 'lib/fog/aws/models/rds/server.rb', line 82

def promote_read_replica
  requires :id
  service.promote_read_replica(id)
end

#ready?Boolean

Returns:

  • (Boolean)


44
45
46
# File 'lib/fog/aws/models/rds/server.rb', line 44

def ready?
  state == 'available'
end

#rebootObject



54
55
56
57
# File 'lib/fog/aws/models/rds/server.rb', line 54

def reboot
  service.reboot_db_instance(id)
  true
end

#remove_tags(tag_keys) ⇒ Object



76
77
78
79
80
# File 'lib/fog/aws/models/rds/server.rb', line 76

def remove_tags(tag_keys)
  requires :id
  service.remove_tags_from_resource(id, tag_keys)
  tags
end

#saveObject



95
96
97
98
99
100
101
102
103
104
105
106
# File 'lib/fog/aws/models/rds/server.rb', line 95

def save
  requires :engine
  requires :allocated_storage
  requires :master_username
  requires :password

  self.flavor_id ||= 'db.m1.small'

  data = service.create_db_instance(id, attributes_to_params)
  merge_attributes(data.body['CreateDBInstanceResult']['DBInstance'])
  true
end

#snapshotsObject



59
60
61
62
# File 'lib/fog/aws/models/rds/server.rb', line 59

def snapshots
  requires :id
  service.snapshots(:server => self)
end

#tagsObject



64
65
66
67
68
# File 'lib/fog/aws/models/rds/server.rb', line 64

def tags
  requires :id
  service.list_tags_for_resource(id).
    body['ListTagsForResourceResult']['TagList']
end