software.amazon.awssdk.services.cloudformation.model

Class TypeSummary

java.lang.Object

software.amazon.awssdk.services.cloudformation.model.TypeSummary

All Implemented Interfaces:

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

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

Contains summary information about the specified CloudFormation extension.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TypeSummary.Builder

Method Summary

Modifier and Type	Method and Description
static TypeSummary.Builder	builder()
String	defaultVersionId() The ID of the default version of the extension.
String	description() The description of the extension.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	isActivated() Whether or not the extension is activated for this account and region.
Instant	lastUpdated() When the specified extension version was registered.
String	latestPublicVersion() For public extensions that have been activated for this account and region, the latest version of the public extension that is available.
String	originalTypeName() For public extensions that have been activated for this account and region, the type name of the public extension.
String	publicVersionNumber() For public extensions that have been activated for this account and region, the version of the public extension to be used for CloudFormation operations in this account and region.
String	publisherId() The ID of the extension publisher, if the extension is published by a third party.
IdentityProvider	publisherIdentity() The service used to verify the publisher identity.
String	publisherIdentityAsString() The service used to verify the publisher identity.
String	publisherName() The publisher name, as defined in the public profile for that publisher in the service used to verify the publisher identity.
List<SdkField<?>>	sdkFields()
static Class<? extends TypeSummary.Builder>	serializableBuilderClass()
TypeSummary.Builder	toBuilder()
String	toString() Returns a string representation of this object.
RegistryType	type() The kind of extension.
String	typeArn() The Amazon Resource Name (ARN) of the extension.
String	typeAsString() The kind of extension.
String	typeName() The name of the extension.

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

type

public final RegistryType type()

The kind of extension.

If the service returns an enum value that is not available in the current SDK version, type will return RegistryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The kind of extension.

See Also:

RegistryType

typeAsString

public final String typeAsString()

The kind of extension.

If the service returns an enum value that is not available in the current SDK version, type will return RegistryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The kind of extension.

See Also:

RegistryType

typeName

public final String typeName()

The name of the extension.

If you specified a TypeNameAlias when you activate this extension in your account and region, CloudFormation considers that alias as the type name.

Returns:

The name of the extension.

If you specified a TypeNameAlias when you activate this extension in your account and region, CloudFormation considers that alias as the type name.

defaultVersionId

public final String defaultVersionId()

The ID of the default version of the extension. The default version is used when the extension version is not specified.

This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon and published by third parties, CloudFormation returns null. For more information, see RegisterType.

To set the default version of an extension, use SetTypeDefaultVersion .

Returns:

The ID of the default version of the extension. The default version is used when the extension version is not specified.

This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon and published by third parties, CloudFormation returns null. For more information, see RegisterType.

To set the default version of an extension, use SetTypeDefaultVersion .

typeArn

public final String typeArn()

The Amazon Resource Name (ARN) of the extension.

Returns:

The Amazon Resource Name (ARN) of the extension.

lastUpdated

public final Instant lastUpdated()

When the specified extension version was registered. This applies only to:

• Private extensions you have registered in your account. For more information, see RegisterType.

• Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType.

For all other extension types, CloudFormation returns null.

Returns:

When the specified extension version was registered. This applies only to:

• Private extensions you have registered in your account. For more information, see RegisterType.

• Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType.

For all other extension types, CloudFormation returns null.

description

public final String description()

The description of the extension.

Returns:

The description of the extension.

publisherId

public final String publisherId()

The ID of the extension publisher, if the extension is published by a third party. Extensions published by Amazon do not return a publisher ID.

Returns:

The ID of the extension publisher, if the extension is published by a third party. Extensions published by Amazon do not return a publisher ID.

originalTypeName

public final String originalTypeName()

For public extensions that have been activated for this account and region, 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:

For public extensions that have been activated for this account and region, 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.

publicVersionNumber

public final String publicVersionNumber()

For public extensions that have been activated for this account and region, the version of the public extension to be used for CloudFormation operations in this account and region.

How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extention in this account and region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.

Returns:

For public extensions that have been activated for this account and region, the version of the public extension to be used for CloudFormation operations in this account and region.

How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extention in this account and region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.

latestPublicVersion

public final String latestPublicVersion()

For public extensions that have been activated for this account and region, the latest version of the public extension that is available. For any extensions other than activated third-arty extensions, CloudFormation returns null.

How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extention in this account and region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.

Returns:

For public extensions that have been activated for this account and region, the latest version of the public extension that is available. For any extensions other than activated third-arty extensions, CloudFormation returns null.

How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extention in this account and region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.

publisherIdentity

public final IdentityProvider publisherIdentity()

The service used to verify the publisher identity.

For more information, see Registering your account to publish CloudFormation extensions in the CFN-CLI User Guide for Extension Development.

If the service returns an enum value that is not available in the current SDK version, publisherIdentity will return IdentityProvider.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from publisherIdentityAsString().

Returns:

The service used to verify the publisher identity.

For more information, see Registering your account to publish CloudFormation extensions in the CFN-CLI User Guide for Extension Development.

See Also:

IdentityProvider

publisherIdentityAsString

public final String publisherIdentityAsString()

The service used to verify the publisher identity.

For more information, see Registering your account to publish CloudFormation extensions in the CFN-CLI User Guide for Extension Development.

If the service returns an enum value that is not available in the current SDK version, publisherIdentity will return IdentityProvider.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from publisherIdentityAsString().

Returns:

The service used to verify the publisher identity.

For more information, see Registering your account to publish CloudFormation extensions in the CFN-CLI User Guide for Extension Development.

See Also:

IdentityProvider

publisherName

public final String publisherName()

The publisher name, as defined in the public profile for that publisher in the service used to verify the publisher identity.

Returns:

The publisher name, as defined in the public profile for that publisher in the service used to verify the publisher identity.

isActivated

public final Boolean isActivated()

Whether or not the extension is activated for this account and region.

This applies only to third-party public extensions. Extensions published by Amazon are activated by default.

Returns:

Whether or not the extension is activated for this account and region.

This applies only to third-party public extensions. Extensions published by Amazon are activated by default.

toBuilder

public TypeSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TypeSummary.Builder,TypeSummary>

builder

public static TypeSummary.Builder builder()

serializableBuilderClass

public static Class<? extends TypeSummary.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