class CfnServiceLevelObjective (construct)
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.aws_applicationsignals.CfnServiceLevelObjective |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsapplicationsignals#CfnServiceLevelObjective |
 Java | software.amazon.awscdk.services.applicationsignals.CfnServiceLevelObjective |
 Python | aws_cdk.aws_applicationsignals.CfnServiceLevelObjective |
 TypeScript | aws-cdk-lib » aws_applicationsignals » CfnServiceLevelObjective |
Implements
IConstruct, IDependable, IInspectable, ITaggable
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 requestsduring 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:GetServiceGraphlogs:StartQuerylogs:GetQueryResultscloudwatch:GetMetricDatacloudwatch:ListMetricstag:GetResourcesautoscaling: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.
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) .
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_applicationsignals as applicationsignals } from 'aws-cdk-lib';
const cfnServiceLevelObjective = new applicationsignals.CfnServiceLevelObjective(this, 'MyCfnServiceLevelObjective', {
name: 'name',
// the properties below are optional
burnRateConfigurations: [{
lookBackWindowMinutes: 123,
}],
description: 'description',
exclusionWindows: [{
window: {
duration: 123,
durationUnit: 'durationUnit',
},
// the properties below are optional
reason: 'reason',
recurrenceRule: {
expression: 'expression',
},
startTime: 'startTime',
}],
goal: {
attainmentGoal: 123,
interval: {
calendarInterval: {
duration: 123,
durationUnit: 'durationUnit',
startTime: 123,
},
rollingInterval: {
duration: 123,
durationUnit: 'durationUnit',
},
},
warningThreshold: 123,
},
requestBasedSli: {
requestBasedSliMetric: {
dependencyConfig: {
dependencyKeyAttributes: {
dependencyKeyAttributesKey: 'dependencyKeyAttributes',
},
dependencyOperationName: 'dependencyOperationName',
},
keyAttributes: {
keyAttributesKey: 'keyAttributes',
},
metricType: 'metricType',
monitoredRequestCountMetric: {
badCountMetric: [{
id: 'id',
// the properties below are optional
accountId: 'accountId',
expression: 'expression',
metricStat: {
metric: {
dimensions: [{
name: 'name',
value: 'value',
}],
metricName: 'metricName',
namespace: 'namespace',
},
period: 123,
stat: 'stat',
// the properties below are optional
unit: 'unit',
},
returnData: false,
}],
goodCountMetric: [{
id: 'id',
// the properties below are optional
accountId: 'accountId',
expression: 'expression',
metricStat: {
metric: {
dimensions: [{
name: 'name',
value: 'value',
}],
metricName: 'metricName',
namespace: 'namespace',
},
period: 123,
stat: 'stat',
// the properties below are optional
unit: 'unit',
},
returnData: false,
}],
},
operationName: 'operationName',
totalRequestCountMetric: [{
id: 'id',
// the properties below are optional
accountId: 'accountId',
expression: 'expression',
metricStat: {
metric: {
dimensions: [{
name: 'name',
value: 'value',
}],
metricName: 'metricName',
namespace: 'namespace',
},
period: 123,
stat: 'stat',
// the properties below are optional
unit: 'unit',
},
returnData: false,
}],
},
// the properties below are optional
comparisonOperator: 'comparisonOperator',
metricThreshold: 123,
},
sli: {
comparisonOperator: 'comparisonOperator',
metricThreshold: 123,
sliMetric: {
dependencyConfig: {
dependencyKeyAttributes: {
dependencyKeyAttributesKey: 'dependencyKeyAttributes',
},
dependencyOperationName: 'dependencyOperationName',
},
keyAttributes: {
keyAttributesKey: 'keyAttributes',
},
metricDataQueries: [{
id: 'id',
// the properties below are optional
accountId: 'accountId',
expression: 'expression',
metricStat: {
metric: {
dimensions: [{
name: 'name',
value: 'value',
}],
metricName: 'metricName',
namespace: 'namespace',
},
period: 123,
stat: 'stat',
// the properties below are optional
unit: 'unit',
},
returnData: false,
}],
metricType: 'metricType',
operationName: 'operationName',
periodSeconds: 123,
statistic: 'statistic',
},
},
tags: [{
key: 'key',
value: 'value',
}],
});
Initializer
new CfnServiceLevelObjective(scope: Construct, id: string, props: CfnServiceLevelObjectiveProps)
Parameters
- scope
Construct— Scope in which this resource is defined. - id
string— Construct identifier for this resource (unique in its scope). - props
Cfn— Resource properties.Service Level Objective Props
Construct Props
| Name | Type | Description |
|---|---|---|
| name | string | A name for this SLO. |
| burn | IResolvable | IResolvable | Burn[] | Each object in this array defines the length of the look-back window used to calculate one burn rate metric for this SLO. |
| description? | string | An optional description for this SLO. |
| exclusion | IResolvable | IResolvable | Exclusion[] | The time window to be excluded from the SLO performance metrics. |
| goal? | IResolvable | Goal | This structure contains the attributes that determine the goal of an SLO. |
| request | IResolvable | Request | A structure containing information about the performance metric that this SLO monitors, if this is a request-based SLO. |
| sli? | IResolvable | Sli | A structure containing information about the performance metric that this SLO monitors, if this is a period-based SLO. |
| tags? | Cfn[] | A list of key-value pairs to associate with the SLO. |
name
Type:
string
A name for this SLO.
burnRateConfigurations?
Type:
IResolvable | IResolvable | Burn[]
(optional)
Each object in this array 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.
description?
Type:
string
(optional, default: "No description")
An optional description for this SLO.
exclusionWindows?
Type:
IResolvable | IResolvable | Exclusion[]
(optional)
The time window to be excluded from the SLO performance metrics.
goal?
Type:
IResolvable | Goal
(optional)
This structure contains the attributes that determine the goal of an SLO.
This includes the time period for evaluation and the attainment threshold.
requestBasedSli?
Type:
IResolvable | Request
(optional)
A structure containing information about the performance metric that this SLO monitors, if this is a request-based SLO.
sli?
Type:
IResolvable | Sli
(optional)
A structure containing information about the performance metric that this SLO monitors, if this is a period-based SLO.
tags?
Type:
Cfn[]
(optional)
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.
Properties
| Name | Type | Description |
|---|---|---|
| attr | string | The ARN of this SLO. |
| attr | number | The date and time that this SLO was created. |
| attr | string | Displays whether this is a period-based SLO or a request-based SLO. |
| attr | number | The time that this SLO was most recently updated. |
| cdk | Tag | Tag Manager which manages the tags for this resource. |
| cfn | ICfn | Options for this resource, such as condition, update policy etc. |
| cfn | { [string]: any } | |
| cfn | string | AWS resource type. |
| creation | string[] | |
| logical | string | The logical ID for this CloudFormation stack element. |
| name | string | A name for this SLO. |
| node | Node | The tree node. |
| ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
| stack | Stack | The stack in which this element is defined. |
| burn | IResolvable | IResolvable | Burn[] | Each object in this array defines the length of the look-back window used to calculate one burn rate metric for this SLO. |
| description? | string | An optional description for this SLO. |
| exclusion | IResolvable | IResolvable | Exclusion[] | The time window to be excluded from the SLO performance metrics. |
| goal? | IResolvable | Goal | This structure contains the attributes that determine the goal of an SLO. |
| request | IResolvable | Request | A structure containing information about the performance metric that this SLO monitors, if this is a request-based SLO. |
| sli? | IResolvable | Sli | A structure containing information about the performance metric that this SLO monitors, if this is a period-based SLO. |
| tags? | Cfn[] | A list of key-value pairs to associate with the SLO. |
| static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrArn
Type:
string
The ARN of this SLO.
attrCreatedTime
Type:
number
The date and time that this SLO was created.
attrEvaluationType
Type:
string
Displays whether this is a period-based SLO or a request-based SLO.
attrLastUpdatedTime
Type:
number
The time that this SLO was most recently updated.
cdkTagManager
Type:
Tag
Tag Manager which manages the tags for this resource.
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
logicalId
Type:
string
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId).
name
Type:
string
A name for this SLO.
node
Type:
Node
The tree node.
ref
Type:
string
Return a string that will be resolved to a CloudFormation { Ref } for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
burnRateConfigurations?
Type:
IResolvable | IResolvable | Burn[]
(optional)
Each object in this array defines the length of the look-back window used to calculate one burn rate metric for this SLO.
description?
Type:
string
(optional)
An optional description for this SLO.
exclusionWindows?
Type:
IResolvable | IResolvable | Exclusion[]
(optional)
The time window to be excluded from the SLO performance metrics.
goal?
Type:
IResolvable | Goal
(optional)
This structure contains the attributes that determine the goal of an SLO.
requestBasedSli?
Type:
IResolvable | Request
(optional)
A structure containing information about the performance metric that this SLO monitors, if this is a request-based SLO.
sli?
Type:
IResolvable | Sli
(optional)
A structure containing information about the performance metric that this SLO monitors, if this is a period-based SLO.
tags?
Type:
Cfn[]
(optional)
A list of key-value pairs to associate with the SLO.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
| Name | Description |
|---|---|
| add | Syntactic sugar for addOverride(path, undefined). |
| add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
| add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
| add | Add a value to the CloudFormation Resource Metadata. |
| add | Adds an override to the synthesized CloudFormation resource. |
| add | Adds an override that deletes the value of a property from the resource definition. |
| add | Adds an override to a resource property. |
| apply | Sets the deletion policy of the resource based on the removal policy specified. |
| get | Returns a token for an runtime attribute of this resource. |
| get | Retrieve a value value from the CloudFormation Resource Metadata. |
| inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
| obtain | Retrieves an array of resources this resource depends on. |
| obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
| override | Overrides the auto-generated logical ID with a specific ID. |
| remove | Indicates that this resource no longer depends on another resource. |
| replace | Replaces one dependency with another. |
| to | Returns a string representation of this construct. |
| protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined).
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
CfnResource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
CfnResource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string - value
any
Add a value to the CloudFormation Resource Metadata.
See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string— - The path of the property, you can use dot notation to override values in complex types. - value
any— - The value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use addPropertyOverride or prefix path with
"Properties." (i.e. Properties.TopicName).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal . in the property name, prefix with a \. In most
programming languages you will need to write this as "\\." because the
\ itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value argument to addOverride will not be processed or translated
in any way. Pass raw JSON values in here with the correct capitalization
for CloudFormation. If you pass CDK classes or structs, they will be
rendered with lowercased key names, and CloudFormation will reject the
template.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string— The path of the property. - value
any— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value).
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
RemovalPolicy - options
RemovalPolicy Options
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT). A list of resources that support this policy
can be found in the following link:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string— The name of the attribute. - typeHint
ResolutionType Hint
Returns
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack|CfnResource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
CfnResource
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn— The dependency to replace.Resource - newTarget
Cfn— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }