CfnServiceLevelObjectivePropsMixin

class aws_cdk.mixins_preview.aws_applicationsignals.mixins.CfnServiceLevelObjectivePropsMixin(props, *, strategy=None)

Bases: Mixin

Creates or updates a service level objective (SLO), which can help you ensure that your critical business operations are meeting customer expectations.

Use SLOs to set and track specific target levels for the reliability and availability of your applications and services. SLOs use service level indicators (SLIs) to calculate whether the application is performing at the level that you want.

Create an SLO to set a target for a service operation, or service dependency’s availability or latency. CloudWatch measures this target frequently you can find whether it has been breached.

The target performance quality that is defined for an SLO is the attainment goal . An attainment goal is the percentage of time or requests that the SLI is expected to meet the threshold over each time interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.

When you create an SLO, you specify whether it is a period-based SLO or a request-based SLO . Each type of SLO has a different way of evaluating your application’s performance against its attainment goal.

A period-based SLO uses defined periods of time within a specified total time interval. For each period of time, Application Signals determines whether the application met its goal. The attainment rate is calculated as the number of good periods/number of total periods .

For example, for a period-based SLO, meeting an attainment goal of 99.9% means that within your interval, your application must meet its performance goal during at least 99.9% of the time periods.

A request-based SLO doesn’t use pre-defined periods of time. Instead, the SLO measures number of good requests/number of total requests during the interval. At any time, you can find the ratio of good requests to total requests for the interval up to the time stamp that you specify, and measure that ratio against the goal set in your SLO.

After you have created an SLO, you can retrieve error budget reports for it. An error budget is the amount of time or amount of requests that your application can be non-compliant with the SLO’s goal, and still have your application meet the goal.

For a period-based SLO, the error budget starts at a number defined by the highest number of periods that can fail to meet the threshold, while still meeting the overall goal. The remaining error budget decreases with every failed period that is recorded. The error budget within one interval can never increase.

For example, an SLO with a threshold that 99.95% of requests must be completed under 2000ms every month translates to an error budget of 21.9 minutes of downtime per month.

For a request-based SLO, the remaining error budget is dynamic and can increase or decrease, depending on the ratio of good requests to total requests.

When you call this operation, Application Signals creates the AWSServiceRoleForCloudWatchApplicationSignals service-linked role, if it doesn’t already exist in your account. This service- linked role has the following permissions:

xray:GetServiceGraph
logs:StartQuery
logs:GetQueryResults
cloudwatch:GetMetricData
cloudwatch:ListMetrics
tag:GetResources
autoscaling:DescribeAutoScalingGroups

You can easily set SLO targets for your applications, and their dependencies, that are discovered by Application Signals, using critical metrics such as latency and availability. You can also set SLOs against any CloudWatch metric or math expression that produces a time series. .. epigraph:

You can't create an SLO for a service operation that was discovered by Application Signals until after that operation has reported standard metrics to Application Signals.

You cannot change from a period-based SLO to a request-based SLO, or change from a request-based SLO to a period-based SLO.

For more information about SLOs, see Service level objectives (SLOs) .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationsignals-servicelevelobjective.html
CloudformationResource:: AWS::ApplicationSignals::ServiceLevelObjective
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_applicationsignals import mixins as applicationsignals_mixins

