Skip to content

Create Transit Gateway Metering Policy Entry

ec2_create_transit_gateway_metering_policy_entry R Documentation

Creates an entry in a transit gateway metering policy to define traffic measurement rules

Description

Creates an entry in a transit gateway metering policy to define traffic measurement rules.

Usage

ec2_create_transit_gateway_metering_policy_entry(
  TransitGatewayMeteringPolicyId, PolicyRuleNumber,
  SourceTransitGatewayAttachmentId, SourceTransitGatewayAttachmentType,
  SourceCidrBlock, SourcePortRange, DestinationTransitGatewayAttachmentId,
  DestinationTransitGatewayAttachmentType, DestinationCidrBlock,
  DestinationPortRange, Protocol, MeteredAccount, DryRun)

Arguments

TransitGatewayMeteringPolicyId

[required] The ID of the transit gateway metering policy to add the entry to.

PolicyRuleNumber

[required] The rule number for the metering policy entry. Rules are processed in order from lowest to highest number.

SourceTransitGatewayAttachmentId

The ID of the source transit gateway attachment for traffic matching.

SourceTransitGatewayAttachmentType

The type of the source transit gateway attachment for traffic matching. Note that the tgw-peering resource type has been deprecated. To configure metering policies for Connect, use the transport attachment type.

SourceCidrBlock

The source CIDR block for traffic matching.

SourcePortRange

The source port range for traffic matching.

DestinationTransitGatewayAttachmentId

The ID of the destination transit gateway attachment for traffic matching.

DestinationTransitGatewayAttachmentType

The type of the destination transit gateway attachment for traffic matching. Note that the tgw-peering resource type has been deprecated. To configure metering policies for Connect, use the transport attachment type.

DestinationCidrBlock

The destination CIDR block for traffic matching.

DestinationPortRange

The destination port range for traffic matching.

Protocol

The protocol for traffic matching (1, 6, 17, etc.).

MeteredAccount

[required] The Amazon Web Services account ID to which the metered traffic should be attributed.

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Value

A list with the following syntax:

list(
  TransitGatewayMeteringPolicyEntry = list(
    PolicyRuleNumber = "string",
    MeteredAccount = "source-attachment-owner"|"destination-attachment-owner"|"transit-gateway-owner",
    State = "available"|"deleted",
    UpdatedAt = as.POSIXct(
      "2015-01-01"
    ),
    UpdateEffectiveAt = as.POSIXct(
      "2015-01-01"
    ),
    MeteringPolicyRule = list(
      SourceTransitGatewayAttachmentId = "string",
      SourceTransitGatewayAttachmentType = "vpc"|"vpn"|"vpn-concentrator"|"direct-connect-gateway"|"connect"|"peering"|"tgw-peering"|"network-function"|"client-vpn",
      SourceCidrBlock = "string",
      SourcePortRange = "string",
      DestinationTransitGatewayAttachmentId = "string",
      DestinationTransitGatewayAttachmentType = "vpc"|"vpn"|"vpn-concentrator"|"direct-connect-gateway"|"connect"|"peering"|"tgw-peering"|"network-function"|"client-vpn",
      DestinationCidrBlock = "string",
      DestinationPortRange = "string",
      Protocol = "string"
    )
  )
)

Request syntax

svc$create_transit_gateway_metering_policy_entry(
  TransitGatewayMeteringPolicyId = "string",
  PolicyRuleNumber = 123,
  SourceTransitGatewayAttachmentId = "string",
  SourceTransitGatewayAttachmentType = "vpc"|"vpn"|"vpn-concentrator"|"direct-connect-gateway"|"connect"|"peering"|"tgw-peering"|"network-function"|"client-vpn",
  SourceCidrBlock = "string",
  SourcePortRange = "string",
  DestinationTransitGatewayAttachmentId = "string",
  DestinationTransitGatewayAttachmentType = "vpc"|"vpn"|"vpn-concentrator"|"direct-connect-gateway"|"connect"|"peering"|"tgw-peering"|"network-function"|"client-vpn",
  DestinationCidrBlock = "string",
  DestinationPortRange = "string",
  Protocol = "string",
  MeteredAccount = "source-attachment-owner"|"destination-attachment-owner"|"transit-gateway-owner",
  DryRun = TRUE|FALSE
)