Package software.amazon.awscdk.services.ec2

Class CfnTransitGatewayMeteringPolicyEntry

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ec2.CfnTransitGatewayMeteringPolicyEntry

All Implemented Interfaces:

IInspectable, ITransitGatewayMeteringPolicyEntryRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-12-01T16:02:19.216Z")
@Stability(Stable)
public class CfnTransitGatewayMeteringPolicyEntry
extends CfnResource
implements IInspectable, ITransitGatewayMeteringPolicyEntryRef

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 CfnTransitGatewayMeteringPolicyEntry cfnTransitGatewayMeteringPolicyEntry = CfnTransitGatewayMeteringPolicyEntry.Builder.create(this, "MyCfnTransitGatewayMeteringPolicyEntry")
         .meteredAccount("meteredAccount")
         .policyRuleNumber(123)
         .transitGatewayMeteringPolicyId("transitGatewayMeteringPolicyId")
         // the properties below are optional
         .destinationCidrBlock("destinationCidrBlock")
         .destinationPortRange("destinationPortRange")
         .destinationTransitGatewayAttachmentId("destinationTransitGatewayAttachmentId")
         .destinationTransitGatewayAttachmentType("destinationTransitGatewayAttachmentType")
         .protocol("protocol")
         .sourceCidrBlock("sourceCidrBlock")
         .sourcePortRange("sourcePortRange")
         .sourceTransitGatewayAttachmentId("sourceTransitGatewayAttachmentId")
         .sourceTransitGatewayAttachmentType("sourceTransitGatewayAttachmentType")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymeteringpolicyentry.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnTransitGatewayMeteringPolicyEntry.Builder	A fluent builder for CfnTransitGatewayMeteringPolicyEntry.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.ec2.ITransitGatewayMeteringPolicyEntryRef

