Class: MintPress::Aws::EC2::NetworkAcl

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/network_acl.rb

Properties (Read/Write)

  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'The tags to assign to the network ACL.'
    Property Attributes
    • source ⇒ "create_network_acl"
    • orig_name ⇒ 'tags'
    • create_network_acl_prop ⇒ 'tag_specifications'
    • read_only ⇒ false
    

30
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/network_acl.rb', line 30

property :tags, description: 'The tags to assign to the network ACL.', source: "create_network_acl", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, create_network_acl_prop: 'tag_specifications', read_only: false, hash: true
  • #dry_run ⇒ [TrueClass,FalseClass]
    'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
    Property Attributes
    • create_network_acl_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "create_network_acl"
    • delete_network_acl_prop ⇒ 'dry_run'
    • describe_network_acls_prop ⇒ 'dry_run'
    

31
32
33
34
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/network_acl.rb', line 31

property :dry_run, create_network_acl_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "create_network_acl", description: 'Checks whether you have the required permissions for the action,
without actually making the request, and provides an error response.
If you have the required permissions, the error response is
DryRunOperation. Otherwise, it is UnauthorizedOperation.', delete_network_acl_prop: 'dry_run', describe_network_acls_prop: 'dry_run'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'One or more filters. association.association-id - The ID of an association ID for the ACL. association.network-acl-id - The ID of the network ACL involved in the association. association.subnet-id - The ID of the subnet involved in the association. default - Indicates whether the ACL is the default network ACL for the VPC. entry.cidr - The IPv4 CIDR range specified in the entry. entry.icmp.code - The ICMP code specified in the entry, if any. entry.icmp.type - The ICMP type specified in the entry, if any. entry.ipv6-cidr - The IPv6 CIDR range specified in the entry. entry.port-range.from - The start of the port range specified in the entry. entry.port-range.to - The end of the port range specified in the entry. entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number). entry.rule-action - Allows or denies the matching traffic (allow | deny). entry.rule-number - The number of an entry (in other words, rule) in the set of ACL entries. network-acl-id - The ID of the network ACL. owner-id - The ID of the AWS account that owns the network ACL. tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. vpc-id - The ID of the VPC for the network ACL.'
    Property Attributes
    • describe_network_acls_prop ⇒ 'filters'
    • source ⇒ "describe_network_acls"
    

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
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/network_acl.rb', line 35

property :filters, describe_network_acls_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_network_acls", description: 'One or more filters.


association.association-id - The ID of an association ID for the
ACL.
association.network-acl-id - The ID of the network ACL involved in
the association.
association.subnet-id - The ID of the subnet involved in the
association.
default - Indicates whether the ACL is the default network ACL for
the VPC.
entry.cidr - The IPv4 CIDR range specified in the entry.
entry.icmp.code - The ICMP code specified in the entry, if any.
entry.icmp.type - The ICMP type specified in the entry, if any.
entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.
entry.port-range.from - The start of the port range specified in
the entry.
entry.port-range.to - The end of the port range specified in the
entry.
entry.protocol - The protocol specified in the entry (tcp |
udp | icmp or a protocol number).
entry.rule-action - Allows or denies the matching traffic (allow
| deny).
entry.rule-number - The number of an entry (in other words, rule)
in the set of ACL entries.
network-acl-id - The ID of the network ACL.
owner-id - The ID of the AWS account that owns the network ACL.
tag:<key> - The key/value combination of a tag assigned to
the resource. Use the tag key in the filter name and the tag value
as the filter value. For example, to find all resources that have a
tag with the key Owner and the value TeamA, specify tag:Owner
for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this
filter to find all resources assigned a tag with a specific key,
regardless of the tag value.
vpc-id - The ID of the VPC for the network ACL.', hash: true
  • #max_results ⇒ [Integer]
    'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
    Property Attributes
    • describe_network_acls_prop ⇒ 'max_results'
    • source ⇒ "describe_network_acls"
    

71
72
73
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/network_acl.rb', line 71

