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

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

Overview

Note:

When making an API call, you may pass DeleteDocumentRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#document_versionString

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

Returns:

  • (String)

4242
4243
4244
4245
4246
4247
4248
4249
# File 'lib/aws-sdk-ssm/types.rb', line 4242

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

#forceBoolean

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)

4242
4243
4244
4245
4246
4247
4248
4249
# File 'lib/aws-sdk-ssm/types.rb', line 4242

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

#nameString

The name of the document.

Returns:

  • (String)

4242
4243
4244
4245
4246
4247
4248
4249
# File 'lib/aws-sdk-ssm/types.rb', line 4242

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

#version_nameString

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

Returns:

  • (String)

4242
4243
4244
4245
4246
4247
4248
4249
# File 'lib/aws-sdk-ssm/types.rb', line 4242

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