Package software.amazon.awssdk.services.ssm.model

Interface DescribeDocumentRequest.Builder

All Superinterfaces:

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

Enclosing class:

DescribeDocumentRequest

@Mutable
@NotThreadSafe
public static interface DescribeDocumentRequest.Builder
extends SsmRequest.Builder, SdkPojo, CopyableBuilder<DescribeDocumentRequest.Builder,DescribeDocumentRequest>

Method Summary

Modifier and Type	Method	Description
DescribeDocumentRequest.Builder	documentVersion(String documentVersion)	The document version for which you want information.
DescribeDocumentRequest.Builder	name(String name)	The name of the SSM document.
DescribeDocumentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
DescribeDocumentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeDocumentRequest.Builder	versionName(String versionName)	An optional field specifying the version of the artifact associated with the document.

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, sdkFieldNameToField, sdkFields

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

build

Method Details

name

DescribeDocumentRequest.Builder name(String name)

The name of the SSM document.

If you're calling a shared SSM document from a different Amazon Web Services account, Name is the full Amazon Resource Name (ARN) of the document.

Parameters:

name - The name of the SSM document.

If you're calling a shared SSM document from a different Amazon Web Services account, Name is the full Amazon Resource Name (ARN) of the document.

Returns:

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

documentVersion

DescribeDocumentRequest.Builder documentVersion(String documentVersion)

The document version for which you want information. Can be a specific version or the default version.

Parameters:

documentVersion - The document version for which you want information. Can be a specific version or the default version.

Returns:

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

versionName

DescribeDocumentRequest.Builder versionName(String versionName)

An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.

Parameters:

versionName - An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.

Returns:

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

overrideConfiguration

DescribeDocumentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder