modify_option_group ( $option_group_name, $opt )

Modifies an existing Option Group.

Access

public

Parameters

Parameter

Type

Required

Description

$option_group_name

string

Required

The name of the option group to be modified.

$opt

array

Optional

An associative array of parameters that can have the following keys:

  • OptionsToInclude - array - Optional - Options in this list are added to the Option Group or, if already present, the specified configuration is used to update the existing configuration.
    • x - array - Optional - This represents a simple array index.
      • OptionName - string - Required - The configuration of options to include in a group.
      • Port - integer - Optional - The optional port for the option.
      • DBSecurityGroupMemberships - string|array - Optional - A list of DBSecurityGroupMemebrship name strings used for this option. Pass a string for a single value, or an indexed array for multiple values.
      • VpcSecurityGroupMemberships - string|array - Optional - A list of VpcSecurityGroupMemebrship name strings used for this option. Pass a string for a single value, or an indexed array for multiple values.
      • OptionSettings - array - Optional - A list of option settings applied for this option.
        • x - array - Optional - This represents a simple array index.
          • Name - string - Optional - The name of the setting.
          • Value - string - Optional - The value of this setting.
          • DefaultValue - string - Optional - Default value for this setting.
          • Description - string - Optional - The description of the setting.
          • ApplyType - string - Optional - Specifies the apply type for this setting.
          • DataType - string - Optional - Specifies the valid data type of this setting
          • AllowedValues - string - Optional - Specifies a valid list/range of values allowed for this setting.
          • IsModifiable - boolean - Optional - Indicates if the setting is modifiable or not.
          • IsCollection - boolean - Optional - Indicates if the value for the setting can be a list of values or a single value.
  • OptionsToRemove - string|array - Optional - Options in this list are removed from the Option Group. Pass a string for a single value, or an indexed array for multiple values.
  • ApplyImmediately - boolean - Optional - Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the Option Group.
  • curlopts - array - Optional - A set of values to pass directly into curl_setopt(), where the key is a pre-defined CURLOPT_* constant.
  • returnCurlHandle - boolean - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.

Returns

Type

Description

CFResponse

A CFResponse object containing a parsed HTTP response.

Source

Method defined in services/rds.class.php | Toggle source view (25 lines) | View on GitHub

public function modify_option_group($option_group_name, $opt = null)
{
    if (!$opt) $opt = array();
    $opt['OptionGroupName'] = $option_group_name;
    
    // Optional list + map
    if (isset($opt['OptionsToInclude']))
    {
        $opt = array_merge($opt, CFComplexType::map(array(
            'OptionsToInclude' => $opt['OptionsToInclude']
        ), 'member'));
        unset($opt['OptionsToInclude']);
    }
    
    // Optional list (non-map)
    if (isset($opt['OptionsToRemove']))
    {
        $opt = array_merge($opt, CFComplexType::map(array(
            'OptionsToRemove' => (is_array($opt['OptionsToRemove']) ? $opt['OptionsToRemove'] : array($opt['OptionsToRemove']))
        ), 'member'));
        unset($opt['OptionsToRemove']);
    }

    return $this->authenticate('ModifyOptionGroup', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback