Modify Option Group

rds_modify_option_group

R Documentation

Modifies an existing option group

Description

Modifies an existing option group.

Usage

rds_modify_option_group(OptionGroupName, OptionsToInclude,
  OptionsToRemove, ApplyImmediately)

Arguments

OptionGroupName

[required] The name of the option group to be modified.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

OptionsToInclude

Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.

OptionsToRemove

Options in this list are removed from the option group.

ApplyImmediately

Specifies whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.

Value

A list with the following syntax:

list(
  OptionGroup = list(
    OptionGroupName = "string",
    OptionGroupDescription = "string",
    EngineName = "string",
    MajorEngineVersion = "string",
    Options = list(
      list(
        OptionName = "string",
        OptionDescription = "string",
        Persistent = TRUE|FALSE,
        Permanent = TRUE|FALSE,
        Port = 123,
        OptionVersion = "string",
        OptionSettings = list(
          list(
            Name = "string",
            Value = "string",
            DefaultValue = "string",
            Description = "string",
            ApplyType = "string",
            DataType = "string",
            AllowedValues = "string",
            IsModifiable = TRUE|FALSE,
            IsCollection = TRUE|FALSE
          )
        ),
        DBSecurityGroupMemberships = list(
          list(
            DBSecurityGroupName = "string",
            Status = "string"
          )
        ),
        VpcSecurityGroupMemberships = list(
          list(
            VpcSecurityGroupId = "string",
            Status = "string"
          )
        )
      )
    ),
    AllowsVpcAndNonVpcInstanceMemberships = TRUE|FALSE,
    VpcId = "string",
    OptionGroupArn = "string",
    SourceOptionGroup = "string",
    SourceAccountId = "string",
    CopyTimestamp = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$modify_option_group(
  OptionGroupName = "string",
  OptionsToInclude = list(
    list(
      OptionName = "string",
      Port = 123,
      OptionVersion = "string",
      DBSecurityGroupMemberships = list(
        "string"
      ),
      VpcSecurityGroupMemberships = list(
        "string"
      ),
      OptionSettings = list(
        list(
          Name = "string",
          Value = "string",
          DefaultValue = "string",
          Description = "string",
          ApplyType = "string",
          DataType = "string",
          AllowedValues = "string",
          IsModifiable = TRUE|FALSE,
          IsCollection = TRUE|FALSE
        )
      )
    )
  ),
  OptionsToRemove = list(
    "string"
  ),
  ApplyImmediately = TRUE|FALSE
)