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 TypeMethodDescriptiondocumentVersion
(String documentVersion) The version of the document that you want to delete.Some SSM document types require that you specify aForce
flag before you can delete the document.The name of the document.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.versionName
(String versionName) The version name of the document that you want to delete.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.services.ssm.model.SsmRequest.Builder
build
-
Method Details
-
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
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
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
Some SSM document types require that you specify a
Force
flag before you can delete the document. For example, you must specify aForce
flag to delete a document of typeApplicationConfigurationSchema
. You can restrict access to theForce
flag in an Identity and Access Management (IAM) policy.- Parameters:
force
- Some SSM document types require that you specify aForce
flag before you can delete the document. For example, you must specify aForce
flag to delete a document of typeApplicationConfigurationSchema
. You can restrict access to theForce
flag in an 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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-