interface MetricSetProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.LookoutMetrics.CfnAnomalyDetector.MetricSetProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awslookoutmetrics#CfnAnomalyDetector_MetricSetProperty |
![]() | software.amazon.awscdk.services.lookoutmetrics.CfnAnomalyDetector.MetricSetProperty |
![]() | aws_cdk.aws_lookoutmetrics.CfnAnomalyDetector.MetricSetProperty |
![]() | aws-cdk-lib » aws_lookoutmetrics » CfnAnomalyDetector » MetricSetProperty |
Contains information about a dataset.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lookoutmetrics as lookoutmetrics } from 'aws-cdk-lib';
const metricSetProperty: lookoutmetrics.CfnAnomalyDetector.MetricSetProperty = {
metricList: [{
aggregationFunction: 'aggregationFunction',
metricName: 'metricName',
// the properties below are optional
namespace: 'namespace',
}],
metricSetName: 'metricSetName',
metricSource: {
appFlowConfig: {
flowName: 'flowName',
roleArn: 'roleArn',
},
cloudwatchConfig: {
roleArn: 'roleArn',
},
rdsSourceConfig: {
databaseHost: 'databaseHost',
databaseName: 'databaseName',
databasePort: 123,
dbInstanceIdentifier: 'dbInstanceIdentifier',
roleArn: 'roleArn',
secretManagerArn: 'secretManagerArn',
tableName: 'tableName',
vpcConfiguration: {
securityGroupIdList: ['securityGroupIdList'],
subnetIdList: ['subnetIdList'],
},
},
redshiftSourceConfig: {
clusterIdentifier: 'clusterIdentifier',
databaseHost: 'databaseHost',
databaseName: 'databaseName',
databasePort: 123,
roleArn: 'roleArn',
secretManagerArn: 'secretManagerArn',
tableName: 'tableName',
vpcConfiguration: {
securityGroupIdList: ['securityGroupIdList'],
subnetIdList: ['subnetIdList'],
},
},
s3SourceConfig: {
fileFormatDescriptor: {
csvFormatDescriptor: {
charset: 'charset',
containsHeader: false,
delimiter: 'delimiter',
fileCompression: 'fileCompression',
headerList: ['headerList'],
quoteSymbol: 'quoteSymbol',
},
jsonFormatDescriptor: {
charset: 'charset',
fileCompression: 'fileCompression',
},
},
roleArn: 'roleArn',
// the properties below are optional
historicalDataPathList: ['historicalDataPathList'],
templatedPathList: ['templatedPathList'],
},
},
// the properties below are optional
dimensionList: ['dimensionList'],
metricSetDescription: 'metricSetDescription',
metricSetFrequency: 'metricSetFrequency',
offset: 123,
timestampColumn: {
columnFormat: 'columnFormat',
columnName: 'columnName',
},
timezone: 'timezone',
};
Properties
Name | Type | Description |
---|---|---|
metric | IResolvable | IResolvable | Metric [] | A list of metrics that the dataset will contain. |
metric | string | The name of the dataset. |
metric | IResolvable | Metric | Contains information about how the source data should be interpreted. |
dimension | string[] | A list of the fields you want to treat as dimensions. |
metric | string | A description of the dataset you are creating. |
metric | string | The frequency with which the source data will be analyzed for anomalies. |
offset? | number | After an interval ends, the amount of seconds that the detector waits before importing data. |
timestamp | IResolvable | Timestamp | Contains information about the column used for tracking time in your source data. |
timezone? | string | The time zone in which your source data was recorded. |
metricList
Type:
IResolvable
|
IResolvable
|
Metric
[]
A list of metrics that the dataset will contain.
metricSetName
Type:
string
The name of the dataset.
metricSource
Type:
IResolvable
|
Metric
Contains information about how the source data should be interpreted.
dimensionList?
Type:
string[]
(optional)
A list of the fields you want to treat as dimensions.
metricSetDescription?
Type:
string
(optional)
A description of the dataset you are creating.
metricSetFrequency?
Type:
string
(optional)
The frequency with which the source data will be analyzed for anomalies.
offset?
Type:
number
(optional)
After an interval ends, the amount of seconds that the detector waits before importing data.
Offset is only supported for S3, Redshift, Athena and datasources.
timestampColumn?
Type:
IResolvable
|
Timestamp
(optional)
Contains information about the column used for tracking time in your source data.
timezone?
Type:
string
(optional)
The time zone in which your source data was recorded.