com.amazonaws.services.cloudformation.model.Parameter Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudformation Show documentation
/*
* 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.cloudformation.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* The Parameter data type.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Parameter implements Serializable, Cloneable {
/**
*
* The key associated with the parameter. If you don't specify a key and value for a particular parameter,
* CloudFormation uses the default value that's specified in your template.
*
*/
private String parameterKey;
/**
*
* The input value associated with the parameter.
*
*/
private String parameterValue;
/**
*
* During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you
* specify true, do not specify a parameter value.
*
*/
private Boolean usePreviousValue;
/**
*
* Read-only. The value that corresponds to a SSM parameter key. This field is returned only for SSM parameter types in the template.
*
*/
private String resolvedValue;
/**
*
* The key associated with the parameter. If you don't specify a key and value for a particular parameter,
* CloudFormation uses the default value that's specified in your template.
*
*
* @param parameterKey
* The key associated with the parameter. If you don't specify a key and value for a particular parameter,
* CloudFormation uses the default value that's specified in your template.
*/
public void setParameterKey(String parameterKey) {
this.parameterKey = parameterKey;
}
/**
*
* The key associated with the parameter. If you don't specify a key and value for a particular parameter,
* CloudFormation uses the default value that's specified in your template.
*
*
* @return The key associated with the parameter. If you don't specify a key and value for a particular parameter,
* CloudFormation uses the default value that's specified in your template.
*/
public String getParameterKey() {
return this.parameterKey;
}
/**
*
* The key associated with the parameter. If you don't specify a key and value for a particular parameter,
* CloudFormation uses the default value that's specified in your template.
*
*
* @param parameterKey
* The key associated with the parameter. If you don't specify a key and value for a particular parameter,
* CloudFormation uses the default value that's specified in your template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Parameter withParameterKey(String parameterKey) {
setParameterKey(parameterKey);
return this;
}
/**
*
* The input value associated with the parameter.
*
*
* @param parameterValue
* The input value associated with the parameter.
*/
public void setParameterValue(String parameterValue) {
this.parameterValue = parameterValue;
}
/**
*
* The input value associated with the parameter.
*
*
* @return The input value associated with the parameter.
*/
public String getParameterValue() {
return this.parameterValue;
}
/**
*
* The input value associated with the parameter.
*
*
* @param parameterValue
* The input value associated with the parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Parameter withParameterValue(String parameterValue) {
setParameterValue(parameterValue);
return this;
}
/**
*
* During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you
* specify true, do not specify a parameter value.
*
*
* @param usePreviousValue
* During a stack update, use the existing parameter value that the stack is using for a given parameter key.
* If you specify true, do not specify a parameter value.
*/
public void setUsePreviousValue(Boolean usePreviousValue) {
this.usePreviousValue = usePreviousValue;
}
/**
*
* During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you
* specify true, do not specify a parameter value.
*
*
* @return During a stack update, use the existing parameter value that the stack is using for a given parameter
* key. If you specify true, do not specify a parameter value.
*/
public Boolean getUsePreviousValue() {
return this.usePreviousValue;
}
/**
*
* During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you
* specify true, do not specify a parameter value.
*
*
* @param usePreviousValue
* During a stack update, use the existing parameter value that the stack is using for a given parameter key.
* If you specify true, do not specify a parameter value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Parameter withUsePreviousValue(Boolean usePreviousValue) {
setUsePreviousValue(usePreviousValue);
return this;
}
/**
*
* During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you
* specify true, do not specify a parameter value.
*
*
* @return During a stack update, use the existing parameter value that the stack is using for a given parameter
* key. If you specify true, do not specify a parameter value.
*/
public Boolean isUsePreviousValue() {
return this.usePreviousValue;
}
/**
*
* Read-only. The value that corresponds to a SSM parameter key. This field is returned only for SSM parameter types in the template.
*
*
* @param resolvedValue
* Read-only. The value that corresponds to a SSM parameter key. This field is returned only for SSM parameter types in the template.
*/
public void setResolvedValue(String resolvedValue) {
this.resolvedValue = resolvedValue;
}
/**
*
* Read-only. The value that corresponds to a SSM parameter key. This field is returned only for SSM parameter types in the template.
*
*
* @return Read-only. The value that corresponds to a SSM parameter key. This field is returned only for SSM parameter types in the template.
*/
public String getResolvedValue() {
return this.resolvedValue;
}
/**
*
* Read-only. The value that corresponds to a SSM parameter key. This field is returned only for SSM parameter types in the template.
*
*
* @param resolvedValue
* Read-only. The value that corresponds to a SSM parameter key. This field is returned only for SSM parameter types in the template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Parameter withResolvedValue(String resolvedValue) {
setResolvedValue(resolvedValue);
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 (getParameterKey() != null)
sb.append("ParameterKey: ").append(getParameterKey()).append(",");
if (getParameterValue() != null)
sb.append("ParameterValue: ").append(getParameterValue()).append(",");
if (getUsePreviousValue() != null)
sb.append("UsePreviousValue: ").append(getUsePreviousValue()).append(",");
if (getResolvedValue() != null)
sb.append("ResolvedValue: ").append(getResolvedValue());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Parameter == false)
return false;
Parameter other = (Parameter) obj;
if (other.getParameterKey() == null ^ this.getParameterKey() == null)
return false;
if (other.getParameterKey() != null && other.getParameterKey().equals(this.getParameterKey()) == false)
return false;
if (other.getParameterValue() == null ^ this.getParameterValue() == null)
return false;
if (other.getParameterValue() != null && other.getParameterValue().equals(this.getParameterValue()) == false)
return false;
if (other.getUsePreviousValue() == null ^ this.getUsePreviousValue() == null)
return false;
if (other.getUsePreviousValue() != null && other.getUsePreviousValue().equals(this.getUsePreviousValue()) == false)
return false;
if (other.getResolvedValue() == null ^ this.getResolvedValue() == null)
return false;
if (other.getResolvedValue() != null && other.getResolvedValue().equals(this.getResolvedValue()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getParameterKey() == null) ? 0 : getParameterKey().hashCode());
hashCode = prime * hashCode + ((getParameterValue() == null) ? 0 : getParameterValue().hashCode());
hashCode = prime * hashCode + ((getUsePreviousValue() == null) ? 0 : getUsePreviousValue().hashCode());
hashCode = prime * hashCode + ((getResolvedValue() == null) ? 0 : getResolvedValue().hashCode());
return hashCode;
}
@Override
public Parameter clone() {
try {
return (Parameter) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}