com.amazonaws.services.dlm.model

Class Script

java.lang.Object

com.amazonaws.services.dlm.model.Script

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

[Custom snapshot policies that target instances only] Information about pre and/or post scripts for a snapshot lifecycle policy that targets instances. For more information, see Automating application-consistent snapshots with pre and post scripts.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Script()

Method Summary

Modifier and Type	Method and Description
Script	clone()
boolean	equals(Object obj)
Boolean	getExecuteOperationOnScriptFailure() Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails.
String	getExecutionHandler() The SSM document that includes the pre and/or post scripts to run.
String	getExecutionHandlerService() Indicates the service used to execute the pre and/or post scripts.
Integer	getExecutionTimeout() Specifies a timeout period, in seconds, after which Amazon Data Lifecycle Manager fails the script run attempt if it has not completed.
Integer	getMaximumRetryCount() Specifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail.
List<String>	getStages() Indicate which scripts Amazon Data Lifecycle Manager should run on target instances.
int	hashCode()
Boolean	isExecuteOperationOnScriptFailure() Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails.
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setExecuteOperationOnScriptFailure(Boolean executeOperationOnScriptFailure) Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails.
void	setExecutionHandler(String executionHandler) The SSM document that includes the pre and/or post scripts to run.
void	setExecutionHandlerService(String executionHandlerService) Indicates the service used to execute the pre and/or post scripts.
void	setExecutionTimeout(Integer executionTimeout) Specifies a timeout period, in seconds, after which Amazon Data Lifecycle Manager fails the script run attempt if it has not completed.
void	setMaximumRetryCount(Integer maximumRetryCount) Specifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail.
void	setStages(Collection<String> stages) Indicate which scripts Amazon Data Lifecycle Manager should run on target instances.
String	toString() Returns a string representation of this object.
Script	withExecuteOperationOnScriptFailure(Boolean executeOperationOnScriptFailure) Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails.
Script	withExecutionHandler(String executionHandler) The SSM document that includes the pre and/or post scripts to run.
Script	withExecutionHandlerService(ExecutionHandlerServiceValues executionHandlerService) Indicates the service used to execute the pre and/or post scripts.
Script	withExecutionHandlerService(String executionHandlerService) Indicates the service used to execute the pre and/or post scripts.
Script	withExecutionTimeout(Integer executionTimeout) Specifies a timeout period, in seconds, after which Amazon Data Lifecycle Manager fails the script run attempt if it has not completed.
Script	withMaximumRetryCount(Integer maximumRetryCount) Specifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail.
Script	withStages(Collection<String> stages) Indicate which scripts Amazon Data Lifecycle Manager should run on target instances.
Script	withStages(StageValues... stages) Indicate which scripts Amazon Data Lifecycle Manager should run on target instances.
Script	withStages(String... stages) Indicate which scripts Amazon Data Lifecycle Manager should run on target instances.

Methods inherited from class java.lang.Object

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

Constructor Detail

Script

public Script()

Method Detail

getStages

public List<String> getStages()

Indicate which scripts Amazon Data Lifecycle Manager should run on target instances. Pre scripts run before Amazon Data Lifecycle Manager initiates snapshot creation. Post scripts run after Amazon Data Lifecycle Manager initiates snapshot creation.

• To run a pre script only, specify PRE. In this case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script parameter before initiating snapshot creation.

• To run a post script only, specify POST. In this case, Amazon Data Lifecycle Manager calls the SSM document with the post-script parameter after initiating snapshot creation.

• To run both pre and post scripts, specify both PRE and POST. In this case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script parameter before initiating snapshot creation, and then it calls the SSM document again with the post-script parameter after initiating snapshot creation.

If you are automating VSS Backups, omit this parameter.

Default: PRE and POST

Returns:

Indicate which scripts Amazon Data Lifecycle Manager should run on target instances. Pre scripts run before Amazon Data Lifecycle Manager initiates snapshot creation. Post scripts run after Amazon Data Lifecycle Manager initiates snapshot creation.

• To run a pre script only, specify PRE. In this case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script parameter before initiating snapshot creation.

• To run a post script only, specify POST. In this case, Amazon Data Lifecycle Manager calls the SSM document with the post-script parameter after initiating snapshot creation.

• To run both pre and post scripts, specify both PRE and POST. In this case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script parameter before initiating snapshot creation, and then it calls the SSM document again with the post-script parameter after initiating snapshot creation.

If you are automating VSS Backups, omit this parameter.

Default: PRE and POST

See Also:

StageValues

setStages

public void setStages(Collection<String> stages)

Indicate which scripts Amazon Data Lifecycle Manager should run on target instances. Pre scripts run before Amazon Data Lifecycle Manager initiates snapshot creation. Post scripts run after Amazon Data Lifecycle Manager initiates snapshot creation.

• To run a pre script only, specify PRE. In this case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script parameter before initiating snapshot creation.

• To run a post script only, specify POST. In this case, Amazon Data Lifecycle Manager calls the SSM document with the post-script parameter after initiating snapshot creation.

• To run both pre and post scripts, specify both PRE and POST. In this case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script parameter before initiating snapshot creation, and then it calls the SSM document again with the post-script parameter after initiating snapshot creation.

If you are automating VSS Backups, omit this parameter.

Default: PRE and POST

Parameters:

stages - Indicate which scripts Amazon Data Lifecycle Manager should run on target instances. Pre scripts run before Amazon Data Lifecycle Manager initiates snapshot creation. Post scripts run after Amazon Data Lifecycle Manager initiates snapshot creation.

• To run a pre script only, specify PRE. In this case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script parameter before initiating snapshot creation.

• To run a post script only, specify POST. In this case, Amazon Data Lifecycle Manager calls the SSM document with the post-script parameter after initiating snapshot creation.

• To run both pre and post scripts, specify both PRE and POST. In this case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script parameter before initiating snapshot creation, and then it calls the SSM document again with the post-script parameter after initiating snapshot creation.

If you are automating VSS Backups, omit this parameter.

Default: PRE and POST

See Also:

StageValues

withStages

public Script withStages(String... stages)

Indicate which scripts Amazon Data Lifecycle Manager should run on target instances. Pre scripts run before Amazon Data Lifecycle Manager initiates snapshot creation. Post scripts run after Amazon Data Lifecycle Manager initiates snapshot creation.

• To run a pre script only, specify PRE. In this case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script parameter before initiating snapshot creation.

• To run a post script only, specify POST. In this case, Amazon Data Lifecycle Manager calls the SSM document with the post-script parameter after initiating snapshot creation.

• To run both pre and post scripts, specify both PRE and POST. In this case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script parameter before initiating snapshot creation, and then it calls the SSM document again with the post-script parameter after initiating snapshot creation.

If you are automating VSS Backups, omit this parameter.

Default: PRE and POST

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

Parameters:

stages - Indicate which scripts Amazon Data Lifecycle Manager should run on target instances. Pre scripts run before Amazon Data Lifecycle Manager initiates snapshot creation. Post scripts run after Amazon Data Lifecycle Manager initiates snapshot creation.

• To run a pre script only, specify PRE. In this case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script parameter before initiating snapshot creation.

• To run a post script only, specify POST. In this case, Amazon Data Lifecycle Manager calls the SSM document with the post-script parameter after initiating snapshot creation.

• To run both pre and post scripts, specify both PRE and POST. In this case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script parameter before initiating snapshot creation, and then it calls the SSM document again with the post-script parameter after initiating snapshot creation.

If you are automating VSS Backups, omit this parameter.

Default: PRE and POST

Returns:

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

See Also:

StageValues

withStages

public Script withStages(Collection<String> stages)

Indicate which scripts Amazon Data Lifecycle Manager should run on target instances. Pre scripts run before Amazon Data Lifecycle Manager initiates snapshot creation. Post scripts run after Amazon Data Lifecycle Manager initiates snapshot creation.

• To run a pre script only, specify PRE. In this case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script parameter before initiating snapshot creation.

• To run a post script only, specify POST. In this case, Amazon Data Lifecycle Manager calls the SSM document with the post-script parameter after initiating snapshot creation.

• To run both pre and post scripts, specify both PRE and POST. In this case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script parameter before initiating snapshot creation, and then it calls the SSM document again with the post-script parameter after initiating snapshot creation.

If you are automating VSS Backups, omit this parameter.

Default: PRE and POST

Parameters:

stages - Indicate which scripts Amazon Data Lifecycle Manager should run on target instances. Pre scripts run before Amazon Data Lifecycle Manager initiates snapshot creation. Post scripts run after Amazon Data Lifecycle Manager initiates snapshot creation.

• To run a pre script only, specify PRE. In this case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script parameter before initiating snapshot creation.

• To run a post script only, specify POST. In this case, Amazon Data Lifecycle Manager calls the SSM document with the post-script parameter after initiating snapshot creation.

• To run both pre and post scripts, specify both PRE and POST. In this case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script parameter before initiating snapshot creation, and then it calls the SSM document again with the post-script parameter after initiating snapshot creation.

If you are automating VSS Backups, omit this parameter.

Default: PRE and POST

Returns:

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

See Also:

StageValues

withStages

public Script withStages(StageValues... stages)

Indicate which scripts Amazon Data Lifecycle Manager should run on target instances. Pre scripts run before Amazon Data Lifecycle Manager initiates snapshot creation. Post scripts run after Amazon Data Lifecycle Manager initiates snapshot creation.

• To run a pre script only, specify PRE. In this case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script parameter before initiating snapshot creation.

• To run a post script only, specify POST. In this case, Amazon Data Lifecycle Manager calls the SSM document with the post-script parameter after initiating snapshot creation.

• To run both pre and post scripts, specify both PRE and POST. In this case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script parameter before initiating snapshot creation, and then it calls the SSM document again with the post-script parameter after initiating snapshot creation.

If you are automating VSS Backups, omit this parameter.

Default: PRE and POST

Parameters:

stages - Indicate which scripts Amazon Data Lifecycle Manager should run on target instances. Pre scripts run before Amazon Data Lifecycle Manager initiates snapshot creation. Post scripts run after Amazon Data Lifecycle Manager initiates snapshot creation.

• To run a pre script only, specify PRE. In this case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script parameter before initiating snapshot creation.

• To run a post script only, specify POST. In this case, Amazon Data Lifecycle Manager calls the SSM document with the post-script parameter after initiating snapshot creation.

• To run both pre and post scripts, specify both PRE and POST. In this case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script parameter before initiating snapshot creation, and then it calls the SSM document again with the post-script parameter after initiating snapshot creation.

If you are automating VSS Backups, omit this parameter.

Default: PRE and POST

Returns:

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

See Also:

StageValues

setExecutionHandlerService

public void setExecutionHandlerService(String executionHandlerService)

Indicates the service used to execute the pre and/or post scripts.

• If you are using custom SSM documents or automating application-consistent snapshots of SAP HANA workloads, specify AWS_SYSTEMS_MANAGER.

• If you are automating VSS Backups, omit this parameter.

Default: AWS_SYSTEMS_MANAGER

Parameters:

executionHandlerService - Indicates the service used to execute the pre and/or post scripts.

• If you are using custom SSM documents or automating application-consistent snapshots of SAP HANA workloads, specify AWS_SYSTEMS_MANAGER.

• If you are automating VSS Backups, omit this parameter.

Default: AWS_SYSTEMS_MANAGER

See Also:

ExecutionHandlerServiceValues

getExecutionHandlerService

public String getExecutionHandlerService()

Indicates the service used to execute the pre and/or post scripts.

• If you are using custom SSM documents or automating application-consistent snapshots of SAP HANA workloads, specify AWS_SYSTEMS_MANAGER.

• If you are automating VSS Backups, omit this parameter.

Default: AWS_SYSTEMS_MANAGER

Returns:

Indicates the service used to execute the pre and/or post scripts.

• If you are using custom SSM documents or automating application-consistent snapshots of SAP HANA workloads, specify AWS_SYSTEMS_MANAGER.

• If you are automating VSS Backups, omit this parameter.

Default: AWS_SYSTEMS_MANAGER

See Also:

ExecutionHandlerServiceValues

withExecutionHandlerService

public Script withExecutionHandlerService(String executionHandlerService)

Indicates the service used to execute the pre and/or post scripts.

