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

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::DeleteDocumentRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-ssm/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #document_version ⇒ 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.

• #name ⇒ String

  The name of the document.

• #version_name ⇒ String

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

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)

# File 'lib/aws-sdk-ssm/types.rb', line 4122

class DeleteDocumentRequest < Struct.new(
  :name,
  :document_version,
  :version_name,
  :force)
  SENSITIVE = []
  include Aws::Structure
end

#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 Identity and Access Management (IAM) policy.

Returns:

• (Boolean)

# File 'lib/aws-sdk-ssm/types.rb', line 4122

class DeleteDocumentRequest < Struct.new(
  :name,
  :document_version,
  :version_name,
  :force)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the document.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 4122

class DeleteDocumentRequest < Struct.new(
  :name,
  :document_version,
  :version_name,
  :force)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-ssm/types.rb', line 4122

class DeleteDocumentRequest < Struct.new(
  :name,
  :document_version,
  :version_name,
  :force)
  SENSITIVE = []
  include Aws::Structure
end