Package software.amazon.awssdk.services.ssm.model

Interface RegisterTargetWithMaintenanceWindowRequest.Builder

    • Method Detail

      • windowId

        RegisterTargetWithMaintenanceWindowRequest.Builder windowId​(String windowId)

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

        Parameters:
        windowId - The ID of the maintenance window the target should be registered with.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targets

        RegisterTargetWithMaintenanceWindowRequest.Builder targets​(Collection<Target> 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=<instance-id-1>,<instance-id-2>,<instance-id-3>

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

        Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>

        Example 3: Use tag-keys applied to managed nodes

        Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>

        Example 4: Use resource group names

        Key=resource-groups:Name,Values=<resource-group-name>

        Example 5: Use filters for resource group types

        Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>

        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.

        Parameters:
        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=<instance-id-1>,<instance-id-2>,<instance-id-3>

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

        Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>

        Example 3: Use tag-keys applied to managed nodes

        Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>

        Example 4: Use resource group names

        Key=resource-groups:Name,Values=<resource-group-name>

        Example 5: Use filters for resource group types

        Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>

        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targets

        RegisterTargetWithMaintenanceWindowRequest.Builder targets​(Target... 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=<instance-id-1>,<instance-id-2>,<instance-id-3>

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

        Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>

        Example 3: Use tag-keys applied to managed nodes

        Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>

        Example 4: Use resource group names

        Key=resource-groups:Name,Values=<resource-group-name>

        Example 5: Use filters for resource group types

        Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>

        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.

        Parameters:
        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=<instance-id-1>,<instance-id-2>,<instance-id-3>

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

        Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>

        Example 3: Use tag-keys applied to managed nodes

        Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>

        Example 4: Use resource group names

        Key=resource-groups:Name,Values=<resource-group-name>

        Example 5: Use filters for resource group types

        Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>

        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targets

        RegisterTargetWithMaintenanceWindowRequest.Builder targets​(Consumer<Target.Builder>... 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=<instance-id-1>,<instance-id-2>,<instance-id-3>

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

        Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>

        Example 3: Use tag-keys applied to managed nodes

        Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>

        Example 4: Use resource group names

        Key=resource-groups:Name,Values=<resource-group-name>

        Example 5: Use filters for resource group types

        Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>

        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.

        This is a convenience method that creates an instance of the Target.Builder avoiding the need to create one manually via Target.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #targets(List).

        Parameters:
        targets - a consumer that will call methods on Target.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #targets(java.util.Collection)

      • ownerInformation

        RegisterTargetWithMaintenanceWindowRequest.Builder ownerInformation​(String ownerInformation)

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

        Parameters:
        ownerInformation - User-provided value that will be included in any Amazon CloudWatch Events events raised while running tasks for these targets in this maintenance window.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        RegisterTargetWithMaintenanceWindowRequest.Builder description​(String description)

        An optional description for the target.

        Parameters:
        description - An optional description for the target.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientToken

        RegisterTargetWithMaintenanceWindowRequest.Builder clientToken​(String clientToken)

        User-provided idempotency token.

        Parameters:
        clientToken - User-provided idempotency token.
        Returns:
        Returns a reference to this object so that method calls can be chained together.