software.amazon.awssdk.services.autoscaling.model

Interface PredefinedMetricSpecification.Builder

All Superinterfaces:

Buildable, CopyableBuilder<PredefinedMetricSpecification.Builder,PredefinedMetricSpecification>, SdkBuilder<PredefinedMetricSpecification.Builder,PredefinedMetricSpecification>, SdkPojo

Enclosing class:

PredefinedMetricSpecification

public static interface PredefinedMetricSpecification.Builder
extends SdkPojo, CopyableBuilder<PredefinedMetricSpecification.Builder,PredefinedMetricSpecification>

Method Summary

Modifier and Type	Method and Description
PredefinedMetricSpecification.Builder	predefinedMetricType(MetricType predefinedMetricType) The metric type.
PredefinedMetricSpecification.Builder	predefinedMetricType(String predefinedMetricType) The metric type.
PredefinedMetricSpecification.Builder	resourceLabel(String resourceLabel) Identifies the resource associated with the metric type.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

predefinedMetricType

PredefinedMetricSpecification.Builder predefinedMetricType(String predefinedMetricType)

The metric type. The following predefined metrics are available:

• ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.

• ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group.

• ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group.

• ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer target group.

Parameters:

predefinedMetricType - The metric type. The following predefined metrics are available:

• ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.

• ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group.

• ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group.

• ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer target group.

Returns:

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

See Also:

MetricType, MetricType

predefinedMetricType

PredefinedMetricSpecification.Builder predefinedMetricType(MetricType predefinedMetricType)

The metric type. The following predefined metrics are available:

• ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.

• ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group.

• ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group.

• ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer target group.

Parameters:

predefinedMetricType - The metric type. The following predefined metrics are available:

• ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.

• ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group.

• ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group.

• ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer target group.

Returns:

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

See Also:

MetricType, MetricType

resourceLabel

PredefinedMetricSpecification.Builder resourceLabel(String resourceLabel)

Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Auto Scaling group.

You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format is app/<load-balancer -name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:

• app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN

• targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

This is an example: app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

Parameters:

resourceLabel - Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Auto Scaling group.

You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format is app /<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target -group-id>, where:

• app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN

• targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

This is an example: app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

Returns:

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