software.amazon.awssdk.services.ssm.model

Interface DeleteDocumentRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DeleteDocumentRequest.Builder,DeleteDocumentRequest>, SdkBuilder<DeleteDocumentRequest.Builder,DeleteDocumentRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder

Enclosing class:

DeleteDocumentRequest

public static interface DeleteDocumentRequest.Builder
extends SsmRequest.Builder, SdkPojo, CopyableBuilder<DeleteDocumentRequest.Builder,DeleteDocumentRequest>

Method Summary

Modifier and Type	Method and Description
DeleteDocumentRequest.Builder	documentVersion(String documentVersion) The version of the document that you want to delete.
DeleteDocumentRequest.Builder	force(Boolean force) Some SSM document types require that you specify a Force flag before you can delete the document.
DeleteDocumentRequest.Builder	name(String name) The name of the document.
DeleteDocumentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
DeleteDocumentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
DeleteDocumentRequest.Builder	versionName(String versionName) The version name of the document that you want to delete.

Methods inherited from interface software.amazon.awssdk.services.ssm.model.SsmRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

name

DeleteDocumentRequest.Builder name(String name)

The name of the document.

Parameters:

name - The name of the document.

Returns:

Returns a reference to this object so that method calls can be chained together.

documentVersion

DeleteDocumentRequest.Builder documentVersion(String documentVersion)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

versionName

DeleteDocumentRequest.Builder versionName(String versionName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

force

DeleteDocumentRequest.Builder force(Boolean force)

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.

Parameters:

force - 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:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

DeleteDocumentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

DeleteDocumentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.