Struct aws_sdk_ssm::client::fluent_builders::RegisterTargetWithMaintenanceWindow

pub struct RegisterTargetWithMaintenanceWindow { /* private fields */ }

Fluent builder constructing a request to RegisterTargetWithMaintenanceWindow.

Registers a target with a maintenance window.

Implementations

impl RegisterTargetWithMaintenanceWindow

pub async fn send(
    self
) -> Result<RegisterTargetWithMaintenanceWindowOutput, SdkError<RegisterTargetWithMaintenanceWindowError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

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

The ID of the maintenance window the target should be registered with.

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

The ID of the maintenance window the target should be registered with.

pub fn resource_type(self, input: MaintenanceWindowResourceType) -> Self

The type of target being registered with the maintenance window.

pub fn set_resource_type(
    self,
    input: Option<MaintenanceWindowResourceType>
) -> Self

The type of target being registered with the maintenance window.

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

Appends an item to Targets.

To override the contents of this collection use set_targets.

The targets to register with the maintenance window. In other words, the managed nodes to run commands on when the maintenance window runs.

If a single maintenance window task is registered with multiple targets, its task invocations occur sequentially and not in parallel. If your task must run on multiple targets at the same time, register a task for each target individually and assign each task the same priority level.

You can specify targets using managed node IDs, resource group names, or tags that have been applied to managed nodes.

Example 1: Specify managed node IDs

Key=InstanceIds,Values= , ,

Example 2: Use tag key-pairs applied to managed nodes

Key=tag: ,Values= ,

Example 3: Use tag-keys applied to managed nodes

Key=tag-key,Values= ,

Example 4: Use resource group names

Key=resource-groups:Name,Values=

Example 5: Use filters for resource group types

Key=resource-groups:ResourceTypeFilters,Values= ,

For Key=resource-groups:ResourceTypeFilters, specify resource types in the following format

Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC

For more information about these examples formats, including the best use case for each one, see Examples: Register targets with a maintenance window in the Amazon Web Services Systems Manager User Guide.

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

The targets to register with the maintenance window. In other words, the managed nodes to run commands on when the maintenance window runs.

If a single maintenance window task is registered with multiple targets, its task invocations occur sequentially and not in parallel. If your task must run on multiple targets at the same time, register a task for each target individually and assign each task the same priority level.

You can specify targets using managed node IDs, resource group names, or tags that have been applied to managed nodes.

Example 1: Specify managed node IDs

Key=InstanceIds,Values= , ,

Example 2: Use tag key-pairs applied to managed nodes

Key=tag: ,Values= ,

Example 3: Use tag-keys applied to managed nodes

Key=tag-key,Values= ,

Example 4: Use resource group names

Key=resource-groups:Name,Values=

Example 5: Use filters for resource group types

Key=resource-groups:ResourceTypeFilters,Values= ,

For Key=resource-groups:ResourceTypeFilters, specify resource types in the following format

Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC

For more information about these examples formats, including the best use case for each one, see Examples: Register targets with a maintenance window in the Amazon Web Services Systems Manager User Guide.

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

User-provided value that will be included in any Amazon CloudWatch Events events raised while running tasks for these targets in this maintenance window.

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

User-provided value that will be included in any Amazon CloudWatch Events events raised while running tasks for these targets in this maintenance window.

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

An optional name for the target.

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

An optional name for the target.

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

An optional description for the target.

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

An optional description for the target.

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

User-provided idempotency token.

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

User-provided idempotency token.

Trait Implementations

impl Clone for RegisterTargetWithMaintenanceWindow

fn clone(&self) -> RegisterTargetWithMaintenanceWindow

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RegisterTargetWithMaintenanceWindow

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

Formats the value using the given formatter.