update_server_certificate ( $server_certificate_name, $opt )

Updates the name and/or the path of the specified server certificate.

You should understand the implications of changing a server certificate’s path or name. For more information, see Managing Server Certificates in Using AWS Identity and Access Management.

To change a server certificate name the requester must have appropriate permissions on both the source object and the target object. For example, to change the name from ProductionCert to ProdCert, the entity making the request must have permission on ProductionCert and ProdCert, or must have permission on all (*). For more information about permissions, see Permissions and Policies.

Access

public

Parameters

Parameter

Type

Required

Description

$server_certificate_name

string

Required

The name of the server certificate that you want to update. [Constraints: The value must be between 1 and 128 characters, and must match the following regular expression pattern: [\w+=,.@-]*]

$opt

array

Optional

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

  • NewPath - string - Optional - The new path for the server certificate. Include this only if you are updating the server certificate’s path. [Constraints: The value must be between 1 and 512 characters, and must match the following regular expression pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)]
  • NewServerCertificateName - string - Optional - The new name for the server certificate. Include this only if you are updating the server certificate’s name. [Constraints: The value must be between 1 and 128 characters, and must match the following regular expression pattern: [\w+=,.@-]*]
  • 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.

Examples

Updates the information for a server certificate.

// Instantiate the class
$iam = new AmazonIAM();

$response = $iam->update_server_certificate('my-server-cert', array(
	'NewPath' => '/'
));

// Success?
var_dump($response->isOK());
Result:
bool(true)

Source

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

public function update_server_certificate($server_certificate_name, $opt = null)
{
    if (!$opt) $opt = array();
    $opt['ServerCertificateName'] = $server_certificate_name;
    
    return $this->authenticate('UpdateServerCertificate', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback