monitoring_subscriptions

Creates, updates, deletes or gets a monitoring_subscription resource or lists monitoring_subscriptions in a region

Overview

Name	monitoring_subscriptions
Type	Resource
Description	A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
Id	awscc.cloudfront.monitoring_subscriptions

Fields

Name	Datatype	Description
distribution_id	string	The ID of the distribution that you are enabling metrics for.
▶monitoring_subscription	object	A subscription configuration for additional CloudWatch metrics.
region	string	AWS region.

For more information, see AWS::CloudFront::MonitoringSubscription.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DistributionId, MonitoringSubscription, region
delete_resource	DELETE	Identifier, region
get_resource	SELECT	Identifier, region

SELECT examples

Gets all properties from an individual monitoring_subscription.

SELECT
  region,
  distribution_id,
  monitoring_subscription
FROM awscc.cloudfront.monitoring_subscriptions
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ distribution_id }}';

INSERT example

Use the following StackQL query and manifest file to create a new monitoring_subscription resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.cloudfront.monitoring_subscriptions (
  DistributionId,
  MonitoringSubscription,
  region
)
SELECT
  '{{ distribution_id }}',
  '{{ monitoring_subscription }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.cloudfront.monitoring_subscriptions (
  DistributionId,
  MonitoringSubscription,
  region
)
SELECT
  '{{ distribution_id }}',
  '{{ monitoring_subscription }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: monitoring_subscription
  props:
    - name: distribution_id
      value: '{{ distribution_id }}'
    - name: monitoring_subscription
      value:
        distribution_id: '{{ distribution_id }}'
        monitoring_subscription: null

DELETE example

/*+ delete */
DELETE FROM awscc.cloudfront.monitoring_subscriptions
WHERE
  Identifier = '{{ distribution_id }}' AND
  region = 'us-east-1'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the monitoring_subscriptions resource, the following permissions are required:

Create

cloudfront:CreateMonitoringSubscription

Delete

cloudfront:DeleteMonitoringSubscription

Read

cloudfront:GetMonitoringSubscription