Package com.amazonaws.services.cloudformation.model

Class GetTemplateSummaryResult

java.lang.Object

com.amazonaws.services.cloudformation.model.GetTemplateSummaryResult

All Implemented Interfaces:

Serializable, Cloneable

public class GetTemplateSummaryResult
extends Object
implements Serializable, Cloneable

The output for the GetTemplateSummary action.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
GetTemplateSummaryResult()

Method Summary

Modifier and Type	Method	Description
GetTemplateSummaryResult	clone()
boolean	equals(Object obj)
List<String>	getCapabilities()	The capabilities found within the template.
String	getCapabilitiesReason()	The list of resources that generated the values in the Capabilities response element.
String	getDescription()	The value that is defined in the Description property of the template.
String	getMetadata()	The value that is defined for the Metadata property of the template.
List<ParameterDeclaration>	getParameters()	A list of parameter declarations that describe various properties for each parameter.
List<String>	getResourceTypes()	A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.
String	getVersion()	The AWS template format version, which identifies the capabilities of the template.
int	hashCode()
void	setCapabilities(Collection<String> capabilities)	The capabilities found within the template.
void	setCapabilitiesReason(String capabilitiesReason)	The list of resources that generated the values in the Capabilities response element.
void	setDescription(String description)	The value that is defined in the Description property of the template.
void	setMetadata(String metadata)	The value that is defined for the Metadata property of the template.
void	setParameters(Collection<ParameterDeclaration> parameters)	A list of parameter declarations that describe various properties for each parameter.
void	setResourceTypes(Collection<String> resourceTypes)	A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.
void	setVersion(String version)	The AWS template format version, which identifies the capabilities of the template.
String	toString()	Returns a string representation of this object; useful for testing and debugging.
GetTemplateSummaryResult	withCapabilities(Capability... capabilities)	The capabilities found within the template.
GetTemplateSummaryResult	withCapabilities(String... capabilities)	The capabilities found within the template.
GetTemplateSummaryResult	withCapabilities(Collection<String> capabilities)	The capabilities found within the template.
GetTemplateSummaryResult	withCapabilitiesReason(String capabilitiesReason)	The list of resources that generated the values in the Capabilities response element.
GetTemplateSummaryResult	withDescription(String description)	The value that is defined in the Description property of the template.
GetTemplateSummaryResult	withMetadata(String metadata)	The value that is defined for the Metadata property of the template.
GetTemplateSummaryResult	withParameters(ParameterDeclaration... parameters)	A list of parameter declarations that describe various properties for each parameter.
GetTemplateSummaryResult	withParameters(Collection<ParameterDeclaration> parameters)	A list of parameter declarations that describe various properties for each parameter.
GetTemplateSummaryResult	withResourceTypes(String... resourceTypes)	A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.
GetTemplateSummaryResult	withResourceTypes(Collection<String> resourceTypes)	A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.
GetTemplateSummaryResult	withVersion(String version)	The AWS template format version, which identifies the capabilities of the template.

Methods inherited from class java.lang.Object

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

Constructor Detail

GetTemplateSummaryResult

public GetTemplateSummaryResult()

Method Detail

getParameters

public List<ParameterDeclaration> getParameters()

A list of parameter declarations that describe various properties for each parameter.

Returns:

A list of parameter declarations that describe various properties for each parameter.

setParameters

public void setParameters(Collection<ParameterDeclaration> parameters)

A list of parameter declarations that describe various properties for each parameter.

Parameters:

parameters - A list of parameter declarations that describe various properties for each parameter.

withParameters

public GetTemplateSummaryResult withParameters(ParameterDeclaration... parameters)

A list of parameter declarations that describe various properties for each parameter.

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.

Parameters:

parameters - A list of parameter declarations that describe various properties for each parameter.

Returns:

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

withParameters

public GetTemplateSummaryResult withParameters(Collection<ParameterDeclaration> parameters)

A list of parameter declarations that describe various properties for each parameter.

Parameters:

parameters - A list of parameter declarations that describe various properties for each parameter.

Returns:

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

setDescription

public void setDescription(String description)

The value that is defined in the Description property of the template.

Parameters:

description - The value that is defined in the Description property of the template.

getDescription

public String getDescription()

The value that is defined in the Description property of the template.

Returns:

The value that is defined in the Description property of the template.

withDescription