• If you are using custom SSM documents or automating application-consistent snapshots of SAP HANA workloads, specify AWS_SYSTEMS_MANAGER.

• If you are automating VSS Backups, omit this parameter.

Default: AWS_SYSTEMS_MANAGER

Parameters:

executionHandlerService - Indicates the service used to execute the pre and/or post scripts.

• If you are using custom SSM documents or automating application-consistent snapshots of SAP HANA workloads, specify AWS_SYSTEMS_MANAGER.

• If you are automating VSS Backups, omit this parameter.

Default: AWS_SYSTEMS_MANAGER

Returns:

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

See Also:

ExecutionHandlerServiceValues

withExecutionHandlerService

public Script withExecutionHandlerService(ExecutionHandlerServiceValues executionHandlerService)

Indicates the service used to execute the pre and/or post scripts.

• If you are using custom SSM documents or automating application-consistent snapshots of SAP HANA workloads, specify AWS_SYSTEMS_MANAGER.

• If you are automating VSS Backups, omit this parameter.

Default: AWS_SYSTEMS_MANAGER

Parameters:

executionHandlerService - Indicates the service used to execute the pre and/or post scripts.

• If you are using custom SSM documents or automating application-consistent snapshots of SAP HANA workloads, specify AWS_SYSTEMS_MANAGER.

• If you are automating VSS Backups, omit this parameter.

Default: AWS_SYSTEMS_MANAGER

Returns:

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

See Also:

ExecutionHandlerServiceValues

setExecutionHandler

public void setExecutionHandler(String executionHandler)

The SSM document that includes the pre and/or post scripts to run.

• If you are automating VSS backups, specify AWS_VSS_BACKUP. In this case, Amazon Data Lifecycle Manager automatically uses the AWSEC2-CreateVssSnapshot SSM document.

• If you are automating application-consistent snapshots for SAP HANA workloads, specify AWSSystemsManagerSAP-CreateDLMSnapshotForSAPHANA.

• If you are using a custom SSM document that you own, specify either the name or ARN of the SSM document. If you are using a custom SSM document that is shared with you, specify the ARN of the SSM document.

Parameters:

executionHandler - The SSM document that includes the pre and/or post scripts to run.

• If you are automating VSS backups, specify AWS_VSS_BACKUP. In this case, Amazon Data Lifecycle Manager automatically uses the AWSEC2-CreateVssSnapshot SSM document.

• If you are automating application-consistent snapshots for SAP HANA workloads, specify AWSSystemsManagerSAP-CreateDLMSnapshotForSAPHANA.

• If you are using a custom SSM document that you own, specify either the name or ARN of the SSM document. If you are using a custom SSM document that is shared with you, specify the ARN of the SSM document.

getExecutionHandler

public String getExecutionHandler()

The SSM document that includes the pre and/or post scripts to run.

• If you are automating VSS backups, specify AWS_VSS_BACKUP. In this case, Amazon Data Lifecycle Manager automatically uses the AWSEC2-CreateVssSnapshot SSM document.

• If you are automating application-consistent snapshots for SAP HANA workloads, specify AWSSystemsManagerSAP-CreateDLMSnapshotForSAPHANA.

• If you are using a custom SSM document that you own, specify either the name or ARN of the SSM document. If you are using a custom SSM document that is shared with you, specify the ARN of the SSM document.

Returns:

The SSM document that includes the pre and/or post scripts to run.

• If you are automating VSS backups, specify AWS_VSS_BACKUP. In this case, Amazon Data Lifecycle Manager automatically uses the AWSEC2-CreateVssSnapshot SSM document.

• If you are automating application-consistent snapshots for SAP HANA workloads, specify AWSSystemsManagerSAP-CreateDLMSnapshotForSAPHANA.

• If you are using a custom SSM document that you own, specify either the name or ARN of the SSM document. If you are using a custom SSM document that is shared with you, specify the ARN of the SSM document.

withExecutionHandler

public Script withExecutionHandler(String executionHandler)

The SSM document that includes the pre and/or post scripts to run.

• If you are automating VSS backups, specify AWS_VSS_BACKUP. In this case, Amazon Data Lifecycle Manager automatically uses the AWSEC2-CreateVssSnapshot SSM document.

