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
When making an API call, you may pass DeleteDocumentRequest data as a hash:
{
name: "DocumentName", # required
document_version: "DocumentVersion",
version_name: "DocumentVersionName",
force: false,
}
Instance Attribute Summary collapse
-
#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.
3388 3389 3390 3391 3392 3393 3394 |
# File 'lib/aws-sdk-ssm/types.rb', line 3388 class DeleteDocumentRequest < Struct.new( :name, :document_version, :version_name, :force) 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 AWS Identity and Access Management (IAM) policy.
3388 3389 3390 3391 3392 3393 3394 |
# File 'lib/aws-sdk-ssm/types.rb', line 3388 class DeleteDocumentRequest < Struct.new( :name, :document_version, :version_name, :force) include Aws::Structure end |
#name ⇒ String
The name of the document.
3388 3389 3390 3391 3392 3393 3394 |
# File 'lib/aws-sdk-ssm/types.rb', line 3388 class DeleteDocumentRequest < Struct.new( :name, :document_version, :version_name, :force) 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.
3388 3389 3390 3391 3392 3393 3394 |
# File 'lib/aws-sdk-ssm/types.rb', line 3388 class DeleteDocumentRequest < Struct.new( :name, :document_version, :version_name, :force) include Aws::Structure end |