You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IAM::ServerCertificate

Inherits:
Resources::Resource show all
Defined in:
(unknown)

Instance Attribute Summary collapse

Attributes inherited from Resources::Resource

#client, #identifiers

Instance Method Summary collapse

Methods inherited from Resources::Resource

add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until

Methods included from Resources::OperationMethods

#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations

Constructor Details

#initialize(name, options = {}) ⇒ Object #initialize(options = {}) ⇒ Object

Overloads:

  • #initialize(name, options = {}) ⇒ Object

    Parameters:

    • name (String)

    Options Hash (options):

    • :client (Client) —

      When `:client is not given, the options hash is used to construct a new Client object.

  • #initialize(options = {}) ⇒ Object

    Options Hash (options):

    • :name (required, String)
    • :client (Client) —

      When `:client is not given, the options hash is used to construct a new Client object.

Instance Attribute Details

#certificate_body ⇒ String (readonly)

The contents of the public key certificate.

Returns:

  • (String) —

    The contents of the public key certificate.

#certificate_chain ⇒ String (readonly)

The contents of the public key certificate chain.

Returns:

  • (String) —

    The contents of the public key certificate chain.

#name ⇒ String (readonly)

Returns:

  • (String)

#server_certificate_metadata ⇒ Types::ServerCertificateMetadata (readonly)

The meta information of the server certificate, such as its name, path, ID, and ARN.

Returns:

Instance Method Details

#delete ⇒ Struct

Deletes the specified server certificate.

For more information about working with server certificates, see Working with Server Certificates in the IAM User Guide. This topic also includes a list of AWS services that can use the server certificates that you manage with IAM.

If you are using a server certificate with Elastic Load Balancing, deleting the certificate could have implications for your application. If Elastic Load Balancing doesn't detect the deletion of bound certificates, it may continue to use the certificates. This could cause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the reference to the certificate from Elastic Load Balancing before using this command to delete the certificate. For more information, go to DeleteLoadBalancerListeners in the Elastic Load Balancing API Reference.

Examples:

Request syntax example with placeholder values


servercertificate.delete()

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#update(options = {}) ⇒ ServerCertificate

Examples:

Request syntax example with placeholder values


servercertificate.update({
  new_path: "pathType",
  new_server_certificate_name: "serverCertificateNameType",
})

Basic usage

servercertificate = servercertificate.update(options)
servercertificate.name
#=> "servercertificate-name"

Options Hash (options):

  • :new_path (String) —

    The new path for the server certificate. Include this only if you are updating the server certificate\'s path.

    This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

  • :new_server_certificate_name (String) —

    The new name for the server certificate. Include this only if you are updating the server certificate\'s name. The name of the certificate cannot contain any spaces.

    This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Returns:

See Also: