software.amazon.awssdk.services.computeoptimizer.model

Class ServiceConfiguration

java.lang.Object

software.amazon.awssdk.services.computeoptimizer.model.ServiceConfiguration

All Implemented Interfaces:

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

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

The Amazon ECS service configurations used for recommendations.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ServiceConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
AutoScalingConfiguration	autoScalingConfiguration() Describes the Auto Scaling configuration methods for an Amazon ECS service.
String	autoScalingConfigurationAsString() Describes the Auto Scaling configuration methods for an Amazon ECS service.
static ServiceConfiguration.Builder	builder()
List<ContainerConfiguration>	containerConfigurations() The container configurations within a task of an Amazon ECS service.
Integer	cpu() The number of CPU units used by the tasks in the Amazon ECS service.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasContainerConfigurations() For responses, this returns true if the service returned a value for the ContainerConfigurations property.
int	hashCode()
Integer	memory() The amount of memory used by the tasks in the Amazon ECS service.
List<SdkField<?>>	sdkFields()
static Class<? extends ServiceConfiguration.Builder>	serializableBuilderClass()
String	taskDefinitionArn() The task definition ARN used by the tasks in the Amazon ECS service.
ServiceConfiguration.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

memory

public final Integer memory()

The amount of memory used by the tasks in the Amazon ECS service.

Returns:

The amount of memory used by the tasks in the Amazon ECS service.

cpu

public final Integer cpu()

The number of CPU units used by the tasks in the Amazon ECS service.

Returns:

The number of CPU units used by the tasks in the Amazon ECS service.

hasContainerConfigurations

public final boolean hasContainerConfigurations()

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

containerConfigurations

public final List<ContainerConfiguration> containerConfigurations()

The container configurations within a task of an Amazon ECS service.

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

Returns:

The container configurations within a task of an Amazon ECS service.

autoScalingConfiguration

public final AutoScalingConfiguration autoScalingConfiguration()

Describes the Auto Scaling configuration methods for an Amazon ECS service. This affects the generated recommendations. For example, if Auto Scaling is configured on a service’s CPU, then Compute Optimizer doesn’t generate CPU size recommendations.

The Auto Scaling configuration methods include:

• TARGET_TRACKING_SCALING_CPU — If the Amazon ECS service is configured to use target scaling on CPU, Compute Optimizer doesn't generate CPU recommendations.

• TARGET_TRACKING_SCALING_MEMORY — If the Amazon ECS service is configured to use target scaling on memory, Compute Optimizer doesn't generate memory recommendations.

For more information about step scaling and target scaling, see Step scaling policies for Application Auto Scaling and Target tracking scaling policies for Application Auto Scaling in the Application Auto Scaling User Guide.

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

Returns:

Describes the Auto Scaling configuration methods for an Amazon ECS service. This affects the generated recommendations. For example, if Auto Scaling is configured on a service’s CPU, then Compute Optimizer doesn’t generate CPU size recommendations.

The Auto Scaling configuration methods include:

• TARGET_TRACKING_SCALING_CPU — If the Amazon ECS service is configured to use target scaling on CPU, Compute Optimizer doesn't generate CPU recommendations.

• TARGET_TRACKING_SCALING_MEMORY — If the Amazon ECS service is configured to use target scaling on memory, Compute Optimizer doesn't generate memory recommendations.

For more information about step scaling and target scaling, see Step scaling policies for Application Auto Scaling and Target tracking scaling policies for Application Auto Scaling in the Application Auto Scaling User Guide.

See Also:

AutoScalingConfiguration

autoScalingConfigurationAsString

public final String autoScalingConfigurationAsString()

Describes the Auto Scaling configuration methods for an Amazon ECS service. This affects the generated recommendations. For example, if Auto Scaling is configured on a service’s CPU, then Compute Optimizer doesn’t generate CPU size recommendations.

The Auto Scaling configuration methods include:

• TARGET_TRACKING_SCALING_CPU — If the Amazon ECS service is configured to use target scaling on CPU, Compute Optimizer doesn't generate CPU recommendations.

• TARGET_TRACKING_SCALING_MEMORY — If the Amazon ECS service is configured to use target scaling on memory, Compute Optimizer doesn't generate memory recommendations.

For more information about step scaling and target scaling, see Step scaling policies for Application Auto Scaling and Target tracking scaling policies for Application Auto Scaling in the Application Auto Scaling User Guide.

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

Returns:

Describes the Auto Scaling configuration methods for an Amazon ECS service. This affects the generated recommendations. For example, if Auto Scaling is configured on a service’s CPU, then Compute Optimizer doesn’t generate CPU size recommendations.

The Auto Scaling configuration methods include:

• TARGET_TRACKING_SCALING_CPU — If the Amazon ECS service is configured to use target scaling on CPU, Compute Optimizer doesn't generate CPU recommendations.

• TARGET_TRACKING_SCALING_MEMORY — If the Amazon ECS service is configured to use target scaling on memory, Compute Optimizer doesn't generate memory recommendations.

For more information about step scaling and target scaling, see Step scaling policies for Application Auto Scaling and Target tracking scaling policies for Application Auto Scaling in the Application Auto Scaling User Guide.

See Also:

AutoScalingConfiguration

taskDefinitionArn

public final String taskDefinitionArn()

The task definition ARN used by the tasks in the Amazon ECS service.

Returns:

The task definition ARN used by the tasks in the Amazon ECS service.

toBuilder

public ServiceConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ServiceConfiguration.Builder,ServiceConfiguration>

builder

public static ServiceConfiguration.Builder builder()

serializableBuilderClass

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