software.amazon.awssdk.services.cloudformation.model

Class GetTemplateSummaryResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.cloudformation.model.CloudFormationResponse

software.amazon.awssdk.services.cloudformation.model.GetTemplateSummaryResponse

All Implemented Interfaces:

ToCopyableBuilder<GetTemplateSummaryResponse.Builder,GetTemplateSummaryResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetTemplateSummaryResponse
extends CloudFormationResponse
implements ToCopyableBuilder<GetTemplateSummaryResponse.Builder,GetTemplateSummaryResponse>

The output for the GetTemplateSummary action.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetTemplateSummaryResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetTemplateSummaryResponse.Builder	builder()
List<Capability>	capabilities() The capabilities found within the template.
List<String>	capabilitiesAsStrings() The capabilities found within the template.
String	capabilitiesReason() The list of resources that generated the values in the Capabilities response element.
List<String>	declaredTransforms() A list of the transforms that are declared in the template.
String	description() The value that is defined in the Description property of the template.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
String	metadata() The value that is defined for the Metadata property of the template.
List<ParameterDeclaration>	parameters() A list of parameter declarations that describe various properties for each parameter.
List<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.
static Class<? extends GetTemplateSummaryResponse.Builder>	serializableBuilderClass()
GetTemplateSummaryResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	version() The AWS template format version, which identifies the capabilities of the template.

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

parameters

public List<ParameterDeclaration> parameters()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

description

public String description()

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.

capabilities

public List<Capability> capabilities()

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

For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

capabilitiesAsStrings

public List<String> capabilitiesAsStrings()

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

For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

capabilitiesReason

public String capabilitiesReason()

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.

resourceTypes

public List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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.

version

public String version()

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.

metadata

public String metadata()

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.

declaredTransforms

public List<String> declaredTransforms()

A list of the transforms that are declared in the template.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A list of the transforms that are declared in the template.

toBuilder

public GetTemplateSummaryResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetTemplateSummaryResponse.Builder,GetTemplateSummaryResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static GetTemplateSummaryResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetTemplateSummaryResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value