Update Server

opsworkscm_update_server

R Documentation

Updates settings for a server

Description

Updates settings for a server.

This operation is synchronous.

Usage

opsworkscm_update_server(DisableAutomatedBackup, BackupRetentionCount,
  ServerName, PreferredMaintenanceWindow, PreferredBackupWindow)

Arguments

DisableAutomatedBackup

Setting DisableAutomatedBackup to true disables automated or scheduled backups. Automated backups are enabled by default.

BackupRetentionCount

Sets the number of automated backups that you want to keep.

ServerName

[required] The name of the server to update.

PreferredMaintenanceWindow

PreferredBackupWindow

Value

A list with the following syntax:

list(
  Server = list(
    AssociatePublicIpAddress = TRUE|FALSE,
    BackupRetentionCount = 123,
    ServerName = "string",
    CreatedAt = as.POSIXct(
      "2015-01-01"
    ),
    CloudFormationStackArn = "string",
    CustomDomain = "string",
    DisableAutomatedBackup = TRUE|FALSE,
    Endpoint = "string",
    Engine = "string",
    EngineModel = "string",
    EngineAttributes = list(
      list(
        Name = "string",
        Value = "string"
      )
    ),
    EngineVersion = "string",
    InstanceProfileArn = "string",
    InstanceType = "string",
    KeyPair = "string",
    MaintenanceStatus = "SUCCESS"|"FAILED",
    PreferredMaintenanceWindow = "string",
    PreferredBackupWindow = "string",
    SecurityGroupIds = list(
      "string"
    ),
    ServiceRoleArn = "string",
    Status = "BACKING_UP"|"CONNECTION_LOST"|"CREATING"|"DELETING"|"MODIFYING"|"FAILED"|"HEALTHY"|"RUNNING"|"RESTORING"|"SETUP"|"UNDER_MAINTENANCE"|"UNHEALTHY"|"TERMINATED",
    StatusReason = "string",
    SubnetIds = list(
      "string"
    ),
    ServerArn = "string"
  )
)

Request syntax

svc$update_server(
  DisableAutomatedBackup = TRUE|FALSE,
  BackupRetentionCount = 123,
  ServerName = "string",
  PreferredMaintenanceWindow = "string",
  PreferredBackupWindow = "string"
)