property :max_results, describe_network_acls_prop: 'max_results', type: [Integer], source: "describe_network_acls", description: 'The maximum number of results to return with a single call. To
retrieve the remaining results, make another call with the returned
nextToken value.'
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'One or more network ACL IDs. Default: Describes all your network ACLs.'
    Property Attributes
    • read_only ⇒ false
    • disposition ⇒ :attribute
    • source ⇒ "describe_network_acls"
    • orig_name ⇒ 'network_acl_id'
    • delete_network_acl_prop ⇒ 'network_acl_id'
    • describe_network_acls_prop ⇒ 'network_acl_ids'
    • default ⇒ Proc.new { self.name }
    

74
75
76
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/network_acl.rb', line 74

property :id, read_only: false, disposition: :attribute, description: 'One or more network ACL IDs.

Default: Describes all your network ACLs.', source: "describe_network_acls", orig_name: 'network_acl_id', type: [String], delete_network_acl_prop: 'network_acl_id', array: false, hash: false, describe_network_acls_prop: 'network_acl_ids', default: Proc.new { self.name }
  • #vpc ⇒ [MintPress::Aws::EC2::Vpc] (Default Value: MintPress::Aws::EC2::Vpc.new)
    'The ID of the VPC.'
    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "NetworkAcl"
    • orig_name ⇒ 'vpc'
    • create_network_acl_prop ⇒ 'vpc_id'
    • read_only ⇒ false
    • default ⇒ MintPress::Aws::EC2::Vpc.new
    • from ⇒ String
    

77
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/network_acl.rb', line 77

property :vpc, disposition: :association, description: 'The ID of the VPC.', source: "NetworkAcl", orig_name: 'vpc', type: [MintPress::Aws::EC2::Vpc], create_network_acl_prop: 'vpc_id', read_only: false, default: MintPress::Aws::EC2::Vpc.new, from: String
  • #name ⇒ String

    Property Attributes 
    

79
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/network_acl.rb', line 79

property :name, type: String
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

83
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/network_acl.rb', line 83

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

86
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/network_acl.rb', line 86

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

  • #associations ⇒ Hash of ⇒ [MintPress::Aws::EC2::NetworkAclAssociation]
    'Any associations between the network ACL and one or more subnets.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "NetworkAcl"
    • orig_name ⇒ 'associations'
    • read_only ⇒ true
    

27
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/network_acl.rb', line 27

property :associations, disposition: :read_only_attribute, description: 'Any associations between the network ACL and one or more subnets.', source: "NetworkAcl", orig_name: 'associations', type: [MintPress::Aws::EC2::NetworkAclAssociation], array: false, read_only: true, hash: true
  • #entries ⇒ Array of ⇒ [MintPress::Aws::EC2::NetworkAclEntry]
    'One or more entries (rules) in the network ACL.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "NetworkAcl"
    • orig_name ⇒ 'entries'
    • read_only ⇒ true
    

28
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/network_acl.rb', line 28

property :entries, disposition: :read_only_attribute, description: 'One or more entries (rules) in the network ACL.', source: "NetworkAcl", orig_name: 'entries', type: [MintPress::Aws::EC2::NetworkAclEntry], array: true, read_only: true
  • #is_default ⇒ [TrueClass,FalseClass]
    'Indicates whether this is the default network ACL for the VPC.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "NetworkAcl"
    • orig_name ⇒ 'is_default'
    • read_only ⇒ true
    

29
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/network_acl.rb', line 29

property :is_default, disposition: :read_only_attribute, description: 'Indicates whether this is the default network ACL for the VPC.', source: "NetworkAcl", orig_name: 'is_default', type: [TrueClass,FalseClass], read_only: true
  • #owner ⇒ [String]
    'The ID of the AWS account that owns the network ACL.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "NetworkAcl"
    • orig_name ⇒ 'owner_id'
    • read_only ⇒ true
    

78
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/network_acl.rb', line 78

property :owner, disposition: :read_only_attribute, description: 'The ID of the AWS account that owns the network ACL.', source: "NetworkAcl", orig_name: 'owner_id', type: [String], read_only: true

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ NetworkAcl

Returns a new instance of NetworkAcl.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object