cfn_service_level_objective_props_mixin = applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin(applicationsignals_mixins.CfnServiceLevelObjectiveMixinProps(
    burn_rate_configurations=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.BurnRateConfigurationProperty(
        look_back_window_minutes=123
    )],
    description="description",
    exclusion_windows=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.ExclusionWindowProperty(
        reason="reason",
        recurrence_rule=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.RecurrenceRuleProperty(
            expression="expression"
        ),
        start_time="startTime",
        window=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.WindowProperty(
            duration=123,
            duration_unit="durationUnit"
        )
    )],
    goal=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.GoalProperty(
        attainment_goal=123,
        interval=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.IntervalProperty(
            calendar_interval=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.CalendarIntervalProperty(
                duration=123,
                duration_unit="durationUnit",
                start_time=123
            ),
            rolling_interval=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.RollingIntervalProperty(
                duration=123,
                duration_unit="durationUnit"
            )
        ),
        warning_threshold=123
    ),
    name="name",
    request_based_sli=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.RequestBasedSliProperty(
        comparison_operator="comparisonOperator",
        metric_threshold=123,
        request_based_sli_metric=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty(
            dependency_config=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.DependencyConfigProperty(
                dependency_key_attributes={
                    "dependency_key_attributes_key": "dependencyKeyAttributes"
                },
                dependency_operation_name="dependencyOperationName"
            ),
            key_attributes={
                "key_attributes_key": "keyAttributes"
            },
            metric_type="metricType",
            monitored_request_count_metric=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MonitoredRequestCountMetricProperty(
                bad_count_metric=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricDataQueryProperty(
                    account_id="accountId",
                    expression="expression",
                    id="id",
                    metric_stat=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricStatProperty(
                        metric=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricProperty(
                            dimensions=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.DimensionProperty(
                                name="name",
                                value="value"
                            )],
                            metric_name="metricName",
                            namespace="namespace"
                        ),
                        period=123,
                        stat="stat",
                        unit="unit"
                    ),
                    return_data=False
                )],
                good_count_metric=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricDataQueryProperty(
                    account_id="accountId",
                    expression="expression",
                    id="id",
                    metric_stat=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricStatProperty(
                        metric=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricProperty(
                            dimensions=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.DimensionProperty(
                                name="name",
                                value="value"
                            )],
                            metric_name="metricName",
                            namespace="namespace"
                        ),
                        period=123,
                        stat="stat",
                        unit="unit"
                    ),
                    return_data=False
                )]
            ),
            operation_name="operationName",
            total_request_count_metric=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricDataQueryProperty(
                account_id="accountId",
                expression="expression",
                id="id",
                metric_stat=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricStatProperty(
                    metric=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricProperty(
                        dimensions=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.DimensionProperty(
                            name="name",
                            value="value"
                        )],
                        metric_name="metricName",
                        namespace="namespace"
                    ),
                    period=123,
                    stat="stat",
                    unit="unit"
                ),
                return_data=False
            )]
        )
    ),
    sli=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.SliProperty(
        comparison_operator="comparisonOperator",
        metric_threshold=123,
        sli_metric=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.SliMetricProperty(
            dependency_config=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.DependencyConfigProperty(
                dependency_key_attributes={
                    "dependency_key_attributes_key": "dependencyKeyAttributes"
                },
                dependency_operation_name="dependencyOperationName"
            ),
            key_attributes={
                "key_attributes_key": "keyAttributes"
            },
            metric_data_queries=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricDataQueryProperty(
                account_id="accountId",
                expression="expression",
                id="id",
                metric_stat=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricStatProperty(
                    metric=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricProperty(
                        dimensions=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.DimensionProperty(
                            name="name",
                            value="value"
                        )],
                        metric_name="metricName",
                        namespace="namespace"
                    ),
                    period=123,
                    stat="stat",
                    unit="unit"
                ),
                return_data=False
            )],
            metric_type="metricType",
            operation_name="operationName",
            period_seconds=123,
            statistic="statistic"
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::ApplicationSignals::ServiceLevelObjective.

Parameters:

props (Union[CfnServiceLevelObjectiveMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['burnRateConfigurations', 'description', 'exclusionWindows', 'goal', 'name', 'requestBasedSli', 'sli', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

BurnRateConfigurationProperty

class CfnServiceLevelObjectivePropsMixin.BurnRateConfigurationProperty(*, look_back_window_minutes=None)

Bases: object

This object defines the length of the look-back window used to calculate one burn rate metric for this SLO.

The burn rate measures how fast the service is consuming the error budget, relative to the attainment goal of the SLO. A burn rate of exactly 1 indicates that the SLO goal will be met exactly.

For example, if you specify 60 as the number of minutes in the look-back window, the burn rate is calculated as the following:

burn rate = error rate over the look-back window / (100% - attainment goal percentage)

For more information about burn rates, see Calculate burn rates .

Parameters:: look_back_window_minutes (Union[int, float, None]) – The number of minutes to use as the look-back window.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-burnrateconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_applicationsignals import mixins as applicationsignals_mixins

burn_rate_configuration_property = applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.BurnRateConfigurationProperty(
    look_back_window_minutes=123
)

Attributes

look_back_window_minutes

The number of minutes to use as the look-back window.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-burnrateconfiguration.html#cfn-applicationsignals-servicelevelobjective-burnrateconfiguration-lookbackwindowminutes

CalendarIntervalProperty

class CfnServiceLevelObjectivePropsMixin.CalendarIntervalProperty(*, duration=None, duration_unit=None, start_time=None)

Bases: object

If the interval for this service level objective is a calendar interval, this structure contains the interval specifications.

Parameters:

duration (Union[int, float, None]) – Specifies the duration of each calendar interval. For example, if Duration is 1 and DurationUnit is MONTH , each interval is one month, aligned with the calendar.
duration_unit (Optional[str]) – Specifies the calendar interval unit.
start_time (Union[int, float, None]) – The date and time when you want the first interval to start. Be sure to choose a time that configures the intervals the way that you want. For example, if you want weekly intervals starting on Mondays at 6 a.m., be sure to specify a start time that is a Monday at 6 a.m. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057 As soon as one calendar interval ends, another automatically begins.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-calendarinterval.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_applicationsignals import mixins as applicationsignals_mixins

calendar_interval_property = applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.CalendarIntervalProperty(
    duration=123,
    duration_unit="durationUnit",
    start_time=123
)

Attributes

duration

Specifies the duration of each calendar interval.

For example, if Duration is 1 and DurationUnit is MONTH , each interval is one month, aligned with the calendar.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-calendarinterval.html#cfn-applicationsignals-servicelevelobjective-calendarinterval-duration

duration_unit

Specifies the calendar interval unit.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-calendarinterval.html#cfn-applicationsignals-servicelevelobjective-calendarinterval-durationunit

start_time

The date and time when you want the first interval to start.

Be sure to choose a time that configures the intervals the way that you want. For example, if you want weekly intervals starting on Mondays at 6 a.m., be sure to specify a start time that is a Monday at 6 a.m.

When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

As soon as one calendar interval ends, another automatically begins.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-calendarinterval.html#cfn-applicationsignals-servicelevelobjective-calendarinterval-starttime

DependencyConfigProperty

class CfnServiceLevelObjectivePropsMixin.DependencyConfigProperty(*, dependency_key_attributes=None, dependency_operation_name=None)

Bases: object

Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName .

Parameters:

dependency_key_attributes (Union[Mapping[str, str], IResolvable, None]) – If this SLO is related to a metric collected by Application Signals, you must use this field to specify which dependency the SLO metric is related to. - Type designates the type of object this is. - 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.
dependency_operation_name (Optional[str]) – When the SLO monitors a specific operation of the dependency, this field specifies the name of that operation in the dependency.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-dependencyconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_applicationsignals import mixins as applicationsignals_mixins

dependency_config_property = applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.DependencyConfigProperty(
    dependency_key_attributes={
        "dependency_key_attributes_key": "dependencyKeyAttributes"
    },
    dependency_operation_name="dependencyOperationName"
)

Attributes

dependency_key_attributes

If this SLO is related to a metric collected by Application Signals, you must use this field to specify which dependency the SLO metric is related to.

Type designates the type of object this is.
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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-dependencyconfig.html#cfn-applicationsignals-servicelevelobjective-dependencyconfig-dependencykeyattributes

dependency_operation_name

When the SLO monitors a specific operation of the dependency, this field specifies the name of that operation in the dependency.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-dependencyconfig.html#cfn-applicationsignals-servicelevelobjective-dependencyconfig-dependencyoperationname

DimensionProperty

class CfnServiceLevelObjectivePropsMixin.DimensionProperty(*, name=None, value=None)

Bases: object

A dimension is a name/value pair that is part of the identity of a metric.

Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.

You can assign up to 30 dimensions to a metric.

Parameters:

name (Optional[str]) – The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon ( : ). ASCII control characters are not supported as part of dimension names.
value (Optional[str]) – The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-dimension.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_applicationsignals import mixins as applicationsignals_mixins

dimension_property = applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.DimensionProperty(
    name="name",
    value="value"
)

Attributes

name

The name of the dimension.

Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon ( : ). ASCII control characters are not supported as part of dimension names.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-dimension.html#cfn-applicationsignals-servicelevelobjective-dimension-name

value

The value of the dimension.

Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-dimension.html#cfn-applicationsignals-servicelevelobjective-dimension-value

ExclusionWindowProperty

class CfnServiceLevelObjectivePropsMixin.ExclusionWindowProperty(*, reason=None, recurrence_rule=None, start_time=None, window=None)

Bases: object

The time window to be excluded from the SLO performance metrics.

Parameters:

reason (Optional[str]) – The reason for the time exclusion windows. For example, maintenance. Default: - “No reason”
recurrence_rule (Union[IResolvable, RecurrenceRuleProperty, Dict[str, Any], None]) – The recurrence rule for the time exclusion window.
start_time (Optional[str]) – The start time of the time exclusion window.
window (Union[IResolvable, WindowProperty, Dict[str, Any], None]) – The time exclusion window.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-exclusionwindow.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_applicationsignals import mixins as applicationsignals_mixins

exclusion_window_property = applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.ExclusionWindowProperty(
    reason="reason",
    recurrence_rule=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.RecurrenceRuleProperty(
        expression="expression"
    ),
    start_time="startTime",
    window=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.WindowProperty(
        duration=123,
        duration_unit="durationUnit"
    )
)

Attributes

reason

The reason for the time exclusion windows.

For example, maintenance.

Default:

“No reason”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-exclusionwindow.html#cfn-applicationsignals-servicelevelobjective-exclusionwindow-reason

recurrence_rule

The recurrence rule for the time exclusion window.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-exclusionwindow.html#cfn-applicationsignals-servicelevelobjective-exclusionwindow-recurrencerule

start_time

The start time of the time exclusion window.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-exclusionwindow.html#cfn-applicationsignals-servicelevelobjective-exclusionwindow-starttime

window

The time exclusion window.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-exclusionwindow.html#cfn-applicationsignals-servicelevelobjective-exclusionwindow-window

GoalProperty

class CfnServiceLevelObjectivePropsMixin.GoalProperty(*, attainment_goal=None, interval=None, warning_threshold=None)

Bases: object

This structure contains the attributes that determine the goal of an SLO.

This includes the time period for evaluation and the attainment threshold.

Parameters:

attainment_goal (Union[int, float, None]) – The threshold that determines if the goal is being met. If this is a period-based SLO, the attainment goal is the percentage of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state. If this is a request-based SLO, the attainment goal is the percentage of requests that must be successful to meet the attainment goal. If you omit this parameter, 99 is used to represent 99% as the attainment goal.
interval (Union[IResolvable, IntervalProperty, Dict[str, Any], None]) – The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval. If you omit this parameter, a rolling interval of 7 days is used.
warning_threshold (Union[int, float, None]) – The percentage of remaining budget over total budget that you want to get warnings for. If you omit this parameter, the default of 50.0 is used.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-goal.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_applicationsignals import mixins as applicationsignals_mixins

goal_property = applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.GoalProperty(
    attainment_goal=123,
    interval=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.IntervalProperty(
        calendar_interval=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.CalendarIntervalProperty(
            duration=123,
            duration_unit="durationUnit",
            start_time=123
        ),
        rolling_interval=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.RollingIntervalProperty(
            duration=123,
            duration_unit="durationUnit"
        )
    ),
    warning_threshold=123
)

Attributes

attainment_goal

The threshold that determines if the goal is being met.

If this is a period-based SLO, the attainment goal is the percentage of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.

If this is a request-based SLO, the attainment goal is the percentage of requests that must be successful to meet the attainment goal.

If you omit this parameter, 99 is used to represent 99% as the attainment goal.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-goal.html#cfn-applicationsignals-servicelevelobjective-goal-attainmentgoal

interval

The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.

If you omit this parameter, a rolling interval of 7 days is used.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-goal.html#cfn-applicationsignals-servicelevelobjective-goal-interval

warning_threshold

The percentage of remaining budget over total budget that you want to get warnings for.

If you omit this parameter, the default of 50.0 is used.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-goal.html#cfn-applicationsignals-servicelevelobjective-goal-warningthreshold

IntervalProperty

class CfnServiceLevelObjectivePropsMixin.IntervalProperty(*, calendar_interval=None, rolling_interval=None)

Bases: object

The time period used to evaluate the SLO.

It can be either a calendar interval or rolling interval.

Parameters:

calendar_interval (Union[IResolvable, CalendarIntervalProperty, Dict[str, Any], None]) – If the interval is a calendar interval, this structure contains the interval specifications.
rolling_interval (Union[IResolvable, RollingIntervalProperty, Dict[str, Any], None]) – If the interval is a rolling interval, this structure contains the interval specifications.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-interval.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_applicationsignals import mixins as applicationsignals_mixins

interval_property = applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.IntervalProperty(
    calendar_interval=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.CalendarIntervalProperty(
        duration=123,
        duration_unit="durationUnit",
        start_time=123
    ),
    rolling_interval=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.RollingIntervalProperty(
        duration=123,
        duration_unit="durationUnit"
    )
)

Attributes

calendar_interval

If the interval is a calendar interval, this structure contains the interval specifications.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-interval.html#cfn-applicationsignals-servicelevelobjective-interval-calendarinterval

rolling_interval

If the interval is a rolling interval, this structure contains the interval specifications.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-interval.html#cfn-applicationsignals-servicelevelobjective-interval-rollinginterval

MetricDataQueryProperty

class CfnServiceLevelObjectivePropsMixin.MetricDataQueryProperty(*, account_id=None, expression=None, id=None, metric_stat=None, return_data=None)

Bases: object

Use this structure to define a metric or metric math expression that you want to use as for a service level objective.

Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for ReturnData . The result of this expression used for the SLO.

For more information about metric math expressions, see Use metric math .

Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.

Parameters:

account_id (Optional[str]) – The ID of the account where this metric is located. If you are performing this operation in a monitoring account, use this to specify which source account to retrieve this metric from.
expression (Optional[str]) – This field can contain a metric math expression to be performed on the other metrics that you are retrieving within this MetricDataQueries structure. A math expression can use the Id of the other metrics or queries to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide . Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.
id (Optional[str]) – A short name used to tie this object to the results in the response. This Id must be unique within a MetricDataQueries array. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the metric math expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
metric_stat (Union[IResolvable, MetricStatProperty, Dict[str, Any], None]) – A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO. Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
return_data (Union[bool, IResolvable, None]) – Use this only if you are using a metric math expression for the SLO. Specify true for ReturnData for only the one expression result to use as the alarm. For all other metrics and expressions in the same CreateServiceLevelObjective operation, specify ReturnData as false .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metricdataquery.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_applicationsignals import mixins as applicationsignals_mixins

metric_data_query_property = applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricDataQueryProperty(
    account_id="accountId",
    expression="expression",
    id="id",
    metric_stat=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricStatProperty(
        metric=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricProperty(
            dimensions=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.DimensionProperty(
                name="name",
                value="value"
            )],
            metric_name="metricName",
            namespace="namespace"
        ),
        period=123,
        stat="stat",
        unit="unit"
    ),
    return_data=False
)

Attributes

account_id

The ID of the account where this metric is located.

If you are performing this operation in a monitoring account, use this to specify which source account to retrieve this metric from.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metricdataquery.html#cfn-applicationsignals-servicelevelobjective-metricdataquery-accountid

expression

This field can contain a metric math expression to be performed on the other metrics that you are retrieving within this MetricDataQueries structure.

A math expression can use the Id of the other metrics or queries to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide .

Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metricdataquery.html#cfn-applicationsignals-servicelevelobjective-metricdataquery-expression

id

A short name used to tie this object to the results in the response.

This Id must be unique within a MetricDataQueries array. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the metric math expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metricdataquery.html#cfn-applicationsignals-servicelevelobjective-metricdataquery-id

metric_stat

A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.

Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metricdataquery.html#cfn-applicationsignals-servicelevelobjective-metricdataquery-metricstat

return_data

Use this only if you are using a metric math expression for the SLO.

Specify true for ReturnData for only the one expression result to use as the alarm. For all other metrics and expressions in the same CreateServiceLevelObjective operation, specify ReturnData as false .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metricdataquery.html#cfn-applicationsignals-servicelevelobjective-metricdataquery-returndata

MetricProperty

class CfnServiceLevelObjectivePropsMixin.MetricProperty(*, dimensions=None, metric_name=None, namespace=None)

Bases: object

This structure defines the metric used for a service level indicator, including the metric name, namespace, and dimensions.

Parameters:

dimensions (Union[IResolvable, Sequence[Union[IResolvable, DimensionProperty, Dict[str, Any]]], None]) – An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions .
metric_name (Optional[str]) – The name of the metric to use.
namespace (Optional[str]) – The namespace of the metric. For more information, see Namespaces .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metric.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_applicationsignals import mixins as applicationsignals_mixins

metric_property = applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricProperty(
    dimensions=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.DimensionProperty(
        name="name",
        value="value"
    )],
    metric_name="metricName",
    namespace="namespace"
)

Attributes

dimensions

An array of one or more dimensions to use to define the metric that you want to use.

For more information, see Dimensions .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metric.html#cfn-applicationsignals-servicelevelobjective-metric-dimensions

metric_name

The name of the metric to use.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metric.html#cfn-applicationsignals-servicelevelobjective-metric-metricname

namespace

The namespace of the metric.

For more information, see Namespaces .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metric.html#cfn-applicationsignals-servicelevelobjective-metric-namespace

MetricStatProperty

class CfnServiceLevelObjectivePropsMixin.MetricStatProperty(*, metric=None, period=None, stat=None, unit=None)

Bases: object

This structure defines the metric to be used as the service level indicator, along with the statistics, period, and unit.

Parameters:

metric (Union[IResolvable, MetricProperty, Dict[str, Any], None]) – The metric to use as the service level indicator, including the metric name, namespace, and dimensions.
period (Union[int, float, None]) – The granularity, in seconds, to be used for the metric. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.
stat (Optional[str]) – The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions .
unit (Optional[str]) – If you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metricstat.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_applicationsignals import mixins as applicationsignals_mixins

metric_stat_property = applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricStatProperty(
    metric=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricProperty(
        dimensions=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.DimensionProperty(
            name="name",
            value="value"
        )],
        metric_name="metricName",
        namespace="namespace"
    ),
    period=123,
    stat="stat",
    unit="unit"
)

Attributes

metric

The metric to use as the service level indicator, including the metric name, namespace, and dimensions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metricstat.html#cfn-applicationsignals-servicelevelobjective-metricstat-metric

period

The granularity, in seconds, to be used for the metric.

For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metricstat.html#cfn-applicationsignals-servicelevelobjective-metricstat-period

stat

The statistic to use for comparison to the threshold.

It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metricstat.html#cfn-applicationsignals-servicelevelobjective-metricstat-stat

unit

If you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch.

If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metricstat.html#cfn-applicationsignals-servicelevelobjective-metricstat-unit

MonitoredRequestCountMetricProperty

class CfnServiceLevelObjectivePropsMixin.MonitoredRequestCountMetricProperty(*, bad_count_metric=None, good_count_metric=None)

Bases: object

This structure defines the metric that is used as the “good request” or “bad request” value for a request-based SLO.

This value observed for the metric defined in TotalRequestCountMetric is divided by the number found for MonitoredRequestCountMetric to determine the percentage of successful requests that this SLO tracks.

Parameters:

bad_count_metric (Union[IResolvable, Sequence[Union[IResolvable, MetricDataQueryProperty, Dict[str, Any]]], None]) – If you want to count “bad requests” to determine the percentage of successful requests for this request-based SLO, specify the metric to use as “bad requests” in this structure.
good_count_metric (Union[IResolvable, Sequence[Union[IResolvable, MetricDataQueryProperty, Dict[str, Any]]], None]) – If you want to count “good requests” to determine the percentage of successful requests for this request-based SLO, specify the metric to use as “good requests” in this structure.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-monitoredrequestcountmetric.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_applicationsignals import mixins as applicationsignals_mixins

