com.amazonaws.services.cloudformation.model.DescribeStackResourcesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudformation Show documentation
/*
* Copyright 2010-2015 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 com.amazonaws.AmazonWebServiceRequest;
/**
*
* The input for DescribeStackResources action.
*
*/
public class DescribeStackResourcesRequest extends AmazonWebServiceRequest
implements Serializable, Cloneable {
/**
*
* The name or the unique stack ID that is associated with the stack, which
* are not always interchangeable:
*
*
* - Running stacks: You can specify either the stack's name or its unique
* stack ID.
* - Deleted stacks: You must specify the unique stack ID.
*
*
* Default: There is no default value.
*
*
* Required: Conditional. If you do not specify StackName, you
* must specify PhysicalResourceId.
*
*/
private String stackName;
/**
*
* The logical name of the resource as specified in the template.
*
*
* Default: There is no default value.
*
*/
private String logicalResourceId;
/**
*
* The name or unique identifier that corresponds to a physical instance ID
* of a resource supported by AWS CloudFormation.
*
*
* For example, for an Amazon Elastic Compute Cloud (EC2) instance,
* PhysicalResourceId corresponds to the
* InstanceId. You can pass the EC2 InstanceId to
* DescribeStackResources to find which stack the instance
* belongs to and what other resources are part of the stack.
*
*
* Required: Conditional. If you do not specify
* PhysicalResourceId, you must specify StackName.
*
*
* Default: There is no default value.
*
*/
private String physicalResourceId;
/**
*
* The name or the unique stack ID that is associated with the stack, which
* are not always interchangeable:
*
*
* - Running stacks: You can specify either the stack's name or its unique
* stack ID.
* - Deleted stacks: You must specify the unique stack ID.
*
*
* Default: There is no default value.
*
*
* Required: Conditional. If you do not specify StackName, you
* must specify PhysicalResourceId.
*
*
* @param stackName
* The name or the unique stack ID that is associated with the stack,
* which are not always interchangeable:
*
* - Running stacks: You can specify either the stack's name or its
* unique stack ID.
* - Deleted stacks: You must specify the unique stack ID.
*
*
* Default: There is no default value.
*
*
* Required: Conditional. If you do not specify
* StackName, you must specify
* PhysicalResourceId.
*/
public void setStackName(String stackName) {
this.stackName = stackName;
}
/**
*
* The name or the unique stack ID that is associated with the stack, which
* are not always interchangeable:
*
*
* - Running stacks: You can specify either the stack's name or its unique
* stack ID.
* - Deleted stacks: You must specify the unique stack ID.
*
*
* Default: There is no default value.
*
*
* Required: Conditional. If you do not specify StackName, you
* must specify PhysicalResourceId.
*
*
* @return The name or the unique stack ID that is associated with the
* stack, which are not always interchangeable:
*
* - Running stacks: You can specify either the stack's name or
* its unique stack ID.
* - Deleted stacks: You must specify the unique stack ID.
*
*
* Default: There is no default value.
*
*
* Required: Conditional. If you do not specify
* StackName, you must specify
* PhysicalResourceId.
*/
public String getStackName() {
return this.stackName;
}
/**
*
* The name or the unique stack ID that is associated with the stack, which
* are not always interchangeable:
*
*
* - Running stacks: You can specify either the stack's name or its unique
* stack ID.
* - Deleted stacks: You must specify the unique stack ID.
*
*
* Default: There is no default value.
*
*
* Required: Conditional. If you do not specify StackName, you
* must specify PhysicalResourceId.
*
*
* @param stackName
* The name or the unique stack ID that is associated with the stack,
* which are not always interchangeable:
*
* - Running stacks: You can specify either the stack's name or its
* unique stack ID.
* - Deleted stacks: You must specify the unique stack ID.
*
*
* Default: There is no default value.
*
*
* Required: Conditional. If you do not specify
* StackName, you must specify
* PhysicalResourceId.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeStackResourcesRequest withStackName(String stackName) {
setStackName(stackName);
return this;
}
/**
*
* The logical name of the resource as specified in the template.
*
*
* Default: There is no default value.
*
*
* @param logicalResourceId
* The logical name of the resource as specified in the template.
*
* Default: There is no default value.
*/
public void setLogicalResourceId(String logicalResourceId) {
this.logicalResourceId = logicalResourceId;
}
/**
*
* The logical name of the resource as specified in the template.
*
*
* Default: There is no default value.
*
*
* @return The logical name of the resource as specified in the
* template.
*
* Default: There is no default value.
*/
public String getLogicalResourceId() {
return this.logicalResourceId;
}
/**
*
* The logical name of the resource as specified in the template.
*
*
* Default: There is no default value.
*
*
* @param logicalResourceId
* The logical name of the resource as specified in the template.
*
* Default: There is no default value.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeStackResourcesRequest withLogicalResourceId(
String logicalResourceId) {
setLogicalResourceId(logicalResourceId);
return this;
}
/**
*
* The name or unique identifier that corresponds to a physical instance ID
* of a resource supported by AWS CloudFormation.
*
*
* For example, for an Amazon Elastic Compute Cloud (EC2) instance,
* PhysicalResourceId corresponds to the
* InstanceId. You can pass the EC2 InstanceId to
* DescribeStackResources to find which stack the instance
* belongs to and what other resources are part of the stack.
*
*
* Required: Conditional. If you do not specify
* PhysicalResourceId, you must specify StackName.
*
*
* Default: There is no default value.
*
*
* @param physicalResourceId
* The name or unique identifier that corresponds to a physical
* instance ID of a resource supported by AWS CloudFormation.
*
* For example, for an Amazon Elastic Compute Cloud (EC2) instance,
* PhysicalResourceId corresponds to the
* InstanceId. You can pass the EC2
* InstanceId to DescribeStackResources to
* find which stack the instance belongs to and what other resources
* are part of the stack.
*
*
* Required: Conditional. If you do not specify
* PhysicalResourceId, you must specify
* StackName.
*
*
* Default: There is no default value.
*/
public void setPhysicalResourceId(String physicalResourceId) {
this.physicalResourceId = physicalResourceId;
}
/**
*
* The name or unique identifier that corresponds to a physical instance ID
* of a resource supported by AWS CloudFormation.
*
*
* For example, for an Amazon Elastic Compute Cloud (EC2) instance,
* PhysicalResourceId corresponds to the
* InstanceId. You can pass the EC2 InstanceId to
* DescribeStackResources to find which stack the instance
* belongs to and what other resources are part of the stack.
*
*
* Required: Conditional. If you do not specify
* PhysicalResourceId, you must specify StackName.
*
*
* Default: There is no default value.
*
*
* @return The name or unique identifier that corresponds to a physical
* instance ID of a resource supported by AWS CloudFormation.
*
* For example, for an Amazon Elastic Compute Cloud (EC2) instance,
* PhysicalResourceId corresponds to the
* InstanceId. You can pass the EC2
* InstanceId to DescribeStackResources to
* find which stack the instance belongs to and what other resources
* are part of the stack.
*
*
* Required: Conditional. If you do not specify
* PhysicalResourceId, you must specify
* StackName.
*
*
* Default: There is no default value.
*/
public String getPhysicalResourceId() {
return this.physicalResourceId;
}
/**
*
* The name or unique identifier that corresponds to a physical instance ID
* of a resource supported by AWS CloudFormation.
*
*
* For example, for an Amazon Elastic Compute Cloud (EC2) instance,
* PhysicalResourceId corresponds to the
* InstanceId. You can pass the EC2 InstanceId to
* DescribeStackResources to find which stack the instance
* belongs to and what other resources are part of the stack.
*
*
* Required: Conditional. If you do not specify
* PhysicalResourceId, you must specify StackName.
*
*
* Default: There is no default value.
*
*
* @param physicalResourceId
* The name or unique identifier that corresponds to a physical
* instance ID of a resource supported by AWS CloudFormation.
*
* For example, for an Amazon Elastic Compute Cloud (EC2) instance,
* PhysicalResourceId corresponds to the
* InstanceId. You can pass the EC2
* InstanceId to DescribeStackResources to
* find which stack the instance belongs to and what other resources
* are part of the stack.
*
*
* Required: Conditional. If you do not specify
* PhysicalResourceId, you must specify
* StackName.
*
*
* Default: There is no default value.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeStackResourcesRequest withPhysicalResourceId(
String physicalResourceId) {
setPhysicalResourceId(physicalResourceId);
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @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: " + getStackName() + ",");
if (getLogicalResourceId() != null)
sb.append("LogicalResourceId: " + getLogicalResourceId() + ",");
if (getPhysicalResourceId() != null)
sb.append("PhysicalResourceId: " + getPhysicalResourceId());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeStackResourcesRequest == false)
return false;
DescribeStackResourcesRequest other = (DescribeStackResourcesRequest) obj;
if (other.getStackName() == null ^ this.getStackName() == null)
return false;
if (other.getStackName() != null
&& other.getStackName().equals(this.getStackName()) == false)
return false;
if (other.getLogicalResourceId() == null
^ this.getLogicalResourceId() == null)
return false;
if (other.getLogicalResourceId() != null
&& other.getLogicalResourceId().equals(
this.getLogicalResourceId()) == false)
return false;
if (other.getPhysicalResourceId() == null
^ this.getPhysicalResourceId() == null)
return false;
if (other.getPhysicalResourceId() != null
&& other.getPhysicalResourceId().equals(
this.getPhysicalResourceId()) == 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
+ ((getLogicalResourceId() == null) ? 0
: getLogicalResourceId().hashCode());
hashCode = prime
* hashCode
+ ((getPhysicalResourceId() == null) ? 0
: getPhysicalResourceId().hashCode());
return hashCode;
}
@Override
public DescribeStackResourcesRequest clone() {
return (DescribeStackResourcesRequest) super.clone();
}
}