Class: AWSCDK::NetworkFirewall::CfnFirewall

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSNetworkfirewall::IFirewallRef
Defined in:
network_firewall/cfn_firewall.rb

Overview

Use the firewall to provide stateful, managed, network firewall and intrusion detection and prevention filtering for your VPCs in Amazon VPC .

The firewall defines the configuration settings for an AWS Network Firewall firewall. The settings include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall AWS resource.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnFirewall

Create a new AWS::NetworkFirewall::Firewall.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::NetworkFirewall::CfnFirewallProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'network_firewall/cfn_firewall.rb', line 20

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

Class Method Details

.arn_for_firewall(resource) ⇒ String

Parameters:

Returns:

  • (String) 


89
90
91
92
 
# File 'network_firewall/cfn_firewall.rb', line 89

def self.arn_for_firewall(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19uZXR3b3JrZmlyZXdhbGwuSUZpcmV3YWxsUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_networkfirewall.CfnFirewall", "arnForFirewall", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


196
197
198
 
# File 'network_firewall/cfn_firewall.rb', line 196

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

.is_cfn_firewall(x) ⇒ Boolean

Checks whether the given object is a CfnFirewall.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


98
99
100
101
 
# File 'network_firewall/cfn_firewall.rb', line 98

def self.is_cfn_firewall(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_networkfirewall.CfnFirewall", "isCfnFirewall", [x])
end

.jsii_overridable_methods ⇒ Object 



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
79
80
81
82
83
84
85
 
# File 'network_firewall/cfn_firewall.rb', line 28

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_endpoint_ids => { kind: :property, name: "attrEndpointIds", is_optional: false },
    :attr_firewall_arn => { kind: :property, name: "attrFirewallArn", is_optional: false },
    :attr_firewall_id => { kind: :property, name: "attrFirewallId", is_optional: false },
    :attr_transit_gateway_attachment_id => { kind: :property, name: "attrTransitGatewayAttachmentId", is_optional: false },
    :firewall_ref => { kind: :property, name: "firewallRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :firewall_name => { kind: :property, name: "firewallName", is_optional: false },
    :firewall_policy_arn => { kind: :property, name: "firewallPolicyArn", is_optional: false },
    :availability_zone_change_protection => { kind: :property, name: "availabilityZoneChangeProtection", is_optional: true },
    :availability_zone_mappings => { kind: :property, name: "availabilityZoneMappings", is_optional: true },
    :delete_protection => { kind: :property, name: "deleteProtection", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :enabled_analysis_types => { kind: :property, name: "enabledAnalysisTypes", is_optional: true },
    :firewall_policy_change_protection => { kind: :property, name: "firewallPolicyChangeProtection", is_optional: true },
    :subnet_change_protection => { kind: :property, name: "subnetChangeProtection", is_optional: true },
    :subnet_mappings => { kind: :property, name: "subnetMappings", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :transit_gateway_id => { kind: :property, name: "transitGatewayId", is_optional: true },
    :vpc_id => { kind: :property, name: "vpcId", 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.



439
440
441
442
 
# File 'network_firewall/cfn_firewall.rb', line 439

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:



451
452
453
454
 
# File 'network_firewall/cfn_firewall.rb', line 451

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:



461
462
463
464
 
# File 'network_firewall/cfn_firewall.rb', line 461

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:



472
473
474
475
476
 
# File 'network_firewall/cfn_firewall.rb', line 472

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.


529
530
531
532
533
 
# File 'network_firewall/cfn_firewall.rb', line 529

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.



539
540
541
542
 
# File 'network_firewall/cfn_firewall.rb', line 539

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.



551
552
553
554
555
 
# File 'network_firewall/cfn_firewall.rb', line 551

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:



564
565
566
567
 
# File 'network_firewall/cfn_firewall.rb', line 564

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:



586
587
588
589
590
591
 
# File 'network_firewall/cfn_firewall.rb', line 586

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_endpoint_ids ⇒ Array<String>

The unique IDs of the firewall endpoints for all of the subnets that you attached to the firewall.

The subnets are not listed in any particular order. For example: ["us-west-2c:vpce-111122223333", "us-west-2a:vpce-987654321098", "us-west-2b:vpce-012345678901"] .

Returns:

  • (Array<String>) 


205
206
207
 
# File 'network_firewall/cfn_firewall.rb', line 205

def attr_endpoint_ids()
  jsii_get_property("attrEndpointIds")
end

#attr_firewall_arn ⇒ String

The Amazon Resource Name (ARN) of the firewall.

Returns:

  • (String) 


212
213
214
 
# File 'network_firewall/cfn_firewall.rb', line 212

def attr_firewall_arn()
  jsii_get_property("attrFirewallArn")
end

#attr_firewall_id ⇒ String

The name of the firewallresource.

Returns:

  • (String) 


219
220
221
 
# File 'network_firewall/cfn_firewall.rb', line 219

def attr_firewall_id()
  jsii_get_property("attrFirewallId")
end

#attr_transit_gateway_attachment_id ⇒ String

The unique identifier of the transit gateway attachment associated with this firewall.

This field is only present for transit gateway-attached firewalls.

Returns:

  • (String) 


228
229
230
 
# File 'network_firewall/cfn_firewall.rb', line 228

def attr_transit_gateway_attachment_id()
  jsii_get_property("attrTransitGatewayAttachmentId")
end

#availability_zone_change_protection ⇒ Boolean, ...

A setting indicating whether the firewall is protected against changes to its Availability Zone configuration.

Returns:



273
274
275
 
# File 'network_firewall/cfn_firewall.rb', line 273

def availability_zone_change_protection()
  jsii_get_property("availabilityZoneChangeProtection")
end

#availability_zone_change_protection=(value) ⇒ Object 



277
278
279
280
 
# File 'network_firewall/cfn_firewall.rb', line 277

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

#availability_zone_mappings ⇒ AWSCDK::IResolvable, ...

The Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall.

Returns:



285
286
287
 
# File 'network_firewall/cfn_firewall.rb', line 285

def availability_zone_mappings()
  jsii_get_property("availabilityZoneMappings")
end

#availability_zone_mappings=(value) ⇒ Object 



289
290
291
292
 
# File 'network_firewall/cfn_firewall.rb', line 289

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



149
150
151
 
# File 'network_firewall/cfn_firewall.rb', line 149

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


154
155
156
 
# File 'network_firewall/cfn_firewall.rb', line 154

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


595
596
597
598
 
# File 'network_firewall/cfn_firewall.rb', line 595

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


159
160
161
 
# File 'network_firewall/cfn_firewall.rb', line 159

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


166
167
168
 
# File 'network_firewall/cfn_firewall.rb', line 166

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


111
112
113
 
# File 'network_firewall/cfn_firewall.rb', line 111

def creation_stack()
  jsii_get_property("creationStack")
end

#delete_protection ⇒ Boolean, ...

A flag indicating whether it is possible to delete the firewall.

Returns:



297
298
299
 
# File 'network_firewall/cfn_firewall.rb', line 297

def delete_protection()
  jsii_get_property("deleteProtection")
end

#delete_protection=(value) ⇒ Object 



301
302
303
304
 
# File 'network_firewall/cfn_firewall.rb', line 301

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

#description ⇒ String?

A description of the firewall.

Returns:

  • (String, nil) 


309
310
311
 
# File 'network_firewall/cfn_firewall.rb', line 309

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



313
314
315
316
 
# File 'network_firewall/cfn_firewall.rb', line 313

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

#enabled_analysis_types ⇒ Array<String>?

An optional setting indicating the specific traffic analysis types to enable on the firewall.

Returns:

  • (Array<String>, nil) 


321
322
323
 
# File 'network_firewall/cfn_firewall.rb', line 321

def enabled_analysis_types()
  jsii_get_property("enabledAnalysisTypes")
end

#enabled_analysis_types=(value) ⇒ Object 



325
326
327
328
 
# File 'network_firewall/cfn_firewall.rb', line 325

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



171
172
173
 
# File 'network_firewall/cfn_firewall.rb', line 171

def env()
  jsii_get_property("env")
end

#firewall_name ⇒ String

The descriptive name of the firewall.

Returns:

  • (String) 


249
250
251
 
# File 'network_firewall/cfn_firewall.rb', line 249

def firewall_name()
  jsii_get_property("firewallName")
end

#firewall_name=(value) ⇒ Object 



253
254
255
256
 
# File 'network_firewall/cfn_firewall.rb', line 253

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

#firewall_policy_arn ⇒ String

The Amazon Resource Name (ARN) of the firewall policy.

Returns:

  • (String) 


261
262
263
 
# File 'network_firewall/cfn_firewall.rb', line 261

def firewall_policy_arn()
  jsii_get_property("firewallPolicyArn")
end

#firewall_policy_arn=(value) ⇒ Object 



265
266
267
268
 
# File 'network_firewall/cfn_firewall.rb', line 265

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

#firewall_policy_change_protection ⇒ Boolean, ...

A setting indicating whether the firewall is protected against a change to the firewall policy association.

Returns:



333
334
335
 
# File 'network_firewall/cfn_firewall.rb', line 333

def firewall_policy_change_protection()
  jsii_get_property("firewallPolicyChangeProtection")
end

#firewall_policy_change_protection=(value) ⇒ Object 



337
338
339
340
 
# File 'network_firewall/cfn_firewall.rb', line 337

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

#firewall_ref ⇒ AWSCDK::Interfaces::AWSNetworkfirewall::FirewallReference

A reference to a Firewall resource.

Returns:



235
236
237
 
# File 'network_firewall/cfn_firewall.rb', line 235

def firewall_ref()
  jsii_get_property("firewallRef")
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:



608
609
610
611
612
 
# File 'network_firewall/cfn_firewall.rb', line 608

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:



619
620
621
622
 
# File 'network_firewall/cfn_firewall.rb', line 619

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:



689
690
691
692
 
# File 'network_firewall/cfn_firewall.rb', line 689

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) 


123
124
125
 
# File 'network_firewall/cfn_firewall.rb', line 123

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


106
107
108
 
# File 'network_firewall/cfn_firewall.rb', line 106

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:



630
631
632
 
# File 'network_firewall/cfn_firewall.rb', line 630

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:



637
638
639
 
# File 'network_firewall/cfn_firewall.rb', line 637

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.



430
431
432
433
 
# File 'network_firewall/cfn_firewall.rb', line 430

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

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


142
143
144
 
# File 'network_firewall/cfn_firewall.rb', line 142

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:



648
649
650
651
 
# File 'network_firewall/cfn_firewall.rb', line 648

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


655
656
657
658
 
# File 'network_firewall/cfn_firewall.rb', line 655

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:



665
666
667
668
669
 
# File 'network_firewall/cfn_firewall.rb', line 665

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_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.



674
675
676
 
# File 'network_firewall/cfn_firewall.rb', line 674

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



132
133
134
 
# File 'network_firewall/cfn_firewall.rb', line 132

def stack()
  jsii_get_property("stack")
end

#subnet_change_protection ⇒ Boolean, ...

A setting indicating whether the firewall is protected against changes to the subnet associations.

Returns:



345
346
347
 
# File 'network_firewall/cfn_firewall.rb', line 345

def subnet_change_protection()
  jsii_get_property("subnetChangeProtection")
end

#subnet_change_protection=(value) ⇒ Object 



349
350
351
352
 
# File 'network_firewall/cfn_firewall.rb', line 349

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

#subnet_mappings ⇒ AWSCDK::IResolvable, ...

The primary public subnets that Network Firewall is using for the firewall.

Returns:



357
358
359
 
# File 'network_firewall/cfn_firewall.rb', line 357

def subnet_mappings()
  jsii_get_property("subnetMappings")
end

#subnet_mappings=(value) ⇒ Object 



361
362
363
364
 
# File 'network_firewall/cfn_firewall.rb', line 361

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

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



242
243
244
 
# File 'network_firewall/cfn_firewall.rb', line 242

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

An array of key-value pairs to apply to this resource.

Returns:



369
370
371
 
# File 'network_firewall/cfn_firewall.rb', line 369

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



373
374
375
376
377
 
# File 'network_firewall/cfn_firewall.rb', line 373

def tags_raw=(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=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



406
407
408
 
# File 'network_firewall/cfn_firewall.rb', line 406

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

#transit_gateway_id ⇒ String?

The unique identifier of the transit gateway associated with this firewall.

Returns:

  • (String, nil) 


382
383
384
 
# File 'network_firewall/cfn_firewall.rb', line 382

def transit_gateway_id()
  jsii_get_property("transitGatewayId")
end

#transit_gateway_id=(value) ⇒ Object 



386
387
388
389
 
# File 'network_firewall/cfn_firewall.rb', line 386

def transit_gateway_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "transitGatewayId") unless value.nil?
  jsii_set_property("transitGatewayId", value)
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}) 


179
180
181
 
# File 'network_firewall/cfn_firewall.rb', line 179

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


189
190
191
 
# File 'network_firewall/cfn_firewall.rb', line 189

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


680
681
682
683
 
# File 'network_firewall/cfn_firewall.rb', line 680

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

#vpc_id ⇒ String?

The unique identifier of the VPC where the firewall is in use.

Returns:

  • (String, nil) 


394
395
396
 
# File 'network_firewall/cfn_firewall.rb', line 394

def vpc_id()
  jsii_get_property("vpcId")
end

#vpc_id=(value) ⇒ Object 



398
399
400
401
 
# File 'network_firewall/cfn_firewall.rb', line 398

def vpc_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vpcId") unless value.nil?
  jsii_set_property("vpcId", value)
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) 


419
420
421
422
423
424
 
# File 'network_firewall/cfn_firewall.rb', line 419

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