delete_tags ( $tags, $opt )

Removes the specified tags or a set of tags from a set of resources.

Access

public

Parameters

Parameter

Type

Required

Description

$tags

array

Required

Each tag should be defined by its resource type, resource ID, key, value, and a propagate flag. Valid values are: Resource type = auto-scaling-group, Resource ID = AutoScalingGroupName, key= value, value= value, propagate= true or false.

  • x - array - Optional - This represents a simple array index.
    • ResourceId - string - Optional - The name of the Auto Scaling group. [Constraints: The value must match the following regular expression pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*]
    • ResourceType - string - Optional - The kind of resource to which the tag is applied. Currently, Auto Scaling supports the auto-scaling-group resource type. [Constraints: The value must match the following regular expression pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*]
    • Key - string - Required - The key of the tag. [Constraints: The value must be between 1 and 128 characters, and must match the following regular expression pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*]
    • Value - string - Optional - The value of the tag. [Constraints: The value must be between 0 and 256 characters, and must match the following regular expression pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*]
    • PropagateAtLaunch - boolean - Optional - Specifies whether the new tag will be applied to instances launched after the tag is created. The same behavior applies to updates: If you change a tag, the changed tag will be applied to all instances launched after you made the change.

$opt

array

Optional

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

  • 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/as.class.php | Toggle source view (11 lines) | View on GitHub

public function delete_tags($tags, $opt = null)
{
    if (!$opt) $opt = array();
            
    // Required list + map
    $opt = array_merge($opt, CFComplexType::map(array(
        'Tags' => (is_array($tags) ? $tags : array($tags))
    ), 'member'));

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

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback