com.amazonaws.services.cloudformation.model.CancelUpdateStackRequest 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;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* The input for the CancelUpdateStack action.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CancelUpdateStackRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
*
* If you don't pass a parameter to StackName, the API returns a response that describes all resources
* in the account.
*
*
* The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid
* returning a response when no parameter is sent in the request:
*
*
* { "Version": "2012-10-17", "Statement": [{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks", "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" }] }
*
*
*
* The name or the unique stack ID that's associated with the stack.
*
*/
private String stackName;
/**
*
* A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry
* requests so that CloudFormation knows that you're not attempting to cancel an update on a stack with the same
* name. You might retry CancelUpdateStack requests to ensure that CloudFormation successfully received
* them.
*
*/
private String clientRequestToken;
/**
*
*
* If you don't pass a parameter to StackName, the API returns a response that describes all resources
* in the account.
*
*
* The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid
* returning a response when no parameter is sent in the request:
*
*
* { "Version": "2012-10-17", "Statement": [{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks", "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" }] }
*
*
*
* The name or the unique stack ID that's associated with the stack.
*
*
* @param stackName
*
* If you don't pass a parameter to StackName, the API returns a response that describes all
* resources in the account.
*
*
* The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and
* avoid returning a response when no parameter is sent in the request:
*
*
* { "Version": "2012-10-17", "Statement": [{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks", "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" }] }
*
*
*
* The name or the unique stack ID that's associated with the stack.
*/
public void setStackName(String stackName) {
this.stackName = stackName;
}
/**
*
*
* If you don't pass a parameter to StackName, the API returns a response that describes all resources
* in the account.
*
*
* The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid
* returning a response when no parameter is sent in the request:
*
*
* { "Version": "2012-10-17", "Statement": [{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks", "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" }] }
*
*
*
* The name or the unique stack ID that's associated with the stack.
*
*
* @return
* If you don't pass a parameter to StackName, the API returns a response that describes all
* resources in the account.
*
*
* The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and
* avoid returning a response when no parameter is sent in the request:
*
*
* { "Version": "2012-10-17", "Statement": [{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks", "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" }] }
*
*
*
* The name or the unique stack ID that's associated with the stack.
*/
public String getStackName() {
return this.stackName;
}
/**
*
*
* If you don't pass a parameter to StackName, the API returns a response that describes all resources
* in the account.
*
*
* The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid
* returning a response when no parameter is sent in the request:
*
*
* { "Version": "2012-10-17", "Statement": [{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks", "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" }] }
*
*
*
* The name or the unique stack ID that's associated with the stack.
*
*
* @param stackName
*
* If you don't pass a parameter to StackName, the API returns a response that describes all
* resources in the account.
*
*
* The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and
* avoid returning a response when no parameter is sent in the request:
*
*
* { "Version": "2012-10-17", "Statement": [{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks", "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" }] }
*
*
*
* The name or the unique stack ID that's associated with the stack.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CancelUpdateStackRequest withStackName(String stackName) {
setStackName(stackName);
return this;
}
/**
*
* A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry
* requests so that CloudFormation knows that you're not attempting to cancel an update on a stack with the same
* name. You might retry CancelUpdateStack requests to ensure that CloudFormation successfully received
* them.
*
*
* @param clientRequestToken
* A unique identifier for this CancelUpdateStack request. Specify this token if you plan to
* retry requests so that CloudFormation knows that you're not attempting to cancel an update on a stack with
* the same name. You might retry CancelUpdateStack requests to ensure that CloudFormation
* successfully received them.
*/
public void setClientRequestToken(String clientRequestToken) {
this.clientRequestToken = clientRequestToken;
}
/**
*
* A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry
* requests so that CloudFormation knows that you're not attempting to cancel an update on a stack with the same
* name. You might retry CancelUpdateStack requests to ensure that CloudFormation successfully received
* them.
*
*
* @return A unique identifier for this CancelUpdateStack request. Specify this token if you plan to
* retry requests so that CloudFormation knows that you're not attempting to cancel an update on a stack
* with the same name. You might retry CancelUpdateStack requests to ensure that CloudFormation
* successfully received them.
*/
public String getClientRequestToken() {
return this.clientRequestToken;
}
/**
*
* A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry
* requests so that CloudFormation knows that you're not attempting to cancel an update on a stack with the same
* name. You might retry CancelUpdateStack requests to ensure that CloudFormation successfully received
* them.
*
*
* @param clientRequestToken
* A unique identifier for this CancelUpdateStack request. Specify this token if you plan to
* retry requests so that CloudFormation knows that you're not attempting to cancel an update on a stack with
* the same name. You might retry CancelUpdateStack requests to ensure that CloudFormation
* successfully received them.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CancelUpdateStackRequest withClientRequestToken(String clientRequestToken) {
setClientRequestToken(clientRequestToken);
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 (getStackName() != null)
sb.append("StackName: ").append(getStackName()).append(",");
if (getClientRequestToken() != null)
sb.append("ClientRequestToken: ").append(getClientRequestToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CancelUpdateStackRequest == false)
return false;
CancelUpdateStackRequest other = (CancelUpdateStackRequest) obj;
if (other.getStackName() == null ^ this.getStackName() == null)
return false;
if (other.getStackName() != null && other.getStackName().equals(this.getStackName()) == false)
return false;
if (other.getClientRequestToken() == null ^ this.getClientRequestToken() == null)
return false;
if (other.getClientRequestToken() != null && other.getClientRequestToken().equals(this.getClientRequestToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getStackName() == null) ? 0 : getStackName().hashCode());
hashCode = prime * hashCode + ((getClientRequestToken() == null) ? 0 : getClientRequestToken().hashCode());
return hashCode;
}
@Override
public CancelUpdateStackRequest clone() {
return (CancelUpdateStackRequest) super.clone();
}
}