com.amazonaws.services.servicecatalog.model.StackInstance Maven / Gradle / Ivy
Show all versions of aws-java-sdk-servicecatalog Show documentation
/*
* Copyright 2020-2025 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.servicecatalog.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* An CloudFormation stack, in a specific account and Region, that's part of a stack set operation. A stack instance is
* a reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist
* without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with
* only one stack set. Each stack instance contains the ID of its associated stack set, as well as the ID of the actual
* stack and the stack status.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class StackInstance implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the Amazon Web Services account that the stack instance is associated with.
*
*/
private String account;
/**
*
* The name of the Amazon Web Services Region that the stack instance is associated with.
*
*/
private String region;
/**
*
* The status of the stack instance, in terms of its synchronization with its associated stack set.
*
*
* -
*
* INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an
* unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might
* need to perform a DeleteStackInstances operation, with RetainStacks set to true, to
* delete the stack instance, and then delete the stack manually.
*
*
* -
*
* OUTDATED: The stack isn't currently up to date with the stack set because either the associated
* stack failed during a CreateStackSet or UpdateStackSet operation, or the stack was part
* of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the
* stack was created or updated.
*
*
* -
*
* CURRENT: The stack is currently up to date with the stack set.
*
*
*
*/
private String stackInstanceStatus;
/**
*
* The name of the Amazon Web Services account that the stack instance is associated with.
*
*
* @param account
* The name of the Amazon Web Services account that the stack instance is associated with.
*/
public void setAccount(String account) {
this.account = account;
}
/**
*
* The name of the Amazon Web Services account that the stack instance is associated with.
*
*
* @return The name of the Amazon Web Services account that the stack instance is associated with.
*/
public String getAccount() {
return this.account;
}
/**
*
* The name of the Amazon Web Services account that the stack instance is associated with.
*
*
* @param account
* The name of the Amazon Web Services account that the stack instance is associated with.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StackInstance withAccount(String account) {
setAccount(account);
return this;
}
/**
*
* The name of the Amazon Web Services Region that the stack instance is associated with.
*
*
* @param region
* The name of the Amazon Web Services Region that the stack instance is associated with.
*/
public void setRegion(String region) {
this.region = region;
}
/**
*
* The name of the Amazon Web Services Region that the stack instance is associated with.
*
*
* @return The name of the Amazon Web Services Region that the stack instance is associated with.
*/
public String getRegion() {
return this.region;
}
/**
*
* The name of the Amazon Web Services Region that the stack instance is associated with.
*
*
* @param region
* The name of the Amazon Web Services Region that the stack instance is associated with.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StackInstance withRegion(String region) {
setRegion(region);
return this;
}
/**
*
* The status of the stack instance, in terms of its synchronization with its associated stack set.
*
*
* -
*
* INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an
* unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might
* need to perform a DeleteStackInstances operation, with RetainStacks set to true, to
* delete the stack instance, and then delete the stack manually.
*
*
* -
*
* OUTDATED: The stack isn't currently up to date with the stack set because either the associated
* stack failed during a CreateStackSet or UpdateStackSet operation, or the stack was part
* of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the
* stack was created or updated.
*
*
* -
*
* CURRENT: The stack is currently up to date with the stack set.
*
*
*
*
* @param stackInstanceStatus
* The status of the stack instance, in terms of its synchronization with its associated stack set.
*
* -
*
* INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an
* unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You
* might need to perform a DeleteStackInstances operation, with RetainStacks set to
* true, to delete the stack instance, and then delete the stack manually.
*
*
* -
*
* OUTDATED: The stack isn't currently up to date with the stack set because either the
* associated stack failed during a CreateStackSet or UpdateStackSet operation, or
* the stack was part of a CreateStackSet or UpdateStackSet operation that failed
* or was stopped before the stack was created or updated.
*
*
* -
*
* CURRENT: The stack is currently up to date with the stack set.
*
*
* @see StackInstanceStatus
*/
public void setStackInstanceStatus(String stackInstanceStatus) {
this.stackInstanceStatus = stackInstanceStatus;
}
/**
*
* The status of the stack instance, in terms of its synchronization with its associated stack set.
*
*
* -
*
* INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an
* unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might
* need to perform a DeleteStackInstances operation, with RetainStacks set to true, to
* delete the stack instance, and then delete the stack manually.
*
*
* -
*
* OUTDATED: The stack isn't currently up to date with the stack set because either the associated
* stack failed during a CreateStackSet or UpdateStackSet operation, or the stack was part
* of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the
* stack was created or updated.
*
*
* -
*
* CURRENT: The stack is currently up to date with the stack set.
*
*
*
*
* @return The status of the stack instance, in terms of its synchronization with its associated stack set.
*
* -
*
* INOPERABLE: A DeleteStackInstances operation has failed and left the stack in
* an unstable state. Stacks in this state are excluded from further UpdateStackSet operations.
* You might need to perform a DeleteStackInstances operation, with RetainStacks
* set to true, to delete the stack instance, and then delete the stack manually.
*
*
* -
*
* OUTDATED: The stack isn't currently up to date with the stack set because either the
* associated stack failed during a CreateStackSet or UpdateStackSet operation, or
* the stack was part of a CreateStackSet or UpdateStackSet operation that failed
* or was stopped before the stack was created or updated.
*
*
* -
*
* CURRENT: The stack is currently up to date with the stack set.
*
*
* @see StackInstanceStatus
*/
public String getStackInstanceStatus() {
return this.stackInstanceStatus;
}
/**
*
* The status of the stack instance, in terms of its synchronization with its associated stack set.
*
*
* -
*
* INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an
* unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might
* need to perform a DeleteStackInstances operation, with RetainStacks set to true, to
* delete the stack instance, and then delete the stack manually.
*
*
* -
*
* OUTDATED: The stack isn't currently up to date with the stack set because either the associated
* stack failed during a CreateStackSet or UpdateStackSet operation, or the stack was part
* of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the
* stack was created or updated.
*
*
* -
*
* CURRENT: The stack is currently up to date with the stack set.
*
*
*
*
* @param stackInstanceStatus
* The status of the stack instance, in terms of its synchronization with its associated stack set.
*
* -
*
* INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an
* unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You
* might need to perform a DeleteStackInstances operation, with RetainStacks set to
* true, to delete the stack instance, and then delete the stack manually.
*
*
* -
*
* OUTDATED: The stack isn't currently up to date with the stack set because either the
* associated stack failed during a CreateStackSet or UpdateStackSet operation, or
* the stack was part of a CreateStackSet or UpdateStackSet operation that failed
* or was stopped before the stack was created or updated.
*
*
* -
*
* CURRENT: The stack is currently up to date with the stack set.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see StackInstanceStatus
*/
public StackInstance withStackInstanceStatus(String stackInstanceStatus) {
setStackInstanceStatus(stackInstanceStatus);
return this;
}
/**
*
* The status of the stack instance, in terms of its synchronization with its associated stack set.
*
*
* -
*
* INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an
* unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might
* need to perform a DeleteStackInstances operation, with RetainStacks set to true, to
* delete the stack instance, and then delete the stack manually.
*
*
* -
*
* OUTDATED: The stack isn't currently up to date with the stack set because either the associated
* stack failed during a CreateStackSet or UpdateStackSet operation, or the stack was part
* of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the
* stack was created or updated.
*
*
* -
*
* CURRENT: The stack is currently up to date with the stack set.
*
*
*
*
* @param stackInstanceStatus
* The status of the stack instance, in terms of its synchronization with its associated stack set.
*
* -
*
* INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an
* unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You
* might need to perform a DeleteStackInstances operation, with RetainStacks set to
* true, to delete the stack instance, and then delete the stack manually.
*
*
* -
*
* OUTDATED: The stack isn't currently up to date with the stack set because either the
* associated stack failed during a CreateStackSet or UpdateStackSet operation, or
* the stack was part of a CreateStackSet or UpdateStackSet operation that failed
* or was stopped before the stack was created or updated.
*
*
* -
*
* CURRENT: The stack is currently up to date with the stack set.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see StackInstanceStatus
*/
public StackInstance withStackInstanceStatus(StackInstanceStatus stackInstanceStatus) {
this.stackInstanceStatus = stackInstanceStatus.toString();
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 (getAccount() != null)
sb.append("Account: ").append(getAccount()).append(",");
if (getRegion() != null)
sb.append("Region: ").append(getRegion()).append(",");
if (getStackInstanceStatus() != null)
sb.append("StackInstanceStatus: ").append(getStackInstanceStatus());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof StackInstance == false)
return false;
StackInstance other = (StackInstance) obj;
if (other.getAccount() == null ^ this.getAccount() == null)
return false;
if (other.getAccount() != null && other.getAccount().equals(this.getAccount()) == false)
return false;
if (other.getRegion() == null ^ this.getRegion() == null)
return false;
if (other.getRegion() != null && other.getRegion().equals(this.getRegion()) == false)
return false;
if (other.getStackInstanceStatus() == null ^ this.getStackInstanceStatus() == null)
return false;
if (other.getStackInstanceStatus() != null && other.getStackInstanceStatus().equals(this.getStackInstanceStatus()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAccount() == null) ? 0 : getAccount().hashCode());
hashCode = prime * hashCode + ((getRegion() == null) ? 0 : getRegion().hashCode());
hashCode = prime * hashCode + ((getStackInstanceStatus() == null) ? 0 : getStackInstanceStatus().hashCode());
return hashCode;
}
@Override
public StackInstance clone() {
try {
return (StackInstance) 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.servicecatalog.model.transform.StackInstanceMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}