public static interface RegisterTargetWithMaintenanceWindowRequest.Builder extends SsmRequest.Builder, SdkPojo, CopyableBuilder<RegisterTargetWithMaintenanceWindowRequest.Builder,RegisterTargetWithMaintenanceWindowRequest>
| Modifier and Type | Method and Description |
|---|---|
RegisterTargetWithMaintenanceWindowRequest.Builder |
clientToken(String clientToken)
User-provided idempotency token.
|
RegisterTargetWithMaintenanceWindowRequest.Builder |
description(String description)
An optional description for the target.
|
RegisterTargetWithMaintenanceWindowRequest.Builder |
name(String name)
An optional name for the target.
|
RegisterTargetWithMaintenanceWindowRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
RegisterTargetWithMaintenanceWindowRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
RegisterTargetWithMaintenanceWindowRequest.Builder |
ownerInformation(String ownerInformation)
User-provided value that will be included in any CloudWatch events raised while running tasks for these
targets in this maintenance window.
|
RegisterTargetWithMaintenanceWindowRequest.Builder |
resourceType(MaintenanceWindowResourceType resourceType)
The type of target being registered with the maintenance window.
|
RegisterTargetWithMaintenanceWindowRequest.Builder |
resourceType(String resourceType)
The type of target being registered with the maintenance window.
|
RegisterTargetWithMaintenanceWindowRequest.Builder |
targets(Collection<Target> targets)
The targets to register with the maintenance window.
|
RegisterTargetWithMaintenanceWindowRequest.Builder |
targets(Consumer<Target.Builder>... targets)
The targets to register with the maintenance window.
|
RegisterTargetWithMaintenanceWindowRequest.Builder |
targets(Target... targets)
The targets to register with the maintenance window.
|
RegisterTargetWithMaintenanceWindowRequest.Builder |
windowId(String windowId)
The ID of the maintenance window the target should be registered with.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildRegisterTargetWithMaintenanceWindowRequest.Builder windowId(String windowId)
The ID of the maintenance window the target should be registered with.
windowId - The ID of the maintenance window the target should be registered with.RegisterTargetWithMaintenanceWindowRequest.Builder resourceType(String resourceType)
The type of target being registered with the maintenance window.
resourceType - The type of target being registered with the maintenance window.MaintenanceWindowResourceType,
MaintenanceWindowResourceTypeRegisterTargetWithMaintenanceWindowRequest.Builder resourceType(MaintenanceWindowResourceType resourceType)
The type of target being registered with the maintenance window.
resourceType - The type of target being registered with the maintenance window.MaintenanceWindowResourceType,
MaintenanceWindowResourceTypeRegisterTargetWithMaintenanceWindowRequest.Builder targets(Collection<Target> targets)
The targets to register with the maintenance window. In other words, the instances 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 instance IDs, resource group names, or tags that have been applied to instances.
Example 1: Specify instance IDs
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
Example 2: Use tag key-pairs applied to instances
Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2
Example 3: Use tag-keys applied to instances
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 AWS Systems Manager User Guide.
targets - The targets to register with the maintenance window. In other words, the instances 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 instance IDs, resource group names, or tags that have been applied to instances.
Example 1: Specify instance IDs
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
Example 2: Use tag key-pairs applied to instances
Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2
Example 3: Use tag-keys applied to instances
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 AWS Systems Manager User Guide.
RegisterTargetWithMaintenanceWindowRequest.Builder targets(Target... targets)
The targets to register with the maintenance window. In other words, the instances 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 instance IDs, resource group names, or tags that have been applied to instances.
Example 1: Specify instance IDs
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
Example 2: Use tag key-pairs applied to instances
Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2
Example 3: Use tag-keys applied to instances
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 AWS Systems Manager User Guide.
targets - The targets to register with the maintenance window. In other words, the instances 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 instance IDs, resource group names, or tags that have been applied to instances.
Example 1: Specify instance IDs
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
Example 2: Use tag key-pairs applied to instances
Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2
Example 3: Use tag-keys applied to instances
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 AWS Systems Manager User Guide.
RegisterTargetWithMaintenanceWindowRequest.Builder targets(Consumer<Target.Builder>... targets)
The targets to register with the maintenance window. In other words, the instances 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 instance IDs, resource group names, or tags that have been applied to instances.
Example 1: Specify instance IDs
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
Example 2: Use tag key-pairs applied to instances
Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2
Example 3: Use tag-keys applied to instances
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 AWS Systems Manager User Guide.
This is a convenience that creates an instance of theList.Builder avoiding the need to
create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its
result is passed to #targets(List) .targets - a consumer that will call methods on List.Builder #targets(List) RegisterTargetWithMaintenanceWindowRequest.Builder ownerInformation(String ownerInformation)
User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this maintenance window.
ownerInformation - User-provided value that will be included in any CloudWatch events raised while running tasks for
these targets in this maintenance window.RegisterTargetWithMaintenanceWindowRequest.Builder name(String name)
An optional name for the target.
name - An optional name for the target.RegisterTargetWithMaintenanceWindowRequest.Builder description(String description)
An optional description for the target.
description - An optional description for the target.RegisterTargetWithMaintenanceWindowRequest.Builder clientToken(String clientToken)
User-provided idempotency token.
clientToken - User-provided idempotency token.RegisterTargetWithMaintenanceWindowRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.RegisterTargetWithMaintenanceWindowRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.