software.amazon.awssdk.services.ssm.model

Class Activation

java.lang.Object

software.amazon.awssdk.services.ssm.model.Activation

All Implemented Interfaces:

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

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

An activation registers one or more on-premises servers or virtual machines (VMs) with Amazon Web Services so that you can configure those servers or VMs using Run Command. A server or VM that has been registered with Amazon Web Services Systems Manager is called a managed node.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Activation.Builder

Method Summary

Modifier and Type	Method and Description
String	activationId() The ID created by Systems Manager when you submitted the activation.
static Activation.Builder	builder()
Instant	createdDate() The date the activation was created.
String	defaultInstanceName() A name for the managed node when it is created.
String	description() A user defined description of the activation.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Instant	expirationDate() The date when this activation can no longer be used to register managed nodes.
Boolean	expired() Whether or not the activation is expired.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	iamRole() The Identity and Access Management (IAM) role to assign to the managed node.
Integer	registrationLimit() The maximum number of managed nodes that can be registered using this activation.
Integer	registrationsCount() The number of managed nodes already registered with this activation.
List<SdkField<?>>	sdkFields()
static Class<? extends Activation.Builder>	serializableBuilderClass()
List<Tag>	tags() Tags assigned to the activation.
Activation.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

activationId

public final String activationId()

The ID created by Systems Manager when you submitted the activation.

Returns:

The ID created by Systems Manager when you submitted the activation.

description

public final String description()

A user defined description of the activation.

Returns:

A user defined description of the activation.

defaultInstanceName

public final String defaultInstanceName()

A name for the managed node when it is created.

Returns:

A name for the managed node when it is created.

iamRole

public final String iamRole()

The Identity and Access Management (IAM) role to assign to the managed node.

Returns:

The Identity and Access Management (IAM) role to assign to the managed node.

registrationLimit

public final Integer registrationLimit()

The maximum number of managed nodes that can be registered using this activation.

Returns:

The maximum number of managed nodes that can be registered using this activation.

registrationsCount

public final Integer registrationsCount()

The number of managed nodes already registered with this activation.

Returns:

The number of managed nodes already registered with this activation.

expirationDate

public final Instant expirationDate()

The date when this activation can no longer be used to register managed nodes.

Returns:

The date when this activation can no longer be used to register managed nodes.

expired

public final Boolean expired()

Whether or not the activation is expired.

Returns:

Whether or not the activation is expired.

createdDate

public final Instant createdDate()

The date the activation was created.

Returns:

The date the activation was created.

hasTags

public final boolean hasTags()

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

tags

public final List<Tag> tags()

Tags assigned to the activation.

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

Returns:

Tags assigned to the activation.

toBuilder

public Activation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Activation.Builder,Activation>

builder

public static Activation.Builder builder()

serializableBuilderClass

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