Struct MaintenanceWindowRunCommandParameters

#[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>,
}

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)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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 IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the Amazon Web Services Systems Manager User Guide.

timeout_seconds: Option<i32>

If this time is reached and the command hasn't already started running, it doesn't run.

Implementations

impl MaintenanceWindowRunCommandParameters

pub fn comment(&self) -> Option<&str>

Information about the commands to run.

pub fn cloud_watch_output_config(&self) -> Option<&CloudWatchOutputConfig>

Configuration options for sending command output to Amazon CloudWatch Logs.

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.

pub fn document_hash_type(&self) -> Option<&DocumentHashType>

SHA-256 or SHA-1. SHA-1 hashes have been deprecated.

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"

pub fn notification_config(&self) -> Option<&NotificationConfig>

Configurations for sending notifications about command status changes on a per-managed node basis.

pub fn output_s3_bucket_name(&self) -> Option<&str>

The name of the Amazon Simple Storage Service (Amazon S3) bucket.

pub fn output_s3_key_prefix(&self) -> Option<&str>

The S3 bucket subfolder.

pub fn parameters(&self) -> Option<&HashMap<String, Vec<String>>>

The parameters for the RUN_COMMAND task execution.

pub fn service_role_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the Amazon Web Services Systems Manager User Guide.

pub fn timeout_seconds(&self) -> Option<i32>

If this time is reached and the command hasn't already started running, it doesn't run.

impl MaintenanceWindowRunCommandParameters

pub fn builder() -> MaintenanceWindowRunCommandParametersBuilder

Creates a new builder-style object to manufacture MaintenanceWindowRunCommandParameters.

Trait Implementations

impl Clone for MaintenanceWindowRunCommandParameters

fn clone(&self) -> MaintenanceWindowRunCommandParameters

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MaintenanceWindowRunCommandParameters

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for MaintenanceWindowRunCommandParameters

fn eq(&self, other: &MaintenanceWindowRunCommandParameters) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for MaintenanceWindowRunCommandParameters