Package software.amazon.awssdk.services.cloudformation.model

Class UpdateGeneratedTemplateRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest

software.amazon.awssdk.services.cloudformation.model.UpdateGeneratedTemplateRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateGeneratedTemplateRequest.Builder,UpdateGeneratedTemplateRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateGeneratedTemplateRequest
extends CloudFormationRequest
implements ToCopyableBuilder<UpdateGeneratedTemplateRequest.Builder,UpdateGeneratedTemplateRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateGeneratedTemplateRequest.Builder

Method Summary

Modifier and Type	Method	Description
List<ResourceDefinition>	addResources()	An optional list of resources to be added to the generated template.
static UpdateGeneratedTemplateRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	generatedTemplateName()	The name or Amazon Resource Name (ARN) of a generated template.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAddResources()	For responses, this returns true if the service returned a value for the AddResources property.
int	hashCode()
boolean	hasRemoveResources()	For responses, this returns true if the service returned a value for the RemoveResources property.
String	newGeneratedTemplateName()	An optional new name to assign to the generated template.
Boolean	refreshAllResources()	If true, update the resource properties in the generated template with their current live state.
List<String>	removeResources()	A list of logical ids for resources to remove from the generated template.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateGeneratedTemplateRequest.Builder>	serializableBuilderClass()
TemplateConfiguration	templateConfiguration()	The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.
UpdateGeneratedTemplateRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

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

copy

Method Detail

generatedTemplateName

public final String generatedTemplateName()

The name or Amazon Resource Name (ARN) of a generated template.

Returns:

The name or Amazon Resource Name (ARN) of a generated template.

newGeneratedTemplateName

public final String newGeneratedTemplateName()

An optional new name to assign to the generated template.

Returns:

An optional new name to assign to the generated template.

hasAddResources

public final boolean hasAddResources()

For responses, this returns true if the service returned a value for the AddResources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

addResources

public final List<ResourceDefinition> addResources()

An optional list of resources to be added to the generated template.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAddResources() method.

Returns:

An optional list of resources to be added to the generated template.

hasRemoveResources

public final boolean hasRemoveResources()

For responses, this returns true if the service returned a value for the RemoveResources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

removeResources

public final List<String> removeResources()

A list of logical ids for resources to remove from the generated template.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRemoveResources() method.

Returns:

A list of logical ids for resources to remove from the generated template.

refreshAllResources

public final Boolean refreshAllResources()

If true, update the resource properties in the generated template with their current live state. This feature is useful when the resource properties in your generated a template does not reflect the live state of the resource properties. This happens when a user update the resource properties after generating a template.

Returns:

If true, update the resource properties in the generated template with their current live state. This feature is useful when the resource properties in your generated a template does not reflect the live state of the resource properties. This happens when a user update the resource properties after generating a template.

templateConfiguration

public final TemplateConfiguration templateConfiguration()

The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.

Returns:

The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.

toBuilder

public UpdateGeneratedTemplateRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateGeneratedTemplateRequest.Builder,UpdateGeneratedTemplateRequest>

Specified by:

toBuilder in class CloudFormationRequest

builder

public static UpdateGeneratedTemplateRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo