Interface CfnAppMonitor.MetricDestinationProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnAppMonitor.MetricDestinationProperty extends
Creates or updates a destination to receive extended metrics from CloudWatch RUM.

You can send extended metrics to CloudWatch or to a CloudWatch Evidently experiment.

For more information about extended metrics, see Extended metrics that you can send to CloudWatch and CloudWatch Evidently .


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 MetricDestinationProperty metricDestinationProperty = MetricDestinationProperty.builder()
         // the properties below are optional
                 // the properties below are optional
                         "dimensionKeysKey", "dimensionKeys"))
  • Method Details

    • getDestination

      @Stability(Stable) @NotNull String getDestination()
      Defines the destination to send the metrics to.

      Valid values are CloudWatch and Evidently . If you specify Evidently , you must also specify the ARN of the CloudWatch Evidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.

    • getDestinationArn

      @Stability(Stable) @Nullable default String getDestinationArn()
      Use this parameter only if Destination is Evidently .

      This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics.

    • getIamRoleArn

      @Stability(Stable) @Nullable default String getIamRoleArn()
      This parameter is required if Destination is Evidently . If Destination is CloudWatch , do not use this parameter.

      This parameter specifies the ARN of an IAM role that RUM will assume to write to the Evidently experiment that you are sending metrics to. This role must have permission to write to that experiment.

    • getMetricDefinitions

      @Stability(Stable) @Nullable default Object getMetricDefinitions()
      An array of structures which define the metrics that you want to send.
    • builder

      @Stability(Stable) static CfnAppMonitor.MetricDestinationProperty.Builder builder()
      a CfnAppMonitor.MetricDestinationProperty.Builder of CfnAppMonitor.MetricDestinationProperty