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

Class: Aws::SSM::Types::DeleteDocumentRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DeleteDocumentRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "DocumentName", # required
  document_version: "DocumentVersion",
  version_name: "DocumentVersionName",
  force: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#document_version ⇒ String

The version of the document that you want to delete. If not provided, all versions of the document are deleted.

Returns:

  • (String) —

    The version of the document that you want to delete.

#force ⇒ Boolean

Some SSM document types require that you specify a Force flag before you can delete the document. For example, you must specify a Force flag to delete a document of type ApplicationConfigurationSchema. You can restrict access to the Force flag in an AWS Identity and Access Management (IAM) policy.

Returns:

  • (Boolean) —

    Some SSM document types require that you specify a Force flag before you can delete the document.

#name ⇒ String

The name of the document.

Returns:

  • (String) —

    The name of the document.

#version_name ⇒ String

The version name of the document that you want to delete. If not provided, all versions of the document are deleted.

Returns:

  • (String) —

    The version name of the document that you want to delete.