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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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) 


4223
4224
4225
4226
4227
4228
4229
4230
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4223

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) 


4223
4224
4225
4226
4227
4228
4229
4230
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4223

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

#name ⇒ String

The name of the document.

Returns:

  • (String) 


4223
4224
4225
4226
4227
4228
4229
4230
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4223

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) 


4223
4224
4225
4226
4227
4228
4229
4230
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4223

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