[ aws . cloudfront ]

create-monitoring-subscription

Description

Enables additional 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 .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-monitoring-subscription
--distribution-id <value>
--monitoring-subscription <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--distribution-id (string)

The ID of the distribution that you are enabling metrics for.

--monitoring-subscription (structure)

A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.

RealtimeMetricsSubscriptionConfig -> (structure)

A subscription configuration for additional CloudWatch metrics.

RealtimeMetricsSubscriptionStatus -> (string)

A flag that indicates whether additional CloudWatch metrics are enabled for a given CloudFront distribution.

Shorthand Syntax:

RealtimeMetricsSubscriptionConfig={RealtimeMetricsSubscriptionStatus=string}

JSON Syntax:

{
  "RealtimeMetricsSubscriptionConfig": {
    "RealtimeMetricsSubscriptionStatus": "Enabled"|"Disabled"
  }
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

MonitoringSubscription -> (structure)

A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.

RealtimeMetricsSubscriptionConfig -> (structure)

A subscription configuration for additional CloudWatch metrics.

RealtimeMetricsSubscriptionStatus -> (string)

A flag that indicates whether additional CloudWatch metrics are enabled for a given CloudFront distribution.