Package software.amazon.awscdk.cfnpropertymixins.services.applicationsignals

Class CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.applicationsignals.CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty>

Enclosing interface:

CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty

@Stability(Stable)
public static final class CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty>

A builder for CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty	build()	Builds the configured instance.
CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.Builder	dependencyConfig(CfnServiceLevelObjectivePropsMixin.DependencyConfigProperty dependencyConfig)	Sets the value of CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.getDependencyConfig()
CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.Builder	dependencyConfig(IResolvable dependencyConfig)	Sets the value of CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.getDependencyConfig()
CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.Builder	keyAttributes(Map<String,String> keyAttributes)	Sets the value of CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.getKeyAttributes()
CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.Builder	keyAttributes(IResolvable keyAttributes)	Sets the value of CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.getKeyAttributes()
CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.Builder	metricType(String metricType)	Sets the value of CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.getMetricType()
CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.Builder	monitoredRequestCountMetric(CfnServiceLevelObjectivePropsMixin.MonitoredRequestCountMetricProperty monitoredRequestCountMetric)	Sets the value of CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.getMonitoredRequestCountMetric()
CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.Builder	monitoredRequestCountMetric(IResolvable monitoredRequestCountMetric)	Sets the value of CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.getMonitoredRequestCountMetric()
CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.Builder	operationName(String operationName)	Sets the value of CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.getOperationName()
CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.Builder	totalRequestCountMetric(List<? extends Object> totalRequestCountMetric)	Sets the value of CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.getTotalRequestCountMetric()
CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.Builder	totalRequestCountMetric(IResolvable totalRequestCountMetric)	Sets the value of CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.getTotalRequestCountMetric()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

dependencyConfig

@Stability(Stable)
public CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.Builder dependencyConfig(IResolvable dependencyConfig)

Sets the value of CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.getDependencyConfig()

Parameters:

dependencyConfig - Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName .

Returns:

this

dependencyConfig

@Stability(Stable)
public CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.Builder dependencyConfig(CfnServiceLevelObjectivePropsMixin.DependencyConfigProperty dependencyConfig)

Sets the value of CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.getDependencyConfig()

Parameters:

dependencyConfig - Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName .

Returns:

this

keyAttributes

@Stability(Stable)
public CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.Builder keyAttributes(Map<String,String> keyAttributes)

Sets the value of CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.getKeyAttributes()

Parameters:

keyAttributes - This is a string-to-string map that contains information about the type of object that this SLO is related to. It can include the following fields.

• Type designates the type of object that this SLO is related to.
• ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource .
• Name specifies the name of the object. This is used only if the value of the Type field is Service , RemoteService , or AWS::Service .
• Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource .
• Environment specifies the location where this object is hosted, or what it belongs to.
• AwsAccountId allows you to create an SLO for an object that exists in another account.

Returns:

this

keyAttributes

@Stability(Stable)
public CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.Builder keyAttributes(IResolvable keyAttributes)

Sets the value of CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.getKeyAttributes()

Parameters:

keyAttributes - This is a string-to-string map that contains information about the type of object that this SLO is related to. It can include the following fields.

• Type designates the type of object that this SLO is related to.
• ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource .
• Name specifies the name of the object. This is used only if the value of the Type field is Service , RemoteService , or AWS::Service .
• Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource .
• Environment specifies the location where this object is hosted, or what it belongs to.
• AwsAccountId allows you to create an SLO for an object that exists in another account.

Returns:

this

metricType

@Stability(Stable)
public CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.Builder metricType(String metricType)

Sets the value of CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.getMetricType()

Parameters:

metricType - If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used.

Returns:

this

monitoredRequestCountMetric

@Stability(Stable)
public CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.Builder monitoredRequestCountMetric(IResolvable monitoredRequestCountMetric)

Sets the value of CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.getMonitoredRequestCountMetric()

Parameters:

monitoredRequestCountMetric - Use this structure to define the metric that you want to use as the "good request" or "bad request" value for a request-based SLO. This value observed for the metric defined in TotalRequestCountMetric will be divided by the number found for MonitoredRequestCountMetric to determine the percentage of successful requests that this SLO tracks.

Returns:

this

monitoredRequestCountMetric

@Stability(Stable)
public CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.Builder monitoredRequestCountMetric(CfnServiceLevelObjectivePropsMixin.MonitoredRequestCountMetricProperty monitoredRequestCountMetric)

Sets the value of CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.getMonitoredRequestCountMetric()

Parameters:

monitoredRequestCountMetric - Use this structure to define the metric that you want to use as the "good request" or "bad request" value for a request-based SLO. This value observed for the metric defined in TotalRequestCountMetric will be divided by the number found for MonitoredRequestCountMetric to determine the percentage of successful requests that this SLO tracks.

Returns:

this

operationName

@Stability(Stable)
public CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.Builder operationName(String operationName)

Sets the value of CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.getOperationName()

Parameters:

operationName - If the SLO monitors a specific operation of the service, this field displays that operation name.

Returns:

this

totalRequestCountMetric

@Stability(Stable)
public CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.Builder totalRequestCountMetric(IResolvable totalRequestCountMetric)

Sets the value of CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.getTotalRequestCountMetric()

Parameters:

totalRequestCountMetric - This structure defines the metric that is used as the "total requests" number for a request-based SLO. The number observed for this metric is divided by the number of "good requests" or "bad requests" that is observed for the metric defined in MonitoredRequestCountMetric .

Returns:

this

totalRequestCountMetric

@Stability(Stable)
public CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.Builder totalRequestCountMetric(List<? extends Object> totalRequestCountMetric)

Sets the value of CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty.getTotalRequestCountMetric()

Parameters:

totalRequestCountMetric - This structure defines the metric that is used as the "total requests" number for a request-based SLO. The number observed for this metric is divided by the number of "good requests" or "bad requests" that is observed for the metric defined in MonitoredRequestCountMetric .

Returns:

this

build

@Stability(Stable)
public CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty>

Returns:

a new instance of CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty

Throws:

NullPointerException - if any required attribute was not provided