monitored_request_count_metric_property = applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MonitoredRequestCountMetricProperty(
    bad_count_metric=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricDataQueryProperty(
        account_id="accountId",
        expression="expression",
        id="id",
        metric_stat=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricStatProperty(
            metric=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricProperty(
                dimensions=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.DimensionProperty(
                    name="name",
                    value="value"
                )],
                metric_name="metricName",
                namespace="namespace"
            ),
            period=123,
            stat="stat",
            unit="unit"
        ),
        return_data=False
    )],
    good_count_metric=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricDataQueryProperty(
        account_id="accountId",
        expression="expression",
        id="id",
        metric_stat=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricStatProperty(
            metric=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricProperty(
                dimensions=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.DimensionProperty(
                    name="name",
                    value="value"
                )],
                metric_name="metricName",
                namespace="namespace"
            ),
            period=123,
            stat="stat",
            unit="unit"
        ),
        return_data=False
    )]
)

Attributes

bad_count_metric

If you want to count “bad requests” to determine the percentage of successful requests for this request-based SLO, specify the metric to use as “bad requests” in this structure.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-monitoredrequestcountmetric.html#cfn-applicationsignals-servicelevelobjective-monitoredrequestcountmetric-badcountmetric

good_count_metric

If you want to count “good requests” to determine the percentage of successful requests for this request-based SLO, specify the metric to use as “good requests” in this structure.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-monitoredrequestcountmetric.html#cfn-applicationsignals-servicelevelobjective-monitoredrequestcountmetric-goodcountmetric

