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_name ⇒ Object

Returns the value of attribute parameter_group_name.



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

def parameter_group_name
  @parameter_group_name
end

#password ⇒ Object

Returns the value of attribute password.



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

def password
  @password
end

#port ⇒ Object

Returns the value of attribute port.



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

def port
  @port
end

#security_group_names ⇒ Object

Returns the value of attribute security_group_names.



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

def security_group_names
  @security_group_names
end

#source_snapshot_id ⇒ Object

Returns the value of attribute source_snapshot_id.



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

def source_snapshot_id
  @source_snapshot_id
end

Instance Method Details

#add_tags(new_tags) ⇒ Object 



84
85
86
87
88
 
# File 'lib/fog/aws/models/rds/server.rb', line 84

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

#attributes_to_params ⇒ Object

Converts attributes to a parameter hash suitable for requests



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/fog/aws/models/rds/server.rb', line 139

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

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

#cluster ⇒ Object 



46
47
48
49
 
# File 'lib/fog/aws/models/rds/server.rb', line 46

def cluster
  return nil unless cluster_id
  service.clusters.get(cluster_id)
end

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



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

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 



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

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

#modify(immediately, options) ⇒ Object 



106
107
108
109
110
111
112
 
# File 'lib/fog/aws/models/rds/server.rb', line 106

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_replica ⇒ Object Also known as: promote 



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

def promote_read_replica
  requires :id

  data = service.promote_read_replica(id).body["PromoteReadReplicaResult"]["DBInstance"]

  merge_attributes(data)
end

#ready? ⇒ Boolean

Returns:

  • (Boolean) 


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

def ready?
  state == 'available'
end

#reboot ⇒ Object 



68
69
70
71
 
# File 'lib/fog/aws/models/rds/server.rb', line 68

def reboot
  service.reboot_db_instance(id)
  true
end

#remove_tags(tag_keys) ⇒ Object 



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

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

#save ⇒ Object 



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 114

def save
  if source_snapshot_id
    requires :id
    data = service.restore_db_instance_from_db_snapshot(source_snapshot_id, id, attributes_to_params)
    merge_attributes(data.body['RestoreDBInstanceFromDBSnapshotResult']['DBInstance'])
  else
    requires :engine

    if engine.start_with?('aurora')
      requires :cluster_id
      self.flavor_id ||= 'db.r4.large'
    else
      requires :master_username
      requires :password
      requires :allocated_storage
      self.flavor_id ||= 'db.m4.large'
    end

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

#snapshots ⇒ Object 



73
74
75
76
 
# File 'lib/fog/aws/models/rds/server.rb', line 73

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

#tags ⇒ Object 



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

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