com.amazonaws.services.simplesystemsmanagement.model.MaintenanceWindowAutomationParameters Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ssm Show documentation
/*
* Copyright 2019-2024 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.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The parameters for an AUTOMATION task type.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class MaintenanceWindowAutomationParameters implements Serializable, Cloneable, StructuredPojo {
/**
*
* The version of an Automation runbook to use during task execution.
*
*/
private String documentVersion;
/**
*
* The parameters for the AUTOMATION task.
*
*
* For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and
* UpdateMaintenanceWindowTask.
*
*
*
* LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to
* contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the
* TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager
* handles these options for the supported maintenance window task types, see
* MaintenanceWindowTaskInvocationParameters.
*
*
* TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead
* use the Parameters option in the TaskInvocationParameters structure. For information
* about how Systems Manager handles these options for the supported maintenance window task types, see
* MaintenanceWindowTaskInvocationParameters.
*
*
* For AUTOMATION task types, Amazon Web Services Systems Manager ignores any values specified for
* these parameters.
*
*
*/
private java.util.Map> parameters;
/**
*
* The version of an Automation runbook to use during task execution.
*
*
* @param documentVersion
* The version of an Automation runbook to use during task execution.
*/
public void setDocumentVersion(String documentVersion) {
this.documentVersion = documentVersion;
}
/**
*
* The version of an Automation runbook to use during task execution.
*
*
* @return The version of an Automation runbook to use during task execution.
*/
public String getDocumentVersion() {
return this.documentVersion;
}
/**
*
* The version of an Automation runbook to use during task execution.
*
*
* @param documentVersion
* The version of an Automation runbook to use during task execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MaintenanceWindowAutomationParameters withDocumentVersion(String documentVersion) {
setDocumentVersion(documentVersion);
return this;
}
/**
*
* The parameters for the AUTOMATION task.
*
*
* For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and
* UpdateMaintenanceWindowTask.
*
*
*
* LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to
* contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the
* TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager
* handles these options for the supported maintenance window task types, see
* MaintenanceWindowTaskInvocationParameters.
*
*
* TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead
* use the Parameters option in the TaskInvocationParameters structure. For information
* about how Systems Manager handles these options for the supported maintenance window task types, see
* MaintenanceWindowTaskInvocationParameters.
*
*
* For AUTOMATION task types, Amazon Web Services Systems Manager ignores any values specified for
* these parameters.
*
*
*
* @return The parameters for the AUTOMATION task.
*
* For information about specifying and updating task parameters, see
* RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.
*
*
*
* LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3)
* bucket to contain logs, instead use the OutputS3BucketName and
* OutputS3KeyPrefix options in the TaskInvocationParameters structure. For
* information about how Amazon Web Services Systems Manager handles these options for the supported
* maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
*
*
* TaskParameters has been deprecated. To specify parameters to pass to a task when it runs,
* instead use the Parameters option in the TaskInvocationParameters structure.
* For information about how Systems Manager handles these options for the supported maintenance window task
* types, see MaintenanceWindowTaskInvocationParameters.
*
*
* For AUTOMATION task types, Amazon Web Services Systems Manager ignores any values specified
* for these parameters.
*
*/
public java.util.Map> getParameters() {
return parameters;
}
/**
*
* The parameters for the AUTOMATION task.
*
*
* For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and
* UpdateMaintenanceWindowTask.
*
*
*
* LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to
* contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the
* TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager
* handles these options for the supported maintenance window task types, see
* MaintenanceWindowTaskInvocationParameters.
*
*
* TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead
* use the Parameters option in the TaskInvocationParameters structure. For information
* about how Systems Manager handles these options for the supported maintenance window task types, see
* MaintenanceWindowTaskInvocationParameters.
*
*
* For AUTOMATION task types, Amazon Web Services Systems Manager ignores any values specified for
* these parameters.
*
*
*
* @param parameters
* The parameters for the AUTOMATION task.
*
* For information about specifying and updating task parameters, see
* RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.
*
*
*
* LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3)
* bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix
* options in the TaskInvocationParameters structure. For information about how Amazon Web
* Services Systems Manager handles these options for the supported maintenance window task types, see
* MaintenanceWindowTaskInvocationParameters.
*
*
* TaskParameters has been deprecated. To specify parameters to pass to a task when it runs,
* instead use the Parameters option in the TaskInvocationParameters structure. For
* information about how Systems Manager handles these options for the supported maintenance window task
* types, see MaintenanceWindowTaskInvocationParameters.
*
*
* For AUTOMATION task types, Amazon Web Services Systems Manager ignores any values specified
* for these parameters.
*
*/
public void setParameters(java.util.Map> parameters) {
this.parameters = parameters;
}
/**
*
* The parameters for the AUTOMATION task.
*
*
* For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and
* UpdateMaintenanceWindowTask.
*
*
*
* LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to
* contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the
* TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager
* handles these options for the supported maintenance window task types, see
* MaintenanceWindowTaskInvocationParameters.
*
*
* TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead
* use the Parameters option in the TaskInvocationParameters structure. For information
* about how Systems Manager handles these options for the supported maintenance window task types, see
* MaintenanceWindowTaskInvocationParameters.
*
*
* For AUTOMATION task types, Amazon Web Services Systems Manager ignores any values specified for
* these parameters.
*
*
*
* @param parameters
* The parameters for the AUTOMATION task.
*
* For information about specifying and updating task parameters, see
* RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.
*
*
*
* LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3)
* bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix
* options in the TaskInvocationParameters structure. For information about how Amazon Web
* Services Systems Manager handles these options for the supported maintenance window task types, see
* MaintenanceWindowTaskInvocationParameters.
*
*
* TaskParameters has been deprecated. To specify parameters to pass to a task when it runs,
* instead use the Parameters option in the TaskInvocationParameters structure. For
* information about how Systems Manager handles these options for the supported maintenance window task
* types, see MaintenanceWindowTaskInvocationParameters.
*
*
* For AUTOMATION task types, Amazon Web Services Systems Manager ignores any values specified
* for these parameters.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MaintenanceWindowAutomationParameters withParameters(java.util.Map> parameters) {
setParameters(parameters);
return this;
}
/**
* Add a single Parameters entry
*
* @see MaintenanceWindowAutomationParameters#withParameters
* @returns a reference to this object so that method calls can be chained together.
*/
public MaintenanceWindowAutomationParameters addParametersEntry(String key, java.util.List value) {
if (null == this.parameters) {
this.parameters = new java.util.HashMap>();
}
if (this.parameters.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.parameters.put(key, value);
return this;
}
/**
* Removes all the entries added into Parameters.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MaintenanceWindowAutomationParameters clearParametersEntries() {
this.parameters = null;
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 (getDocumentVersion() != null)
sb.append("DocumentVersion: ").append(getDocumentVersion()).append(",");
if (getParameters() != null)
sb.append("Parameters: ").append(getParameters());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof MaintenanceWindowAutomationParameters == false)
return false;
MaintenanceWindowAutomationParameters other = (MaintenanceWindowAutomationParameters) obj;
if (other.getDocumentVersion() == null ^ this.getDocumentVersion() == null)
return false;
if (other.getDocumentVersion() != null && other.getDocumentVersion().equals(this.getDocumentVersion()) == false)
return false;
if (other.getParameters() == null ^ this.getParameters() == null)
return false;
if (other.getParameters() != null && other.getParameters().equals(this.getParameters()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDocumentVersion() == null) ? 0 : getDocumentVersion().hashCode());
hashCode = prime * hashCode + ((getParameters() == null) ? 0 : getParameters().hashCode());
return hashCode;
}
@Override
public MaintenanceWindowAutomationParameters clone() {
try {
return (MaintenanceWindowAutomationParameters) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.simplesystemsmanagement.model.transform.MaintenanceWindowAutomationParametersMarshaller.getInstance().marshall(this,
protocolMarshaller);
}
}