Class: MintPress::Aws::Lightsail::RelationalDatabase

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

Properties (Read/Write)

  • #relational_database_name ⇒ [String]
    'The name of your database to update.'
    Property Attributes
    • create_relational_database_prop ⇒ 'relational_database_name'
    • read_only ⇒ false
    • source ⇒ "update_relational_database"
    • delete_relational_database_prop ⇒ 'relational_database_name'
    • get_relational_database_prop ⇒ 'relational_database_name'
    • start_relational_database_prop ⇒ 'relational_database_name'
    • stop_relational_database_prop ⇒ 'relational_database_name'
    • update_relational_database_prop ⇒ 'relational_database_name'
    

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

property :relational_database_name, create_relational_database_prop: 'relational_database_name', type: [String], read_only: false, source: "update_relational_database", description: 'The name of your database to update.', delete_relational_database_prop: 'relational_database_name', get_relational_database_prop: 'relational_database_name', start_relational_database_prop: 'relational_database_name', stop_relational_database_prop: 'relational_database_name', update_relational_database_prop: 'relational_database_name'
  • #availability_zone ⇒ [String]
    'The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format. You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request.'
    Property Attributes
    • create_relational_database_prop ⇒ 'availability_zone'
    • read_only ⇒ false
    • source ⇒ "create_relational_database"
    

36
37
38
39
40
41
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 36

property :availability_zone, create_relational_database_prop: 'availability_zone', type: [String], read_only: false, source: "create_relational_database", description: 'The Availability Zone in which to create your new database. Use the
us-east-2a case-sensitive format.

You can get a list of Availability Zones by using the get regions
operation. Be sure to add the include relational database
Availability Zones parameter to your request.'
  • #master_database_name ⇒ [String]
    'The name of the master database created when the Lightsail database resource is created.'
    Property Attributes
    • create_relational_database_prop ⇒ 'master_database_name'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::Lightsail::RelationalDatabase"
    • orig_name ⇒ 'master_database_name'
    

42
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 42

property :master_database_name, create_relational_database_prop: 'master_database_name', type: [String], disposition: :attribute, read_only: false, source: "MintPress::Aws::Lightsail::RelationalDatabase", description: 'The name of the master database created when the Lightsail database resource is created.', orig_name: 'master_database_name'
  • #master_username ⇒ [String]
    'The master user name of the database.'
    Property Attributes
    • create_relational_database_prop ⇒ 'master_username'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::Lightsail::RelationalDatabase"
    • orig_name ⇒ 'master_username'
    

43
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 43

property :master_username, create_relational_database_prop: 'master_username', type: [String], disposition: :attribute, read_only: false, source: "MintPress::Aws::Lightsail::RelationalDatabase", description: 'The master user name of the database.', orig_name: 'master_username'
  • #master_user_password ⇒ [String]
    'The password for the master user of your database. The password can include any printable ASCII character except "/", """, or "@". Constraints: Must contain 8 to 41 characters.'
    Property Attributes
    • create_relational_database_prop ⇒ 'master_user_password'
    • read_only ⇒ false
    • source ⇒ "update_relational_database"
    • update_relational_database_prop ⇒ 'master_user_password'
    

44
45
46
47
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 44

