Class GetTemplateSummaryResult
- All Implemented Interfaces:
Serializable
,Cloneable
The output for the GetTemplateSummary action.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The capabilities found within the template.The list of resources that generated the values in theCapabilities
response element.The value that is defined in theDescription
property of the template.The value that is defined for theMetadata
property of the template.A list of parameter declarations that describe various properties for each parameter.A list of all the template resource types that are defined in the template, such asAWS::EC2::Instance
,AWS::Dynamo::Table
, andCustom::MyCustomInstance
.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 theCapabilities
response element.void
setDescription
(String description) The value that is defined in theDescription
property of the template.void
setMetadata
(String metadata) The value that is defined for theMetadata
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 asAWS::EC2::Instance
,AWS::Dynamo::Table
, andCustom::MyCustomInstance
.void
setVersion
(String version) The AWS template format version, which identifies the capabilities of the template.toString()
Returns a string representation of this object; useful for testing and debugging.withCapabilities
(Capability... capabilities) The capabilities found within the template.withCapabilities
(String... capabilities) The capabilities found within the template.withCapabilities
(Collection<String> capabilities) The capabilities found within the template.withCapabilitiesReason
(String capabilitiesReason) The list of resources that generated the values in theCapabilities
response element.withDescription
(String description) The value that is defined in theDescription
property of the template.withMetadata
(String metadata) The value that is defined for theMetadata
property of the template.withParameters
(ParameterDeclaration... parameters) A list of parameter declarations that describe various properties for each parameter.withParameters
(Collection<ParameterDeclaration> parameters) A list of parameter declarations that describe various properties for each parameter.withResourceTypes
(String... resourceTypes) A list of all the template resource types that are defined in the template, such asAWS::EC2::Instance
,AWS::Dynamo::Table
, andCustom::MyCustomInstance
.withResourceTypes
(Collection<String> resourceTypes) A list of all the template resource types that are defined in the template, such asAWS::EC2::Instance
,AWS::Dynamo::Table
, andCustom::MyCustomInstance
.withVersion
(String version) The AWS template format version, which identifies the capabilities of the template.
-
Constructor Details
-
GetTemplateSummaryResult
public GetTemplateSummaryResult()
-
-
Method Details
-
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
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
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)
orwithParameters(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
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
The value that is defined in the
Description
property of the template.- Parameters:
description
- The value that is defined in theDescription
property of the template.
-
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
The value that is defined in the
Description
property of the template.- Parameters:
description
- The value that is defined in theDescription
property of the template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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:
-
setCapabilities
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:
-
withCapabilities
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)
orwithCapabilities(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:
-
withCapabilities
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:
-
withCapabilities
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:
-
setCapabilitiesReason
The list of resources that generated the values in the
Capabilities
response element.- Parameters:
capabilitiesReason
- The list of resources that generated the values in theCapabilities
response element.
-
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
The list of resources that generated the values in the
Capabilities
response element.- Parameters:
capabilitiesReason
- The list of resources that generated the values in theCapabilities
response element.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getResourceTypes
A list of all the template resource types that are defined in the template, such as
AWS::EC2::Instance
,AWS::Dynamo::Table
, andCustom::MyCustomInstance
.- Returns:
- A list of all the template resource types that are defined in the
template, such as
AWS::EC2::Instance
,AWS::Dynamo::Table
, andCustom::MyCustomInstance
.
-
setResourceTypes
A list of all the template resource types that are defined in the template, such as
AWS::EC2::Instance
,AWS::Dynamo::Table
, andCustom::MyCustomInstance
.- Parameters:
resourceTypes
- A list of all the template resource types that are defined in the template, such asAWS::EC2::Instance
,AWS::Dynamo::Table
, andCustom::MyCustomInstance
.
-
withResourceTypes
A list of all the template resource types that are defined in the template, such as
AWS::EC2::Instance
,AWS::Dynamo::Table
, andCustom::MyCustomInstance
.NOTE: This method appends the values to the existing list (if any). Use
setResourceTypes(java.util.Collection)
orwithResourceTypes(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 asAWS::EC2::Instance
,AWS::Dynamo::Table
, andCustom::MyCustomInstance
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withResourceTypes
A list of all the template resource types that are defined in the template, such as
AWS::EC2::Instance
,AWS::Dynamo::Table
, andCustom::MyCustomInstance
.- Parameters:
resourceTypes
- A list of all the template resource types that are defined in the template, such asAWS::EC2::Instance
,AWS::Dynamo::Table
, andCustom::MyCustomInstance
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setVersion
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
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
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
The value that is defined for the
Metadata
property of the template.- Parameters:
metadata
- The value that is defined for theMetadata
property of the template.
-
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
The value that is defined for the
Metadata
property of the template.- Parameters:
metadata
- The value that is defined for theMetadata
property of the template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-