monitoring_subscriptions

Creates, updates, deletes, gets or lists a monitoring_subscriptions resource.

Overview

Name	monitoring_subscriptions
Type	Resource
Id	aws.cloudfront.monitoring_subscriptions

Fields

The following fields are returned by SELECT queries:

get_monitoring_subscription

Name	Datatype	Description
realtime_metrics_subscription_config	string	A subscription configuration for additional CloudWatch metrics.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_monitoring_subscription	select	distribution_id, region		Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.
create_monitoring_subscription	insert	distribution_id, region, MonitoringSubscription		Enables or disables additional Amazon CloudWatch metrics for the specified CloudFront distribution. The additional metrics incur an additional cost. For more information, see Viewing additional CloudFront distribution metrics in the Amazon CloudFront Developer Guide.
delete_monitoring_subscription	delete	distribution_id, region		Disables additional CloudWatch metrics for the specified CloudFront distribution.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
distribution_id	string	The ID of the distribution that you are disabling metrics for.
region	string	AWS region (default: us-east-1)

SELECT examples

get_monitoring_subscription

Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.

SELECT
realtime_metrics_subscription_config
FROM aws.cloudfront.monitoring_subscriptions
WHERE distribution_id = '{{ distribution_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_monitoring_subscription

Enables or disables additional Amazon CloudWatch metrics for the specified CloudFront distribution. The additional metrics incur an additional cost. For more information, see Viewing additional CloudFront distribution metrics in the Amazon CloudFront Developer Guide.

INSERT INTO aws.cloudfront.monitoring_subscriptions (
MonitoringSubscription,
distribution_id,
region
)
SELECT 
'{{ MonitoringSubscription }}' /* required */,
'{{ distribution_id }}',
'{{ region }}'
RETURNING
realtime_metrics_subscription_config
;

Manifest

# Description fields are for documentation purposes
- name: monitoring_subscriptions
props:
  - name: distribution_id
    value: "{{ distribution_id }}"
    description: Required parameter for the monitoring_subscriptions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the monitoring_subscriptions resource.
  - name: MonitoringSubscription
    description: |
      A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
    value:
      RealtimeMetricsSubscriptionConfig:
        RealtimeMetricsSubscriptionStatus: "{{ RealtimeMetricsSubscriptionStatus }}"

DELETE examples

delete_monitoring_subscription

Disables additional CloudWatch metrics for the specified CloudFront distribution.

DELETE FROM aws.cloudfront.monitoring_subscriptions
WHERE distribution_id = '{{ distribution_id }}' --required
AND region = '{{ region }}' --required
;