Package software.amazon.awssdk.services.computeoptimizer.model

Class ECSServiceRecommendation

    • Method Detail

      • serviceArn

        public final String serviceArn()

        The Amazon Resource Name (ARN) of the current Amazon ECS service.

        The following is the format of the ARN:

        arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name

        Returns:
        The Amazon Resource Name (ARN) of the current Amazon ECS service.

        The following is the format of the ARN:

        arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name

      • accountId

        public final String accountId()

        The Amazon Web Services account ID of the Amazon ECS service.

        Returns:
        The Amazon Web Services account ID of the Amazon ECS service.

      • currentServiceConfiguration

        public final ServiceConfiguration currentServiceConfiguration()

        The configuration of the current Amazon ECS service.

        Returns:
        The configuration of the current Amazon ECS service.

      • hasUtilizationMetrics

        public final boolean hasUtilizationMetrics()
        For responses, this returns true if the service returned a value for the UtilizationMetrics 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.

      • utilizationMetrics

        public final List<ECSServiceUtilizationMetric> utilizationMetrics()

        An array of objects that describe the utilization metrics of the 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 hasUtilizationMetrics() method.

        Returns:
        An array of objects that describe the utilization metrics of the Amazon ECS service.

      • lookbackPeriodInDays

        public final Double lookbackPeriodInDays()

        The number of days the Amazon ECS service utilization metrics were analyzed.

        Returns:
        The number of days the Amazon ECS service utilization metrics were analyzed.

      • launchTypeAsString

        public final String launchTypeAsString()

        The launch type the Amazon ECS service is using.

        Compute Optimizer only supports the Fargate launch type.

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

        Returns:
        The launch type the Amazon ECS service is using.

        Compute Optimizer only supports the Fargate launch type.

        See Also:
        ECSServiceLaunchType

      • lastRefreshTimestamp

        public final Instant lastRefreshTimestamp()

        The timestamp of when the Amazon ECS service recommendation was last generated.

        Returns:
        The timestamp of when the Amazon ECS service recommendation was last generated.

      • finding

        public final ECSServiceRecommendationFinding finding()

        The finding classification of an Amazon ECS service.

        Findings for Amazon ECS services include:

        • Underprovisioned — When Compute Optimizer detects that there’s not enough memory or CPU, an Amazon ECS service is considered under-provisioned. An under-provisioned service might result in poor application performance.

        • Overprovisioned — When Compute Optimizer detects that there’s excessive memory or CPU, an Amazon ECS service is considered over-provisioned. An over-provisioned service might result in additional infrastructure costs.

        • Optimized — When both the CPU and memory of your Amazon ECS service meet the performance requirements of your workload, the service is considered optimized.

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

        Returns:
        The finding classification of an Amazon ECS service.

        Findings for Amazon ECS services include:

        • Underprovisioned — When Compute Optimizer detects that there’s not enough memory or CPU, an Amazon ECS service is considered under-provisioned. An under-provisioned service might result in poor application performance.

        • Overprovisioned — When Compute Optimizer detects that there’s excessive memory or CPU, an Amazon ECS service is considered over-provisioned. An over-provisioned service might result in additional infrastructure costs.

        • Optimized — When both the CPU and memory of your Amazon ECS service meet the performance requirements of your workload, the service is considered optimized.

        See Also:
        ECSServiceRecommendationFinding

      • findingAsString

        public final String findingAsString()

        The finding classification of an Amazon ECS service.

        Findings for Amazon ECS services include:

        • Underprovisioned — When Compute Optimizer detects that there’s not enough memory or CPU, an Amazon ECS service is considered under-provisioned. An under-provisioned service might result in poor application performance.

        • Overprovisioned — When Compute Optimizer detects that there’s excessive memory or CPU, an Amazon ECS service is considered over-provisioned. An over-provisioned service might result in additional infrastructure costs.

        • Optimized — When both the CPU and memory of your Amazon ECS service meet the performance requirements of your workload, the service is considered optimized.

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

        Returns:
        The finding classification of an Amazon ECS service.

        Findings for Amazon ECS services include:

        • Underprovisioned — When Compute Optimizer detects that there’s not enough memory or CPU, an Amazon ECS service is considered under-provisioned. An under-provisioned service might result in poor application performance.

        • Overprovisioned — When Compute Optimizer detects that there’s excessive memory or CPU, an Amazon ECS service is considered over-provisioned. An over-provisioned service might result in additional infrastructure costs.

        • Optimized — When both the CPU and memory of your Amazon ECS service meet the performance requirements of your workload, the service is considered optimized.

        See Also:
        ECSServiceRecommendationFinding

      • findingReasonCodes

        public final List<ECSServiceRecommendationFindingReasonCode> findingReasonCodes()

        The reason for the finding classification of an Amazon ECS service.

        Finding reason codes for Amazon ECS services include:

        • CPUUnderprovisioned — The service CPU configuration can be sized up to enhance the performance of your workload. This is identified by analyzing the CPUUtilization metric of the current service during the look-back period.

        • CPUOverprovisioned — The service CPU configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the CPUUtilization metric of the current service during the look-back period.

        • MemoryUnderprovisioned — The service memory configuration can be sized up to enhance the performance of your workload. This is identified by analyzing the MemoryUtilization metric of the current service during the look-back period.

        • MemoryOverprovisioned — The service memory configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the MemoryUtilization metric of the current service during the look-back period.

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

        Returns:
        The reason for the finding classification of an Amazon ECS service.

        Finding reason codes for Amazon ECS services include:

        • CPUUnderprovisioned — The service CPU configuration can be sized up to enhance the performance of your workload. This is identified by analyzing the CPUUtilization metric of the current service during the look-back period.

        • CPUOverprovisioned — The service CPU configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the CPUUtilization metric of the current service during the look-back period.

        • MemoryUnderprovisioned — The service memory configuration can be sized up to enhance the performance of your workload. This is identified by analyzing the MemoryUtilization metric of the current service during the look-back period.

        • MemoryOverprovisioned — The service memory configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the MemoryUtilization metric of the current service during the look-back period.

      • hasFindingReasonCodes

        public final boolean hasFindingReasonCodes()
        For responses, this returns true if the service returned a value for the FindingReasonCodes 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.

      • findingReasonCodesAsStrings

        public final List<String> findingReasonCodesAsStrings()

        The reason for the finding classification of an Amazon ECS service.

        Finding reason codes for Amazon ECS services include:

        • CPUUnderprovisioned — The service CPU configuration can be sized up to enhance the performance of your workload. This is identified by analyzing the CPUUtilization metric of the current service during the look-back period.

        • CPUOverprovisioned — The service CPU configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the CPUUtilization metric of the current service during the look-back period.

        • MemoryUnderprovisioned — The service memory configuration can be sized up to enhance the performance of your workload. This is identified by analyzing the MemoryUtilization metric of the current service during the look-back period.

        • MemoryOverprovisioned — The service memory configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the MemoryUtilization metric of the current service during the look-back period.

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

        Returns:
        The reason for the finding classification of an Amazon ECS service.

        Finding reason codes for Amazon ECS services include:

        • CPUUnderprovisioned — The service CPU configuration can be sized up to enhance the performance of your workload. This is identified by analyzing the CPUUtilization metric of the current service during the look-back period.

        • CPUOverprovisioned — The service CPU configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the CPUUtilization metric of the current service during the look-back period.

        • MemoryUnderprovisioned — The service memory configuration can be sized up to enhance the performance of your workload. This is identified by analyzing the MemoryUtilization metric of the current service during the look-back period.

        • MemoryOverprovisioned — The service memory configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the MemoryUtilization metric of the current service during the look-back period.

      • hasServiceRecommendationOptions

        public final boolean hasServiceRecommendationOptions()
        For responses, this returns true if the service returned a value for the ServiceRecommendationOptions 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.

      • serviceRecommendationOptions

        public final List<ECSServiceRecommendationOption> serviceRecommendationOptions()

        An array of objects that describe the recommendation options for the 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 hasServiceRecommendationOptions() method.

        Returns:
        An array of objects that describe the recommendation options for the Amazon ECS service.

      • currentPerformanceRisk

        public final CurrentPerformanceRisk currentPerformanceRisk()

        The risk of the current Amazon ECS service not meeting the performance needs of its workloads. The higher the risk, the more likely the current service can't meet the performance requirements of its workload.

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

        Returns:
        The risk of the current Amazon ECS service not meeting the performance needs of its workloads. The higher the risk, the more likely the current service can't meet the performance requirements of its workload.
        See Also:
        CurrentPerformanceRisk

      • currentPerformanceRiskAsString

        public final String currentPerformanceRiskAsString()

        The risk of the current Amazon ECS service not meeting the performance needs of its workloads. The higher the risk, the more likely the current service can't meet the performance requirements of its workload.

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

        Returns:
        The risk of the current Amazon ECS service not meeting the performance needs of its workloads. The higher the risk, the more likely the current service can't meet the performance requirements of its workload.
        See Also:
        CurrentPerformanceRisk

      • 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()

        A list of tags assigned to your Amazon ECS service recommendations.

        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:
        A list of tags assigned to your Amazon ECS service recommendations.

      • effectiveRecommendationPreferences

        public final ECSEffectiveRecommendationPreferences effectiveRecommendationPreferences()

        Describes the effective recommendation preferences for Amazon ECS services.

        Returns:
        Describes the effective recommendation preferences for Amazon ECS services.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • 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)