Struct aws_sdk_ssm::model::Runbook
source · [−]#[non_exhaustive]pub struct Runbook {
pub document_name: Option<String>,
pub document_version: Option<String>,
pub parameters: Option<HashMap<String, Vec<String>>>,
pub target_parameter_name: Option<String>,
pub targets: Option<Vec<Target>>,
pub max_concurrency: Option<String>,
pub max_errors: Option<String>,
pub target_locations: Option<Vec<TargetLocation>>,
}
Expand description
Information about an Automation runbook used in a runbook workflow in Change Manager.
The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
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.document_name: Option<String>
The name of the Automation runbook used in a runbook workflow.
document_version: Option<String>
The version of the Automation runbook used in a runbook workflow.
parameters: Option<HashMap<String, Vec<String>>>
The key-value map of execution parameters, which were supplied when calling StartChangeRequestExecution
.
target_parameter_name: Option<String>
The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify Targets
.
targets: Option<Vec<Target>>
A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify TargetParameterName
.
max_concurrency: Option<String>
The MaxConcurrency
value specified by the user when the operation started, indicating the maximum number of resources that the runbook operation can run on at the same time.
max_errors: Option<String>
The MaxErrors
value specified by the user when the execution started, indicating the maximum number of errors that can occur during the operation before the updates are stopped or rolled back.
target_locations: Option<Vec<TargetLocation>>
Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.
Implementations
sourceimpl Runbook
impl Runbook
sourcepub fn document_name(&self) -> Option<&str>
pub fn document_name(&self) -> Option<&str>
The name of the Automation runbook used in a runbook workflow.
sourcepub fn document_version(&self) -> Option<&str>
pub fn document_version(&self) -> Option<&str>
The version of the Automation runbook used in a runbook workflow.
sourcepub fn parameters(&self) -> Option<&HashMap<String, Vec<String>>>
pub fn parameters(&self) -> Option<&HashMap<String, Vec<String>>>
The key-value map of execution parameters, which were supplied when calling StartChangeRequestExecution
.
sourcepub fn target_parameter_name(&self) -> Option<&str>
pub fn target_parameter_name(&self) -> Option<&str>
The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify Targets
.
sourcepub fn targets(&self) -> Option<&[Target]>
pub fn targets(&self) -> Option<&[Target]>
A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify TargetParameterName
.
sourcepub fn max_concurrency(&self) -> Option<&str>
pub fn max_concurrency(&self) -> Option<&str>
The MaxConcurrency
value specified by the user when the operation started, indicating the maximum number of resources that the runbook operation can run on at the same time.
sourcepub fn max_errors(&self) -> Option<&str>
pub fn max_errors(&self) -> Option<&str>
The MaxErrors
value specified by the user when the execution started, indicating the maximum number of errors that can occur during the operation before the updates are stopped or rolled back.
sourcepub fn target_locations(&self) -> Option<&[TargetLocation]>
pub fn target_locations(&self) -> Option<&[TargetLocation]>
Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.
Trait Implementations
impl StructuralPartialEq for Runbook
Auto Trait Implementations
impl RefUnwindSafe for Runbook
impl Send for Runbook
impl Sync for Runbook
impl Unpin for Runbook
impl UnwindSafe for Runbook
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more