• If you are automating application-consistent snapshots for SAP HANA workloads, specify AWSSystemsManagerSAP-CreateDLMSnapshotForSAPHANA.

• If you are using a custom SSM document that you own, specify either the name or ARN of the SSM document. If you are using a custom SSM document that is shared with you, specify the ARN of the SSM document.

Parameters:

executionHandler - The SSM document that includes the pre and/or post scripts to run.

• If you are automating VSS backups, specify AWS_VSS_BACKUP. In this case, Amazon Data Lifecycle Manager automatically uses the AWSEC2-CreateVssSnapshot SSM document.

• If you are automating application-consistent snapshots for SAP HANA workloads, specify AWSSystemsManagerSAP-CreateDLMSnapshotForSAPHANA.

• If you are using a custom SSM document that you own, specify either the name or ARN of the SSM document. If you are using a custom SSM document that is shared with you, specify the ARN of the SSM document.

Returns:

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

setExecuteOperationOnScriptFailure

public void setExecuteOperationOnScriptFailure(Boolean executeOperationOnScriptFailure)

Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails.

• To default to crash consistent snapshot if the pre script fails, specify true.

• To skip the instance for snapshot creation if the pre script fails, specify false.

This parameter is supported only if you run a pre script. If you run a post script only, omit this parameter.

Default: true

Parameters:

executeOperationOnScriptFailure - Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails.

• To default to crash consistent snapshot if the pre script fails, specify true.

• To skip the instance for snapshot creation if the pre script fails, specify false.

This parameter is supported only if you run a pre script. If you run a post script only, omit this parameter.

Default: true

getExecuteOperationOnScriptFailure

public Boolean getExecuteOperationOnScriptFailure()

Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails.

• To default to crash consistent snapshot if the pre script fails, specify true.

• To skip the instance for snapshot creation if the pre script fails, specify false.

This parameter is supported only if you run a pre script. If you run a post script only, omit this parameter.

Default: true

Returns:

Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails.

• To default to crash consistent snapshot if the pre script fails, specify true.

• To skip the instance for snapshot creation if the pre script fails, specify false.

This parameter is supported only if you run a pre script. If you run a post script only, omit this parameter.

Default: true

withExecuteOperationOnScriptFailure

public Script withExecuteOperationOnScriptFailure(Boolean executeOperationOnScriptFailure)

Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails.

• To default to crash consistent snapshot if the pre script fails, specify true.

• To skip the instance for snapshot creation if the pre script fails, specify false.

This parameter is supported only if you run a pre script. If you run a post script only, omit this parameter.

Default: true

Parameters:

executeOperationOnScriptFailure - Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails.

• To default to crash consistent snapshot if the pre script fails, specify true.

• To skip the instance for snapshot creation if the pre script fails, specify false.

This parameter is supported only if you run a pre script. If you run a post script only, omit this parameter.

Default: true

Returns:

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

isExecuteOperationOnScriptFailure

public Boolean isExecuteOperationOnScriptFailure()

Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails.

• To default to crash consistent snapshot if the pre script fails, specify true.

• To skip the instance for snapshot creation if the pre script fails, specify false.

This parameter is supported only if you run a pre script. If you run a post script only, omit this parameter.

Default: true

Returns:

Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails.

• To default to crash consistent snapshot if the pre script fails, specify true.

• To skip the instance for snapshot creation if the pre script fails, specify false.

This parameter is supported only if you run a pre script. If you run a post script only, omit this parameter.

Default: true

setExecutionTimeout

public void setExecutionTimeout(Integer executionTimeout)

Specifies a timeout period, in seconds, after which Amazon Data Lifecycle Manager fails the script run attempt if it has not completed. If a script does not complete within its timeout period, Amazon Data Lifecycle Manager fails the attempt. The timeout period applies to the pre and post scripts individually.

If you are automating VSS Backups, omit this parameter.

Default: 10

Parameters:

executionTimeout - Specifies a timeout period, in seconds, after which Amazon Data Lifecycle Manager fails the script run attempt if it has not completed. If a script does not complete within its timeout period, Amazon Data Lifecycle Manager fails the attempt. The timeout period applies to the pre and post scripts individually.

If you are automating VSS Backups, omit this parameter.

Default: 10

getExecutionTimeout

public Integer getExecutionTimeout()

Specifies a timeout period, in seconds, after which Amazon Data Lifecycle Manager fails the script run attempt if it has not completed. If a script does not complete within its timeout period, Amazon Data Lifecycle Manager fails the attempt. The timeout period applies to the pre and post scripts individually.

If you are automating VSS Backups, omit this parameter.

Default: 10

Returns:

Specifies a timeout period, in seconds, after which Amazon Data Lifecycle Manager fails the script run attempt if it has not completed. If a script does not complete within its timeout period, Amazon Data Lifecycle Manager fails the attempt. The timeout period applies to the pre and post scripts individually.

If you are automating VSS Backups, omit this parameter.

Default: 10

withExecutionTimeout

public Script withExecutionTimeout(Integer executionTimeout)

Specifies a timeout period, in seconds, after which Amazon Data Lifecycle Manager fails the script run attempt if it has not completed. If a script does not complete within its timeout period, Amazon Data Lifecycle Manager fails the attempt. The timeout period applies to the pre and post scripts individually.

If you are automating VSS Backups, omit this parameter.

Default: 10

Parameters:

executionTimeout - Specifies a timeout period, in seconds, after which Amazon Data Lifecycle Manager fails the script run attempt if it has not completed. If a script does not complete within its timeout period, Amazon Data Lifecycle Manager fails the attempt. The timeout period applies to the pre and post scripts individually.

If you are automating VSS Backups, omit this parameter.

Default: 10

Returns:

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

setMaximumRetryCount

public void setMaximumRetryCount(Integer maximumRetryCount)

Specifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail.

• If the pre script fails, Amazon Data Lifecycle Manager retries the entire snapshot creation process, including running the pre and post scripts.

• If the post script fails, Amazon Data Lifecycle Manager retries the post script only; in this case, the pre script will have completed and the snapshot might have been created.

If you do not want Amazon Data Lifecycle Manager to retry failed scripts, specify 0.

Default: 0

Parameters:

maximumRetryCount - Specifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail.

• If the pre script fails, Amazon Data Lifecycle Manager retries the entire snapshot creation process, including running the pre and post scripts.

• If the post script fails, Amazon Data Lifecycle Manager retries the post script only; in this case, the pre script will have completed and the snapshot might have been created.

If you do not want Amazon Data Lifecycle Manager to retry failed scripts, specify 0.

Default: 0

getMaximumRetryCount

public Integer getMaximumRetryCount()

Specifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail.

• If the pre script fails, Amazon Data Lifecycle Manager retries the entire snapshot creation process, including running the pre and post scripts.

• If the post script fails, Amazon Data Lifecycle Manager retries the post script only; in this case, the pre script will have completed and the snapshot might have been created.

If you do not want Amazon Data Lifecycle Manager to retry failed scripts, specify 0.

Default: 0

Returns:

Specifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail.

• If the pre script fails, Amazon Data Lifecycle Manager retries the entire snapshot creation process, including running the pre and post scripts.

• If the post script fails, Amazon Data Lifecycle Manager retries the post script only; in this case, the pre script will have completed and the snapshot might have been created.

If you do not want Amazon Data Lifecycle Manager to retry failed scripts, specify 0.

Default: 0

withMaximumRetryCount

public Script withMaximumRetryCount(Integer maximumRetryCount)

Specifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail.

• If the pre script fails, Amazon Data Lifecycle Manager retries the entire snapshot creation process, including running the pre and post scripts.

• If the post script fails, Amazon Data Lifecycle Manager retries the post script only; in this case, the pre script will have completed and the snapshot might have been created.

If you do not want Amazon Data Lifecycle Manager to retry failed scripts, specify 0.

Default: 0

Parameters:

maximumRetryCount - Specifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail.

• If the pre script fails, Amazon Data Lifecycle Manager retries the entire snapshot creation process, including running the pre and post scripts.

• If the post script fails, Amazon Data Lifecycle Manager retries the post script only; in this case, the pre script will have completed and the snapshot might have been created.

If you do not want Amazon Data Lifecycle Manager to retry failed scripts, specify 0.

Default: 0

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

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo