Class: AWSCDK::EC2::CfnTrafficMirrorFilterRule

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSEC2::ITrafficMirrorFilterRuleRef
Defined in:
ec2/cfn_traffic_mirror_filter_rule.rb

Overview

Creates a Traffic Mirror filter rule.

A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.

You need the Traffic Mirror filter ID when you create the rule.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnTrafficMirrorFilterRule

Create a new AWS::EC2::TrafficMirrorFilterRule.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::EC2::CfnTrafficMirrorFilterRuleProps) —

    Resource properties.



22
23
24
25
26
27
28
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 22

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::EC2::CfnTrafficMirrorFilterRuleProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmblRyYWZmaWNNaXJyb3JGaWx0ZXJSdWxlUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_traffic_mirror_filter_rule(resource) ⇒ String

Parameters:

Returns:

  • (String) 


86
87
88
89
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 86

def self.arn_for_traffic_mirror_filter_rule(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSVRyYWZmaWNNaXJyb3JGaWx0ZXJSdWxlUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnTrafficMirrorFilterRule", "arnForTrafficMirrorFilterRule", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


206
207
208
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 206

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

.from_traffic_mirror_filter_rule_id(scope, id, traffic_mirror_filter_rule_id) ⇒ AWSCDK::Interfaces::AWSEC2::ITrafficMirrorFilterRuleRef

Creates a new ITrafficMirrorFilterRuleRef from a trafficMirrorFilterRuleId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • traffic_mirror_filter_rule_id (String)

Returns:



97
98
99
100
101
102
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 97

def self.from_traffic_mirror_filter_rule_id(scope, id, traffic_mirror_filter_rule_id)
  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(traffic_mirror_filter_rule_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "trafficMirrorFilterRuleId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnTrafficMirrorFilterRule", "fromTrafficMirrorFilterRuleId", [scope, id, traffic_mirror_filter_rule_id])
end

.is_cfn_traffic_mirror_filter_rule(x) ⇒ Boolean

Checks whether the given object is a CfnTrafficMirrorFilterRule.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

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

.jsii_overridable_methods ⇒ Object 



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
79
80
81
82
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 30

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_traffic_mirror_filter_rule_id => { kind: :property, name: "attrTrafficMirrorFilterRuleId", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :traffic_mirror_filter_rule_ref => { kind: :property, name: "trafficMirrorFilterRuleRef", is_optional: false },
    :destination_cidr_block => { kind: :property, name: "destinationCidrBlock", is_optional: false },
    :rule_action => { kind: :property, name: "ruleAction", is_optional: false },
    :rule_number => { kind: :property, name: "ruleNumber", is_optional: false },
    :source_cidr_block => { kind: :property, name: "sourceCidrBlock", is_optional: false },
    :traffic_direction => { kind: :property, name: "trafficDirection", is_optional: false },
    :traffic_mirror_filter_id => { kind: :property, name: "trafficMirrorFilterId", is_optional: false },
    :description => { kind: :property, name: "description", is_optional: true },
    :destination_port_range => { kind: :property, name: "destinationPortRange", is_optional: true },
    :protocol => { kind: :property, name: "protocol", is_optional: true },
    :source_port_range => { kind: :property, name: "sourcePortRange", is_optional: true },
    :tags => { kind: :property, name: "tags", 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.



402
403
404
405
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 402

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:



414
415
416
417
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 414

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:



424
425
426
427
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 424

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.

Parameters:

  • key (String)
  • value (Object)

See Also:



435
436
437
438
439
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 435

def add_metadata(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.


492
493
494
495
496
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 492

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.



502
503
504
505
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 502

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.



514
515
516
517
518
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 514

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:



527
528
529
530
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 527

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:

Parameters:

See Also:



549
550
551
552
553
554
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 549

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_traffic_mirror_filter_rule_id ⇒ String

The ID of the Traffic Mirror rule.

Returns:

  • (String) 


213
214
215
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 213

def attr_traffic_mirror_filter_rule_id()
  jsii_get_property("attrTrafficMirrorFilterRuleId")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



220
221
222
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 220

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



159
160
161
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 159

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


164
165
166
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 164

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


558
559
560
561
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 558

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_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


169
170
171
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 169

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


176
177
178
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 176

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


121
122
123
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 121

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The description of the Traffic Mirror rule.

Returns:

  • (String, nil) 


306
307
308
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 306

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



310
311
312
313
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 310

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

#destination_cidr_block ⇒ String

The destination CIDR block to assign to the Traffic Mirror rule.

Returns:

  • (String) 


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

def destination_cidr_block()
  jsii_get_property("destinationCidrBlock")
end

#destination_cidr_block=(value) ⇒ Object 



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

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

#destination_port_range ⇒ AWSCDK::IResolvable, ...

The destination port range.

Returns:



318
319
320
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 318

def destination_port_range()
  jsii_get_property("destinationPortRange")
end

#destination_port_range=(value) ⇒ Object 



322
323
324
325
326
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 322

def destination_port_range=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EC2::CfnTrafficMirrorFilterRule::TrafficMirrorPortRangeProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuQ2ZuVHJhZmZpY01pcnJvckZpbHRlclJ1bGUuVHJhZmZpY01pcnJvclBvcnRSYW5nZVByb3BlcnR5In1dfX0=")), "destinationPortRange") unless value.nil?
  jsii_set_property("destinationPortRange", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



181
182
183
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 181

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:



571
572
573
574
575
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 571

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.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



582
583
584
585
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 582

def get_metadata(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:



652
653
654
655
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 652

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

#logical_id ⇒ String

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) 


133
134
135
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 133

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


116
117
118
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 116

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<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:



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

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

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

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

Returns:



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

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.



393
394
395
396
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 393

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

#protocol ⇒ Numeric?

The protocol, for example UDP, to assign to the Traffic Mirror rule.

Returns:

  • (Numeric, nil) 


331
332
333
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 331

def protocol()
  jsii_get_property("protocol")
end

#protocol=(value) ⇒ Object 



335
336
337
338
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 335

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

#ref ⇒ String

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) 


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

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:



611
612
613
614
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 611

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}) 


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

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:



628
629
630
631
632
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 628

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

#rule_action ⇒ String

The action to take on the filtered traffic.

Returns:

  • (String) 


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

def rule_action()
  jsii_get_property("ruleAction")
end

#rule_action=(value) ⇒ Object 



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

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

#rule_number ⇒ Numeric

The number of the Traffic Mirror rule.

Returns:

  • (Numeric) 


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

def rule_number()
  jsii_get_property("ruleNumber")
end

#rule_number=(value) ⇒ Object 



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

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

#should_synthesize ⇒ Boolean

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.



637
638
639
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 637

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

#source_cidr_block ⇒ String

The source CIDR block to assign to the Traffic Mirror rule.

Returns:

  • (String) 


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

def source_cidr_block()
  jsii_get_property("sourceCidrBlock")
end

#source_cidr_block=(value) ⇒ Object 



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

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

#source_port_range ⇒ AWSCDK::IResolvable, ...

The source port range.

Returns:



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

def source_port_range()
  jsii_get_property("sourcePortRange")
end

#source_port_range=(value) ⇒ Object 



347
348
349
350
351
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 347

def source_port_range=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EC2::CfnTrafficMirrorFilterRule::TrafficMirrorPortRangeProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuQ2ZuVHJhZmZpY01pcnJvckZpbHRlclJ1bGUuVHJhZmZpY01pcnJvclBvcnRSYW5nZVByb3BlcnR5In1dfX0=")), "sourcePortRange") unless value.nil?
  jsii_set_property("sourcePortRange", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



142
143
144
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 142

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

Tags on Traffic Mirroring filter rules.

Returns:



356
357
358
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 356

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



360
361
362
363
364
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 360

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



369
370
371
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 369

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

#traffic_direction ⇒ String

The type of traffic.

Returns:

  • (String) 


282
283
284
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 282

def traffic_direction()
  jsii_get_property("trafficDirection")
end

#traffic_direction=(value) ⇒ Object 



286
287
288
289
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 286

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

#traffic_mirror_filter_id ⇒ String

The ID of the filter that this rule is associated with.

Returns:

  • (String) 


294
295
296
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 294

def traffic_mirror_filter_id()
  jsii_get_property("trafficMirrorFilterId")
end

#traffic_mirror_filter_id=(value) ⇒ Object 



298
299
300
301
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 298

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

#traffic_mirror_filter_rule_ref ⇒ AWSCDK::Interfaces::AWSEC2::TrafficMirrorFilterRuleReference

A reference to a TrafficMirrorFilterRule resource.

Returns:



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

def traffic_mirror_filter_rule_ref()
  jsii_get_property("trafficMirrorFilterRuleRef")
end

#updated_properites ⇒ Hash{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}) 


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

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{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}) 


199
200
201
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 199

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


643
644
645
646
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 643

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) 


382
383
384
385
386
387
 
# File 'ec2/cfn_traffic_mirror_filter_rule.rb', line 382

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