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

Class RequiredActivatedType

java.lang.Object

software.amazon.awssdk.services.cloudformation.model.RequiredActivatedType

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RequiredActivatedType.Builder,RequiredActivatedType>

@Generated("software.amazon.awssdk:codegen")
public final class RequiredActivatedType
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RequiredActivatedType.Builder,RequiredActivatedType>

For extensions that are modules, a public third-party extension that must be activated in your account in order for the module itself to be activated.

For more information, see Activating public modules for use in your account in the CloudFormation User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RequiredActivatedType.Builder

Method Summary

Modifier and Type	Method	Description
static RequiredActivatedType.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSupportedMajorVersions()	For responses, this returns true if the service returned a value for the SupportedMajorVersions property.
String	originalTypeName()	The type name of the public extension.
String	publisherId()	The publisher ID of the extension publisher.
List<SdkField<?>>	sdkFields()
static Class<? extends RequiredActivatedType.Builder>	serializableBuilderClass()
List<Integer>	supportedMajorVersions()	A list of the major versions of the extension type that the macro supports.
RequiredActivatedType.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	typeNameAlias()	An alias assigned to the public extension, in this account and Region.

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

typeNameAlias

public final String typeNameAlias()

An alias assigned to the public extension, in this account and Region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.

Returns:

An alias assigned to the public extension, in this account and Region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.

originalTypeName

public final String originalTypeName()

The type name of the public extension.

If you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.

Returns:

The type name of the public extension.

If you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.

publisherId

public final String publisherId()

The publisher ID of the extension publisher.

Returns:

The publisher ID of the extension publisher.

hasSupportedMajorVersions

public final boolean hasSupportedMajorVersions()

For responses, this returns true if the service returned a value for the SupportedMajorVersions 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.

supportedMajorVersions

public final List<Integer> supportedMajorVersions()

A list of the major versions of the extension type that the macro supports.

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 hasSupportedMajorVersions() method.

Returns:

A list of the major versions of the extension type that the macro supports.

toBuilder

public RequiredActivatedType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RequiredActivatedType.Builder,RequiredActivatedType>

builder

public static RequiredActivatedType.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo