#[non_exhaustive]pub struct MaintenanceWindowRunCommandParameters {
pub comment: Option<String>,
pub cloud_watch_output_config: Option<CloudWatchOutputConfig>,
pub document_hash: Option<String>,
pub document_hash_type: Option<DocumentHashType>,
pub document_version: Option<String>,
pub notification_config: Option<NotificationConfig>,
pub output_s3_bucket_name: Option<String>,
pub output_s3_key_prefix: Option<String>,
pub parameters: Option<HashMap<String, Vec<String>>>,
pub service_role_arn: Option<String>,
pub timeout_seconds: Option<i32>,
}
Expand description
The parameters for a RUN_COMMAND
task type.
For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow
and UpdateMaintenanceWindowTask
.
LoggingInfo
has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName
and OutputS3KeyPrefix
options in the TaskInvocationParameters
structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters
.
TaskParameters
has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters
option in the TaskInvocationParameters
structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters
.
For RUN_COMMAND
tasks, Systems Manager uses specified values for TaskParameters
and LoggingInfo
only if no values are specified for TaskInvocationParameters
.
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.comment: Option<String>
Information about the commands to run.
cloud_watch_output_config: Option<CloudWatchOutputConfig>
Configuration options for sending command output to Amazon CloudWatch Logs.
document_hash: Option<String>
The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
document_hash_type: Option<DocumentHashType>
SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
document_version: Option<String>
The Amazon Web Services Systems Manager document (SSM document) version to use in the request. You can specify $DEFAULT
, $LATEST
, or a specific version number. If you run commands by using the Amazon Web Services CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:
--document-version "\$DEFAULT"
--document-version "\$LATEST"
--document-version "3"
notification_config: Option<NotificationConfig>
Configurations for sending notifications about command status changes on a per-managed node basis.
output_s3_bucket_name: Option<String>
The name of the Amazon Simple Storage Service (Amazon S3) bucket.
output_s3_key_prefix: Option<String>
The S3 bucket subfolder.
parameters: Option<HashMap<String, Vec<String>>>
The parameters for the RUN_COMMAND
task execution.
service_role_arn: Option<String>
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
timeout_seconds: Option<i32>
If this time is reached and the command hasn't already started running, it doesn't run.
Implementations
sourceimpl MaintenanceWindowRunCommandParameters
impl MaintenanceWindowRunCommandParameters
sourcepub fn cloud_watch_output_config(&self) -> Option<&CloudWatchOutputConfig>
pub fn cloud_watch_output_config(&self) -> Option<&CloudWatchOutputConfig>
Configuration options for sending command output to Amazon CloudWatch Logs.
sourcepub fn document_hash(&self) -> Option<&str>
pub fn document_hash(&self) -> Option<&str>
The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
sourcepub fn document_hash_type(&self) -> Option<&DocumentHashType>
pub fn document_hash_type(&self) -> Option<&DocumentHashType>
SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
sourcepub fn document_version(&self) -> Option<&str>
pub fn document_version(&self) -> Option<&str>
The Amazon Web Services Systems Manager document (SSM document) version to use in the request. You can specify $DEFAULT
, $LATEST
, or a specific version number. If you run commands by using the Amazon Web Services CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:
--document-version "\$DEFAULT"
--document-version "\$LATEST"
--document-version "3"
sourcepub fn notification_config(&self) -> Option<&NotificationConfig>
pub fn notification_config(&self) -> Option<&NotificationConfig>
Configurations for sending notifications about command status changes on a per-managed node basis.
sourcepub fn output_s3_bucket_name(&self) -> Option<&str>
pub fn output_s3_bucket_name(&self) -> Option<&str>
The name of the Amazon Simple Storage Service (Amazon S3) bucket.
sourcepub fn output_s3_key_prefix(&self) -> Option<&str>
pub fn output_s3_key_prefix(&self) -> Option<&str>
The S3 bucket subfolder.
sourcepub fn parameters(&self) -> Option<&HashMap<String, Vec<String>>>
pub fn parameters(&self) -> Option<&HashMap<String, Vec<String>>>
The parameters for the RUN_COMMAND
task execution.
sourcepub fn service_role_arn(&self) -> Option<&str>
pub fn service_role_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
sourcepub fn timeout_seconds(&self) -> Option<i32>
pub fn timeout_seconds(&self) -> Option<i32>
If this time is reached and the command hasn't already started running, it doesn't run.
sourceimpl MaintenanceWindowRunCommandParameters
impl MaintenanceWindowRunCommandParameters
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture MaintenanceWindowRunCommandParameters
Trait Implementations
sourceimpl Clone for MaintenanceWindowRunCommandParameters
impl Clone for MaintenanceWindowRunCommandParameters
sourcefn clone(&self) -> MaintenanceWindowRunCommandParameters
fn clone(&self) -> MaintenanceWindowRunCommandParameters
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl PartialEq<MaintenanceWindowRunCommandParameters> for MaintenanceWindowRunCommandParameters
impl PartialEq<MaintenanceWindowRunCommandParameters> for MaintenanceWindowRunCommandParameters
sourcefn eq(&self, other: &MaintenanceWindowRunCommandParameters) -> bool
fn eq(&self, other: &MaintenanceWindowRunCommandParameters) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &MaintenanceWindowRunCommandParameters) -> bool
fn ne(&self, other: &MaintenanceWindowRunCommandParameters) -> bool
This method tests for !=
.
impl StructuralPartialEq for MaintenanceWindowRunCommandParameters
Auto Trait Implementations
impl RefUnwindSafe for MaintenanceWindowRunCommandParameters
impl Send for MaintenanceWindowRunCommandParameters
impl Sync for MaintenanceWindowRunCommandParameters
impl Unpin for MaintenanceWindowRunCommandParameters
impl UnwindSafe for MaintenanceWindowRunCommandParameters
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