RecurrenceRuleProperty

class CfnServiceLevelObjectivePropsMixin.RecurrenceRuleProperty(*, expression=None)

Bases: object

The recurrence rule for the time exclusion window.

Parameters:: expression (Optional[str]) – The following two rules are supported:. - rate(value unit) - The value must be a positive integer and the unit can be hour|day|month. - cron - An expression which consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-recurrencerule.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_applicationsignals import mixins as applicationsignals_mixins

recurrence_rule_property = applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.RecurrenceRuleProperty(
    expression="expression"
)

Attributes

expression

.

rate(value unit) - The value must be a positive integer and the unit can be hour|day|month.
cron - An expression which consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-recurrencerule.html#cfn-applicationsignals-servicelevelobjective-recurrencerule-expression
Type:: The following two rules are supported

RequestBasedSliMetricProperty

class CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty(*, dependency_config=None, key_attributes=None, metric_type=None, monitored_request_count_metric=None, operation_name=None, total_request_count_metric=None)

Bases: object

This structure contains the information about the metric that is used for a request-based SLO.

Parameters:

dependency_config (Union[IResolvable, DependencyConfigProperty, Dict[str, Any], None]) – Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName .
key_attributes (Union[Mapping[str, str], IResolvable, None]) – 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.
metric_type (Optional[str]) – If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used.
monitored_request_count_metric (Union[IResolvable, MonitoredRequestCountMetricProperty, Dict[str, Any], None]) – 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.
operation_name (Optional[str]) – If the SLO monitors a specific operation of the service, this field displays that operation name.
total_request_count_metric (Union[IResolvable, Sequence[Union[IResolvable, MetricDataQueryProperty, Dict[str, Any]]], None]) – 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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedslimetric.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_applicationsignals import mixins as applicationsignals_mixins

request_based_sli_metric_property = applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty(
    dependency_config=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.DependencyConfigProperty(
        dependency_key_attributes={
            "dependency_key_attributes_key": "dependencyKeyAttributes"
        },
        dependency_operation_name="dependencyOperationName"
    ),
    key_attributes={
        "key_attributes_key": "keyAttributes"
    },
    metric_type="metricType",
    monitored_request_count_metric=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MonitoredRequestCountMetricProperty(
        bad_count_metric=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricDataQueryProperty(
            account_id="accountId",
            expression="expression",
            id="id",
            metric_stat=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricStatProperty(
                metric=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricProperty(
                    dimensions=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.DimensionProperty(
                        name="name",
                        value="value"
                    )],
                    metric_name="metricName",
                    namespace="namespace"
                ),
                period=123,
                stat="stat",
                unit="unit"
            ),
            return_data=False
        )],
        good_count_metric=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricDataQueryProperty(
            account_id="accountId",
            expression="expression",
            id="id",
            metric_stat=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricStatProperty(
                metric=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricProperty(
                    dimensions=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.DimensionProperty(
                        name="name",
                        value="value"
                    )],
                    metric_name="metricName",
                    namespace="namespace"
                ),
                period=123,
                stat="stat",
                unit="unit"
            ),
            return_data=False
        )]
    ),
    operation_name="operationName",
    total_request_count_metric=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricDataQueryProperty(
        account_id="accountId",
        expression="expression",
        id="id",
        metric_stat=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricStatProperty(
            metric=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricProperty(
                dimensions=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.DimensionProperty(
                    name="name",
                    value="value"
                )],
                metric_name="metricName",
                namespace="namespace"
            ),
            period=123,
            stat="stat",
            unit="unit"
        ),
        return_data=False
    )]
)

Attributes

dependency_config

Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedslimetric.html#cfn-applicationsignals-servicelevelobjective-requestbasedslimetric-dependencyconfig

key_attributes

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedslimetric.html#cfn-applicationsignals-servicelevelobjective-requestbasedslimetric-keyattributes

metric_type

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedslimetric.html#cfn-applicationsignals-servicelevelobjective-requestbasedslimetric-metrictype

monitored_request_count_metric

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedslimetric.html#cfn-applicationsignals-servicelevelobjective-requestbasedslimetric-monitoredrequestcountmetric

operation_name

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedslimetric.html#cfn-applicationsignals-servicelevelobjective-requestbasedslimetric-operationname

total_request_count_metric

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedslimetric.html#cfn-applicationsignals-servicelevelobjective-requestbasedslimetric-totalrequestcountmetric

RequestBasedSliProperty

class CfnServiceLevelObjectivePropsMixin.RequestBasedSliProperty(*, comparison_operator=None, metric_threshold=None, request_based_sli_metric=None)

Bases: object

This structure contains information about the performance metric that a request-based SLO monitors.

Parameters:

comparison_operator (Optional[str]) – The arithmetic operation used when comparing the specified metric to the threshold.
metric_threshold (Union[int, float, None]) – This value is the threshold that the observed metric values of the SLI metric are compared to.
request_based_sli_metric (Union[IResolvable, RequestBasedSliMetricProperty, Dict[str, Any], None]) – A structure that contains information about the metric that the SLO monitors.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedsli.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_applicationsignals import mixins as applicationsignals_mixins

