opsworkscm_update_server: Updates settings for a server

Description Usage Arguments Value Request syntax

View source: R/opsworkscm_operations.R

Description

Updates settings for a server.

This operation is synchronous.

Usage

1
2
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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
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

1
2
3
4
5
6
7
svc$update_server(
  DisableAutomatedBackup = TRUE|FALSE,
  BackupRetentionCount = 123,
  ServerName = "string",
  PreferredMaintenanceWindow = "string",
  PreferredBackupWindow = "string"
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.