Package software.amazon.awscdk.services.dlm

Interface CfnLifecyclePolicy.ScriptProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLifecyclePolicy.ScriptProperty.Jsii$Proxy

Enclosing class:

CfnLifecyclePolicy

@Stability(Stable)
public static interface CfnLifecyclePolicy.ScriptProperty
extends software.amazon.jsii.JsiiSerializable

[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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dlm.*;
 ScriptProperty scriptProperty = ScriptProperty.builder()
         .executeOperationOnScriptFailure(false)
         .executionHandler("executionHandler")
         .executionHandlerService("executionHandlerService")
         .executionTimeout(123)
         .maximumRetryCount(123)
         .stages(List.of("stages"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-script.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnLifecyclePolicy.ScriptProperty.Builder	A builder for CfnLifecyclePolicy.ScriptProperty
static final class	CfnLifecyclePolicy.ScriptProperty.Jsii$Proxy	An implementation for CfnLifecyclePolicy.ScriptProperty

Method Summary

Modifier and Type	Method	Description
static CfnLifecyclePolicy.ScriptProperty.Builder	builder()
default Object	getExecuteOperationOnScriptFailure()	Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails.
default String	getExecutionHandler()	The SSM document that includes the pre and/or post scripts to run.
default String	getExecutionHandlerService()	Indicates the service used to execute the pre and/or post scripts.
default Number	getExecutionTimeout()	Specifies a timeout period, in seconds, after which Amazon Data Lifecycle Manager fails the script run attempt if it has not completed.
default Number	getMaximumRetryCount()	Specifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail.
default List<String>	getStages()	Indicate which scripts Amazon Data Lifecycle Manager should run on target instances.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExecuteOperationOnScriptFailure

@Stability(Stable)
@Nullable
default Object 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-script.html#cfn-dlm-lifecyclepolicy-script-executeoperationonscriptfailure

getExecutionHandler

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-script.html#cfn-dlm-lifecyclepolicy-script-executionhandler

getExecutionHandlerService

@Stability(Stable)
@Nullable
default 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-script.html#cfn-dlm-lifecyclepolicy-script-executionhandlerservice

getExecutionTimeout

@Stability(Stable)
@Nullable
default Number 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-script.html#cfn-dlm-lifecyclepolicy-script-executiontimeout

getMaximumRetryCount

@Stability(Stable)
@Nullable
default Number 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-script.html#cfn-dlm-lifecyclepolicy-script-maximumretrycount

getStages

@Stability(Stable)
@Nullable
default 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-script.html#cfn-dlm-lifecyclepolicy-script-stages

builder

@Stability(Stable)
static CfnLifecyclePolicy.ScriptProperty.Builder builder()

Returns:

a CfnLifecyclePolicy.ScriptProperty.Builder of CfnLifecyclePolicy.ScriptProperty