request_based_sli_property = applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.RequestBasedSliProperty(
    comparison_operator="comparisonOperator",
    metric_threshold=123,
    request_based_sli_metric=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.RequestBasedSliMetricProperty(
        dependency_config=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.DependencyConfigProperty(
            dependency_key_attributes={
                "dependency_key_attributes_key": "dependencyKeyAttributes"
            },
            dependency_operation_name="dependencyOperationName"
        ),
        key_attributes={
            "key_attributes_key": "keyAttributes"
        },
        metric_type="metricType",
        monitored_request_count_metric=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MonitoredRequestCountMetricProperty(
            bad_count_metric=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricDataQueryProperty(
                account_id="accountId",
                expression="expression",
                id="id",
                metric_stat=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricStatProperty(
                    metric=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricProperty(
                        dimensions=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.DimensionProperty(
                            name="name",
                            value="value"
                        )],
                        metric_name="metricName",
                        namespace="namespace"
                    ),
                    period=123,
                    stat="stat",
                    unit="unit"
                ),
                return_data=False
            )],
            good_count_metric=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricDataQueryProperty(
                account_id="accountId",
                expression="expression",
                id="id",
                metric_stat=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricStatProperty(
                    metric=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricProperty(
                        dimensions=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.DimensionProperty(
                            name="name",
                            value="value"
                        )],
                        metric_name="metricName",
                        namespace="namespace"
                    ),
                    period=123,
                    stat="stat",
                    unit="unit"
                ),
                return_data=False
            )]
        ),
        operation_name="operationName",
        total_request_count_metric=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricDataQueryProperty(
            account_id="accountId",
            expression="expression",
            id="id",
            metric_stat=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricStatProperty(
                metric=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricProperty(
                    dimensions=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.DimensionProperty(
                        name="name",
                        value="value"
                    )],
                    metric_name="metricName",
                    namespace="namespace"
                ),
                period=123,
                stat="stat",
                unit="unit"
            ),
            return_data=False
        )]
    )
)

Attributes

comparison_operator

The arithmetic operation used when comparing the specified metric to the threshold.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedsli.html#cfn-applicationsignals-servicelevelobjective-requestbasedsli-comparisonoperator

metric_threshold

This value is the threshold that the observed metric values of the SLI metric are compared to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedsli.html#cfn-applicationsignals-servicelevelobjective-requestbasedsli-metricthreshold

request_based_sli_metric

A structure that contains information about the metric that the SLO monitors.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedsli.html#cfn-applicationsignals-servicelevelobjective-requestbasedsli-requestbasedslimetric

RollingIntervalProperty

class CfnServiceLevelObjectivePropsMixin.RollingIntervalProperty(*, duration=None, duration_unit=None)

Bases: object

If the interval for this SLO is a rolling interval, this structure contains the interval specifications.

Parameters:

duration (Union[int, float, None]) – Specifies the duration of each rolling interval. For example, if Duration is 7 and DurationUnit is DAY , each rolling interval is seven days.
duration_unit (Optional[str]) – Specifies the rolling interval unit.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-rollinginterval.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_applicationsignals import mixins as applicationsignals_mixins

rolling_interval_property = applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.RollingIntervalProperty(
    duration=123,
    duration_unit="durationUnit"
)

Attributes

duration

Specifies the duration of each rolling interval.

For example, if Duration is 7 and DurationUnit is DAY , each rolling interval is seven days.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-rollinginterval.html#cfn-applicationsignals-servicelevelobjective-rollinginterval-duration

duration_unit

Specifies the rolling interval unit.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-rollinginterval.html#cfn-applicationsignals-servicelevelobjective-rollinginterval-durationunit

SliMetricProperty

class CfnServiceLevelObjectivePropsMixin.SliMetricProperty(*, dependency_config=None, key_attributes=None, metric_data_queries=None, metric_type=None, operation_name=None, period_seconds=None, statistic=None)

Bases: object

Use this structure to specify the metric to be used for the SLO.

Parameters:

dependency_config (Union[IResolvable, DependencyConfigProperty, Dict[str, Any], None]) – Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName .
key_attributes (Union[Mapping[str, str], IResolvable, None]) – If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service the SLO metric is related to. To do so, you must specify at least the Type , Name , and Environment attributes. This is a string-to-string map. It can include the following fields. - Type designates the type of object this is. - 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.
metric_data_queries (Union[IResolvable, Sequence[Union[IResolvable, MetricDataQueryProperty, Dict[str, Any]]], None]) – If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, use this structure to specify that metric or expression.
metric_type (Optional[str]) – If the SLO is to monitor either the LATENCY or AVAILABILITY metric that Application Signals collects, use this field to specify which of those metrics is used.
operation_name (Optional[str]) – If the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation.
period_seconds (Union[int, float, None]) – The number of seconds to use as the period for SLO evaluation. Your application’s performance is compared to the SLI during each period. For each period, the application is determined to have either achieved or not achieved the necessary performance.
statistic (Optional[str]) –
The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-slimetric.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_applicationsignals import mixins as applicationsignals_mixins

