com.amazonaws.services.simplesystemsmanagement.model

Class RegisterTargetWithMaintenanceWindowRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simplesystemsmanagement.model.RegisterTargetWithMaintenanceWindowRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RegisterTargetWithMaintenanceWindowRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RegisterTargetWithMaintenanceWindowRequest()

Method Summary

Modifier and Type	Method and Description
RegisterTargetWithMaintenanceWindowRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() User-provided idempotency token.
String	getDescription() An optional description for the target.
String	getName() An optional name for the target.
String	getOwnerInformation() User-provided value that will be included in any Amazon CloudWatch Events events raised while running tasks for these targets in this maintenance window.
String	getResourceType() The type of target being registered with the maintenance window.
List<Target>	getTargets() The targets to register with the maintenance window.
String	getWindowId() The ID of the maintenance window the target should be registered with.
int	hashCode()
void	setClientToken(String clientToken) User-provided idempotency token.
void	setDescription(String description) An optional description for the target.
void	setName(String name) An optional name for the target.
void	setOwnerInformation(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.
void	setResourceType(MaintenanceWindowResourceType resourceType) The type of target being registered with the maintenance window.
void	setResourceType(String resourceType) The type of target being registered with the maintenance window.
void	setTargets(Collection<Target> targets) The targets to register with the maintenance window.
void	setWindowId(String windowId) The ID of the maintenance window the target should be registered with.
String	toString() Returns a string representation of this object.
RegisterTargetWithMaintenanceWindowRequest	withClientToken(String clientToken) User-provided idempotency token.
RegisterTargetWithMaintenanceWindowRequest	withDescription(String description) An optional description for the target.
RegisterTargetWithMaintenanceWindowRequest	withName(String name) An optional name for the target.
RegisterTargetWithMaintenanceWindowRequest	withOwnerInformation(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.
RegisterTargetWithMaintenanceWindowRequest	withResourceType(MaintenanceWindowResourceType resourceType) The type of target being registered with the maintenance window.
RegisterTargetWithMaintenanceWindowRequest	withResourceType(String resourceType) The type of target being registered with the maintenance window.
RegisterTargetWithMaintenanceWindowRequest	withTargets(Collection<Target> targets) The targets to register with the maintenance window.
RegisterTargetWithMaintenanceWindowRequest	withTargets(Target... targets) The targets to register with the maintenance window.
RegisterTargetWithMaintenanceWindowRequest	withWindowId(String windowId) The ID of the maintenance window the target should be registered with.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RegisterTargetWithMaintenanceWindowRequest

public RegisterTargetWithMaintenanceWindowRequest()

Method Detail

setWindowId

public void setWindowId(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.

getWindowId

public String getWindowId()

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

Returns:

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

withWindowId

public RegisterTargetWithMaintenanceWindowRequest withWindowId(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.

setResourceType

public void setResourceType(String resourceType)

The type of target being registered with the maintenance window.

Parameters:

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

See Also:

MaintenanceWindowResourceType

getResourceType

public String getResourceType()

The type of target being registered with the maintenance window.

Returns:

The type of target being registered with the maintenance window.

See Also:

MaintenanceWindowResourceType

withResourceType

public RegisterTargetWithMaintenanceWindowRequest withResourceType(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

setResourceType

public void setResourceType(MaintenanceWindowResourceType resourceType)

The type of target being registered with the maintenance window.

Parameters:

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

See Also:

MaintenanceWindowResourceType

withResourceType

public RegisterTargetWithMaintenanceWindowRequest withResourceType(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

getTargets

public List<Target> getTargets()

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:

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.

setTargets

public void setTargets(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.

withTargets

public RegisterTargetWithMaintenanceWindowRequest withTargets(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.

NOTE: This method appends the values to the existing list (if any). Use setTargets(java.util.Collection) or withTargets(java.util.Collection) if you want to override the existing values.

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.

withTargets

public RegisterTargetWithMaintenanceWindowRequest withTargets(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.

setOwnerInformation

public void setOwnerInformation(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.

getOwnerInformation

public String getOwnerInformation()

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:

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

withOwnerInformation

public RegisterTargetWithMaintenanceWindowRequest withOwnerInformation(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.

setName

public void setName(String name)

An optional name for the target.

Parameters:

name - An optional name for the target.

getName

public String getName()

An optional name for the target.

Returns:

An optional name for the target.

withName

public RegisterTargetWithMaintenanceWindowRequest withName(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.

setDescription

public void setDescription(String description)

An optional description for the target.

Parameters:

description - An optional description for the target.

getDescription

public String getDescription()

An optional description for the target.

Returns:

An optional description for the target.

withDescription

public RegisterTargetWithMaintenanceWindowRequest withDescription(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.

setClientToken

public void setClientToken(String clientToken)

User-provided idempotency token.

Parameters:

clientToken - User-provided idempotency token.

getClientToken

public String getClientToken()

User-provided idempotency token.

Returns:

User-provided idempotency token.

withClientToken

public RegisterTargetWithMaintenanceWindowRequest withClientToken(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.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public RegisterTargetWithMaintenanceWindowRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()