Struct rusoto_ssm::RegisterTaskWithMaintenanceWindowRequest

pub struct RegisterTaskWithMaintenanceWindowRequest {
    pub client_token: Option<String>,
    pub description: Option<String>,
    pub logging_info: Option<LoggingInfo>,
    pub max_concurrency: Option<String>,
    pub max_errors: Option<String>,
    pub name: Option<String>,
    pub priority: Option<i64>,
    pub service_role_arn: Option<String>,
    pub targets: Option<Vec<Target>>,
    pub task_arn: String,
    pub task_invocation_parameters: Option<MaintenanceWindowTaskInvocationParameters>,
    pub task_parameters: Option<HashMap<String, MaintenanceWindowTaskParameterValueExpression>>,
    pub task_type: String,
    pub window_id: String,
}

Fields

client_token: Option<String>

User-provided idempotency token.

description: Option<String>

An optional description for the task.

logging_info: Option<LoggingInfo>

A structure containing information about an S3 bucket to write instance-level logs to.

LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

max_concurrency: Option<String>

The maximum number of targets this task can be run for in parallel.

For maintenance window tasks without a target specified, you cannot supply a value for this option. Instead, the system inserts a placeholder value of 1. This value does not affect the running of your task.

max_errors: Option<String>

The maximum number of errors allowed before this task stops being scheduled.

For maintenance window tasks without a target specified, you cannot supply a value for this option. Instead, the system inserts a placeholder value of 1. This value does not affect the running of your task.

name: Option<String>

An optional name for the task.

priority: Option<i64>

The priority of the task in the maintenance window, the lower the number the higher the priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the same priority scheduled in parallel.

service_role_arn: Option<String>

The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

For more information, see the following topics in the in the AWS Systems Manager User Guide:

• Using service-linked roles for Systems Manager

• Should I use a service-linked role or a custom service role to run maintenance window tasks?

targets: Option<Vec<Target>>

The targets (either instances or maintenance window targets).

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, AWS Lambda, and AWS Step Functions). For more information about running tasks that do not specify targets, see see Registering maintenance window tasks without targets in the AWS Systems Manager User Guide.

Specify instances using the following format:

Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>

Specify maintenance window targets using the following format:

Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>

task_arn: String

The ARN of the task to run.

task_invocation_parameters: Option<MaintenanceWindowTaskInvocationParameters>

The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

task_parameters: Option<HashMap<String, MaintenanceWindowTaskParameterValueExpression>>

The parameters that should be passed to the task when it is run.

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.

task_type: String

The type of task being registered.

window_id: String

The ID of the maintenance window the task should be added to.

Trait Implementations

impl Clone for RegisterTaskWithMaintenanceWindowRequest

pub fn clone(&self) -> RegisterTaskWithMaintenanceWindowRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RegisterTaskWithMaintenanceWindowRequest

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

Formats the value using the given formatter.

impl Default for RegisterTaskWithMaintenanceWindowRequest

pub fn default() -> RegisterTaskWithMaintenanceWindowRequest

Returns the "default value" for a type.

impl PartialEq<RegisterTaskWithMaintenanceWindowRequest> for RegisterTaskWithMaintenanceWindowRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for RegisterTaskWithMaintenanceWindowRequest

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RegisterTaskWithMaintenanceWindowRequest