Struct aws_sdk_dlm::types::Script
source · #[non_exhaustive]pub struct Script {
pub stages: Option<Vec<StageValues>>,
pub execution_handler_service: Option<ExecutionHandlerServiceValues>,
pub execution_handler: Option<String>,
pub execute_operation_on_script_failure: Option<bool>,
pub execution_timeout: Option<i32>,
pub maximum_retry_count: Option<i32>,
}
Expand description
[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.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.stages: Option<Vec<StageValues>>
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
execution_handler_service: Option<ExecutionHandlerServiceValues>
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
execution_handler: Option<String>
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.
execute_operation_on_script_failure: Option<bool>
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
execution_timeout: Option<i32>
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
maximum_retry_count: Option<i32>
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
Implementations§
source§impl Script
impl Script
sourcepub fn stages(&self) -> &[StageValues]
pub fn stages(&self) -> &[StageValues]
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
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .stages.is_none()
.
sourcepub fn execution_handler_service(
&self
) -> Option<&ExecutionHandlerServiceValues>
pub fn execution_handler_service( &self ) -> Option<&ExecutionHandlerServiceValues>
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
sourcepub fn execution_handler(&self) -> Option<&str>
pub fn execution_handler(&self) -> Option<&str>
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.
sourcepub fn execute_operation_on_script_failure(&self) -> Option<bool>
pub fn execute_operation_on_script_failure(&self) -> Option<bool>
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
sourcepub fn execution_timeout(&self) -> Option<i32>
pub fn execution_timeout(&self) -> Option<i32>
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
sourcepub fn maximum_retry_count(&self) -> Option<i32>
pub fn maximum_retry_count(&self) -> Option<i32>
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
Trait Implementations§
source§impl PartialEq for Script
impl PartialEq for Script
impl StructuralPartialEq for Script
Auto Trait Implementations§
impl Freeze for Script
impl RefUnwindSafe for Script
impl Send for Script
impl Sync for Script
impl Unpin for Script
impl UnwindSafe for Script
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more