Class CfnLifecyclePolicy.ScriptProperty.Jsii$Proxy
- All Implemented Interfaces:
CfnLifecyclePolicy.ScriptProperty
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnLifecyclePolicy.ScriptProperty
CfnLifecyclePolicy.ScriptProperty
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.dlm.CfnLifecyclePolicy.ScriptProperty
CfnLifecyclePolicy.ScriptProperty.Builder, CfnLifecyclePolicy.ScriptProperty.Jsii$Proxy
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Constructor that initializes the object based on literal property values passed by theCfnLifecyclePolicy.ScriptProperty.Builder
.protected
Jsii$Proxy
(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final Object
Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails.final String
The SSM document that includes the pre and/or post scripts to run.final String
Indicates the service used to execute the pre and/or post scripts.final Number
Specifies a timeout period, in seconds, after which Amazon Data Lifecycle Manager fails the script run attempt if it has not completed.final Number
Specifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail.Indicate which scripts Amazon Data Lifecycle Manager should run on target instances.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef
- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theCfnLifecyclePolicy.ScriptProperty.Builder
.
-
-
Method Details
-
getExecuteOperationOnScriptFailure
Description copied from interface:CfnLifecyclePolicy.ScriptProperty
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
- Specified by:
getExecuteOperationOnScriptFailure
in interfaceCfnLifecyclePolicy.ScriptProperty
- See Also:
- To default to crash consistent snapshot if the pre script fails, specify
-
getExecutionHandler
Description copied from interface:CfnLifecyclePolicy.ScriptProperty
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 theAWSEC2-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.
- Specified by:
getExecutionHandler
in interfaceCfnLifecyclePolicy.ScriptProperty
- See Also:
- If you are automating VSS backups, specify
-
getExecutionHandlerService
Description copied from interface:CfnLifecyclePolicy.ScriptProperty
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
- Specified by:
getExecutionHandlerService
in interfaceCfnLifecyclePolicy.ScriptProperty
- See Also:
- If you are using custom SSM documents or automating application-consistent snapshots of SAP HANA workloads, specify
-
getExecutionTimeout
Description copied from interface:CfnLifecyclePolicy.ScriptProperty
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
- Specified by:
getExecutionTimeout
in interfaceCfnLifecyclePolicy.ScriptProperty
- See Also:
-
getMaximumRetryCount
Description copied from interface:CfnLifecyclePolicy.ScriptProperty
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
- Specified by:
getMaximumRetryCount
in interfaceCfnLifecyclePolicy.ScriptProperty
- See Also:
-
getStages
Description copied from interface:CfnLifecyclePolicy.ScriptProperty
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 thepre-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 thepost-script
parameter after initiating snapshot creation. - To run both pre and post scripts, specify both
PRE
andPOST
. In this case, Amazon Data Lifecycle Manager calls the SSM document with thepre-script
parameter before initiating snapshot creation, and then it calls the SSM document again with thepost-script
parameter after initiating snapshot creation.
If you are automating VSS Backups, omit this parameter.
Default: PRE and POST
- Specified by:
getStages
in interfaceCfnLifecyclePolicy.ScriptProperty
- See Also:
- To run a pre script only, specify
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-