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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/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)


3685
3686
3687
3688
3689
3690
3691
3692
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3685

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

Returns:

  • (Boolean)


3685
3686
3687
3688
3689
3690
3691
3692
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3685

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

#nameString

The name of the document.

Returns:

  • (String)


3685
3686
3687
3688
3689
3690
3691
3692
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3685

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)


3685
3686
3687
3688
3689
3690
3691
3692
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3685

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