Struct aws_sdk_ssm::operation::get_maintenance_window_task::builders::GetMaintenanceWindowTaskOutputBuilder

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

A builder for GetMaintenanceWindowTaskOutput.

Implementations

impl GetMaintenanceWindowTaskOutputBuilder

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

The retrieved maintenance window ID.

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

The retrieved maintenance window ID.

pub fn get_window_id(&self) -> &Option<String>

The retrieved maintenance window ID.

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

The retrieved maintenance window task ID.

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

The retrieved maintenance window task ID.

pub fn get_window_task_id(&self) -> &Option<String>

The retrieved maintenance window task ID.

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

Appends an item to targets.

To override the contents of this collection use set_targets.

The targets where the task should run.

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

The targets where the task should run.

pub fn get_targets(&self) -> &Option<Vec<Target>>

The targets where the task should run.

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

The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the value of TaskArn is the SSM document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value is the state machine ARN.

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

The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the value of TaskArn is the SSM document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value is the state machine ARN.

pub fn get_task_arn(&self) -> &Option<String>

The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the value of TaskArn is the SSM document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value is the state machine ARN.

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 get_service_role_arn(&self) -> &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.

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

The type of task to run.

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

The type of task to run.

pub fn get_task_type(&self) -> &Option<MaintenanceWindowTaskType>

The type of task to run.

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 to pass to the task when it runs.

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 to pass to the task when it runs.

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 get_task_parameters( &self ) -> &Option<HashMap<String, MaintenanceWindowTaskParameterValueExpression>>

The parameters to pass to the task when it runs.

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 task_invocation_parameters( self, input: MaintenanceWindowTaskInvocationParameters ) -> Self

The parameters to pass to the task when it runs.

pub fn set_task_invocation_parameters( self, input: Option<MaintenanceWindowTaskInvocationParameters> ) -> Self

The parameters to pass to the task when it runs.

pub fn get_task_invocation_parameters( &self ) -> &Option<MaintenanceWindowTaskInvocationParameters>

The parameters to pass to the task when it runs.

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

The priority of the task when it runs. 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 when it runs. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

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

The priority of the task when it runs. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

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

The maximum number of targets allowed to run this task in parallel.

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, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.

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

The maximum number of targets allowed to run this task in parallel.

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, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.

pub fn get_max_concurrency(&self) -> &Option<String>

The maximum number of targets allowed to run this task in parallel.

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, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.

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

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

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, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.

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

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

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, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.

pub fn get_max_errors(&self) -> &Option<String>

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

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, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.

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

The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.

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

The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.

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 get_logging_info(&self) -> &Option<LoggingInfo>

The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.

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 name(self, input: impl Into<String>) -> Self

The retrieved task name.

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

The retrieved task name.

pub fn get_name(&self) -> &Option<String>

The retrieved task name.

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

The retrieved task description.

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

The retrieved task description.

pub fn get_description(&self) -> &Option<String>

The retrieved task description.

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

The action to take on tasks when the maintenance window cutoff time is reached. CONTINUE_TASK means that tasks continue to run. For Automation, Lambda, Step Functions tasks, CANCEL_TASK means that currently running task invocations continue, but no new task invocations are started. For Run Command tasks, CANCEL_TASK means the system attempts to stop the task by sending a CancelCommand operation.

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

The action to take on tasks when the maintenance window cutoff time is reached. CONTINUE_TASK means that tasks continue to run. For Automation, Lambda, Step Functions tasks, CANCEL_TASK means that currently running task invocations continue, but no new task invocations are started. For Run Command tasks, CANCEL_TASK means the system attempts to stop the task by sending a CancelCommand operation.

pub fn get_cutoff_behavior( &self ) -> &Option<MaintenanceWindowTaskCutoffBehavior>

The action to take on tasks when the maintenance window cutoff time is reached. CONTINUE_TASK means that tasks continue to run. For Automation, Lambda, Step Functions tasks, CANCEL_TASK means that currently running task invocations continue, but no new task invocations are started. For Run Command tasks, CANCEL_TASK means the system attempts to stop the task by sending a CancelCommand operation.

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

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

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

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

pub fn get_alarm_configuration(&self) -> &Option<AlarmConfiguration>

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

pub fn build(self) -> GetMaintenanceWindowTaskOutput

Consumes the builder and constructs a GetMaintenanceWindowTaskOutput.

Trait Implementations

impl Clone for GetMaintenanceWindowTaskOutputBuilder

fn clone(&self) -> GetMaintenanceWindowTaskOutputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetMaintenanceWindowTaskOutputBuilder

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

Formats the value using the given formatter.

impl Default for GetMaintenanceWindowTaskOutputBuilder

fn default() -> GetMaintenanceWindowTaskOutputBuilder

Returns the “default value” for a type.

impl PartialEq for GetMaintenanceWindowTaskOutputBuilder

fn eq(&self, other: &GetMaintenanceWindowTaskOutputBuilder) -> 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 GetMaintenanceWindowTaskOutputBuilder