com.amazonaws.services.simplesystemsmanagement.model

Class UpdateDocumentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simplesystemsmanagement.model.UpdateDocumentRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateDocumentRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateDocumentRequest()

Method Summary

Modifier and Type	Method and Description
UpdateDocumentRequest	clone()
boolean	equals(Object obj)
List<AttachmentsSource>	getAttachments() A list of key-value pairs that describe attachments to a version of a document.
String	getContent() A valid JSON or YAML string.
String	getDisplayName() The friendly name of the SSM document that you want to update.
String	getDocumentFormat() Specify the document format for the new document version.
String	getDocumentVersion() The version of the document that you want to update.
String	getName() The name of the SSM document that you want to update.
String	getTargetType() Specify a new target type for the document.
String	getVersionName() An optional field specifying the version of the artifact you are updating with the document.
int	hashCode()
void	setAttachments(Collection<AttachmentsSource> attachments) A list of key-value pairs that describe attachments to a version of a document.
void	setContent(String content) A valid JSON or YAML string.
void	setDisplayName(String displayName) The friendly name of the SSM document that you want to update.
void	setDocumentFormat(String documentFormat) Specify the document format for the new document version.
void	setDocumentVersion(String documentVersion) The version of the document that you want to update.
void	setName(String name) The name of the SSM document that you want to update.
void	setTargetType(String targetType) Specify a new target type for the document.
void	setVersionName(String versionName) An optional field specifying the version of the artifact you are updating with the document.
String	toString() Returns a string representation of this object.
UpdateDocumentRequest	withAttachments(AttachmentsSource... attachments) A list of key-value pairs that describe attachments to a version of a document.
UpdateDocumentRequest	withAttachments(Collection<AttachmentsSource> attachments) A list of key-value pairs that describe attachments to a version of a document.
UpdateDocumentRequest	withContent(String content) A valid JSON or YAML string.
UpdateDocumentRequest	withDisplayName(String displayName) The friendly name of the SSM document that you want to update.
UpdateDocumentRequest	withDocumentFormat(DocumentFormat documentFormat) Specify the document format for the new document version.
UpdateDocumentRequest	withDocumentFormat(String documentFormat) Specify the document format for the new document version.
UpdateDocumentRequest	withDocumentVersion(String documentVersion) The version of the document that you want to update.
UpdateDocumentRequest	withName(String name) The name of the SSM document that you want to update.
UpdateDocumentRequest	withTargetType(String targetType) Specify a new target type for the document.
UpdateDocumentRequest	withVersionName(String versionName) An optional field specifying the version of the artifact you are updating with the document.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateDocumentRequest

public UpdateDocumentRequest()

Method Detail

setContent

public void setContent(String content)

A valid JSON or YAML string.

Parameters:

content - A valid JSON or YAML string.

getContent

public String getContent()

A valid JSON or YAML string.

Returns:

A valid JSON or YAML string.

withContent

public UpdateDocumentRequest withContent(String content)

A valid JSON or YAML string.

Parameters:

content - A valid JSON or YAML string.

Returns:

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

getAttachments

public List<AttachmentsSource> getAttachments()

A list of key-value pairs that describe attachments to a version of a document.

Returns:

A list of key-value pairs that describe attachments to a version of a document.

setAttachments

public void setAttachments(Collection<AttachmentsSource> attachments)

A list of key-value pairs that describe attachments to a version of a document.

Parameters:

attachments - A list of key-value pairs that describe attachments to a version of a document.

withAttachments

public UpdateDocumentRequest withAttachments(AttachmentsSource... attachments)

A list of key-value pairs that describe attachments to a version of a document.

NOTE: This method appends the values to the existing list (if any). Use setAttachments(java.util.Collection) or withAttachments(java.util.Collection) if you want to override the existing values.

Parameters:

attachments - A list of key-value pairs that describe attachments to a version of a document.

Returns:

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

withAttachments

public UpdateDocumentRequest withAttachments(Collection<AttachmentsSource> attachments)

A list of key-value pairs that describe attachments to a version of a document.

Parameters:

attachments - A list of key-value pairs that describe attachments to a version of a document.

Returns:

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

setName

public void setName(String name)

The name of the SSM document that you want to update.

Parameters:

name - The name of the SSM document that you want to update.

getName

public String getName()

The name of the SSM document that you want to update.

Returns:

The name of the SSM document that you want to update.

withName

public UpdateDocumentRequest withName(String name)

The name of the SSM document that you want to update.

Parameters:

name - The name of the SSM document that you want to update.

Returns:

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

setDisplayName

public void setDisplayName(String displayName)

The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.

Parameters:

displayName - The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.

getDisplayName

public String getDisplayName()

The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.

Returns:

The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.

withDisplayName

public UpdateDocumentRequest withDisplayName(String displayName)

The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.

Parameters:

displayName - The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.

Returns:

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

setVersionName

public void setVersionName(String versionName)

An optional field specifying the version of the artifact you are updating with the document. For example, "Release 12, Update 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 you are updating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed.

getVersionName

public String getVersionName()

An optional field specifying the version of the artifact you are updating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed.

Returns:

An optional field specifying the version of the artifact you are updating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed.

withVersionName

public UpdateDocumentRequest withVersionName(String versionName)

An optional field specifying the version of the artifact you are updating with the document. For example, "Release 12, Update 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 you are updating with the document. For example, "Release 12, Update 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.

setDocumentVersion

public void setDocumentVersion(String documentVersion)

The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the $LATEST variable.

If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

Parameters:

documentVersion - The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the $LATEST variable.

If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

getDocumentVersion

public String getDocumentVersion()

The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the $LATEST variable.

If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

Returns:

The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the $LATEST variable.

If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

withDocumentVersion

public UpdateDocumentRequest withDocumentVersion(String documentVersion)

The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the $LATEST variable.

If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

Parameters:

documentVersion - The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the $LATEST variable.

If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

Returns:

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

setDocumentFormat

public void setDocumentFormat(String documentFormat)

Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

Parameters:

documentFormat - Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

See Also:

DocumentFormat

getDocumentFormat

public String getDocumentFormat()

Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

Returns:

Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

See Also:

DocumentFormat

withDocumentFormat

public UpdateDocumentRequest withDocumentFormat(String documentFormat)

Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

Parameters:

documentFormat - Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

Returns:

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

See Also:

DocumentFormat

withDocumentFormat

public UpdateDocumentRequest withDocumentFormat(DocumentFormat documentFormat)

Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

Parameters:

documentFormat - Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

Returns:

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

See Also:

DocumentFormat

setTargetType

public void setTargetType(String targetType)

Specify a new target type for the document.

Parameters:

targetType - Specify a new target type for the document.

getTargetType

public String getTargetType()

Specify a new target type for the document.

Returns:

Specify a new target type for the document.

withTargetType

public UpdateDocumentRequest withTargetType(String targetType)

Specify a new target type for the document.

Parameters:

targetType - Specify a new target type for the document.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateDocumentRequest clone()

Overrides:

clone in class AmazonWebServiceRequest