property :master_user_password, create_relational_database_prop: 'master_user_password', type: [String], read_only: false, source: "update_relational_database", description: 'The password for the master user of your database. The password can
include any printable ASCII character except "/", """, or "@".

Constraints: Must contain 8 to 41 characters.', update_relational_database_prop: 'master_user_password'
  • #preferred_backup_window ⇒ [String]
    'The daily time range during which automated backups are created for your database if automated backups are enabled. Constraints: Must be in the hh24:mi-hh24:mi format. Example: 16:00-16:30 Specified in Coordinated Universal Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.'
    Property Attributes
    • create_relational_database_prop ⇒ 'preferred_backup_window'
    • read_only ⇒ false
    • source ⇒ "update_relational_database"
    • orig_name ⇒ 'preferred_backup_window'
    • update_relational_database_prop ⇒ 'preferred_backup_window'
    

48
49
50
51
52
53
54
55
56
57
58
59
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 48

property :preferred_backup_window, create_relational_database_prop: 'preferred_backup_window', type: [String], read_only: false, source: "update_relational_database", description: 'The daily time range during which automated backups are created for
your database if automated backups are enabled.

Constraints:


Must be in the hh24:mi-hh24:mi format.

Example: 16:00-16:30
Specified in Coordinated Universal Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.', orig_name: 'preferred_backup_window', update_relational_database_prop: 'preferred_backup_window'
  • #preferred_maintenance_window ⇒ [String]
    'The weekly time range during which system maintenance can occur on your database. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. Constraints: Must be in the ddd:hh24:mi-ddd:hh24:mi format. Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Must be at least 30 minutes. Specified in Coordinated Universal Time (UTC). Example: Tue:17:00-Tue:17:30'
    Property Attributes
    • create_relational_database_prop ⇒ 'preferred_maintenance_window'
    • read_only ⇒ false
    • source ⇒ "update_relational_database"
    • orig_name ⇒ 'preferred_maintenance_window'
    • update_relational_database_prop ⇒ 'preferred_maintenance_window'
    

60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 60

property :preferred_maintenance_window, create_relational_database_prop: 'preferred_maintenance_window', type: [String], read_only: false, source: "update_relational_database", description: 'The weekly time range during which system maintenance can occur on
your database.

The default is a 30-minute window selected at random from an 8-hour
block of time for each AWS Region, occurring on a random day of the
week.

Constraints:


Must be in the ddd:hh24:mi-ddd:hh24:mi format.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be at least 30 minutes.
Specified in Coordinated Universal Time (UTC).
Example: Tue:17:00-Tue:17:30', orig_name: 'preferred_maintenance_window', update_relational_database_prop: 'preferred_maintenance_window'
  • #publicly_accessible ⇒ [TrueClass,FalseClass]
    'Specifies the accessibility options for your database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.'
    Property Attributes
    • create_relational_database_prop ⇒ 'publicly_accessible'
    • read_only ⇒ false
    • source ⇒ "update_relational_database"
    • orig_name ⇒ 'publicly_accessible'
    • update_relational_database_prop ⇒ 'publicly_accessible'
    

75
76
77
78
79
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 75

property :publicly_accessible, create_relational_database_prop: 'publicly_accessible', type: [TrueClass,FalseClass], read_only: false, source: "update_relational_database", description: 'Specifies the accessibility options for your database. A value of
true specifies a database that is available to resources outside of
your Lightsail account. A value of false specifies a database that
is available only to your Lightsail resources in the same region as
your database.', orig_name: 'publicly_accessible', update_relational_database_prop: 'publicly_accessible'
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::Lightsail::Tag]
    'The tag keys and optional values for the resource.'
    Property Attributes
    • create_relational_database_prop ⇒ 'tags'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::Lightsail::RelationalDatabase"
    • orig_name ⇒ 'tags'
    

80
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 80

property :tags, create_relational_database_prop: 'tags', type: [MintPress::Aws::Lightsail::Tag], array: false, disposition: :attribute, read_only: false, source: "MintPress::Aws::Lightsail::RelationalDatabase", description: 'The tag keys and optional values for the resource.', orig_name: 'tags', hash: true
  • #skip_final_snapshot ⇒ [TrueClass,FalseClass]
    'Determines whether a final database snapshot is created before your database is deleted. If true is specified, no database snapshot is created. If false is specified, a database snapshot is created before your database is deleted. You must specify the final relational database snapshot name parameter if the skip final snapshot parameter is false. Default: false'
    Property Attributes
    • delete_relational_database_prop ⇒ 'skip_final_snapshot'
    • read_only ⇒ false
    • source ⇒ "delete_relational_database"
    

81
82
83
84
85
86
87
88
89
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 81

property :skip_final_snapshot, delete_relational_database_prop: 'skip_final_snapshot', type: [TrueClass,FalseClass], read_only: false, source: "delete_relational_database", description: 'Determines whether a final database snapshot is created before your
database is deleted. If true is specified, no database snapshot is
created. If false is specified, a database snapshot is created
before your database is deleted.

You must specify the final relational database snapshot name
parameter if the skip final snapshot parameter is false.

Default: false'
  • #final_relational_database_snapshot_name ⇒ [String]
    'The name of the database snapshot created if skip final snapshot is false, which is the default value for that parameter. Specifying this parameter and also specifying the skip final snapshot parameter to true results in an error. Constraints: Must contain from 2 to 255 alphanumeric characters, or hyphens. The first and last character must be a letter or number.'
    Property Attributes
    • delete_relational_database_prop ⇒ 'final_relational_database_snapshot_name'
    • read_only ⇒ false
    • source ⇒ "delete_relational_database"
    

90
91
92
93
94
95
96
97
98
99
100
101
102
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 90

property :final_relational_database_snapshot_name, delete_relational_database_prop: 'final_relational_database_snapshot_name', type: [String], read_only: false, source: "delete_relational_database", description: 'The name of the database snapshot created if skip final snapshot is
false, which is the default value for that parameter.

 Specifying this parameter and also specifying the skip final
snapshot parameter to true results in an error.

 

Constraints:


Must contain from 2 to 255 alphanumeric characters, or hyphens.
The first and last character must be a letter or number.'
  • #arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the database.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::RelationalDatabase"
    • orig_name ⇒ 'arn'
    

103
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 103

property :arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) of the database.', source: "MintPress::Aws::Lightsail::RelationalDatabase", orig_name: 'arn', type: [String]
  • #backup_retention_enabled ⇒ [TrueClass,FalseClass]
    'A Boolean value indicating whether automated backup retention is enabled for the database.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::RelationalDatabase"
    • orig_name ⇒ 'backup_retention_enabled'
    

104
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 104

property :backup_retention_enabled, disposition: :attribute, description: 'A Boolean value indicating whether automated backup retention is enabled for the database.', source: "MintPress::Aws::Lightsail::RelationalDatabase", orig_name: 'backup_retention_enabled', type: [TrueClass,FalseClass]
  • #ca_certificate_identifier ⇒ [String]
    'Indicates the certificate that needs to be associated with the database.'
    Property Attributes
    • source ⇒ "update_relational_database"
    • orig_name ⇒ 'ca_certificate_identifier'
    • update_relational_database_prop ⇒ 'ca_certificate_identifier'
    • read_only ⇒ false
    

105
106
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 105

property :ca_certificate_identifier, description: 'Indicates the certificate that needs to be associated with the
database.', source: "update_relational_database", orig_name: 'ca_certificate_identifier', type: [String], update_relational_database_prop: 'ca_certificate_identifier', read_only: false
  • #created_at ⇒ [Time]
    'The timestamp when the database was created.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::RelationalDatabase"
    • orig_name ⇒ 'created_at'
    

107
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 107

property :created_at, disposition: :attribute, description: 'The timestamp when the database was created.', source: "MintPress::Aws::Lightsail::RelationalDatabase", orig_name: 'created_at', type: [Time]
  • #engine ⇒ [String]
    'The database software (for example, MySQL).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::RelationalDatabase"
    • orig_name ⇒ 'engine'
    

108
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 108

property :engine, disposition: :attribute, description: 'The database software (for example, MySQL).', source: "MintPress::Aws::Lightsail::RelationalDatabase", orig_name: 'engine', type: [String]
  • #engine_version ⇒ [String]
    'The database engine version (for example, 5.7.23).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::RelationalDatabase"
    • orig_name ⇒ 'engine_version'
    

109
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 109

property :engine_version, disposition: :attribute, description: 'The database engine version (for example, 5.7.23).', source: "MintPress::Aws::Lightsail::RelationalDatabase", orig_name: 'engine_version', type: [String]
  • #hardware ⇒ [MintPress::Aws::Lightsail::RelationalDatabaseHardware] (Default Value: MintPress::Aws::Lightsail::RelationalDatabaseHardware.new)
    'Describes the hardware of the database.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::RelationalDatabase"
    • orig_name ⇒ 'hardware'
    • default ⇒ MintPress::Aws::Lightsail::RelationalDatabaseHardware.new
    

110
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 110

property :hardware, disposition: :attribute, description: 'Describes the hardware of the database.', source: "MintPress::Aws::Lightsail::RelationalDatabase", orig_name: 'hardware', type: [MintPress::Aws::Lightsail::RelationalDatabaseHardware], default: MintPress::Aws::Lightsail::RelationalDatabaseHardware.new
  • #latest_restorable_time ⇒ [Time]
    'The latest point in time to which the database can be restored.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::RelationalDatabase"
    • orig_name ⇒ 'latest_restorable_time'
    

111
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 111

property :latest_restorable_time, disposition: :attribute, description: 'The latest point in time to which the database can be restored.', source: "MintPress::Aws::Lightsail::RelationalDatabase", orig_name: 'latest_restorable_time', type: [Time]
  • #location ⇒ [MintPress::Aws::Lightsail::ResourceLocation] (Default Value: MintPress::Aws::Lightsail::ResourceLocation.new)
    'The Region name and Availability Zone where the database is located.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::RelationalDatabase"
    • orig_name ⇒ 'location'
    • default ⇒ MintPress::Aws::Lightsail::ResourceLocation.new
    

112
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 112

property :location, disposition: :attribute, description: 'The Region name and Availability Zone where the database is located.', source: "MintPress::Aws::Lightsail::RelationalDatabase", orig_name: 'location', type: [MintPress::Aws::Lightsail::ResourceLocation], default: MintPress::Aws::Lightsail::ResourceLocation.new
  • #master_endpoint ⇒ [MintPress::Aws::Lightsail::RelationalDatabaseEndpoint] (Default Value: MintPress::Aws::Lightsail::RelationalDatabaseEndpoint.new)
    'The master endpoint for the database.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::RelationalDatabase"
    • orig_name ⇒ 'master_endpoint'
    • default ⇒ MintPress::Aws::Lightsail::RelationalDatabaseEndpoint.new
    

113
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 113

property :master_endpoint, disposition: :attribute, description: 'The master endpoint for the database.', source: "MintPress::Aws::Lightsail::RelationalDatabase", orig_name: 'master_endpoint', type: [MintPress::Aws::Lightsail::RelationalDatabaseEndpoint], default: MintPress::Aws::Lightsail::RelationalDatabaseEndpoint.new
  • #name ⇒ [String]
    'The unique name of the database resource in Lightsail.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::RelationalDatabase"
    • orig_name ⇒ 'name'
    

114
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 114

property :name, disposition: :attribute, description: 'The unique name of the database resource in Lightsail.', source: "MintPress::Aws::Lightsail::RelationalDatabase", orig_name: 'name', type: [String]
  • #parameter_apply_status ⇒ [String]
    'The status of parameter updates for the database.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::RelationalDatabase"
    • orig_name ⇒ 'parameter_apply_status'
    

115
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 115

property :parameter_apply_status, disposition: :attribute, description: 'The status of parameter updates for the database.', source: "MintPress::Aws::Lightsail::RelationalDatabase", orig_name: 'parameter_apply_status', type: [String]
  • #pending_maintenance_actions ⇒ Array of ⇒ [MintPress::Aws::Lightsail::PendingMaintenanceAction]
    'Describes the pending maintenance actions for the database.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::RelationalDatabase"
    • orig_name ⇒ 'pending_maintenance_actions'
    

116
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 116

property :pending_maintenance_actions, disposition: :attribute, description: 'Describes the pending maintenance actions for the database.', source: "MintPress::Aws::Lightsail::RelationalDatabase", orig_name: 'pending_maintenance_actions', type: [MintPress::Aws::Lightsail::PendingMaintenanceAction], array: true
  • #pending_modified_values ⇒ [MintPress::Aws::Lightsail::PendingModifiedRelationalDatabaseValue] (Default Value: MintPress::Aws::Lightsail::PendingModifiedRelationalDatabaseValue.new)
    'Describes pending database value modifications.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::RelationalDatabase"
    • orig_name ⇒ 'pending_modified_values'
    • default ⇒ MintPress::Aws::Lightsail::PendingModifiedRelationalDatabaseValue.new
    

117
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 117

property :pending_modified_values, disposition: :attribute, description: 'Describes pending database value modifications.', source: "MintPress::Aws::Lightsail::RelationalDatabase", orig_name: 'pending_modified_values', type: [MintPress::Aws::Lightsail::PendingModifiedRelationalDatabaseValue], default: MintPress::Aws::Lightsail::PendingModifiedRelationalDatabaseValue.new
  • #resource_type ⇒ [String]
    'The Lightsail resource type for the database (for example, RelationalDatabase).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::RelationalDatabase"
    • orig_name ⇒ 'resource_type'
    

118
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 118

property :resource_type, disposition: :attribute, description: 'The Lightsail resource type for the database (for example, RelationalDatabase).', source: "MintPress::Aws::Lightsail::RelationalDatabase", orig_name: 'resource_type', type: [String]
  • #secondary_availability_zone ⇒ [String]
    'Describes the secondary Availability Zone of a high availability database.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::RelationalDatabase"
    • orig_name ⇒ 'secondary_availability_zone'
    

119
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 119

property :secondary_availability_zone, disposition: :attribute, description: 'Describes the secondary Availability Zone of a high availability database.', source: "MintPress::Aws::Lightsail::RelationalDatabase", orig_name: 'secondary_availability_zone', type: [String]
  • #state ⇒ [String]
    'Describes the current state of the database.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::RelationalDatabase"
    • orig_name ⇒ 'state'
    

120
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 120

property :state, disposition: :attribute, description: 'Describes the current state of the database.', source: "MintPress::Aws::Lightsail::RelationalDatabase", orig_name: 'state', type: [String]
  • #support_code ⇒ [String]
    'The support code for the database.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::RelationalDatabase"
    • orig_name ⇒ 'support_code'
    

121
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 121

property :support_code, disposition: :attribute, description: 'The support code for the database.', source: "MintPress::Aws::Lightsail::RelationalDatabase", orig_name: 'support_code', type: [String]
  • #page_token ⇒ [String]
    'The token to advance to the next page of results from your request. To get a page token, perform an initial GetRelationalDatabases request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.'
    Property Attributes
    • get_relational_databases_prop ⇒ 'page_token'
    • read_only ⇒ false
    • source ⇒ "get_relational_databases"
    

122
123
124
125
126
127
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 122

property :page_token, get_relational_databases_prop: 'page_token', type: [String], read_only: false, source: "get_relational_databases", description: 'The token to advance to the next page of results from your request.

To get a page token, perform an initial GetRelationalDatabases
request. If your results are paginated, the response will return a
next page token that you can specify as the page token in a subsequent
request.'
  • #relational_database_snapshot_name ⇒ [String]
    'The name of your new database snapshot to be created before stopping your database.'
    Property Attributes
    • stop_relational_database_prop ⇒ 'relational_database_snapshot_name'
    • read_only ⇒ false
    • source ⇒ "stop_relational_database"
    

128
129
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 128

property :relational_database_snapshot_name, stop_relational_database_prop: 'relational_database_snapshot_name', type: [String], read_only: false, source: "stop_relational_database", description: 'The name of your new database snapshot to be created before stopping
your database.'
  • #rotate_master_user_password ⇒ [TrueClass,FalseClass]
    'When true, the master user password is changed to a new strong password generated by Lightsail. Use the get relational database master user password operation to get the new password.'
    Property Attributes
    • update_relational_database_prop ⇒ 'rotate_master_user_password'
    • read_only ⇒ false
    • source ⇒ "update_relational_database"
    

130
131
132
133
134
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 130

property :rotate_master_user_password, update_relational_database_prop: 'rotate_master_user_password', type: [TrueClass,FalseClass], read_only: false, source: "update_relational_database", description: 'When true, the master user password is changed to a new strong
password generated by Lightsail.

Use the get relational database master user password operation to
get the new password.'
  • #enable_backup_retention ⇒ [TrueClass,FalseClass]
    'When true, enables automated backup retention for your database. Updates are applied during the next maintenance window because this can result in an outage.'
    Property Attributes
    • update_relational_database_prop ⇒ 'enable_backup_retention'
    • read_only ⇒ false
    • source ⇒ "update_relational_database"
    

135
136
137
138
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 135

property :enable_backup_retention, update_relational_database_prop: 'enable_backup_retention', type: [TrueClass,FalseClass], read_only: false, source: "update_relational_database", description: 'When true, enables automated backup retention for your database.

Updates are applied during the next maintenance window because this
can result in an outage.'
  • #disable_backup_retention ⇒ [TrueClass,FalseClass]
    'When true, disables automated backup retention for your database. Disabling backup retention deletes all automated database backups. Before disabling this, you may want to create a snapshot of your database using the create relational database snapshot operation. Updates are applied during the next maintenance window because this can result in an outage.'
    Property Attributes
    • update_relational_database_prop ⇒ 'disable_backup_retention'
    • read_only ⇒ false
    • source ⇒ "update_relational_database"
    

139
140
141
142
143
144
145
146
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 139

property :disable_backup_retention, update_relational_database_prop: 'disable_backup_retention', type: [TrueClass,FalseClass], read_only: false, source: "update_relational_database", description: 'When true, disables automated backup retention for your database.

Disabling backup retention deletes all automated database backups.
Before disabling this, you may want to create a snapshot of your
database using the create relational database snapshot operation.

Updates are applied during the next maintenance window because this
can result in an outage.'
  • #apply_immediately ⇒ [TrueClass,FalseClass]
    'When true, applies changes immediately. When false, applies changes during the preferred maintenance window. Some changes may cause an outage. Default: false'
    Property Attributes
    • update_relational_database_prop ⇒ 'apply_immediately'
    • read_only ⇒ false
    • source ⇒ "update_relational_database"
    

147
148
149
150
151
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 147

property :apply_immediately, update_relational_database_prop: 'apply_immediately', type: [TrueClass,FalseClass], read_only: false, source: "update_relational_database", description: 'When true, applies changes immediately. When false, applies
changes during the preferred maintenance window. Some changes may
cause an outage.

Default: false'
  • #relational_database_blueprint ⇒ [MintPress::Aws::Lightsail::RelationalDatabaseBlueprint]
    'The blueprint ID for the database.'
    Property Attributes
    • create_relational_database_prop ⇒ 'relational_database_blueprint_id'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::Lightsail::RelationalDatabase"
    • orig_name ⇒ 'relational_database_blueprint_id'
    • from ⇒ String
    

152
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 152

property :relational_database_blueprint, create_relational_database_prop: 'relational_database_blueprint_id', type: [MintPress::Aws::Lightsail::RelationalDatabaseBlueprint], disposition: :attribute, read_only: false, source: "MintPress::Aws::Lightsail::RelationalDatabase", description: 'The blueprint ID for the database.', orig_name: 'relational_database_blueprint_id', from: String
  • #relational_database_bundle ⇒ [MintPress::Aws::Lightsail::RelationalDatabaseBundle]
    'The bundle ID for the database.'
    Property Attributes
    • create_relational_database_prop ⇒ 'relational_database_bundle_id'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::Lightsail::RelationalDatabase"
    • orig_name ⇒ 'relational_database_bundle_id'
    • from ⇒ String
    

153
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 153

property :relational_database_bundle, create_relational_database_prop: 'relational_database_bundle_id', type: [MintPress::Aws::Lightsail::RelationalDatabaseBundle], disposition: :attribute, read_only: false, source: "MintPress::Aws::Lightsail::RelationalDatabase", description: 'The bundle ID for the database.', orig_name: 'relational_database_bundle_id', from: 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 
    

157
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 157

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
    

160
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database.rb', line 160

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

Returns a new instance of RelationalDatabase.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#get ⇒ Object

#start ⇒ Object

#stop ⇒ Object

#update ⇒ Object