Struct aws_sdk_ssm::client::fluent_builders::DeleteDocument

source · [−]

pub struct DeleteDocument<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Expand description

Fluent builder constructing a request to DeleteDocument.

Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document.

Before you delete the document, we recommend that you use DeleteAssociation to disassociate all managed nodes that are associated with the document.

Implementations

source

impl<C, M, R> DeleteDocument<C, M, R> where
 C: SmithyConnector,
 M: SmithyMiddleware<C>,
 R: NewRequestPolicy,

source

pub async fn send(
self
) -> Result<DeleteDocumentOutput, SdkError<DeleteDocumentError>> where
R::Policy: SmithyRetryPolicy<DeleteDocumentInputOperationOutputAlias, DeleteDocumentOutput, DeleteDocumentError, DeleteDocumentInputOperationRetryAlias>,

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

source

pub fn name(self, input: impl Into<String>) -> Self

The name of the document.

source

pub fn set_name(self, input: Option<String>) -> Self

The name of the document.

source

pub fn document_version(self, input: impl Into<String>) -> Self

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

source

pub fn set_document_version(self, input: Option<String>) -> Self

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

source

pub fn version_name(self, input: impl Into<String>) -> Self

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

source

pub fn set_version_name(self, input: Option<String>) -> Self

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

source

pub fn force(self, input: bool) -> Self

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.

source

pub fn set_force(self, input: Option<bool>) -> Self

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.