Class: AWSCDK::EC2::CfnTransitGatewayMeteringPolicyEntry

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSEC2::ITransitGatewayMeteringPolicyEntryRef
Defined in:
ec2/cfn_transit_gateway_metering_policy_entry.rb

Overview

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnTransitGatewayMeteringPolicyEntry

Create a new AWS::EC2::TransitGatewayMeteringPolicyEntry.

Parameters:



17
18
19
20
21
22
23
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 17

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::EC2::CfnTransitGatewayMeteringPolicyEntryProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmblRyYW5zaXRHYXRld2F5TWV0ZXJpbmdQb2xpY3lFbnRyeVByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAMEString

The CloudFormation resource type name for this resource class.

Returns:

  • (String)


182
183
184
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 182

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.CfnTransitGatewayMeteringPolicyEntry", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_transit_gateway_metering_policy_entry(x) ⇒ Boolean

Checks whether the given object is a CfnTransitGatewayMeteringPolicyEntry.

Parameters:

  • x (Object)

Returns:

  • (Boolean)


84
85
86
87
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 84

def self.is_cfn_transit_gateway_metering_policy_entry(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnTransitGatewayMeteringPolicyEntry", "isCfnTransitGatewayMeteringPolicyEntry", [x])
end

.jsii_overridable_methodsObject



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 25

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_state => { kind: :property, name: "attrState", is_optional: false },
    :attr_update_effective_at => { kind: :property, name: "attrUpdateEffectiveAt", is_optional: false },
    :transit_gateway_metering_policy_entry_ref => { kind: :property, name: "transitGatewayMeteringPolicyEntryRef", is_optional: false },
    :metered_account => { kind: :property, name: "meteredAccount", is_optional: false },
    :policy_rule_number => { kind: :property, name: "policyRuleNumber", is_optional: false },
    :transit_gateway_metering_policy_id => { kind: :property, name: "transitGatewayMeteringPolicyId", is_optional: false },
    :destination_cidr_block => { kind: :property, name: "destinationCidrBlock", is_optional: true },
    :destination_port_range => { kind: :property, name: "destinationPortRange", is_optional: true },
    :destination_transit_gateway_attachment_id => { kind: :property, name: "destinationTransitGatewayAttachmentId", is_optional: true },
    :destination_transit_gateway_attachment_type => { kind: :property, name: "destinationTransitGatewayAttachmentType", is_optional: true },
    :protocol => { kind: :property, name: "protocol", is_optional: true },
    :source_cidr_block => { kind: :property, name: "sourceCidrBlock", is_optional: true },
    :source_port_range => { kind: :property, name: "sourcePortRange", is_optional: true },
    :source_transit_gateway_attachment_id => { kind: :property, name: "sourceTransitGatewayAttachmentId", is_optional: true },
    :source_transit_gateway_attachment_type => { kind: :property, name: "sourceTransitGatewayAttachmentType", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String)

    The path of the value to delete.



383
384
385
386
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 383

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



395
396
397
398
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 395

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



405
406
407
408
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 405

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.



416
417
418
419
420
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 416

def (key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String)
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object)
    • The value.


473
474
475
476
477
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 473

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String)

    The path to the property.



483
484
485
486
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 483

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String)

    The path of the property.

  • value (Object)

    The value.



495
496
497
498
499
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 495

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



508
509
510
511
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 508

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:



530
531
532
533
534
535
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 530

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_stateString

The state of the metering policy entry.

Returns:

  • (String)


189
190
191
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 189

def attr_state()
  jsii_get_property("attrState")
end

#attr_update_effective_atString

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

Returns:

  • (String)


196
197
198
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 196

def attr_update_effective_at()
  jsii_get_property("attrUpdateEffectiveAt")
end

#cfn_optionsAWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.



135
136
137
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 135

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_propertiesHash{String => Object}

Returns:

  • (Hash{String => Object})


140
141
142
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 140

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil)


539
540
541
542
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 539

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_namesHash{String => String}

Returns:

  • (Hash{String => String})


145
146
147
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 145

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_typeString

AWS resource type.

Returns:

  • (String)


152
153
154
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 152

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stackArray<String>

Returns:

  • (Array<String>)


97
98
99
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 97

def creation_stack()
  jsii_get_property("creationStack")
end

#destination_cidr_blockString?

Describes an IPv4 CIDR block.

Returns:

  • (String, nil)


246
247
248
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 246

def destination_cidr_block()
  jsii_get_property("destinationCidrBlock")
end

#destination_cidr_block=(value) ⇒ Object



250
251
252
253
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 250

def destination_cidr_block=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "destinationCidrBlock") unless value.nil?
  jsii_set_property("destinationCidrBlock", value)
end

#destination_port_rangeString?

Describes a range of ports.

Returns:

  • (String, nil)


258
259
260
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 258

def destination_port_range()
  jsii_get_property("destinationPortRange")
end

#destination_port_range=(value) ⇒ Object



262
263
264
265
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 262

def destination_port_range=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "destinationPortRange") unless value.nil?
  jsii_set_property("destinationPortRange", value)
end

#destination_transit_gateway_attachment_idString?

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

Returns:

  • (String, nil)


270
271
272
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 270

def destination_transit_gateway_attachment_id()
  jsii_get_property("destinationTransitGatewayAttachmentId")
end

#destination_transit_gateway_attachment_id=(value) ⇒ Object



274
275
276
277
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 274

def destination_transit_gateway_attachment_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "destinationTransitGatewayAttachmentId") unless value.nil?
  jsii_set_property("destinationTransitGatewayAttachmentId", value)
end

#destination_transit_gateway_attachment_typeString?

