network_performance_metric_subscriptions

Creates, updates, deletes or gets a network_performance_metric_subscription resource or lists network_performance_metric_subscriptions in a region

Overview

Name	network_performance_metric_subscriptions
Type	Resource
Description	Resource Type definition for AWS::EC2::NetworkPerformanceMetricSubscription
Id	awscc.ec2.network_performance_metric_subscriptions

Fields

get (all properties)

Name	Datatype	Description
source	string	The starting Region or Availability Zone for metric to subscribe to.
destination	string	The target Region or Availability Zone for the metric to subscribe to.
metric	string	The metric type to subscribe to.
statistic	string	The statistic to subscribe to.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
source	string	The starting Region or Availability Zone for metric to subscribe to.
destination	string	The target Region or Availability Zone for the metric to subscribe to.
metric	string	The metric type to subscribe to.
statistic	string	The statistic to subscribe to.
region	string	AWS region.

For more information, see AWS::EC2::NetworkPerformanceMetricSubscription.

Methods

Name	Resource	Accessible by	Required Params
create_resource	network_performance_metric_subscriptions	INSERT	Source, Destination, Metric, Statistic, region
delete_resource	network_performance_metric_subscriptions	DELETE	Identifier, region
list_resources	network_performance_metric_subscriptions_list_only	SELECT	region
get_resource	network_performance_metric_subscriptions	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual network_performance_metric_subscription.

SELECT
  region,
  source,
  destination,
  metric,
  statistic
FROM awscc.ec2.network_performance_metric_subscriptions
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ source }}|{{ destination }}|{{ metric }}|{{ statistic }}';

list (identifiers only)

Lists all network_performance_metric_subscriptions in a region.

SELECT
  region,
  source,
  destination,
  metric,
  statistic
FROM awscc.ec2.network_performance_metric_subscriptions_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ec2.network_performance_metric_subscriptions (
  Source,
  Destination,
  Metric,
  Statistic,
  region
)
SELECT
  '{{ source }}',
  '{{ destination }}',
  '{{ metric }}',
  '{{ statistic }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.ec2.network_performance_metric_subscriptions (
  Source,
  Destination,
  Metric,
  Statistic,
  region
)
SELECT
  '{{ source }}',
  '{{ destination }}',
  '{{ metric }}',
  '{{ statistic }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: network_performance_metric_subscription
    props:
      - name: source
        value: '{{ source }}'
      - name: destination
        value: '{{ destination }}'
      - name: metric
        value: '{{ metric }}'
      - name: statistic
        value: '{{ statistic }}'

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.network_performance_metric_subscriptions
WHERE
  Identifier = '{{ source }}|{{ destination }}|{{ metric }}|{{ statistic }}' AND
  region = 'us-east-1';

Permissions

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

Create

ec2:DescribeAwsNetworkPerformanceMetricSubscriptions,
ec2:EnableAwsNetworkPerformanceMetricSubscription

Read

ec2:DescribeAwsNetworkPerformanceMetricSubscriptions

Delete

ec2:DescribeAwsNetworkPerformanceMetricSubscriptions,
ec2:DisableAwsNetworkPerformanceMetricSubscription

List

ec2:DescribeAwsNetworkPerformanceMetricSubscriptions