1. Packages
  2. AWS Native
  3. API Docs
  4. lookoutmetrics
  5. Alert

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

aws-native.lookoutmetrics.Alert

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

    Resource Type definition for AWS::LookoutMetrics::Alert

    Create Alert Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Alert(name: string, args: AlertArgs, opts?: CustomResourceOptions);
    @overload
    def Alert(resource_name: str,
              args: AlertArgs,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Alert(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              action: Optional[AlertActionArgs] = None,
              alert_sensitivity_threshold: Optional[int] = None,
              anomaly_detector_arn: Optional[str] = None,
              alert_description: Optional[str] = None,
              alert_name: Optional[str] = None)
    func NewAlert(ctx *Context, name string, args AlertArgs, opts ...ResourceOption) (*Alert, error)
    public Alert(string name, AlertArgs args, CustomResourceOptions? opts = null)
    public Alert(String name, AlertArgs args)
    public Alert(String name, AlertArgs args, CustomResourceOptions options)
    
    type: aws-native:lookoutmetrics:Alert
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args AlertArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AlertArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AlertArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AlertArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AlertArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const alertResource = new aws_native.lookoutmetrics.Alert("alertResource", {
        action: {
            lambdaConfiguration: {
                lambdaArn: "string",
                roleArn: "string",
            },
            snsConfiguration: {
                roleArn: "string",
                snsTopicArn: "string",
            },
        },
        alertSensitivityThreshold: 0,
        anomalyDetectorArn: "string",
        alertDescription: "string",
        alertName: "string",
    });
    
    Coming soon!
    

    Alert Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Alert resource accepts the following input properties:

    Action Pulumi.AwsNative.LookoutMetrics.Inputs.AlertAction
    The action to be taken by the alert when an anomaly is detected.
    AlertSensitivityThreshold int
    A number between 0 and 100 (inclusive) that tunes the sensitivity of the alert.
    AnomalyDetectorArn string
    The Amazon resource name (ARN) of the Anomaly Detector to alert.
    AlertDescription string
    A description for the alert.
    AlertName string
    The name of the alert. If not provided, a name is generated automatically.
    Action AlertActionArgs
    The action to be taken by the alert when an anomaly is detected.
    AlertSensitivityThreshold int
    A number between 0 and 100 (inclusive) that tunes the sensitivity of the alert.
    AnomalyDetectorArn string
    The Amazon resource name (ARN) of the Anomaly Detector to alert.
    AlertDescription string
    A description for the alert.
    AlertName string
    The name of the alert. If not provided, a name is generated automatically.
    action AlertAction
    The action to be taken by the alert when an anomaly is detected.
    alertSensitivityThreshold Integer
    A number between 0 and 100 (inclusive) that tunes the sensitivity of the alert.
    anomalyDetectorArn String
    The Amazon resource name (ARN) of the Anomaly Detector to alert.
    alertDescription String
    A description for the alert.
    alertName String
    The name of the alert. If not provided, a name is generated automatically.
    action AlertAction
    The action to be taken by the alert when an anomaly is detected.
    alertSensitivityThreshold number
    A number between 0 and 100 (inclusive) that tunes the sensitivity of the alert.
    anomalyDetectorArn string
    The Amazon resource name (ARN) of the Anomaly Detector to alert.
    alertDescription string
    A description for the alert.
    alertName string
    The name of the alert. If not provided, a name is generated automatically.
    action AlertActionArgs
    The action to be taken by the alert when an anomaly is detected.
    alert_sensitivity_threshold int
    A number between 0 and 100 (inclusive) that tunes the sensitivity of the alert.
    anomaly_detector_arn str
    The Amazon resource name (ARN) of the Anomaly Detector to alert.
    alert_description str
    A description for the alert.
    alert_name str
    The name of the alert. If not provided, a name is generated automatically.
    action Property Map
    The action to be taken by the alert when an anomaly is detected.
    alertSensitivityThreshold Number
    A number between 0 and 100 (inclusive) that tunes the sensitivity of the alert.
    anomalyDetectorArn String
    The Amazon resource name (ARN) of the Anomaly Detector to alert.
    alertDescription String
    A description for the alert.
    alertName String
    The name of the alert. If not provided, a name is generated automatically.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Alert resource produces the following output properties:

    Arn string
    ARN assigned to the alert.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    ARN assigned to the alert.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    ARN assigned to the alert.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    ARN assigned to the alert.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    ARN assigned to the alert.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    ARN assigned to the alert.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    AlertAction, AlertActionArgs

    LambdaConfiguration AlertLambdaConfiguration
    A configuration for an AWS Lambda channel.
    SnsConfiguration AlertSnsConfiguration
    A configuration for an Amazon SNS channel.
    lambdaConfiguration AlertLambdaConfiguration
    A configuration for an AWS Lambda channel.
    snsConfiguration AlertSnsConfiguration
    A configuration for an Amazon SNS channel.
    lambdaConfiguration AlertLambdaConfiguration
    A configuration for an AWS Lambda channel.
    snsConfiguration AlertSnsConfiguration
    A configuration for an Amazon SNS channel.
    lambda_configuration AlertLambdaConfiguration
    A configuration for an AWS Lambda channel.
    sns_configuration AlertSnsConfiguration
    A configuration for an Amazon SNS channel.
    lambdaConfiguration Property Map
    A configuration for an AWS Lambda channel.
    snsConfiguration Property Map
    A configuration for an Amazon SNS channel.

    AlertLambdaConfiguration, AlertLambdaConfigurationArgs

    LambdaArn string
    ARN of a Lambda to send alert notifications to.
    RoleArn string
    ARN of an IAM role that LookoutMetrics should assume to access the Lambda function.
    LambdaArn string
    ARN of a Lambda to send alert notifications to.
    RoleArn string
    ARN of an IAM role that LookoutMetrics should assume to access the Lambda function.
    lambdaArn String
    ARN of a Lambda to send alert notifications to.
    roleArn String
    ARN of an IAM role that LookoutMetrics should assume to access the Lambda function.
    lambdaArn string
    ARN of a Lambda to send alert notifications to.
    roleArn string
    ARN of an IAM role that LookoutMetrics should assume to access the Lambda function.
    lambda_arn str
    ARN of a Lambda to send alert notifications to.
    role_arn str
    ARN of an IAM role that LookoutMetrics should assume to access the Lambda function.
    lambdaArn String
    ARN of a Lambda to send alert notifications to.
    roleArn String
    ARN of an IAM role that LookoutMetrics should assume to access the Lambda function.

    AlertSnsConfiguration, AlertSnsConfigurationArgs

    RoleArn string
    ARN of an IAM role that LookoutMetrics should assume to access the SNS topic.
    SnsTopicArn string
    ARN of an SNS topic to send alert notifications to.
    RoleArn string
    ARN of an IAM role that LookoutMetrics should assume to access the SNS topic.
    SnsTopicArn string
    ARN of an SNS topic to send alert notifications to.
    roleArn String
    ARN of an IAM role that LookoutMetrics should assume to access the SNS topic.
    snsTopicArn String
    ARN of an SNS topic to send alert notifications to.
    roleArn string
    ARN of an IAM role that LookoutMetrics should assume to access the SNS topic.
    snsTopicArn string
    ARN of an SNS topic to send alert notifications to.
    role_arn str
    ARN of an IAM role that LookoutMetrics should assume to access the SNS topic.
    sns_topic_arn str
    ARN of an SNS topic to send alert notifications to.
    roleArn String
    ARN of an IAM role that LookoutMetrics should assume to access the SNS topic.
    snsTopicArn String
    ARN of an SNS topic to send alert notifications to.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi