Package software.amazon.awssdk.services.codedeploy.model

Class InstanceTarget

java.lang.Object

software.amazon.awssdk.services.codedeploy.model.InstanceTarget

All Implemented Interfaces:

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

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

A target Amazon EC2 or on-premises instance during a deployment that uses the EC2/On-premises compute platform.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InstanceTarget.Builder

Method Summary

Modifier and Type	Method	Description
static InstanceTarget.Builder	builder()
String	deploymentId()	The unique ID of a deployment.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLifecycleEvents()	For responses, this returns true if the service returned a value for the LifecycleEvents property.
TargetLabel	instanceLabel()	A label that identifies whether the instance is an original target (BLUE) or a replacement target ( GREEN).
String	instanceLabelAsString()	A label that identifies whether the instance is an original target (BLUE) or a replacement target ( GREEN).
Instant	lastUpdatedAt()	The date and time when the target instance was updated by a deployment.
List<LifecycleEvent>	lifecycleEvents()	The lifecycle events of the deployment to this target instance.
List<SdkField<?>>	sdkFields()
static Class<? extends InstanceTarget.Builder>	serializableBuilderClass()
TargetStatus	status()	The status an EC2/On-premises deployment's target instance.
String	statusAsString()	The status an EC2/On-premises deployment's target instance.
String	targetArn()	The Amazon Resource Name (ARN) of the target.
String	targetId()	The unique ID of a deployment target that has a type of instanceTarget.
InstanceTarget.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

deploymentId

public final String deploymentId()

The unique ID of a deployment.

Returns:

The unique ID of a deployment.

targetId

public final String targetId()

The unique ID of a deployment target that has a type of instanceTarget.

Returns:

The unique ID of a deployment target that has a type of instanceTarget.

targetArn

public final String targetArn()

The Amazon Resource Name (ARN) of the target.

Returns:

The Amazon Resource Name (ARN) of the target.

status

public final TargetStatus status()

The status an EC2/On-premises deployment's target instance.

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

Returns:

The status an EC2/On-premises deployment's target instance.

See Also:

TargetStatus

statusAsString

public final String statusAsString()

The status an EC2/On-premises deployment's target instance.

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

Returns:

The status an EC2/On-premises deployment's target instance.

See Also:

TargetStatus

lastUpdatedAt

public final Instant lastUpdatedAt()

The date and time when the target instance was updated by a deployment.

Returns:

The date and time when the target instance was updated by a deployment.

hasLifecycleEvents

public final boolean hasLifecycleEvents()

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

lifecycleEvents

public final List<LifecycleEvent> lifecycleEvents()

The lifecycle events of the deployment to this target instance.

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

Returns:

The lifecycle events of the deployment to this target instance.

instanceLabel

public final TargetLabel instanceLabel()

A label that identifies whether the instance is an original target (BLUE) or a replacement target ( GREEN).

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

Returns:

A label that identifies whether the instance is an original target (BLUE) or a replacement target (GREEN).

See Also:

TargetLabel

instanceLabelAsString

public final String instanceLabelAsString()

A label that identifies whether the instance is an original target (BLUE) or a replacement target ( GREEN).

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

Returns:

A label that identifies whether the instance is an original target (BLUE) or a replacement target (GREEN).

See Also:

TargetLabel

toBuilder

public InstanceTarget.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InstanceTarget.Builder,InstanceTarget>

builder

public static InstanceTarget.Builder builder()

serializableBuilderClass

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