sli_metric_property = applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.SliMetricProperty(
    dependency_config=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.DependencyConfigProperty(
        dependency_key_attributes={
            "dependency_key_attributes_key": "dependencyKeyAttributes"
        },
        dependency_operation_name="dependencyOperationName"
    ),
    key_attributes={
        "key_attributes_key": "keyAttributes"
    },
    metric_data_queries=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricDataQueryProperty(
        account_id="accountId",
        expression="expression",
        id="id",
        metric_stat=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricStatProperty(
            metric=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricProperty(
                dimensions=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.DimensionProperty(
                    name="name",
                    value="value"
                )],
                metric_name="metricName",
                namespace="namespace"
            ),
            period=123,
            stat="stat",
            unit="unit"
        ),
        return_data=False
    )],
    metric_type="metricType",
    operation_name="operationName",
    period_seconds=123,
    statistic="statistic"
)

Attributes

dependency_config

Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-slimetric.html#cfn-applicationsignals-servicelevelobjective-slimetric-dependencyconfig

key_attributes

If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service the SLO metric is related to.

To do so, you must specify at least the Type , Name , and Environment attributes.

This is a string-to-string map. It can include the following fields.

Type designates the type of object this is.
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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-slimetric.html#cfn-applicationsignals-servicelevelobjective-slimetric-keyattributes

metric_data_queries

If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, use this structure to specify that metric or expression.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-slimetric.html#cfn-applicationsignals-servicelevelobjective-slimetric-metricdataqueries

metric_type

If the SLO is to monitor either the LATENCY or AVAILABILITY metric that Application Signals collects, use this field to specify which of those metrics is used.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-slimetric.html#cfn-applicationsignals-servicelevelobjective-slimetric-metrictype

operation_name

If the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-slimetric.html#cfn-applicationsignals-servicelevelobjective-slimetric-operationname

period_seconds

The number of seconds to use as the period for SLO evaluation.

Your application’s performance is compared to the SLI during each period. For each period, the application is determined to have either achieved or not achieved the necessary performance.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-slimetric.html#cfn-applicationsignals-servicelevelobjective-slimetric-periodseconds

statistic

The statistic to use for comparison to the threshold.

It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-slimetric.html#cfn-applicationsignals-servicelevelobjective-slimetric-statistic

SliProperty

class CfnServiceLevelObjectivePropsMixin.SliProperty(*, comparison_operator=None, metric_threshold=None, sli_metric=None)

Bases: object

This structure specifies the information about the service and the performance metric that an SLO is to monitor.

Parameters:

comparison_operator (Optional[str]) – The arithmetic operation to use when comparing the specified metric to the threshold.
metric_threshold (Union[int, float, None]) – The value that the SLI metric is compared to.
sli_metric (Union[IResolvable, SliMetricProperty, Dict[str, Any], None]) – Use this structure to specify the metric to be used for the SLO.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-sli.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_applicationsignals import mixins as applicationsignals_mixins

sli_property = applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.SliProperty(
    comparison_operator="comparisonOperator",
    metric_threshold=123,
    sli_metric=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.SliMetricProperty(
        dependency_config=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.DependencyConfigProperty(
            dependency_key_attributes={
                "dependency_key_attributes_key": "dependencyKeyAttributes"
            },
            dependency_operation_name="dependencyOperationName"
        ),
        key_attributes={
            "key_attributes_key": "keyAttributes"
        },
        metric_data_queries=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricDataQueryProperty(
            account_id="accountId",
            expression="expression",
            id="id",
            metric_stat=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricStatProperty(
                metric=applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.MetricProperty(
                    dimensions=[applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.DimensionProperty(
                        name="name",
                        value="value"
                    )],
                    metric_name="metricName",
                    namespace="namespace"
                ),
                period=123,
                stat="stat",
                unit="unit"
            ),
            return_data=False
        )],
        metric_type="metricType",
        operation_name="operationName",
        period_seconds=123,
        statistic="statistic"
    )
)

Attributes

comparison_operator

The arithmetic operation to use when comparing the specified metric to the threshold.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-sli.html#cfn-applicationsignals-servicelevelobjective-sli-comparisonoperator

metric_threshold

The value that the SLI metric is compared to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-sli.html#cfn-applicationsignals-servicelevelobjective-sli-metricthreshold

sli_metric

Use this structure to specify the metric to be used for the SLO.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-sli.html#cfn-applicationsignals-servicelevelobjective-sli-slimetric

WindowProperty

class CfnServiceLevelObjectivePropsMixin.WindowProperty(*, duration=None, duration_unit=None)

Bases: object

The start and end time of the time exclusion window.

Parameters:

duration (Union[int, float, None]) – The start and end time of the time exclusion window.
duration_unit (Optional[str]) – The unit of measurement to use during the time window exclusion.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-window.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_applicationsignals import mixins as applicationsignals_mixins

window_property = applicationsignals_mixins.CfnServiceLevelObjectivePropsMixin.WindowProperty(
    duration=123,
    duration_unit="durationUnit"
)

Attributes

duration

The start and end time of the time exclusion window.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-window.html#cfn-applicationsignals-servicelevelobjective-window-duration

duration_unit

The unit of measurement to use during the time window exclusion.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-window.html#cfn-applicationsignals-servicelevelobjective-window-durationunit