CfnServiceLevelObjective L1 construct
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
ts
// 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: {
compositeSliConfig: {
selectionConfig: {
type: 'type',
// the properties below are optional
pattern: 'pattern',
},
// the properties below are optional
compositeSliComponents: [{
operationName: 'operationName',
}],
},
dependencyConfig: {
dependencyKeyAttributes: {
dependencyKeyAttributesKey: 'dependencyKeyAttributes',
},
dependencyOperationName: 'dependencyOperationName',
},
keyAttributes: {
keyAttributesKey: 'keyAttributes',
},
metricName: 'metricName',
metricSource: {
metricSourceKeyAttributes: {
metricSourceKeyAttributesKey: 'metricSourceKeyAttributes',
},
// the properties below are optional
metricSourceAttributes: {
metricSourceAttributesKey: 'metricSourceAttributes',
},
},
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: {
compositeSliConfig: {
selectionConfig: {
type: 'type',
// the properties below are optional
pattern: 'pattern',
},
// the properties below are optional
compositeSliComponents: [{
operationName: 'operationName',
}],
},
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,
}],
metricName: 'metricName',
metricSource: {
metricSourceKeyAttributes: {
metricSourceKeyAttributesKey: 'metricSourceKeyAttributes',
},
// the properties below are optional
metricSourceAttributes: {
metricSourceAttributesKey: 'metricSourceAttributes',
},
},
metricType: 'metricType',
operationName: 'operationName',
periodSeconds: 123,
statistic: 'statistic',
},
},
tags: [{
key: 'key',
value: 'value',
}],
});
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_applicationsignals as applicationsignals
cfn_service_level_objective = applicationsignals.CfnServiceLevelObjective(self, "MyCfnServiceLevelObjective",
name="name",
# the properties below are optional
burn_rate_configurations=[applicationsignals.CfnServiceLevelObjective.BurnRateConfigurationProperty(
look_back_window_minutes=123
)],
description="description",
exclusion_windows=[applicationsignals.CfnServiceLevelObjective.ExclusionWindowProperty(
window=applicationsignals.CfnServiceLevelObjective.WindowProperty(
duration=123,
duration_unit="durationUnit"
),
# the properties below are optional
reason="reason",
recurrence_rule=applicationsignals.CfnServiceLevelObjective.RecurrenceRuleProperty(
expression="expression"
),
start_time="startTime"
)],
goal=applicationsignals.CfnServiceLevelObjective.GoalProperty(
attainment_goal=123,
interval=applicationsignals.CfnServiceLevelObjective.IntervalProperty(
calendar_interval=applicationsignals.CfnServiceLevelObjective.CalendarIntervalProperty(
duration=123,
duration_unit="durationUnit",
start_time=123
),
rolling_interval=applicationsignals.CfnServiceLevelObjective.RollingIntervalProperty(
duration=123,
duration_unit="durationUnit"
)
),
warning_threshold=123
),
request_based_sli=applicationsignals.CfnServiceLevelObjective.RequestBasedSliProperty(
request_based_sli_metric=applicationsignals.CfnServiceLevelObjective.RequestBasedSliMetricProperty(
composite_sli_config=applicationsignals.CfnServiceLevelObjective.CompositeSliConfigProperty(
selection_config=applicationsignals.CfnServiceLevelObjective.SelectionConfigProperty(
type="type",
# the properties below are optional
pattern="pattern"
),
# the properties below are optional
composite_sli_components=[applicationsignals.CfnServiceLevelObjective.CompositeSliComponentProperty(
operation_name="operationName"
)]
),
dependency_config=applicationsignals.CfnServiceLevelObjective.DependencyConfigProperty(
dependency_key_attributes={
"dependency_key_attributes_key": "dependencyKeyAttributes"
},
dependency_operation_name="dependencyOperationName"
),
key_attributes={
"key_attributes_key": "keyAttributes"
},
metric_name="metricName",
metric_source=applicationsignals.CfnServiceLevelObjective.MetricSourceProperty(
metric_source_key_attributes={
"metric_source_key_attributes_key": "metricSourceKeyAttributes"
},
# the properties below are optional
metric_source_attributes={
"metric_source_attributes_key": "metricSourceAttributes"
}
),
metric_type="metricType",
monitored_request_count_metric=applicationsignals.CfnServiceLevelObjective.MonitoredRequestCountMetricProperty(
bad_count_metric=[applicationsignals.CfnServiceLevelObjective.MetricDataQueryProperty(
id="id",
# the properties below are optional
account_id="accountId",
expression="expression",
metric_stat=applicationsignals.CfnServiceLevelObjective.MetricStatProperty(
metric=applicationsignals.CfnServiceLevelObjective.MetricProperty(
dimensions=[applicationsignals.CfnServiceLevelObjective.DimensionProperty(
name="name",
value="value"
)],
metric_name="metricName",
namespace="namespace"
),
period=123,
stat="stat",
# the properties below are optional
unit="unit"
),
return_data=False
)],
good_count_metric=[applicationsignals.CfnServiceLevelObjective.MetricDataQueryProperty(
id="id",
# the properties below are optional
account_id="accountId",
expression="expression",
metric_stat=applicationsignals.CfnServiceLevelObjective.MetricStatProperty(
metric=applicationsignals.CfnServiceLevelObjective.MetricProperty(
dimensions=[applicationsignals.CfnServiceLevelObjective.DimensionProperty(
name="name",
value="value"
)],
metric_name="metricName",
namespace="namespace"
),
period=123,
stat="stat",
# the properties below are optional
unit="unit"
),
return_data=False
)]
),
operation_name="operationName",
total_request_count_metric=[applicationsignals.CfnServiceLevelObjective.MetricDataQueryProperty(
id="id",
# the properties below are optional
account_id="accountId",
expression="expression",
metric_stat=applicationsignals.CfnServiceLevelObjective.MetricStatProperty(
metric=applicationsignals.CfnServiceLevelObjective.MetricProperty(
dimensions=[applicationsignals.CfnServiceLevelObjective.DimensionProperty(
name="name",
value="value"
)],
metric_name="metricName",
namespace="namespace"
),
period=123,
stat="stat",
# the properties below are optional
unit="unit"
),
return_data=False
)]
),
# the properties below are optional
comparison_operator="comparisonOperator",
metric_threshold=123
),
sli=applicationsignals.CfnServiceLevelObjective.SliProperty(
comparison_operator="comparisonOperator",
metric_threshold=123,
sli_metric=applicationsignals.CfnServiceLevelObjective.SliMetricProperty(
composite_sli_config=applicationsignals.CfnServiceLevelObjective.CompositeSliConfigProperty(
selection_config=applicationsignals.CfnServiceLevelObjective.SelectionConfigProperty(
type="type",
# the properties below are optional
pattern="pattern"
),
# the properties below are optional
composite_sli_components=[applicationsignals.CfnServiceLevelObjective.CompositeSliComponentProperty(
operation_name="operationName"
)]
),
dependency_config=applicationsignals.CfnServiceLevelObjective.DependencyConfigProperty(
dependency_key_attributes={
"dependency_key_attributes_key": "dependencyKeyAttributes"
},
dependency_operation_name="dependencyOperationName"
),
key_attributes={
"key_attributes_key": "keyAttributes"
},
metric_data_queries=[applicationsignals.CfnServiceLevelObjective.MetricDataQueryProperty(
id="id",
# the properties below are optional
account_id="accountId",
expression="expression",
metric_stat=applicationsignals.CfnServiceLevelObjective.MetricStatProperty(
metric=applicationsignals.CfnServiceLevelObjective.MetricProperty(
dimensions=[applicationsignals.CfnServiceLevelObjective.DimensionProperty(
name="name",
value="value"
)],
metric_name="metricName",
namespace="namespace"
),
period=123,
stat="stat",
# the properties below are optional
unit="unit"
),
return_data=False
)],
metric_name="metricName",
metric_source=applicationsignals.CfnServiceLevelObjective.MetricSourceProperty(
metric_source_key_attributes={
"metric_source_key_attributes_key": "metricSourceKeyAttributes"
},
# the properties below are optional
metric_source_attributes={
"metric_source_attributes_key": "metricSourceAttributes"
}
),
metric_type="metricType",
operation_name="operationName",
period_seconds=123,
statistic="statistic"
)
),
tags=[CfnTag(
key="key",
value="value"
)]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.applicationsignals.*;
CfnServiceLevelObjective cfnServiceLevelObjective = CfnServiceLevelObjective.Builder.create(this, "MyCfnServiceLevelObjective")
.name("name")
// the properties below are optional
.burnRateConfigurations(List.of(BurnRateConfigurationProperty.builder()
.lookBackWindowMinutes(123)
.build()))
.description("description")
.exclusionWindows(List.of(ExclusionWindowProperty.builder()
.window(WindowProperty.builder()
.duration(123)
.durationUnit("durationUnit")
.build())
// the properties below are optional
.reason("reason")
.recurrenceRule(RecurrenceRuleProperty.builder()
.expression("expression")
.build())
.startTime("startTime")
.build()))
.goal(GoalProperty.builder()
.attainmentGoal(123)
.interval(IntervalProperty.builder()
.calendarInterval(CalendarIntervalProperty.builder()
.duration(123)
.durationUnit("durationUnit")
.startTime(123)
.build())
.rollingInterval(RollingIntervalProperty.builder()
.duration(123)
.durationUnit("durationUnit")
.build())
.build())
.warningThreshold(123)
.build())
.requestBasedSli(RequestBasedSliProperty.builder()
.requestBasedSliMetric(RequestBasedSliMetricProperty.builder()
.compositeSliConfig(CompositeSliConfigProperty.builder()
.selectionConfig(SelectionConfigProperty.builder()
.type("type")
// the properties below are optional
.pattern("pattern")
.build())
// the properties below are optional
.compositeSliComponents(List.of(CompositeSliComponentProperty.builder()
.operationName("operationName")
.build()))
.build())
.dependencyConfig(DependencyConfigProperty.builder()
.dependencyKeyAttributes(Map.of(
"dependencyKeyAttributesKey", "dependencyKeyAttributes"))
.dependencyOperationName("dependencyOperationName")
.build())
.keyAttributes(Map.of(
"keyAttributesKey", "keyAttributes"))
.metricName("metricName")
.metricSource(MetricSourceProperty.builder()
.metricSourceKeyAttributes(Map.of(
"metricSourceKeyAttributesKey", "metricSourceKeyAttributes"))
// the properties below are optional
.metricSourceAttributes(Map.of(
"metricSourceAttributesKey", "metricSourceAttributes"))
.build())
.metricType("metricType")
.monitoredRequestCountMetric(MonitoredRequestCountMetricProperty.builder()
.badCountMetric(List.of(MetricDataQueryProperty.builder()
.id("id")
// the properties below are optional
.accountId("accountId")
.expression("expression")
.metricStat(MetricStatProperty.builder()
.metric(MetricProperty.builder()
.dimensions(List.of(DimensionProperty.builder()
.name("name")
.value("value")
.build()))
.metricName("metricName")
.namespace("namespace")
.build())
.period(123)
.stat("stat")
// the properties below are optional
.unit("unit")
.build())
.returnData(false)
.build()))
.goodCountMetric(List.of(MetricDataQueryProperty.builder()
.id("id")
// the properties below are optional
.accountId("accountId")
.expression("expression")
.metricStat(MetricStatProperty.builder()
.metric(MetricProperty.builder()
.dimensions(List.of(DimensionProperty.builder()
.name("name")
.value("value")
.build()))
.metricName("metricName")
.namespace("namespace")
.build())
.period(123)
.stat("stat")
// the properties below are optional
.unit("unit")
.build())
.returnData(false)
.build()))
.build())
.operationName("operationName")
.totalRequestCountMetric(List.of(MetricDataQueryProperty.builder()
.id("id")
// the properties below are optional
.accountId("accountId")
.expression("expression")
.metricStat(MetricStatProperty.builder()
.metric(MetricProperty.builder()
.dimensions(List.of(DimensionProperty.builder()
.name("name")
.value("value")
.build()))
.metricName("metricName")
.namespace("namespace")
.build())
.period(123)
.stat("stat")
// the properties below are optional
.unit("unit")
.build())
.returnData(false)
.build()))
.build())
// the properties below are optional
.comparisonOperator("comparisonOperator")
.metricThreshold(123)
.build())
.sli(SliProperty.builder()
.comparisonOperator("comparisonOperator")
.metricThreshold(123)
.sliMetric(SliMetricProperty.builder()
.compositeSliConfig(CompositeSliConfigProperty.builder()
.selectionConfig(SelectionConfigProperty.builder()
.type("type")
// the properties below are optional
.pattern("pattern")
.build())
// the properties below are optional
.compositeSliComponents(List.of(CompositeSliComponentProperty.builder()
.operationName("operationName")
.build()))
.build())
.dependencyConfig(DependencyConfigProperty.builder()
.dependencyKeyAttributes(Map.of(
"dependencyKeyAttributesKey", "dependencyKeyAttributes"))
.dependencyOperationName("dependencyOperationName")
.build())
.keyAttributes(Map.of(
"keyAttributesKey", "keyAttributes"))
.metricDataQueries(List.of(MetricDataQueryProperty.builder()
.id("id")
// the properties below are optional
.accountId("accountId")
.expression("expression")
.metricStat(MetricStatProperty.builder()
.metric(MetricProperty.builder()
.dimensions(List.of(DimensionProperty.builder()
.name("name")
.value("value")
.build()))
.metricName("metricName")
.namespace("namespace")
.build())
.period(123)
.stat("stat")
// the properties below are optional
.unit("unit")
.build())
.returnData(false)
.build()))
.metricName("metricName")
.metricSource(MetricSourceProperty.builder()
.metricSourceKeyAttributes(Map.of(
"metricSourceKeyAttributesKey", "metricSourceKeyAttributes"))
// the properties below are optional
.metricSourceAttributes(Map.of(
"metricSourceAttributesKey", "metricSourceAttributes"))
.build())
.metricType("metricType")
.operationName("operationName")
.periodSeconds(123)
.statistic("statistic")
.build())
.build())
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ApplicationSignals;
var cfnServiceLevelObjective = new CfnServiceLevelObjective(this, "MyCfnServiceLevelObjective", new CfnServiceLevelObjectiveProps {
Name = "name",
// the properties below are optional
BurnRateConfigurations = new [] { new BurnRateConfigurationProperty {
LookBackWindowMinutes = 123
} },
Description = "description",
ExclusionWindows = new [] { new ExclusionWindowProperty {
Window = new WindowProperty {
Duration = 123,
DurationUnit = "durationUnit"
},
// the properties below are optional
Reason = "reason",
RecurrenceRule = new RecurrenceRuleProperty {
Expression = "expression"
},
StartTime = "startTime"
} },
Goal = new GoalProperty {
AttainmentGoal = 123,
Interval = new IntervalProperty {
CalendarInterval = new CalendarIntervalProperty {
Duration = 123,
DurationUnit = "durationUnit",
StartTime = 123
},
RollingInterval = new RollingIntervalProperty {
Duration = 123,
DurationUnit = "durationUnit"
}
},
WarningThreshold = 123
},
RequestBasedSli = new RequestBasedSliProperty {
RequestBasedSliMetric = new RequestBasedSliMetricProperty {
CompositeSliConfig = new CompositeSliConfigProperty {
SelectionConfig = new SelectionConfigProperty {
Type = "type",
// the properties below are optional
Pattern = "pattern"
},
// the properties below are optional
CompositeSliComponents = new [] { new CompositeSliComponentProperty {
OperationName = "operationName"
} }
},
DependencyConfig = new DependencyConfigProperty {
DependencyKeyAttributes = new Dictionary<string, string> {
{ "dependencyKeyAttributesKey", "dependencyKeyAttributes" }
},
DependencyOperationName = "dependencyOperationName"
},
KeyAttributes = new Dictionary<string, string> {
{ "keyAttributesKey", "keyAttributes" }
},
MetricName = "metricName",
MetricSource = new MetricSourceProperty {
MetricSourceKeyAttributes = new Dictionary<string, string> {
{ "metricSourceKeyAttributesKey", "metricSourceKeyAttributes" }
},
// the properties below are optional
MetricSourceAttributes = new Dictionary<string, string> {
{ "metricSourceAttributesKey", "metricSourceAttributes" }
}
},
MetricType = "metricType",
MonitoredRequestCountMetric = new MonitoredRequestCountMetricProperty {
BadCountMetric = new [] { new MetricDataQueryProperty {
Id = "id",
// the properties below are optional
AccountId = "accountId",
Expression = "expression",
MetricStat = new MetricStatProperty {
Metric = new MetricProperty {
Dimensions = new [] { new DimensionProperty {
Name = "name",
Value = "value"
} },
MetricName = "metricName",
Namespace = "namespace"
},
Period = 123,
Stat = "stat",
// the properties below are optional
Unit = "unit"
},
ReturnData = false
} },
GoodCountMetric = new [] { new MetricDataQueryProperty {
Id = "id",
// the properties below are optional
AccountId = "accountId",
Expression = "expression",
MetricStat = new MetricStatProperty {
Metric = new MetricProperty {
Dimensions = new [] { new DimensionProperty {
Name = "name",
Value = "value"
} },
MetricName = "metricName",
Namespace = "namespace"
},
Period = 123,
Stat = "stat",
// the properties below are optional
Unit = "unit"
},
ReturnData = false
} }
},
OperationName = "operationName",
TotalRequestCountMetric = new [] { new MetricDataQueryProperty {
Id = "id",
// the properties below are optional
AccountId = "accountId",
Expression = "expression",
MetricStat = new MetricStatProperty {
Metric = new MetricProperty {
Dimensions = new [] { new DimensionProperty {
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 = new SliProperty {
ComparisonOperator = "comparisonOperator",
MetricThreshold = 123,
SliMetric = new SliMetricProperty {
CompositeSliConfig = new CompositeSliConfigProperty {
SelectionConfig = new SelectionConfigProperty {
Type = "type",
// the properties below are optional
Pattern = "pattern"
},
// the properties below are optional
CompositeSliComponents = new [] { new CompositeSliComponentProperty {
OperationName = "operationName"
} }
},
DependencyConfig = new DependencyConfigProperty {
DependencyKeyAttributes = new Dictionary<string, string> {
{ "dependencyKeyAttributesKey", "dependencyKeyAttributes" }
},
DependencyOperationName = "dependencyOperationName"
},
KeyAttributes = new Dictionary<string, string> {
{ "keyAttributesKey", "keyAttributes" }
},
MetricDataQueries = new [] { new MetricDataQueryProperty {
Id = "id",
// the properties below are optional
AccountId = "accountId",
Expression = "expression",
MetricStat = new MetricStatProperty {
Metric = new MetricProperty {
Dimensions = new [] { new DimensionProperty {
Name = "name",
Value = "value"
} },
MetricName = "metricName",
Namespace = "namespace"
},
Period = 123,
Stat = "stat",
// the properties below are optional
Unit = "unit"
},
ReturnData = false
} },
MetricName = "metricName",
MetricSource = new MetricSourceProperty {
MetricSourceKeyAttributes = new Dictionary<string, string> {
{ "metricSourceKeyAttributesKey", "metricSourceKeyAttributes" }
},
// the properties below are optional
MetricSourceAttributes = new Dictionary<string, string> {
{ "metricSourceAttributesKey", "metricSourceAttributes" }
}
},
MetricType = "metricType",
OperationName = "operationName",
PeriodSeconds = 123,
Statistic = "statistic"
}
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnServiceLevelObjective := awscdk.Aws_applicationsignals.NewCfnServiceLevelObjective(this, jsii.String("MyCfnServiceLevelObjective"), &CfnServiceLevelObjectiveProps{
Name: jsii.String("name"),
// the properties below are optional
BurnRateConfigurations: []interface{}{
&BurnRateConfigurationProperty{
LookBackWindowMinutes: jsii.Number(123),
},
},
Description: jsii.String("description"),
ExclusionWindows: []interface{}{
&ExclusionWindowProperty{
Window: &WindowProperty{
Duration: jsii.Number(123),
DurationUnit: jsii.String("durationUnit"),
},
// the properties below are optional
Reason: jsii.String("reason"),
RecurrenceRule: &RecurrenceRuleProperty{
Expression: jsii.String("expression"),
},
StartTime: jsii.String("startTime"),
},
},
Goal: &GoalProperty{
AttainmentGoal: jsii.Number(123),
Interval: &IntervalProperty{
CalendarInterval: &CalendarIntervalProperty{
Duration: jsii.Number(123),
DurationUnit: jsii.String("durationUnit"),
StartTime: jsii.Number(123),
},
RollingInterval: &RollingIntervalProperty{
Duration: jsii.Number(123),
DurationUnit: jsii.String("durationUnit"),
},
},
WarningThreshold: jsii.Number(123),
},
RequestBasedSli: &RequestBasedSliProperty{
RequestBasedSliMetric: &RequestBasedSliMetricProperty{
CompositeSliConfig: &CompositeSliConfigProperty{
SelectionConfig: &SelectionConfigProperty{
Type: jsii.String("type"),
// the properties below are optional
Pattern: jsii.String("pattern"),
},
// the properties below are optional
CompositeSliComponents: []interface{}{
&CompositeSliComponentProperty{
OperationName: jsii.String("operationName"),
},
},
},
DependencyConfig: &DependencyConfigProperty{
DependencyKeyAttributes: map[string]*string{
"dependencyKeyAttributesKey": jsii.String("dependencyKeyAttributes"),
},
DependencyOperationName: jsii.String("dependencyOperationName"),
},
KeyAttributes: map[string]*string{
"keyAttributesKey": jsii.String("keyAttributes"),
},
MetricName: jsii.String("metricName"),
MetricSource: &MetricSourceProperty{
MetricSourceKeyAttributes: map[string]*string{
"metricSourceKeyAttributesKey": jsii.String("metricSourceKeyAttributes"),
},
// the properties below are optional
MetricSourceAttributes: map[string]*string{
"metricSourceAttributesKey": jsii.String("metricSourceAttributes"),
},
},
MetricType: jsii.String("metricType"),
MonitoredRequestCountMetric: &MonitoredRequestCountMetricProperty{
BadCountMetric: []interface{}{
&MetricDataQueryProperty{
Id: jsii.String("id"),
// the properties below are optional
AccountId: jsii.String("accountId"),
Expression: jsii.String("expression"),
MetricStat: &MetricStatProperty{
Metric: &MetricProperty{
Dimensions: []interface{}{
&DimensionProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
MetricName: jsii.String("metricName"),
Namespace: jsii.String("namespace"),
},
Period: jsii.Number(123),
Stat: jsii.String("stat"),
// the properties below are optional
Unit: jsii.String("unit"),
},
ReturnData: jsii.Boolean(false),
},
},
GoodCountMetric: []interface{}{
&MetricDataQueryProperty{
Id: jsii.String("id"),
// the properties below are optional
AccountId: jsii.String("accountId"),
Expression: jsii.String("expression"),
MetricStat: &MetricStatProperty{
Metric: &MetricProperty{
Dimensions: []interface{}{
&DimensionProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
MetricName: jsii.String("metricName"),
Namespace: jsii.String("namespace"),
},
Period: jsii.Number(123),
Stat: jsii.String("stat"),
// the properties below are optional
Unit: jsii.String("unit"),
},
ReturnData: jsii.Boolean(false),
},
},
},
OperationName: jsii.String("operationName"),
TotalRequestCountMetric: []interface{}{
&MetricDataQueryProperty{
Id: jsii.String("id"),
// the properties below are optional
AccountId: jsii.String("accountId"),
Expression: jsii.String("expression"),
MetricStat: &MetricStatProperty{
Metric: &MetricProperty{
Dimensions: []interface{}{
&DimensionProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
MetricName: jsii.String("metricName"),
Namespace: jsii.String("namespace"),
},
Period: jsii.Number(123),
Stat: jsii.String("stat"),
// the properties below are optional
Unit: jsii.String("unit"),
},
ReturnData: jsii.Boolean(false),
},
},
},
// the properties below are optional
ComparisonOperator: jsii.String("comparisonOperator"),
MetricThreshold: jsii.Number(123),
},
Sli: &SliProperty{
ComparisonOperator: jsii.String("comparisonOperator"),
MetricThreshold: jsii.Number(123),
SliMetric: &SliMetricProperty{
CompositeSliConfig: &CompositeSliConfigProperty{
SelectionConfig: &SelectionConfigProperty{
Type: jsii.String("type"),
// the properties below are optional
Pattern: jsii.String("pattern"),
},
// the properties below are optional
CompositeSliComponents: []interface{}{
&CompositeSliComponentProperty{
OperationName: jsii.String("operationName"),
},
},
},
DependencyConfig: &DependencyConfigProperty{
DependencyKeyAttributes: map[string]*string{
"dependencyKeyAttributesKey": jsii.String("dependencyKeyAttributes"),
},
DependencyOperationName: jsii.String("dependencyOperationName"),
},
KeyAttributes: map[string]*string{
"keyAttributesKey": jsii.String("keyAttributes"),
},
MetricDataQueries: []interface{}{
&MetricDataQueryProperty{
Id: jsii.String("id"),
// the properties below are optional
AccountId: jsii.String("accountId"),
Expression: jsii.String("expression"),
MetricStat: &MetricStatProperty{
Metric: &MetricProperty{
Dimensions: []interface{}{
&DimensionProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
MetricName: jsii.String("metricName"),
Namespace: jsii.String("namespace"),
},
Period: jsii.Number(123),
Stat: jsii.String("stat"),
// the properties below are optional
Unit: jsii.String("unit"),
},
ReturnData: jsii.Boolean(false),
},
},
MetricName: jsii.String("metricName"),
MetricSource: &MetricSourceProperty{
MetricSourceKeyAttributes: map[string]*string{
"metricSourceKeyAttributesKey": jsii.String("metricSourceKeyAttributes"),
},
// the properties below are optional
MetricSourceAttributes: map[string]*string{
"metricSourceAttributesKey": jsii.String("metricSourceAttributes"),
},
},
MetricType: jsii.String("metricType"),
OperationName: jsii.String("operationName"),
PeriodSeconds: jsii.Number(123),
Statistic: jsii.String("statistic"),
},
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
Initializer
ts
new CfnServiceLevelObjective(scope: Construct, id: string, props: CfnServiceLevelObjectiveProps)
python
CfnServiceLevelObjective(scope: Construct, id: str, props: CfnServiceLevelObjectiveProps)
java
new CfnServiceLevelObjective(Construct scope, String id, CfnServiceLevelObjectiveProps props)
csharp
new CfnServiceLevelObjective(Construct scope, string id, CfnServiceLevelObjectiveProps props)
go
NewCfnServiceLevelObjective(Scope Construct, Id *string, Props CfnServiceLevelObjectiveProps)
Construct Props
burnRateConfigurationsoptionalIResolvable | IResolvable | CfnServiceLevelObjective.BurnRateConfigurationProperty[]burn_rate_configurationsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, BurnRateConfigurationProperty]]]burnRateConfigurationsoptionalIResolvableBurnRateConfigurationsoptionalIResolvableBurnRateConfigurationsoptionalinterface{}#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.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#An optional description for this SLO.
Default: "No description"
exclusionWindowsoptionalIResolvable | IResolvable | CfnServiceLevelObjective.ExclusionWindowProperty[]exclusion_windowsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ExclusionWindowProperty]]]exclusionWindowsoptionalIResolvableExclusionWindowsoptionalIResolvableExclusionWindowsoptionalinterface{}#The time window to be excluded from the SLO performance metrics.
goaloptionalIResolvable | CfnServiceLevelObjective.GoalPropertygoaloptionaltyping.Union[IResolvable, GoalProperty]goaloptionalIResolvableGoaloptionalIResolvableGoaloptionalinterface{}#This structure contains the attributes that determine the goal of an SLO.
This includes the time period for evaluation and the attainment threshold.
A name for this SLO.
requestBasedSlioptionalIResolvable | CfnServiceLevelObjective.RequestBasedSliPropertyrequest_based_slioptionaltyping.Union[IResolvable, RequestBasedSliProperty]requestBasedSlioptionalIResolvableRequestBasedSlioptionalIResolvableRequestBasedSlioptionalinterface{}#A structure containing information about the performance metric that this SLO monitors, if this is a request-based SLO.
slioptionalIResolvable | CfnServiceLevelObjective.SliPropertyslioptionaltyping.Union[IResolvable, SliProperty]slioptionalIResolvableSlioptionalIResolvableSlioptionalinterface{}#A structure containing information about the performance metric that this SLO monitors, if this is a period-based SLO.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#A list of key-value pairs to associate with the SLO.
notes
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
The ARN of this SLO.
attrCreatedTimenumberattr_created_timeint | floatattrCreatedTimeNumberAttrCreatedTimedoubleAttrCreatedTime*float64required#The date and time that this SLO was created.
attrEvaluationTypestringattr_evaluation_typestrattrEvaluationTypeStringAttrEvaluationTypestringAttrEvaluationType*stringrequired#Displays whether this is a period-based SLO or a request-based SLO.
attrLastUpdatedTimenumberattr_last_updated_timeint | floatattrLastUpdatedTimeNumberAttrLastUpdatedTimedoubleAttrLastUpdatedTime*float64required#The time that this SLO was most recently updated.
burnRateConfigurationsmay be undefinedIResolvable | IResolvable | CfnServiceLevelObjective.BurnRateConfigurationProperty[]burn_rate_configurationsmay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, BurnRateConfigurationProperty]]]burnRateConfigurationsmay be undefinedIResolvableBurnRateConfigurationsmay be undefinedIResolvableBurnRateConfigurationsmay be undefinedinterface{}#Each object in this array defines the length of the look-back window used to calculate one burn rate metric for this SLO.
cdkTagManagerTagManagercdk_tag_managerTagManagercdkTagManagerTagManagerCdkTagManagerTagManagerCdkTagManagerTagManagerrequired#Tag Manager which manages the tags for this resource.
CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringrequiredstatic#The CloudFormation resource type name for this resource class.
cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsrequired#Options for this resource, such as condition, update policy etc.
cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*stringrequired#AWS resource type.
creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*stringrequired#descriptionmay be undefinedstringdescriptionmay be undefinedstrdescriptionmay be undefinedStringDescriptionmay be undefinedstringDescriptionmay be undefined*string#An optional description for this SLO.
exclusionWindowsmay be undefinedIResolvable | IResolvable | CfnServiceLevelObjective.ExclusionWindowProperty[]exclusion_windowsmay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ExclusionWindowProperty]]]exclusionWindowsmay be undefinedIResolvableExclusionWindowsmay be undefinedIResolvableExclusionWindowsmay be undefinedinterface{}#The time window to be excluded from the SLO performance metrics.
goalmay be undefinedIResolvable | CfnServiceLevelObjective.GoalPropertygoalmay be undefinedtyping.Union[IResolvable, GoalProperty]goalmay be undefinedIResolvableGoalmay be undefinedIResolvableGoalmay be undefinedinterface{}#This structure contains the attributes that determine the goal of an SLO.
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).
A name for this SLO.
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 }).
requestBasedSlimay be undefinedIResolvable | CfnServiceLevelObjective.RequestBasedSliPropertyrequest_based_slimay be undefinedtyping.Union[IResolvable, RequestBasedSliProperty]requestBasedSlimay be undefinedIResolvableRequestBasedSlimay be undefinedIResolvableRequestBasedSlimay be undefinedinterface{}#A structure containing information about the performance metric that this SLO monitors, if this is a request-based SLO.
serviceLevelObjectiveRefServiceLevelObjectiveReferenceservice_level_objective_refServiceLevelObjectiveReferenceserviceLevelObjectiveRefServiceLevelObjectiveReferenceServiceLevelObjectiveRefServiceLevelObjectiveReferenceServiceLevelObjectiveRefServiceLevelObjectiveReferencerequired#A reference to a ServiceLevelObjective resource.
slimay be undefinedIResolvable | CfnServiceLevelObjective.SliPropertyslimay be undefinedtyping.Union[IResolvable, SliProperty]slimay be undefinedIResolvableSlimay be undefinedIResolvableSlimay be undefinedinterface{}#A structure containing information about the performance metric that this SLO monitors, if this is a period-based SLO.
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
Methods
addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#Syntactic sugar for `addOverride(path, undefined)`.
1 parameter
Parameters
pathpathpathpathPath— The path of the value to delete.
addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#Use `addResourceDependency` instead.
This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.
addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#Use `addResourceDependency` instead.
notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.
addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#Add a value to the CloudFormation Resource Metadata.
addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#Adds an override to the synthesized CloudFormation resource.
notes · 2 parameters
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,
typescript
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
json
"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.
Parameters
pathpathpathpathPath— - The path of the property, you can use dot notation to override values in complex types.valuevaluevaluevalueValue— - The value.
addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#Adds an override that deletes the value of a property from the resource definition.
1 parameter
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path to the property.
addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value).
2 parameters
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path of the property.valuevaluevaluevalueValue— The value.
addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#Sets the cross-stack reference strength for this resource.
When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.
1 parameter
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#Sets the deletion policy of the resource based on the removal policy specified.
notes
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:
arnForServiceLevelObjective(resource: IServiceLevelObjectiveRef): string@staticmethod def arn_for_service_level_objective(resource: IServiceLevelObjectiveRef) -> strpublic static String arnForServiceLevelObjective(IServiceLevelObjectiveRef resource)public static string ArnForServiceLevelObjective(IServiceLevelObjectiveRef resource)func ArnForServiceLevelObjective(Resource IServiceLevelObjectiveRef) *stringstatic#cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#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.
1 parameter
Parameters
attributeNameattribute_nameattributeNameattributeNameAttributeName— The name of the attribute.
getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#Examines the CloudFormation resource and discloses attributes.
1 parameter
Parameters
inspectorinspectorinspectorinspectorInspector— tree inspector to collect and process attributes.
isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.
returns
Returns: The construct as a stack element or undefined if it is not a stack element.
isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#Check whether the given object is a CfnResource.
isCfnServiceLevelObjective(x: any): boolean@staticmethod def is_cfn_service_level_objective(x: Any) -> boolpublic static Boolean isCfnServiceLevelObjective(Object x)public static bool IsCfnServiceLevelObjective(object x)func IsCfnServiceLevelObjective(X interface{}) *boolstatic#Checks whether the given object is a CfnServiceLevelObjective.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#Checks if `x` is a construct.
notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#Retrieves an array of resources and stacks this resource depends on.
For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.
overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#Overrides the auto-generated logical ID with a specific ID.
1 parameter
Parameters
newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId— The new logical ID to use for this stack element.
removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#Use `removeResourceDependency` instead
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(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: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#Replaces one dependency with another.
2 parameters
Parameters
targettargettargettargetTarget— The dependency to replace.newTargetnew_targetnewTargetnewTargetNewTarget— The new dependency to add.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#Returns a string representation of this construct.
returns
Returns: a string representation of this resource
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.