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

Interface ECSServiceRecommendation.Builder

    • Method Detail

      • serviceArn

        ECSServiceRecommendation.Builder serviceArn​(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

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • accountId

        ECSServiceRecommendation.Builder accountId​(String accountId)

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

        Parameters:
        accountId - The Amazon Web Services account ID of the Amazon ECS service.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • currentServiceConfiguration

        ECSServiceRecommendation.Builder currentServiceConfiguration​(ServiceConfiguration currentServiceConfiguration)

        The configuration of the current Amazon ECS service.

        Parameters:
        currentServiceConfiguration - The configuration of the current Amazon ECS service.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • utilizationMetrics

        ECSServiceRecommendation.Builder utilizationMetrics​(Collection<ECSServiceUtilizationMetric> utilizationMetrics)

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

        Parameters:
        utilizationMetrics - An array of objects that describe the utilization metrics of the Amazon ECS service.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • utilizationMetrics

        ECSServiceRecommendation.Builder utilizationMetrics​(ECSServiceUtilizationMetric... utilizationMetrics)

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

        Parameters:
        utilizationMetrics - An array of objects that describe the utilization metrics of the Amazon ECS service.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lookbackPeriodInDays

        ECSServiceRecommendation.Builder lookbackPeriodInDays​(Double lookbackPeriodInDays)

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

        Parameters:
        lookbackPeriodInDays - The number of days the Amazon ECS service utilization metrics were analyzed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • launchType

        ECSServiceRecommendation.Builder launchType​(String launchType)

        The launch type the Amazon ECS service is using.

        Compute Optimizer only supports the Fargate launch type.

        Parameters:
        launchType - The launch type the Amazon ECS service is using.

        Compute Optimizer only supports the Fargate launch type.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ECSServiceLaunchType, ECSServiceLaunchType

      • launchType

        ECSServiceRecommendation.Builder launchType​(ECSServiceLaunchType launchType)

        The launch type the Amazon ECS service is using.

        Compute Optimizer only supports the Fargate launch type.

        Parameters:
        launchType - The launch type the Amazon ECS service is using.

        Compute Optimizer only supports the Fargate launch type.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ECSServiceLaunchType, ECSServiceLaunchType

      • lastRefreshTimestamp

        ECSServiceRecommendation.Builder lastRefreshTimestamp​(Instant lastRefreshTimestamp)

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

        Parameters:
        lastRefreshTimestamp - The timestamp of when the Amazon ECS service recommendation was last generated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • finding

        ECSServiceRecommendation.Builder finding​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ECSServiceRecommendationFinding, ECSServiceRecommendationFinding

      • finding

        ECSServiceRecommendation.Builder finding​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ECSServiceRecommendationFinding, ECSServiceRecommendationFinding

      • findingReasonCodesWithStrings

        ECSServiceRecommendation.Builder findingReasonCodesWithStrings​(Collection<String> 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • findingReasonCodesWithStrings

        ECSServiceRecommendation.Builder findingReasonCodesWithStrings​(String... 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • findingReasonCodes

        ECSServiceRecommendation.Builder findingReasonCodes​(Collection<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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • findingReasonCodes

        ECSServiceRecommendation.Builder findingReasonCodes​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serviceRecommendationOptions

        ECSServiceRecommendation.Builder serviceRecommendationOptions​(Collection<ECSServiceRecommendationOption> serviceRecommendationOptions)

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

        Parameters:
        serviceRecommendationOptions - An array of objects that describe the recommendation options for the Amazon ECS service.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serviceRecommendationOptions

        ECSServiceRecommendation.Builder serviceRecommendationOptions​(ECSServiceRecommendationOption... serviceRecommendationOptions)

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

        Parameters:
        serviceRecommendationOptions - An array of objects that describe the recommendation options for the Amazon ECS service.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • currentPerformanceRisk

        ECSServiceRecommendation.Builder currentPerformanceRisk​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        CurrentPerformanceRisk, CurrentPerformanceRisk

      • currentPerformanceRisk

        ECSServiceRecommendation.Builder currentPerformanceRisk​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        CurrentPerformanceRisk, CurrentPerformanceRisk

      • tags

        ECSServiceRecommendation.Builder tags​(Collection<Tag> tags)

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

        Parameters:
        tags - A list of tags assigned to your Amazon ECS service recommendations.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        ECSServiceRecommendation.Builder tags​(Tag... tags)

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

        Parameters:
        tags - A list of tags assigned to your Amazon ECS service recommendations.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        ECSServiceRecommendation.Builder tags​(Consumer<Tag.Builder>... tags)

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

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • effectiveRecommendationPreferences

        ECSServiceRecommendation.Builder effectiveRecommendationPreferences​(ECSEffectiveRecommendationPreferences effectiveRecommendationPreferences)

        Describes the effective recommendation preferences for Amazon ECS services.

        Parameters:
        effectiveRecommendationPreferences - Describes the effective recommendation preferences for Amazon ECS services.
        Returns:
        Returns a reference to this object so that method calls can be chained together.