software.amazon.awssdk.services.ssm.model

Interface RegisterTargetWithMaintenanceWindowRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<RegisterTargetWithMaintenanceWindowRequest.Builder,RegisterTargetWithMaintenanceWindowRequest>, SdkBuilder<RegisterTargetWithMaintenanceWindowRequest.Builder,RegisterTargetWithMaintenanceWindowRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder

Enclosing class:

RegisterTargetWithMaintenanceWindowRequest

public static interface RegisterTargetWithMaintenanceWindowRequest.Builder
extends SsmRequest.Builder, SdkPojo, CopyableBuilder<RegisterTargetWithMaintenanceWindowRequest.Builder,RegisterTargetWithMaintenanceWindowRequest>

Method Summary

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.

Methods inherited from interface software.amazon.awssdk.services.ssm.model.SsmRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

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.

resourceType

RegisterTargetWithMaintenanceWindowRequest.Builder resourceType(String resourceType)

The type of target being registered with the maintenance window.

Parameters:

resourceType - The type of target being registered with the maintenance window.

Returns:

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

See Also:

MaintenanceWindowResourceType, MaintenanceWindowResourceType

resourceType

RegisterTargetWithMaintenanceWindowRequest.Builder resourceType(MaintenanceWindowResourceType resourceType)

The type of target being registered with the maintenance window.

Parameters:

resourceType - The type of target being registered with the maintenance window.

Returns:

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

See Also:

MaintenanceWindowResourceType, MaintenanceWindowResourceType

targets

RegisterTargetWithMaintenanceWindowRequest.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.

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.

Parameters:

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

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.

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 instances to run commands on when the maintenance window runs.

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.

Parameters:

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

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.

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 instances to run commands on when the maintenance window runs.

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 the List.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).

Parameters:

targets - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#targets(List)

ownerInformation

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.

Parameters:

ownerInformation - User-provided value that will be included in any CloudWatch 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.

name

RegisterTargetWithMaintenanceWindowRequest.Builder name(String name)

An optional name for the target.

Parameters:

name - An optional name for the target.

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.

overrideConfiguration

RegisterTargetWithMaintenanceWindowRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

RegisterTargetWithMaintenanceWindowRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.