/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.simplesystemsmanagement.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class RegisterTargetWithMaintenanceWindowRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

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

*/ private String windowId; /** *

* The type of target being registered with the maintenance window. *

*/ private String resourceType; /** *

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

*/ private com.amazonaws.internal.SdkInternalList targets; /** *

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

*/ private String ownerInformation; /** *

* An optional name for the target. *

*/ private String name; /** *

* An optional description for the target. *

*/ private String description; /** *

* User-provided idempotency token. *

*/ private String clientToken; /** *

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

* * @param windowId * The ID of the maintenance window the target should be registered with. */ public void setWindowId(String windowId) { this.windowId = windowId; } /** *

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

* * @return The ID of the maintenance window the target should be registered with. */ public String getWindowId() { return this.windowId; } /** *

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

* * @param windowId * The ID of the maintenance window the target should be registered with. * @return Returns a reference to this object so that method calls can be chained together. */ public RegisterTargetWithMaintenanceWindowRequest withWindowId(String windowId) { setWindowId(windowId); return this; } /** *

* The type of target being registered with the maintenance window. *

* * @param resourceType * The type of target being registered with the maintenance window. * @see MaintenanceWindowResourceType */ public void setResourceType(String resourceType) { this.resourceType = resourceType; } /** *

* The type of target being registered with the maintenance window. *

* * @return The type of target being registered with the maintenance window. * @see MaintenanceWindowResourceType */ public String getResourceType() { return this.resourceType; } /** *

* The type of target being registered with the maintenance window. *

* * @param resourceType * The type of target being registered with the maintenance window. * @return Returns a reference to this object so that method calls can be chained together. * @see MaintenanceWindowResourceType */ public RegisterTargetWithMaintenanceWindowRequest withResourceType(String resourceType) { setResourceType(resourceType); return this; } /** *

* The type of target being registered with the maintenance window. *

* * @param resourceType * The type of target being registered with the maintenance window. * @see MaintenanceWindowResourceType */ public void setResourceType(MaintenanceWindowResourceType resourceType) { withResourceType(resourceType); } /** *

* The type of target being registered with the maintenance window. *

* * @param resourceType * The type of target being registered with the maintenance window. * @return Returns a reference to this object so that method calls can be chained together. * @see MaintenanceWindowResourceType */ public RegisterTargetWithMaintenanceWindowRequest withResourceType(MaintenanceWindowResourceType resourceType) { this.resourceType = resourceType.toString(); return this; } /** *

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

* * @return 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. */ public java.util.List getTargets() { if (targets == null) { targets = new com.amazonaws.internal.SdkInternalList(); } return 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. *

* * @param 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. */ public void setTargets(java.util.Collection targets) { if (targets == null) { this.targets = null; return; } this.targets = new com.amazonaws.internal.SdkInternalList(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 * {@link #setTargets(java.util.Collection)} or {@link #withTargets(java.util.Collection)} if you want to override * the existing values. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public RegisterTargetWithMaintenanceWindowRequest withTargets(Target... targets) { if (this.targets == null) { setTargets(new com.amazonaws.internal.SdkInternalList(targets.length)); } for (Target ele : targets) { this.targets.add(ele); } return this; } /** *

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

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public RegisterTargetWithMaintenanceWindowRequest withTargets(java.util.Collection targets) { setTargets(targets); return this; } /** *

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

* * @param 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. */ public void setOwnerInformation(String ownerInformation) { this.ownerInformation = 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. *

* * @return User-provided value that will be included in any Amazon CloudWatch Events events raised while running * tasks for these targets in this maintenance window. */ public String getOwnerInformation() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public RegisterTargetWithMaintenanceWindowRequest withOwnerInformation(String ownerInformation) { setOwnerInformation(ownerInformation); return this; } /** *

* An optional name for the target. *

* * @param name * An optional name for the target. */ public void setName(String name) { this.name = name; } /** *

* An optional name for the target. *

* * @return An optional name for the target. */ public String getName() { return this.name; } /** *

* An optional name for the target. *

* * @param name * An optional name for the target. * @return Returns a reference to this object so that method calls can be chained together. */ public RegisterTargetWithMaintenanceWindowRequest withName(String name) { setName(name); return this; } /** *

* An optional description for the target. *

* * @param description * An optional description for the target. */ public void setDescription(String description) { this.description = description; } /** *

* An optional description for the target. *

* * @return An optional description for the target. */ public String getDescription() { return this.description; } /** *

* An optional description for the target. *

* * @param description * An optional description for the target. * @return Returns a reference to this object so that method calls can be chained together. */ public RegisterTargetWithMaintenanceWindowRequest withDescription(String description) { setDescription(description); return this; } /** *

* User-provided idempotency token. *

* * @param clientToken * User-provided idempotency token. */ public void setClientToken(String clientToken) { this.clientToken = clientToken; } /** *

* User-provided idempotency token. *

* * @return User-provided idempotency token. */ public String getClientToken() { return this.clientToken; } /** *

* User-provided idempotency token. *

* * @param clientToken * User-provided idempotency token. * @return Returns a reference to this object so that method calls can be chained together. */ public RegisterTargetWithMaintenanceWindowRequest withClientToken(String clientToken) { setClientToken(clientToken); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getWindowId() != null) sb.append("WindowId: ").append(getWindowId()).append(","); if (getResourceType() != null) sb.append("ResourceType: ").append(getResourceType()).append(","); if (getTargets() != null) sb.append("Targets: ").append(getTargets()).append(","); if (getOwnerInformation() != null) sb.append("OwnerInformation: ").append("***Sensitive Data Redacted***").append(","); if (getName() != null) sb.append("Name: ").append(getName()).append(","); if (getDescription() != null) sb.append("Description: ").append("***Sensitive Data Redacted***").append(","); if (getClientToken() != null) sb.append("ClientToken: ").append(getClientToken()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof RegisterTargetWithMaintenanceWindowRequest == false) return false; RegisterTargetWithMaintenanceWindowRequest other = (RegisterTargetWithMaintenanceWindowRequest) obj; if (other.getWindowId() == null ^ this.getWindowId() == null) return false; if (other.getWindowId() != null && other.getWindowId().equals(this.getWindowId()) == false) return false; if (other.getResourceType() == null ^ this.getResourceType() == null) return false; if (other.getResourceType() != null && other.getResourceType().equals(this.getResourceType()) == false) return false; if (other.getTargets() == null ^ this.getTargets() == null) return false; if (other.getTargets() != null && other.getTargets().equals(this.getTargets()) == false) return false; if (other.getOwnerInformation() == null ^ this.getOwnerInformation() == null) return false; if (other.getOwnerInformation() != null && other.getOwnerInformation().equals(this.getOwnerInformation()) == false) return false; if (other.getName() == null ^ this.getName() == null) return false; if (other.getName() != null && other.getName().equals(this.getName()) == false) return false; if (other.getDescription() == null ^ this.getDescription() == null) return false; if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false) return false; if (other.getClientToken() == null ^ this.getClientToken() == null) return false; if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getWindowId() == null) ? 0 : getWindowId().hashCode()); hashCode = prime * hashCode + ((getResourceType() == null) ? 0 : getResourceType().hashCode()); hashCode = prime * hashCode + ((getTargets() == null) ? 0 : getTargets().hashCode()); hashCode = prime * hashCode + ((getOwnerInformation() == null) ? 0 : getOwnerInformation().hashCode()); hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode()); hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode()); hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode()); return hashCode; } @Override public RegisterTargetWithMaintenanceWindowRequest clone() { return (RegisterTargetWithMaintenanceWindowRequest) super.clone(); } }