public GetTemplateSummaryResult withDescription(String description)

The value that is defined in the Description property of the template.

Parameters:

description - The value that is defined in the Description property of the template.

Returns:

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

getCapabilities

public List<String> getCapabilities()

The capabilities found within the template. Currently, AWS CloudFormation supports only the CAPABILITY_IAM capability. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

Returns:

The capabilities found within the template. Currently, AWS CloudFormation supports only the CAPABILITY_IAM capability. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

See Also:

Capability

setCapabilities

public void setCapabilities(Collection<String> capabilities)

The capabilities found within the template. Currently, AWS CloudFormation supports only the CAPABILITY_IAM capability. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

Parameters:

capabilities - The capabilities found within the template. Currently, AWS CloudFormation supports only the CAPABILITY_IAM capability. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

See Also:

Capability

withCapabilities

public GetTemplateSummaryResult withCapabilities(String... capabilities)

The capabilities found within the template. Currently, AWS CloudFormation supports only the CAPABILITY_IAM capability. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

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

Parameters:

capabilities - The capabilities found within the template. Currently, AWS CloudFormation supports only the CAPABILITY_IAM capability. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

Returns:

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

See Also:

Capability

withCapabilities

public GetTemplateSummaryResult withCapabilities(Collection<String> capabilities)

The capabilities found within the template. Currently, AWS CloudFormation supports only the CAPABILITY_IAM capability. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

Parameters:

capabilities - The capabilities found within the template. Currently, AWS CloudFormation supports only the CAPABILITY_IAM capability. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

Returns:

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

See Also:

Capability

withCapabilities

public GetTemplateSummaryResult withCapabilities(Capability... capabilities)

The capabilities found within the template. Currently, AWS CloudFormation supports only the CAPABILITY_IAM capability. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

Parameters:

capabilities - The capabilities found within the template. Currently, AWS CloudFormation supports only the CAPABILITY_IAM capability. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

Returns:

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

See Also:

Capability

setCapabilitiesReason

public void setCapabilitiesReason(String capabilitiesReason)

The list of resources that generated the values in the Capabilities response element.

Parameters:

capabilitiesReason - The list of resources that generated the values in the Capabilities response element.

getCapabilitiesReason

public String getCapabilitiesReason()

The list of resources that generated the values in the Capabilities response element.

Returns:

The list of resources that generated the values in the Capabilities response element.

withCapabilitiesReason

public GetTemplateSummaryResult withCapabilitiesReason(String capabilitiesReason)

The list of resources that generated the values in the Capabilities response element.

Parameters:

capabilitiesReason - The list of resources that generated the values in the Capabilities response element.

Returns:

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

getResourceTypes

public List<String> getResourceTypes()

A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.

Returns:

A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.

setResourceTypes

public void setResourceTypes(Collection<String> resourceTypes)

A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.

Parameters:

resourceTypes - A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.

withResourceTypes

public GetTemplateSummaryResult withResourceTypes(String... resourceTypes)

A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.

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

Parameters:

resourceTypes - A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.

Returns:

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

withResourceTypes

public GetTemplateSummaryResult withResourceTypes(Collection<String> resourceTypes)

A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.

Parameters:

resourceTypes - A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.

Returns:

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

setVersion

public void setVersion(String version)

The AWS template format version, which identifies the capabilities of the template.

Parameters:

version - The AWS template format version, which identifies the capabilities of the template.

getVersion

public String getVersion()

The AWS template format version, which identifies the capabilities of the template.

Returns:

The AWS template format version, which identifies the capabilities of the template.

withVersion

public GetTemplateSummaryResult withVersion(String version)

The AWS template format version, which identifies the capabilities of the template.

Parameters:

version - The AWS template format version, which identifies the capabilities of the template.

Returns:

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

setMetadata

public void setMetadata(String metadata)

The value that is defined for the Metadata property of the template.

Parameters:

metadata - The value that is defined for the Metadata property of the template.

getMetadata

public String getMetadata()

The value that is defined for the Metadata property of the template.

Returns:

The value that is defined for the Metadata property of the template.

withMetadata

public GetTemplateSummaryResult withMetadata(String metadata)

The value that is defined for the Metadata property of the template.

Parameters:

metadata - The value that is defined for the Metadata property of the template.

Returns:

Returns a reference to this 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()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetTemplateSummaryResult clone()

Overrides:

clone in class Object