AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Class: Aws::IAM::SigningCertificate

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(user_name, id, options = {}) ⇒ Object #initialize(options = {}) ⇒ Object

Overloads:

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

    Parameters:

    • user_name (String)
    • id (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):

    • :user_name (required, String)
    • :id (required, String)
    • :client (Client)

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

Instance Attribute Details

#certificate_bodyString (readonly)

The contents of the signing certificate.

Returns:

  • (String)

    The contents of the signing certificate.

#certificate_idString (readonly)

The ID for the signing certificate.

Returns:

  • (String)

    The ID for the signing certificate.

#idString (readonly)

Returns:

  • (String)

#statusString (readonly)

The status of the signing certificate. Active means that the key is valid for API calls, while Inactive means it is not.

Possible values:

  • Active
  • Inactive

Returns:

  • (String)

    The status of the signing certificate.

#upload_dateTime (readonly)

The date when the signing certificate was uploaded.

Returns:

  • (Time)

    The date when the signing certificate was uploaded.

#user_nameString (readonly)

Returns:

  • (String)

Instance Method Details

#activateStruct

Changes the status of the specified user signing certificate from active to disabled, or vice versa. This operation can be used to disable an IAM user's signing certificate as part of a certificate rotation work flow.

If the UserName field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials even if the AWS account has no associated users.

Examples:

Request syntax example with placeholder values


signingcertificate.activate()

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#deactivateStruct

Changes the status of the specified user signing certificate from active to disabled, or vice versa. This operation can be used to disable an IAM user's signing certificate as part of a certificate rotation work flow.

If the UserName field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials even if the AWS account has no associated users.

Examples:

Request syntax example with placeholder values


signingcertificate.deactivate()

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#deleteStruct

Deletes a signing certificate associated with the specified IAM user.

If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials even if the AWS account has no associated IAM users.

Examples:

Request syntax example with placeholder values


signingcertificate.delete()

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#userUser

Returns: