com.amazonaws.services.simplesystemsmanagement.model

Class StartChangeRequestExecutionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simplesystemsmanagement.model.StartChangeRequestExecutionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartChangeRequestExecutionRequest
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
StartChangeRequestExecutionRequest()

Method Summary

Modifier and Type	Method and Description
StartChangeRequestExecutionRequest	addParametersEntry(String key, List<String> value) Add a single Parameters entry
StartChangeRequestExecutionRequest	clearParametersEntries() Removes all the entries added into Parameters.
StartChangeRequestExecutionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getAutoApprove() Indicates whether the change request can be approved automatically without the need for manual approvals.
String	getChangeDetails() User-provided details about the change.
String	getChangeRequestName() The name of the change request associated with the runbook workflow to be run.
String	getClientToken() The user-provided idempotency token.
String	getDocumentName() The name of the change template document to run during the runbook workflow.
String	getDocumentVersion() The version of the change template document to run during the runbook workflow.
Map<String,List<String>>	getParameters() A key-value map of parameters that match the declared parameters in the change template document.
List<Runbook>	getRunbooks() Information about the Automation runbooks that are run during the runbook workflow.
Date	getScheduledEndTime() The time that the requester expects the runbook workflow related to the change request to complete.
Date	getScheduledTime() The date and time specified in the change request to run the Automation runbooks.
List<Tag>	getTags() Optional metadata that you assign to a resource.
int	hashCode()
Boolean	isAutoApprove() Indicates whether the change request can be approved automatically without the need for manual approvals.
void	setAutoApprove(Boolean autoApprove) Indicates whether the change request can be approved automatically without the need for manual approvals.
void	setChangeDetails(String changeDetails) User-provided details about the change.
void	setChangeRequestName(String changeRequestName) The name of the change request associated with the runbook workflow to be run.
void	setClientToken(String clientToken) The user-provided idempotency token.
void	setDocumentName(String documentName) The name of the change template document to run during the runbook workflow.
void	setDocumentVersion(String documentVersion) The version of the change template document to run during the runbook workflow.
void	setParameters(Map<String,List<String>> parameters) A key-value map of parameters that match the declared parameters in the change template document.
void	setRunbooks(Collection<Runbook> runbooks) Information about the Automation runbooks that are run during the runbook workflow.
void	setScheduledEndTime(Date scheduledEndTime) The time that the requester expects the runbook workflow related to the change request to complete.
void	setScheduledTime(Date scheduledTime) The date and time specified in the change request to run the Automation runbooks.
void	setTags(Collection<Tag> tags) Optional metadata that you assign to a resource.
String	toString() Returns a string representation of this object.
StartChangeRequestExecutionRequest	withAutoApprove(Boolean autoApprove) Indicates whether the change request can be approved automatically without the need for manual approvals.
StartChangeRequestExecutionRequest	withChangeDetails(String changeDetails) User-provided details about the change.
StartChangeRequestExecutionRequest	withChangeRequestName(String changeRequestName) The name of the change request associated with the runbook workflow to be run.
StartChangeRequestExecutionRequest	withClientToken(String clientToken) The user-provided idempotency token.
StartChangeRequestExecutionRequest	withDocumentName(String documentName) The name of the change template document to run during the runbook workflow.
StartChangeRequestExecutionRequest	withDocumentVersion(String documentVersion) The version of the change template document to run during the runbook workflow.
StartChangeRequestExecutionRequest	withParameters(Map<String,List<String>> parameters) A key-value map of parameters that match the declared parameters in the change template document.
StartChangeRequestExecutionRequest	withRunbooks(Collection<Runbook> runbooks) Information about the Automation runbooks that are run during the runbook workflow.
StartChangeRequestExecutionRequest	withRunbooks(Runbook... runbooks) Information about the Automation runbooks that are run during the runbook workflow.
StartChangeRequestExecutionRequest	withScheduledEndTime(Date scheduledEndTime) The time that the requester expects the runbook workflow related to the change request to complete.
StartChangeRequestExecutionRequest	withScheduledTime(Date scheduledTime) The date and time specified in the change request to run the Automation runbooks.
StartChangeRequestExecutionRequest	withTags(Collection<Tag> tags) Optional metadata that you assign to a resource.
StartChangeRequestExecutionRequest	withTags(Tag... tags) Optional metadata that you assign to a resource.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, 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

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartChangeRequestExecutionRequest

public StartChangeRequestExecutionRequest()

Method Detail

setScheduledTime

public void setScheduledTime(Date scheduledTime)

The date and time specified in the change request to run the Automation runbooks.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

Parameters:

scheduledTime - The date and time specified in the change request to run the Automation runbooks.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

getScheduledTime

public Date getScheduledTime()

The date and time specified in the change request to run the Automation runbooks.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

Returns:

The date and time specified in the change request to run the Automation runbooks.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

withScheduledTime

public StartChangeRequestExecutionRequest withScheduledTime(Date scheduledTime)

The date and time specified in the change request to run the Automation runbooks.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

Parameters:

scheduledTime - The date and time specified in the change request to run the Automation runbooks.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

Returns:

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

setDocumentName

public void setDocumentName(String documentName)

The name of the change template document to run during the runbook workflow.

Parameters:

documentName - The name of the change template document to run during the runbook workflow.

getDocumentName

public String getDocumentName()

The name of the change template document to run during the runbook workflow.

Returns:

The name of the change template document to run during the runbook workflow.

withDocumentName

public StartChangeRequestExecutionRequest withDocumentName(String documentName)

The name of the change template document to run during the runbook workflow.

Parameters:

documentName - The name of the change template document to run during the runbook workflow.

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 change template document to run during the runbook workflow.

Parameters:

documentVersion - The version of the change template document to run during the runbook workflow.

getDocumentVersion

public String getDocumentVersion()

The version of the change template document to run during the runbook workflow.

Returns:

The version of the change template document to run during the runbook workflow.

withDocumentVersion

public StartChangeRequestExecutionRequest withDocumentVersion(String documentVersion)

The version of the change template document to run during the runbook workflow.

Parameters:

documentVersion - The version of the change template document to run during the runbook workflow.

Returns:

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

getParameters

public Map<String,List<String>> getParameters()

A key-value map of parameters that match the declared parameters in the change template document.

Returns:

A key-value map of parameters that match the declared parameters in the change template document.

setParameters

public void setParameters(Map<String,List<String>> parameters)

A key-value map of parameters that match the declared parameters in the change template document.

Parameters:

parameters - A key-value map of parameters that match the declared parameters in the change template document.

withParameters

public StartChangeRequestExecutionRequest withParameters(Map<String,List<String>> parameters)

A key-value map of parameters that match the declared parameters in the change template document.

Parameters:

parameters - A key-value map of parameters that match the declared parameters in the change template document.

Returns:

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

addParametersEntry

public StartChangeRequestExecutionRequest addParametersEntry(String key,
                                                             List<String> value)

Add a single Parameters entry

See Also:

withParameters(java.util.Map<java.lang.String, java.util.List<java.lang.String>>)

clearParametersEntries

public StartChangeRequestExecutionRequest clearParametersEntries()

Removes all the entries added into Parameters.

Returns:

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

setChangeRequestName

public void setChangeRequestName(String changeRequestName)

The name of the change request associated with the runbook workflow to be run.

Parameters:

changeRequestName - The name of the change request associated with the runbook workflow to be run.

getChangeRequestName

public String getChangeRequestName()

The name of the change request associated with the runbook workflow to be run.

Returns:

The name of the change request associated with the runbook workflow to be run.

withChangeRequestName

public StartChangeRequestExecutionRequest withChangeRequestName(String changeRequestName)

The name of the change request associated with the runbook workflow to be run.

Parameters:

changeRequestName - The name of the change request associated with the runbook workflow to be run.

Returns:

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

setClientToken

public void setClientToken(String clientToken)

The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

Parameters:

clientToken - The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

getClientToken

public String getClientToken()

The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

Returns:

The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

withClientToken

public StartChangeRequestExecutionRequest withClientToken(String clientToken)

The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

Parameters:

clientToken - The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

Returns:

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

setAutoApprove

public void setAutoApprove(Boolean autoApprove)

Indicates whether the change request can be approved automatically without the need for manual approvals.

If AutoApprovable is enabled in a change template, then setting AutoApprove to true in StartChangeRequestExecution creates a change request that bypasses approver review.

Change Calendar restrictions are not bypassed in this scenario. If the state of an associated calendar is CLOSED, change freeze approvers must still grant permission for this change request to run. If they don't, the change won't be processed until the calendar state is again OPEN.

Parameters:

autoApprove - Indicates whether the change request can be approved automatically without the need for manual approvals.

If AutoApprovable is enabled in a change template, then setting AutoApprove to true in StartChangeRequestExecution creates a change request that bypasses approver review.

Change Calendar restrictions are not bypassed in this scenario. If the state of an associated calendar is CLOSED, change freeze approvers must still grant permission for this change request to run. If they don't, the change won't be processed until the calendar state is again OPEN.

getAutoApprove

public Boolean getAutoApprove()

Indicates whether the change request can be approved automatically without the need for manual approvals.

If AutoApprovable is enabled in a change template, then setting AutoApprove to true in StartChangeRequestExecution creates a change request that bypasses approver review.

Change Calendar restrictions are not bypassed in this scenario. If the state of an associated calendar is CLOSED, change freeze approvers must still grant permission for this change request to run. If they don't, the change won't be processed until the calendar state is again OPEN.

Returns:

Indicates whether the change request can be approved automatically without the need for manual approvals.

If AutoApprovable is enabled in a change template, then setting AutoApprove to true in StartChangeRequestExecution creates a change request that bypasses approver review.

Change Calendar restrictions are not bypassed in this scenario. If the state of an associated calendar is CLOSED, change freeze approvers must still grant permission for this change request to run. If they don't, the change won't be processed until the calendar state is again OPEN.

withAutoApprove

public StartChangeRequestExecutionRequest withAutoApprove(Boolean autoApprove)

Indicates whether the change request can be approved automatically without the need for manual approvals.

If AutoApprovable is enabled in a change template, then setting AutoApprove to true in StartChangeRequestExecution creates a change request that bypasses approver review.

Change Calendar restrictions are not bypassed in this scenario. If the state of an associated calendar is CLOSED, change freeze approvers must still grant permission for this change request to run. If they don't, the change won't be processed until the calendar state is again OPEN.

Parameters:

autoApprove - Indicates whether the change request can be approved automatically without the need for manual approvals.

If AutoApprovable is enabled in a change template, then setting AutoApprove to true in StartChangeRequestExecution creates a change request that bypasses approver review.

Change Calendar restrictions are not bypassed in this scenario. If the state of an associated calendar is CLOSED, change freeze approvers must still grant permission for this change request to run. If they don't, the change won't be processed until the calendar state is again OPEN.

Returns:

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

isAutoApprove

public Boolean isAutoApprove()

Indicates whether the change request can be approved automatically without the need for manual approvals.

If AutoApprovable is enabled in a change template, then setting AutoApprove to true in StartChangeRequestExecution creates a change request that bypasses approver review.

Change Calendar restrictions are not bypassed in this scenario. If the state of an associated calendar is CLOSED, change freeze approvers must still grant permission for this change request to run. If they don't, the change won't be processed until the calendar state is again OPEN.

Returns:

Indicates whether the change request can be approved automatically without the need for manual approvals.

If AutoApprovable is enabled in a change template, then setting AutoApprove to true in StartChangeRequestExecution creates a change request that bypasses approver review.

Change Calendar restrictions are not bypassed in this scenario. If the state of an associated calendar is CLOSED, change freeze approvers must still grant permission for this change request to run. If they don't, the change won't be processed until the calendar state is again OPEN.

getRunbooks

public List<Runbook> getRunbooks()

Information about the Automation runbooks that are run during the runbook workflow.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

Returns:

Information about the Automation runbooks that are run during the runbook workflow.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

setRunbooks

public void setRunbooks(Collection<Runbook> runbooks)

Information about the Automation runbooks that are run during the runbook workflow.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

Parameters:

runbooks - Information about the Automation runbooks that are run during the runbook workflow.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

withRunbooks

public StartChangeRequestExecutionRequest withRunbooks(Runbook... runbooks)

Information about the Automation runbooks that are run during the runbook workflow.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

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

Parameters:

runbooks - Information about the Automation runbooks that are run during the runbook workflow.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

Returns:

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

withRunbooks

public StartChangeRequestExecutionRequest withRunbooks(Collection<Runbook> runbooks)

Information about the Automation runbooks that are run during the runbook workflow.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

Parameters:

runbooks - Information about the Automation runbooks that are run during the runbook workflow.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

Returns:

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

getTags

public List<Tag> getTags()

Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:

• Key=Environment,Value=Production

• Key=Region,Value=us-east-2

Returns:

Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:

• Key=Environment,Value=Production

• Key=Region,Value=us-east-2

setTags

public void setTags(Collection<Tag> tags)

Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:

• Key=Environment,Value=Production

• Key=Region,Value=us-east-2

Parameters:

tags - Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:

• Key=Environment,Value=Production

• Key=Region,Value=us-east-2

withTags

public StartChangeRequestExecutionRequest withTags(Tag... tags)

Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:

• Key=Environment,Value=Production

• Key=Region,Value=us-east-2

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

Parameters:

tags - Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:

• Key=Environment,Value=Production

• Key=Region,Value=us-east-2

Returns:

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

withTags

public StartChangeRequestExecutionRequest withTags(Collection<Tag> tags)

Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:

• Key=Environment,Value=Production

• Key=Region,Value=us-east-2

Parameters:

tags - Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:

• Key=Environment,Value=Production

• Key=Region,Value=us-east-2

Returns:

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

setScheduledEndTime

public void setScheduledEndTime(Date scheduledEndTime)

The time that the requester expects the runbook workflow related to the change request to complete. The time is an estimate only that the requester provides for reviewers.

Parameters:

scheduledEndTime - The time that the requester expects the runbook workflow related to the change request to complete. The time is an estimate only that the requester provides for reviewers.

getScheduledEndTime

public Date getScheduledEndTime()

The time that the requester expects the runbook workflow related to the change request to complete. The time is an estimate only that the requester provides for reviewers.

Returns:

The time that the requester expects the runbook workflow related to the change request to complete. The time is an estimate only that the requester provides for reviewers.

withScheduledEndTime

public StartChangeRequestExecutionRequest withScheduledEndTime(Date scheduledEndTime)

The time that the requester expects the runbook workflow related to the change request to complete. The time is an estimate only that the requester provides for reviewers.

Parameters:

scheduledEndTime - The time that the requester expects the runbook workflow related to the change request to complete. The time is an estimate only that the requester provides for reviewers.

Returns:

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

setChangeDetails

public void setChangeDetails(String changeDetails)

User-provided details about the change. If no details are provided, content specified in the Template information section of the associated change template is added.

Parameters:

changeDetails - User-provided details about the change. If no details are provided, content specified in the Template information section of the associated change template is added.

getChangeDetails

public String getChangeDetails()

User-provided details about the change. If no details are provided, content specified in the Template information section of the associated change template is added.

Returns:

User-provided details about the change. If no details are provided, content specified in the Template information section of the associated change template is added.

withChangeDetails

public StartChangeRequestExecutionRequest withChangeDetails(String changeDetails)

User-provided details about the change. If no details are provided, content specified in the Template information section of the associated change template is added.

Parameters:

changeDetails - User-provided details about the change. If no details are provided, content specified in the Template information section of the associated change template is added.

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 StartChangeRequestExecutionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()