Module classic/cognito
APIs
APIs
namespace metrics
function accountTakeOverRisk
accountTakeOverRisk(change?: CognitoMetricChange): Metric
Requests where Amazon Cognito detected account take-over risk.
interface CognitoMetricChange
interface CognitoMetricChange extends MetricChange
property color
color?: pulumi.Input<string>;
The six-digit HTML hex color code to be used for this metric.
Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].
property dimensions
dimensions?: pulumi.Input<Record<string, pulumi.Input<string>>>;
The new dimension for this metric. If this object is missing this property, then no change will be made. However, if the property is there by set to [undefined] then the value will be cleared.
property extendedStatistic
extendedStatistic?: pulumi.Input<number>;
The new percentile statistic for the metric associated with the alarm. If this object is missing this property, then no change will be made. However, if the property is there by set to [undefined] then the value will be set to the default.
property label
label?: pulumi.Input<string>;
The label to display for this metric in the graph legend. If this is not specified, the metric is given an autogenerated label that distinguishes it from the other metrics in the widget.
Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].
property period
period?: pulumi.Input<number>;
The new period in seconds over which the specified stat
is applied. If this object is
missing this property, then no change will be made. However, if the property is there by set
to [undefined] then the value will be set to the default (300s).
property statistic
statistic?: pulumi.Input<MetricStatistic>;
The new statistic to apply to the alarm’s associated metric. If this object is missing this property, then no change will be made. However, if the property is there by set to [undefined] then the value will be set to the default.
property unit
unit?: pulumi.Input<MetricUnit>;
The new unit for this metric. If this object is missing this property, then no change will be made. However, if the property is there by set to [undefined] then the value will be set to the default.
property userPool
userPool?: aws.cognito.UserPool;
Optional [UserPool] this metric should be filtered down to.
property visible
visible?: pulumi.Input<boolean>;
Set this to true to have the metric appear in the graph, or false to have it be hidden. The default is true.
Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].
property yAxis
yAxis?: pulumi.Input<"left" | "right">;
Where on the graph to display the y-axis for this metric. The default is left.
Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].
type CognitoMetricName
type CognitoMetricName = "CompromisedCredentialsRisk" | "AccountTakeOverRisk" | "OverrideBlock" | "Risk" | "NoRisk";
function compromisedCredentialsRisk
compromisedCredentialsRisk(change?: CognitoMetricChange): Metric
Requests where Amazon Cognito detected compromised credentials.
function metric
metric(metricName: CognitoMetricName, change: CognitoMetricChange): Metric
Creates an AWS/Cognito metric with the requested [metricName]. See https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-advanced-security-metrics.html for list of all metric-names.
Note, individual metrics can easily be obtained without supplying the name using the other [metricXXX] functions.
Amazon Cognito publishes metrics for advanced security features to your account in Amazon CloudWatch. The advanced security metrics are grouped together by risk level and also by request level.
function noRisk
noRisk(change?: CognitoMetricChange): Metric
Requests where Amazon Cognito did not identify any risk.
function overrideBlock
overrideBlock(change?: CognitoMetricChange): Metric
Requests that Amazon Cognito blocked because of the configuration provided by the developer.
function risk
risk(change?: CognitoMetricChange): Metric
Requests that Amazon Cognito marked as risky.
Thank you for your feedback!
If you have a question about how to use Pulumi, reach out in Community Slack.
Open an issue on GitHub to report a problem or suggest an improvement.