Class: MintPress::Aws::EC2::NetworkInsightsPath

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

Properties (Read/Write)

  • #created_date ⇒ [Time]
    'The time stamp when the path was created.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::NetworkInsightsPath"
    • orig_name ⇒ 'created_date'
    

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

property :created_date, disposition: :attribute, description: 'The time stamp when the path was created.', source: "MintPress::Aws::EC2::NetworkInsightsPath", orig_name: 'created_date', type: [Time]
  • #destination ⇒ [String]
    'The AWS resource that is the destination of the path.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::NetworkInsightsPath"
    • orig_name ⇒ 'destination'
    • create_network_insights_path_prop ⇒ 'destination'
    • read_only ⇒ false
    

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

property :destination, disposition: :attribute, description: 'The AWS resource that is the destination of the path.', source: "MintPress::Aws::EC2::NetworkInsightsPath", orig_name: 'destination', type: [String], create_network_insights_path_prop: 'destination', read_only: false
  • #destination_ip ⇒ [String]
    'The IP address of the AWS resource that is the destination of the path.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::NetworkInsightsPath"
    • orig_name ⇒ 'destination_ip'
    • create_network_insights_path_prop ⇒ 'destination_ip'
    • read_only ⇒ false
    

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

property :destination_ip, disposition: :attribute, description: 'The IP address of the AWS resource that is the destination of the path.', source: "MintPress::Aws::EC2::NetworkInsightsPath", orig_name: 'destination_ip', type: [String], create_network_insights_path_prop: 'destination_ip', read_only: false
  • #destination_port ⇒ [Integer]
    'The destination port.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::NetworkInsightsPath"
    • orig_name ⇒ 'destination_port'
    • create_network_insights_path_prop ⇒ 'destination_port'
    • read_only ⇒ false
    

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

property :destination_port, disposition: :attribute, description: 'The destination port.', source: "MintPress::Aws::EC2::NetworkInsightsPath", orig_name: 'destination_port', type: [Integer], create_network_insights_path_prop: 'destination_port', read_only: false
  • #network_insights_path_arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the path.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::NetworkInsightsPath"
    • orig_name ⇒ 'network_insights_path_arn'
    

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

property :network_insights_path_arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) of the path.', source: "MintPress::Aws::EC2::NetworkInsightsPath", orig_name: 'network_insights_path_arn', type: [String]
  • #protocol ⇒ [String]
    'The protocol.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::NetworkInsightsPath"
    • orig_name ⇒ 'protocol'
    • create_network_insights_path_prop ⇒ 'protocol'
    • read_only ⇒ false
    

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

property :protocol, disposition: :attribute, description: 'The protocol.', source: "MintPress::Aws::EC2::NetworkInsightsPath", orig_name: 'protocol', type: [String], create_network_insights_path_prop: 'protocol', read_only: false
  • #source ⇒ [String]
    'The AWS resource that is the source of the path.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::NetworkInsightsPath"
    • orig_name ⇒ 'source'
    • create_network_insights_path_prop ⇒ 'source'
    • read_only ⇒ false
    

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

property :source, disposition: :attribute, description: 'The AWS resource that is the source of the path.', source: "MintPress::Aws::EC2::NetworkInsightsPath", orig_name: 'source', type: [String], create_network_insights_path_prop: 'source', read_only: false
  • #source_ip ⇒ [String]
    'The IP address of the AWS resource that is the source of the path.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::NetworkInsightsPath"
    • orig_name ⇒ 'source_ip'
    • create_network_insights_path_prop ⇒ 'source_ip'
    • read_only ⇒ false
    

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

property :source_ip, disposition: :attribute, description: 'The IP address of the AWS resource that is the source of the path.', source: "MintPress::Aws::EC2::NetworkInsightsPath", orig_name: 'source_ip', type: [String], create_network_insights_path_prop: 'source_ip', read_only: false
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'The tags associated with the path.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::NetworkInsightsPath"
    • orig_name ⇒ 'tags'
    • create_network_insights_path_prop ⇒ 'tag_specifications'
    • read_only ⇒ false
    

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

property :tags, disposition: :attribute, description: 'The tags associated with the path.', source: "MintPress::Aws::EC2::NetworkInsightsPath", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, create_network_insights_path_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_insights_path_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "describe_network_insights_paths"
    • delete_network_insights_path_prop ⇒ 'dry_run'
    • describe_network_insights_paths_prop ⇒ 'dry_run'
    

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

property :dry_run, create_network_insights_path_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "describe_network_insights_paths", 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_insights_path_prop: 'dry_run', describe_network_insights_paths_prop: 'dry_run'
  • #client_token ⇒ [String]
    'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency. A suitable default value is auto-generated. You should normally not need to pass this option.**'
    Property Attributes
    • create_network_insights_path_prop ⇒ 'client_token'
    • read_only ⇒ false
    • source ⇒ "create_network_insights_path"
    

36
37
38
39
40
41
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/network_insights_path.rb', line 36

property :client_token, create_network_insights_path_prop: 'client_token', type: [String], read_only: false, source: "create_network_insights_path", description: 'Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see How to Ensure
Idempotency.

A suitable default value is auto-generated. You should normally
not need to pass this option.**'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'The filters. The following are possible values: Destination - The ID of the resource. DestinationPort - The destination port. Name - The path name. Protocol - The protocol. Source - The ID of the resource.'
    Property Attributes
    • describe_network_insights_paths_prop ⇒ 'filters'
    • source ⇒ "describe_network_insights_paths"
    

42
43
44
45
46
47
48
49
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/network_insights_path.rb', line 42

property :filters, describe_network_insights_paths_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_network_insights_paths", description: 'The filters. The following are possible values:


Destination - The ID of the resource.
DestinationPort - The destination port.
Name - The path name.
Protocol - The protocol.
Source - The ID of the resource.', 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_insights_paths_prop ⇒ 'max_results'
    • source ⇒ "describe_network_insights_paths"
    

50
51
52
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/network_insights_path.rb', line 50

property :max_results, describe_network_insights_paths_prop: 'max_results', type: [Integer], source: "describe_network_insights_paths", 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 })
    'The IDs of the paths.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "describe_network_insights_paths"
    • orig_name ⇒ 'network_insights_path_id'
    • delete_network_insights_path_prop ⇒ 'network_insights_path_id'
    • read_only ⇒ false
    • describe_network_insights_paths_prop ⇒ 'network_insights_path_ids'
    • default ⇒ Proc.new { self.name }
    

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

property :id, disposition: :attribute, description: 'The IDs of the paths.', source: "describe_network_insights_paths", orig_name: 'network_insights_path_id', type: [String], delete_network_insights_path_prop: 'network_insights_path_id', read_only: false, array: false, hash: false, describe_network_insights_paths_prop: 'network_insights_path_ids', default: Proc.new { self.name }
  • #name ⇒ String

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Properties (Read Only)

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 = {}) ⇒ NetworkInsightsPath

Returns a new instance of NetworkInsightsPath.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object