com.amazonaws.services.cloudformation.model

Class EstimateTemplateCostRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudformation.model.EstimateTemplateCostRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class EstimateTemplateCostRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the EstimateTemplateCost operation.

Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.

See Also:

AmazonCloudFormation.estimateTemplateCost(EstimateTemplateCostRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
EstimateTemplateCostRequest()

Method Summary

Methods

Modifier and Type	Method and Description
EstimateTemplateCostRequest	clone()
boolean	equals(Object obj)
List<Parameter>	getParameters() A list of Parameter structures that specify input parameters.
String	getTemplateBody() Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
String	getTemplateURL() Location of file containing the template body.
int	hashCode()
void	setParameters(Collection<Parameter> parameters) A list of Parameter structures that specify input parameters.
void	setTemplateBody(String templateBody) Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
void	setTemplateURL(String templateURL) Location of file containing the template body.
String	toString() Returns a string representation of this object; useful for testing and debugging.
EstimateTemplateCostRequest	withParameters(Collection<Parameter> parameters) A list of Parameter structures that specify input parameters.
EstimateTemplateCostRequest	withParameters(Parameter... parameters) A list of Parameter structures that specify input parameters.
EstimateTemplateCostRequest	withTemplateBody(String templateBody) Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
EstimateTemplateCostRequest	withTemplateURL(String templateURL) Location of file containing the template body.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EstimateTemplateCostRequest

public EstimateTemplateCostRequest()

Method Detail

getTemplateBody

public String getTemplateBody()

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.

Constraints:
Length: 1 -

Returns:

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.

setTemplateBody

public void setTemplateBody(String templateBody)

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.

Constraints:
Length: 1 -

Parameters:

templateBody - Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.

withTemplateBody

public EstimateTemplateCostRequest withTemplateBody(String templateBody)

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 -

Parameters:

templateBody - Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.

Returns:

A reference to this updated object so that method calls can be chained together.

getTemplateURL

public String getTemplateURL()

Location of file containing the template body. The URL must point to a template located in an S3 bucket in the same region as the stack. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

Constraints:
Length: 1 - 1024

Returns:

Location of file containing the template body. The URL must point to a template located in an S3 bucket in the same region as the stack. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

setTemplateURL

public void setTemplateURL(String templateURL)

Location of file containing the template body. The URL must point to a template located in an S3 bucket in the same region as the stack. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

Constraints:
Length: 1 - 1024

Parameters:

templateURL - Location of file containing the template body. The URL must point to a template located in an S3 bucket in the same region as the stack. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

withTemplateURL

public EstimateTemplateCostRequest withTemplateURL(String templateURL)

Location of file containing the template body. The URL must point to a template located in an S3 bucket in the same region as the stack. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 1024

Parameters:

templateURL - Location of file containing the template body. The URL must point to a template located in an S3 bucket in the same region as the stack. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

Returns:

A reference to this updated object so that method calls can be chained together.

getParameters

public List<Parameter> getParameters()

A list of Parameter structures that specify input parameters.

Returns:

A list of Parameter structures that specify input parameters.

setParameters

public void setParameters(Collection<Parameter> parameters)

A list of Parameter structures that specify input parameters.

Parameters:

parameters - A list of Parameter structures that specify input parameters.

withParameters

public EstimateTemplateCostRequest withParameters(Parameter... parameters)

A list of Parameter structures that specify input parameters.

NOTE: This method appends the values to the existing list (if any). Use setParameters(java.util.Collection) or withParameters(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

parameters - A list of Parameter structures that specify input parameters.

Returns:

A reference to this updated object so that method calls can be chained together.

withParameters

public EstimateTemplateCostRequest withParameters(Collection<Parameter> parameters)

A list of Parameter structures that specify input parameters.

Returns a reference to this object so that method calls can be chained together.

Parameters:

parameters - A list of Parameter structures that specify input parameters.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public EstimateTemplateCostRequest clone()

Overrides:

clone in class AmazonWebServiceRequest