Class: AWSCDK::NetworkFirewall::CfnVPCEndpointAssociationProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
network_firewall/cfn_vpc_endpoint_association_props.rb

Overview

Properties for defining a CfnVpcEndpointAssociation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(firewall_arn:, subnet_mapping:, vpc_id:, description: nil, tags: nil) ⇒ CfnVPCEndpointAssociationProps

Returns a new instance of CfnVPCEndpointAssociationProps.

Parameters:

  • firewall_arn (String)

    The Amazon Resource Name (ARN) of the firewall.

  • subnet_mapping (AWSCDK::IResolvable, AWSCDK::NetworkFirewall::CfnVPCEndpointAssociation::SubnetMappingProperty)

    The ID for a subnet that's used in an association with a firewall.

  • vpc_id (String)

    The unique identifier of the VPC for the endpoint association.

  • description (String, nil) (defaults to: nil)

    A description of the VPC endpoint association.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil)

    The key:value pairs to associate with the resource.



14
15
16
17
18
19
20
21
22
23
24
25
# File 'network_firewall/cfn_vpc_endpoint_association_props.rb', line 14

def initialize(firewall_arn:, subnet_mapping:, vpc_id:, description: nil, tags: nil)
  @firewall_arn = firewall_arn
  Jsii::Type.check_type(@firewall_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "firewallArn")
  @subnet_mapping = subnet_mapping.is_a?(Hash) ? ::AWSCDK::NetworkFirewall::CfnVPCEndpointAssociation::SubnetMappingProperty.new(**subnet_mapping.transform_keys(&:to_sym)) : subnet_mapping
  Jsii::Type.check_type(@subnet_mapping, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19uZXR3b3JrZmlyZXdhbGwuQ2ZuVnBjRW5kcG9pbnRBc3NvY2lhdGlvbi5TdWJuZXRNYXBwaW5nUHJvcGVydHkifV19fQ==")), "subnetMapping")
  @vpc_id = vpc_id
  Jsii::Type.check_type(@vpc_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vpcId")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#descriptionString? (readonly)

A description of the VPC endpoint association.



48
49
50
# File 'network_firewall/cfn_vpc_endpoint_association_props.rb', line 48

def description
  @description
end

#firewall_arnString (readonly)

The Amazon Resource Name (ARN) of the firewall.



31
32
33
# File 'network_firewall/cfn_vpc_endpoint_association_props.rb', line 31

def firewall_arn
  @firewall_arn
end

#subnet_mappingAWSCDK::IResolvable, AWSCDK::NetworkFirewall::CfnVPCEndpointAssociation::SubnetMappingProperty (readonly)

The ID for a subnet that's used in an association with a firewall.

This is used in CreateFirewall , AssociateSubnets , and CreateVpcEndpointAssociation . AWS Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.



38
39
40
# File 'network_firewall/cfn_vpc_endpoint_association_props.rb', line 38

def subnet_mapping
  @subnet_mapping
end

#tagsArray<AWSCDK::CfnTag>? (readonly)

The key:value pairs to associate with the resource.



53
54
55
# File 'network_firewall/cfn_vpc_endpoint_association_props.rb', line 53

def tags
  @tags
end

#vpc_idString (readonly)

The unique identifier of the VPC for the endpoint association.



43
44
45
# File 'network_firewall/cfn_vpc_endpoint_association_props.rb', line 43

def vpc_id
  @vpc_id
end

Class Method Details

.jsii_propertiesObject



55
56
57
58
59
60
61
62
63
# File 'network_firewall/cfn_vpc_endpoint_association_props.rb', line 55

def self.jsii_properties
  {
    :firewall_arn => "firewallArn",
    :subnet_mapping => "subnetMapping",
    :vpc_id => "vpcId",
    :description => "description",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsiiObject



65
66
67
68
69
70
71
72
73
74
75
# File 'network_firewall/cfn_vpc_endpoint_association_props.rb', line 65

def to_jsii
  result = {}
  result.merge!({
    "firewallArn" => @firewall_arn,
    "subnetMapping" => @subnet_mapping,
    "vpcId" => @vpc_id,
    "description" => @description,
    "tags" => @tags,
  })
  result.compact
end