ITransitGatewayMeteringPolicyEntryRef.Jsii$Default, ITransitGatewayMeteringPolicyEntryRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnTransitGatewayMeteringPolicyEntry(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTransitGatewayMeteringPolicyEntry(software.amazon.jsii.JsiiObjectRef objRef)
	CfnTransitGatewayMeteringPolicyEntry(software.constructs.Construct scope, String id, CfnTransitGatewayMeteringPolicyEntryProps props)	Create a new AWS::EC2::TransitGatewayMeteringPolicyEntry.

Method Summary

Modifier and Type	Method	Description
String	getAttrState()	The state of the metering policy entry.
String	getAttrUpdateEffectiveAt()	The date and time when the metering policy entry update becomes effective.
protected Map<String,Object>	getCfnProperties()
String	getDestinationCidrBlock()	Describes an IPv4 CIDR block.
String	getDestinationPortRange()	Describes a range of ports.
String	getDestinationTransitGatewayAttachmentId()	The ID of the source attachment through which traffic leaves a transit gateway.
String	getDestinationTransitGatewayAttachmentType()
String	getMeteredAccount()	The AWS account ID to which the metered traffic is attributed.
Number	getPolicyRuleNumber()	The rule number of the metering policy entry.
String	getProtocol()	The protocol of the traffic.
String	getSourceCidrBlock()	Describes an IPv4 CIDR block.
String	getSourcePortRange()	Describes a range of ports.
String	getSourceTransitGatewayAttachmentId()	The ID of the source attachment through which traffic enters a transit gateway.
String	getSourceTransitGatewayAttachmentType()
TransitGatewayMeteringPolicyEntryReference	getTransitGatewayMeteringPolicyEntryRef()	A reference to a TransitGatewayMeteringPolicyEntry resource.
String	getTransitGatewayMeteringPolicyId()	The ID of the transit gateway metering policy for which the entry is being created.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnTransitGatewayMeteringPolicyEntry(Object x)	Checks whether the given object is a CfnTransitGatewayMeteringPolicyEntry.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDestinationCidrBlock(String value)	Describes an IPv4 CIDR block.
void	setDestinationPortRange(String value)	Describes a range of ports.
void	setDestinationTransitGatewayAttachmentId(String value)	The ID of the source attachment through which traffic leaves a transit gateway.
void	setDestinationTransitGatewayAttachmentType(String value)
void	setMeteredAccount(String value)	The AWS account ID to which the metered traffic is attributed.
void	setPolicyRuleNumber(Number value)	The rule number of the metering policy entry.
void	setProtocol(String value)	The protocol of the traffic.
void	setSourceCidrBlock(String value)	Describes an IPv4 CIDR block.
void	setSourcePortRange(String value)	Describes a range of ports.
void	setSourceTransitGatewayAttachmentId(String value)	The ID of the source attachment through which traffic enters a transit gateway.
void	setSourceTransitGatewayAttachmentType(String value)
void	setTransitGatewayMeteringPolicyId(String value)	The ID of the transit gateway metering policy for which the entry is being created.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnTransitGatewayMeteringPolicyEntry

protected CfnTransitGatewayMeteringPolicyEntry(software.amazon.jsii.JsiiObjectRef objRef)

CfnTransitGatewayMeteringPolicyEntry

protected CfnTransitGatewayMeteringPolicyEntry(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnTransitGatewayMeteringPolicyEntry

@Stability(Stable)
public CfnTransitGatewayMeteringPolicyEntry(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnTransitGatewayMeteringPolicyEntryProps props)

Create a new AWS::EC2::TransitGatewayMeteringPolicyEntry.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

isCfnTransitGatewayMeteringPolicyEntry

@Stability(Stable)
@NotNull
public static Boolean isCfnTransitGatewayMeteringPolicyEntry(@NotNull
 Object x)

Checks whether the given object is a CfnTransitGatewayMeteringPolicyEntry.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrState

@Stability(Stable)
@NotNull
public String getAttrState()

The state of the metering policy entry.

getAttrUpdateEffectiveAt

@Stability(Stable)
@NotNull
public String getAttrUpdateEffectiveAt()

The date and time when the metering policy entry update becomes effective.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTransitGatewayMeteringPolicyEntryRef

@Stability(Stable)
@NotNull
public TransitGatewayMeteringPolicyEntryReference getTransitGatewayMeteringPolicyEntryRef()

A reference to a TransitGatewayMeteringPolicyEntry resource.

Specified by:

getTransitGatewayMeteringPolicyEntryRef in interface ITransitGatewayMeteringPolicyEntryRef

getMeteredAccount

@Stability(Stable)
@NotNull
public String getMeteredAccount()

The AWS account ID to which the metered traffic is attributed.

setMeteredAccount

@Stability(Stable)
public void setMeteredAccount(@NotNull
 String value)

The AWS account ID to which the metered traffic is attributed.

getPolicyRuleNumber

@Stability(Stable)
@NotNull
public Number getPolicyRuleNumber()

The rule number of the metering policy entry.

setPolicyRuleNumber

@Stability(Stable)
public void setPolicyRuleNumber(@NotNull
 Number value)

The rule number of the metering policy entry.

getTransitGatewayMeteringPolicyId

@Stability(Stable)
@NotNull
public String getTransitGatewayMeteringPolicyId()

The ID of the transit gateway metering policy for which the entry is being created.

setTransitGatewayMeteringPolicyId

@Stability(Stable)
public void setTransitGatewayMeteringPolicyId(@NotNull
 String value)

The ID of the transit gateway metering policy for which the entry is being created.

getDestinationCidrBlock

@Stability(Stable)
@Nullable
public String getDestinationCidrBlock()

Describes an IPv4 CIDR block.

setDestinationCidrBlock

@Stability(Stable)
public void setDestinationCidrBlock(@Nullable
 String value)

Describes an IPv4 CIDR block.

getDestinationPortRange

@Stability(Stable)
@Nullable
public String getDestinationPortRange()

Describes a range of ports.

setDestinationPortRange

@Stability(Stable)
public void setDestinationPortRange(@Nullable
 String value)

Describes a range of ports.

getDestinationTransitGatewayAttachmentId

@Stability(Stable)
@Nullable
public String getDestinationTransitGatewayAttachmentId()

The ID of the source attachment through which traffic leaves a transit gateway.

setDestinationTransitGatewayAttachmentId

@Stability(Stable)
public void setDestinationTransitGatewayAttachmentId(@Nullable
 String value)

The ID of the source attachment through which traffic leaves a transit gateway.

getDestinationTransitGatewayAttachmentType

@Stability(Stable)
@Nullable
public String getDestinationTransitGatewayAttachmentType()

setDestinationTransitGatewayAttachmentType

@Stability(Stable)
public void setDestinationTransitGatewayAttachmentType(@Nullable
 String value)

getProtocol

@Stability(Stable)
@Nullable
public String getProtocol()

The protocol of the traffic.

setProtocol

@Stability(Stable)
public void setProtocol(@Nullable
 String value)

The protocol of the traffic.

getSourceCidrBlock

@Stability(Stable)
@Nullable
public String getSourceCidrBlock()

Describes an IPv4 CIDR block.

setSourceCidrBlock

@Stability(Stable)
public void setSourceCidrBlock(@Nullable
 String value)

Describes an IPv4 CIDR block.

getSourcePortRange

@Stability(Stable)
@Nullable
public String getSourcePortRange()

Describes a range of ports.

setSourcePortRange

@Stability(Stable)
public void setSourcePortRange(@Nullable
 String value)

Describes a range of ports.

getSourceTransitGatewayAttachmentId

@Stability(Stable)
@Nullable
public String getSourceTransitGatewayAttachmentId()

The ID of the source attachment through which traffic enters a transit gateway.

setSourceTransitGatewayAttachmentId

@Stability(Stable)
public void setSourceTransitGatewayAttachmentId(@Nullable
 String value)

The ID of the source attachment through which traffic enters a transit gateway.

getSourceTransitGatewayAttachmentType

@Stability(Stable)
@Nullable
public String getSourceTransitGatewayAttachmentType()

setSourceTransitGatewayAttachmentType

@Stability(Stable)
public void setSourceTransitGatewayAttachmentType(@Nullable
 String value)