Update Relational Database
lightsail_update_relational_database | R Documentation |
Allows the update of one or more attributes of a database in Amazon Lightsail¶
Description¶
Allows the update of one or more attributes of a database in Amazon Lightsail.
Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database's predefined maintenance window.
The update relational database
operation supports tag-based access
control via resource tags applied to the resource identified by
relationalDatabaseName. For more information, see the Amazon Lightsail
Developer
Guide.
Usage¶
lightsail_update_relational_database(relationalDatabaseName,
masterUserPassword, rotateMasterUserPassword, preferredBackupWindow,
preferredMaintenanceWindow, enableBackupRetention,
disableBackupRetention, publiclyAccessible, applyImmediately,
caCertificateIdentifier, relationalDatabaseBlueprintId)
Arguments¶
relationalDatabaseName
[required] The name of your Lightsail database resource to update.
masterUserPassword
The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
MySQL
Constraints: Must contain from 8 to 41 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
rotateMasterUserPassword
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.preferredBackupWindow
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.
preferredMaintenanceWindow
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 Amazon Web Services 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
enableBackupRetention
When
true
, enables automated backup retention for your database.Updates are applied during the next maintenance window because this can result in an outage.
disableBackupRetention
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.
publiclyAccessible
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 offalse
specifies a database that is available only to your Lightsail resources in the same region as your database.applyImmediately
When
true
, applies changes immediately. Whenfalse
, applies changes during the preferred maintenance window. Some changes may cause an outage.Default:
false
caCertificateIdentifier
Indicates the certificate that needs to be associated with the database.
relationalDatabaseBlueprintId
This parameter is used to update the major version of the database. Enter the
blueprintId
for the major version that you want to update to.Use the
get_relational_database_blueprints
action to get a list of available blueprint IDs.
Value¶
A list with the following syntax:
list(
operations = list(
list(
id = "string",
resourceName = "string",
resourceType = "ContainerService"|"Instance"|"StaticIp"|"KeyPair"|"InstanceSnapshot"|"Domain"|"PeeredVpc"|"LoadBalancer"|"LoadBalancerTlsCertificate"|"Disk"|"DiskSnapshot"|"RelationalDatabase"|"RelationalDatabaseSnapshot"|"ExportSnapshotRecord"|"CloudFormationStackRecord"|"Alarm"|"ContactMethod"|"Distribution"|"Certificate"|"Bucket",
createdAt = as.POSIXct(
"2015-01-01"
),
location = list(
availabilityZone = "string",
regionName = "us-east-1"|"us-east-2"|"us-west-1"|"us-west-2"|"eu-west-1"|"eu-west-2"|"eu-west-3"|"eu-central-1"|"ca-central-1"|"ap-south-1"|"ap-southeast-1"|"ap-southeast-2"|"ap-northeast-1"|"ap-northeast-2"|"eu-north-1"
),
isTerminal = TRUE|FALSE,
operationDetails = "string",
operationType = "DeleteKnownHostKeys"|"DeleteInstance"|"CreateInstance"|"StopInstance"|"StartInstance"|"RebootInstance"|"OpenInstancePublicPorts"|"PutInstancePublicPorts"|"CloseInstancePublicPorts"|"AllocateStaticIp"|"ReleaseStaticIp"|"AttachStaticIp"|"DetachStaticIp"|"UpdateDomainEntry"|"DeleteDomainEntry"|"CreateDomain"|"DeleteDomain"|"CreateInstanceSnapshot"|"DeleteInstanceSnapshot"|"CreateInstancesFromSnapshot"|"CreateLoadBalancer"|"DeleteLoadBalancer"|"AttachInstancesToLoadBalancer"|"DetachInstancesFromLoadBalancer"|"UpdateLoadBalancerAttribute"|"CreateLoadBalancerTlsCertificate"|"DeleteLoadBalancerTlsCertificate"|"AttachLoadBalancerTlsCertificate"|"CreateDisk"|"DeleteDisk"|"AttachDisk"|"DetachDisk"|"CreateDiskSnapshot"|"DeleteDiskSnapshot"|"CreateDiskFromSnapshot"|"CreateRelationalDatabase"|"UpdateRelationalDatabase"|"DeleteRelationalDatabase"|"CreateRelationalDatabaseFromSnapshot"|"CreateRelationalDatabaseSnapshot"|"DeleteRelationalDatabaseSnapshot"|"UpdateRelationalDatabaseParameters"|"StartRelationalDatabase"|"RebootRelationalDatabase"|"StopRelationalDatabase"|"EnableAddOn"|"DisableAddOn"|"PutAlarm"|"GetAlarms"|"DeleteAlarm"|"TestAlarm"|"CreateContactMethod"|"GetContactMethods"|"SendContactMethodVerification"|"DeleteContactMethod"|"CreateDistribution"|"UpdateDistribution"|"DeleteDistribution"|"ResetDistributionCache"|"AttachCertificateToDistribution"|"DetachCertificateFromDistribution"|"UpdateDistributionBundle"|"SetIpAddressType"|"CreateCertificate"|"DeleteCertificate"|"CreateContainerService"|"UpdateContainerService"|"DeleteContainerService"|"CreateContainerServiceDeployment"|"CreateContainerServiceRegistryLogin"|"RegisterContainerImage"|"DeleteContainerImage"|"CreateBucket"|"DeleteBucket"|"CreateBucketAccessKey"|"DeleteBucketAccessKey"|"UpdateBucketBundle"|"UpdateBucket"|"SetResourceAccessForBucket"|"UpdateInstanceMetadataOptions"|"StartGUISession"|"StopGUISession"|"SetupInstanceHttps",
status = "NotStarted"|"Started"|"Failed"|"Completed"|"Succeeded",
statusChangedAt = as.POSIXct(
"2015-01-01"
),
errorCode = "string",
errorDetails = "string"
)
)
)
Request syntax¶
svc$update_relational_database(
relationalDatabaseName = "string",
masterUserPassword = "string",
rotateMasterUserPassword = TRUE|FALSE,
preferredBackupWindow = "string",
preferredMaintenanceWindow = "string",
enableBackupRetention = TRUE|FALSE,
disableBackupRetention = TRUE|FALSE,
publiclyAccessible = TRUE|FALSE,
applyImmediately = TRUE|FALSE,
caCertificateIdentifier = "string",
relationalDatabaseBlueprintId = "string"
)