Skip to content

CreateServiceLevelObjectiveInput

Source code in docs_src/capo_application_signals/types/create_service_level_objective_input.py
class CreateServiceLevelObjectiveInput(TypedDict, closed=True):
    name: "capo_application_signals.types.service_level_objective_name.ServiceLevelObjectiveName"
    """<p>A name for this SLO.</p>"""
    description: NotRequired[
        "capo_application_signals.types.service_level_objective_description.ServiceLevelObjectiveDescription"
    ]
    """<p>An optional description for this SLO.</p>"""
    sli_config: NotRequired[
        "capo_application_signals.types.service_level_indicator_config.ServiceLevelIndicatorConfig"
    ]
    """<p>If this SLO is a period-based SLO, this structure defines the information about what performance metric this SLO will monitor.</p> <p>You can't specify both <code>RequestBasedSliConfig</code> and <code>SliConfig</code> in the same operation.</p>"""
    request_based_sli_config: NotRequired[
        "capo_application_signals.types.request_based_service_level_indicator_config.RequestBasedServiceLevelIndicatorConfig"
    ]
    """<p>If this SLO is a request-based SLO, this structure defines the information about what performance metric this SLO will monitor.</p> <p>You can't specify both <code>RequestBasedSliConfig</code> and <code>SliConfig</code> in the same operation.</p>"""
    goal: NotRequired["capo_application_signals.types.goal.Goal"]
    """<p>This structure contains the attributes that determine the goal of the SLO.</p>"""
    tags: NotRequired["capo_application_signals.types.tag_list.TagList"]
    """<p>A list of key-value pairs to associate with the SLO. You can associate as many as 50 tags with an SLO. To be able to associate tags with the SLO when you create the SLO, you must have the <code>cloudwatch:TagResource</code> permission.</p> <p>Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.</p>"""
    burn_rate_configurations: NotRequired[
        "capo_application_signals.types.burn_rate_configurations.BurnRateConfigurations"
    ]
    """<p>Use this array to create <i>burn rates</i> for this SLO. Each burn rate is a metric that indicates how fast the service is consuming the error budget, relative to the attainment goal of the SLO.</p>"""
    create_recommended_slo: "bool"
    """<p>Set this to <code>true</code> to create a recommended SLO out of the box. When set to <code>true</code>, you don't need to specify the <code>MetricThreshold</code> or <code>ComparisonOperator</code> in the <code>SliConfig</code> or <code>RequestBasedSliConfig</code>. The default value is <code>false</code>.</p> <p>This is supported for SLOs on a service, service operation, or a dependency.</p>"""
    auto_investigation_enabled: NotRequired["bool"]
    """Indicates whether DevOps Agent will automatically investigate this SLO when it is breached"""

auto_investigation_enabled instance-attribute

auto_investigation_enabled: NotRequired[bool]

Indicates whether DevOps Agent will automatically investigate this SLO when it is breached

burn_rate_configurations instance-attribute

burn_rate_configurations: NotRequired[BurnRateConfigurations]

Use this array to create burn rates for this SLO. Each burn rate is a metric that indicates how fast the service is consuming the error budget, relative to the attainment goal of the SLO.

create_recommended_slo: bool

Set this to true to create a recommended SLO out of the box. When set to true, you don't need to specify the MetricThreshold or ComparisonOperator in the SliConfig or RequestBasedSliConfig. The default value is false.

This is supported for SLOs on a service, service operation, or a dependency.

description instance-attribute

description: NotRequired[ServiceLevelObjectiveDescription]

An optional description for this SLO.

goal instance-attribute

goal: NotRequired[Goal]

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

name instance-attribute

A name for this SLO.

request_based_sli_config instance-attribute

request_based_sli_config: NotRequired[RequestBasedServiceLevelIndicatorConfig]

If this SLO is a request-based SLO, this structure defines the information about what performance metric this SLO will monitor.

You can't specify both RequestBasedSliConfig and SliConfig in the same operation.

sli_config instance-attribute

sli_config: NotRequired[ServiceLevelIndicatorConfig]

If this SLO is a period-based SLO, this structure defines the information about what performance metric this SLO will monitor.

You can't specify both RequestBasedSliConfig and SliConfig in the same operation.

tags instance-attribute

tags: NotRequired[TagList]

A list of key-value pairs to associate with the SLO. You can associate as many as 50 tags with an SLO. To be able to associate tags with the SLO when you create the SLO, you must have the cloudwatch:TagResource permission.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.