Returns:

  • (String, nil)


280
281
282
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 280

def destination_transit_gateway_attachment_type()
  jsii_get_property("destinationTransitGatewayAttachmentType")
end

#destination_transit_gateway_attachment_type=(value) ⇒ Object



284
285
286
287
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 284

def destination_transit_gateway_attachment_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "destinationTransitGatewayAttachmentType") unless value.nil?
  jsii_set_property("destinationTransitGatewayAttachmentType", value)
end

#envAWSCDK::Interfaces::ResourceEnvironment



157
158
159
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 157

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



552
553
554
555
556
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 552

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.



563
564
565
566
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 563

def (key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



633
634
635
636
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 633

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_idString

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String)


109
110
111
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 109

def logical_id()
  jsii_get_property("logicalId")
end

#metered_accountString

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

Returns:

  • (String)


210
211
212
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 210

def ()
  jsii_get_property("meteredAccount")
end

#metered_account=(value) ⇒ Object



214
215
216
217
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 214

def metered_account=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "meteredAccount")
  jsii_set_property("meteredAccount", value)
end

#nodeConstructs::Node

The tree node.

Returns:

  • (Constructs::Node)


92
93
94
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 92

def node()
  jsii_get_property("node")
end

#obtain_dependenciesArray<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



574
575
576
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 574

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependenciesArray<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



581
582
583
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 581

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String)

    The new logical ID to use for this stack element.



374
375
376
377
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 374

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#policy_rule_numberNumeric

The rule number of the metering policy entry.

Returns:

  • (Numeric)


222
223
224
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 222

def policy_rule_number()
  jsii_get_property("policyRuleNumber")
end

#policy_rule_number=(value) ⇒ Object



226
227
228
229
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 226

def policy_rule_number=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "policyRuleNumber")
  jsii_set_property("policyRuleNumber", value)
end

#protocolString?

The protocol of the traffic.

Returns:

  • (String, nil)


292
293
294
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 292

def protocol()
  jsii_get_property("protocol")
end

#protocol=(value) ⇒ Object



296
297
298
299
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 296

def protocol=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "protocol") unless value.nil?
  jsii_set_property("protocol", value)
end

#refString

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String)


128
129
130
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 128

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



592
593
594
595
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 592

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object})


599
600
601
602
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 599

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



609
610
611
612
613
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 609

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesizeBoolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean)

    true if the resource should be included or false is the resource should be omitted.



618
619
620
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 618

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#source_cidr_blockString?

Describes an IPv4 CIDR block.

Returns:

  • (String, nil)


304
305
306
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 304

def source_cidr_block()
  jsii_get_property("sourceCidrBlock")
end

#source_cidr_block=(value) ⇒ Object



308
309
310
311
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 308

def source_cidr_block=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceCidrBlock") unless value.nil?
  jsii_set_property("sourceCidrBlock", value)
end

#source_port_rangeString?

Describes a range of ports.

Returns:

  • (String, nil)


316
317
318
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 316

def source_port_range()
  jsii_get_property("sourcePortRange")
end

#source_port_range=(value) ⇒ Object



320
321
322
323
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 320

def source_port_range=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourcePortRange") unless value.nil?
  jsii_set_property("sourcePortRange", value)
end

#source_transit_gateway_attachment_idString?

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

Returns:

  • (String, nil)


328
329
330
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 328

def source_transit_gateway_attachment_id()
  jsii_get_property("sourceTransitGatewayAttachmentId")
end

#source_transit_gateway_attachment_id=(value) ⇒ Object



332
333
334
335
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 332

def source_transit_gateway_attachment_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceTransitGatewayAttachmentId") unless value.nil?
  jsii_set_property("sourceTransitGatewayAttachmentId", value)
end

#source_transit_gateway_attachment_typeString?

Returns:

  • (String, nil)


338
339
340
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 338

def source_transit_gateway_attachment_type()
  jsii_get_property("sourceTransitGatewayAttachmentType")
end

#source_transit_gateway_attachment_type=(value) ⇒ Object



342
343
344
345
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 342

def source_transit_gateway_attachment_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceTransitGatewayAttachmentType") unless value.nil?
  jsii_set_property("sourceTransitGatewayAttachmentType", value)
end

#stackAWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



118
119
120
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 118

def stack()
  jsii_get_property("stack")
end

#to_stringString

Returns a string representation of this construct.

Returns:

  • (String)

    a string representation of this resource



350
351
352
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 350

def to_string()
  jsii_call_method("toString", [])
end

#transit_gateway_metering_policy_entry_refAWSCDK::Interfaces::AWSEC2::TransitGatewayMeteringPolicyEntryReference

A reference to a TransitGatewayMeteringPolicyEntry resource.



203
204
205
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 203

def transit_gateway_metering_policy_entry_ref()
  jsii_get_property("transitGatewayMeteringPolicyEntryRef")
end

#transit_gateway_metering_policy_idString

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

Returns:

  • (String)


234
235
236
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 234

def transit_gateway_metering_policy_id()
  jsii_get_property("transitGatewayMeteringPolicyId")
end

#transit_gateway_metering_policy_id=(value) ⇒ Object



238
239
240
241
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 238

def transit_gateway_metering_policy_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "transitGatewayMeteringPolicyId")
  jsii_set_property("transitGatewayMeteringPolicyId", value)
end

#updated_properitesHash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object})


165
166
167
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 165

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_propertiesHash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object})


175
176
177
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 175

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object)


624
625
626
627
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 624

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct)


363
364
365
366
367
368
# File 'ec2/cfn_transit_gateway_metering_policy_entry.rb', line 363

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end