Struct aws_sdk_ssm::types::builders::MaintenanceWindowTaskBuilder

#[non_exhaustive]
pub struct MaintenanceWindowTaskBuilder { /* private fields */ }

A builder for MaintenanceWindowTask.

Implementations

impl MaintenanceWindowTaskBuilder

pub fn window_id(self, input: impl Into<String>) -> Self

The ID of the maintenance window where the task is registered.

pub fn set_window_id(self, input: Option<String>) -> Self

The ID of the maintenance window where the task is registered.

pub fn window_task_id(self, input: impl Into<String>) -> Self

The task ID.

pub fn set_window_task_id(self, input: Option<String>) -> Self

The task ID.

pub fn task_arn(self, input: impl Into<String>) -> Self

The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, TaskArn is the Amazon Web Services Systems Manager (SSM document) name or ARN. For LAMBDA tasks, it's the function name or ARN. For STEP_FUNCTIONS tasks, it's the state machine ARN.

pub fn set_task_arn(self, input: Option<String>) -> Self

The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, TaskArn is the Amazon Web Services Systems Manager (SSM document) name or ARN. For LAMBDA tasks, it's the function name or ARN. For STEP_FUNCTIONS tasks, it's the state machine ARN.

pub fn type(self, input: MaintenanceWindowTaskType) -> Self

The type of task.

pub fn set_type(self, input: Option<MaintenanceWindowTaskType>) -> Self

The type of task.

pub fn targets(self, input: Target) -> Self

Appends an item to targets.

To override the contents of this collection use set_targets.

The targets (either managed nodes or tags). Managed nodes are specified using Key=instanceids,Values= , . Tags are specified using Key= ,Values= .

pub fn set_targets(self, input: Option<Vec<Target>>) -> Self

The targets (either managed nodes or tags). Managed nodes are specified using Key=instanceids,Values= , . Tags are specified using Key= ,Values= .

pub fn task_parameters( self, k: impl Into<String>, v: MaintenanceWindowTaskParameterValueExpression ) -> Self

Adds a key-value pair to task_parameters.

To override the contents of this collection use set_task_parameters.

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.

pub fn set_task_parameters( self, input: Option<HashMap<String, MaintenanceWindowTaskParameterValueExpression>> ) -> Self

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.

pub fn priority(self, input: i32) -> Self

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

pub fn set_priority(self, input: Option<i32>) -> Self

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

pub fn logging_info(self, input: LoggingInfo) -> Self

Information about an S3 bucket to write task-level logs to.

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.

pub fn set_logging_info(self, input: Option<LoggingInfo>) -> Self

Information about an S3 bucket to write task-level logs to.

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.

pub fn service_role_arn(self, input: impl Into<String>) -> Self

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.

pub fn set_service_role_arn(self, input: Option<String>) -> Self

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.

pub fn max_concurrency(self, input: impl Into<String>) -> Self

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

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

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

pub fn set_max_concurrency(self, input: Option<String>) -> Self

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

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

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

pub fn max_errors(self, input: impl Into<String>) -> Self

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

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

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

pub fn set_max_errors(self, input: Option<String>) -> Self

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

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

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

pub fn name(self, input: impl Into<String>) -> Self

The task name.

pub fn set_name(self, input: Option<String>) -> Self

The task name.

pub fn description(self, input: impl Into<String>) -> Self

A description of the task.

pub fn set_description(self, input: Option<String>) -> Self

A description of the task.

pub fn cutoff_behavior(self, input: MaintenanceWindowTaskCutoffBehavior) -> Self

The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

pub fn set_cutoff_behavior( self, input: Option<MaintenanceWindowTaskCutoffBehavior> ) -> Self

The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

pub fn alarm_configuration(self, input: AlarmConfiguration) -> Self

The details for the CloudWatch alarm applied to your maintenance window task.

pub fn set_alarm_configuration(self, input: Option<AlarmConfiguration>) -> Self

The details for the CloudWatch alarm applied to your maintenance window task.

pub fn build(self) -> MaintenanceWindowTask

Consumes the builder and constructs a MaintenanceWindowTask.

Trait Implementations

impl Clone for MaintenanceWindowTaskBuilder

fn clone(&self) -> MaintenanceWindowTaskBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MaintenanceWindowTaskBuilder

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

Formats the value using the given formatter.

impl Default for MaintenanceWindowTaskBuilder

fn default() -> MaintenanceWindowTaskBuilder

Returns the “default value” for a type.

impl PartialEq<MaintenanceWindowTaskBuilder> for MaintenanceWindowTaskBuilder

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

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

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

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

impl StructuralPartialEq for MaintenanceWindowTaskBuilder