Class: MintPress::Aws::EC2::NetworkInsightsAnalysis

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

Properties (Read/Write)

  • #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
    • delete_network_insights_analysis_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "start_network_insights_analysis"
    • describe_network_insights_analyses_prop ⇒ 'dry_run'
    • start_network_insights_analysis_prop ⇒ 'dry_run'
    

28
29
30
31
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/network_insights_analysis.rb', line 28

property :dry_run, delete_network_insights_analysis_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "start_network_insights_analysis", 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.', describe_network_insights_analyses_prop: 'dry_run', start_network_insights_analysis_prop: 'dry_run'
  • #alternate_path_hints ⇒ Array of ⇒ [MintPress::Aws::EC2::AlternatePathHint]
    'Potential intermediate components.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::NetworkInsightsAnalysis"
    • orig_name ⇒ 'alternate_path_hints'
    

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

property :alternate_path_hints, disposition: :attribute, description: 'Potential intermediate components.', source: "MintPress::Aws::EC2::NetworkInsightsAnalysis", orig_name: 'alternate_path_hints', type: [MintPress::Aws::EC2::AlternatePathHint], array: true
  • #explanations ⇒ Array of ⇒ [MintPress::Aws::EC2::Explanation]
    'The explanations.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::NetworkInsightsAnalysis"
    • orig_name ⇒ 'explanations'
    

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

property :explanations, disposition: :attribute, description: 'The explanations.', source: "MintPress::Aws::EC2::NetworkInsightsAnalysis", orig_name: 'explanations', type: [MintPress::Aws::EC2::Explanation], array: true
  • #filter_in_arns ⇒ Array of ⇒ [String]
    'The Amazon Resource Names (ARN) of the resources that the path must traverse.'
    Property Attributes
    • source ⇒ "start_network_insights_analysis"
    • orig_name ⇒ 'filter_in_arns'
    • start_network_insights_analysis_prop ⇒ 'filter_in_arns'
    • read_only ⇒ false
    

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

property :filter_in_arns, description: 'The Amazon Resource Names (ARN) of the resources that the path must
traverse.', source: "start_network_insights_analysis", orig_name: 'filter_in_arns', type: [String], array: true, start_network_insights_analysis_prop: 'filter_in_arns', read_only: false
  • #forward_path_components ⇒ Array of ⇒ [MintPress::Aws::EC2::PathComponent]
    'The components in the path from source to destination.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::NetworkInsightsAnalysis"
    • orig_name ⇒ 'forward_path_components'
    

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

property :forward_path_components, disposition: :attribute, description: 'The components in the path from source to destination.', source: "MintPress::Aws::EC2::NetworkInsightsAnalysis", orig_name: 'forward_path_components', type: [MintPress::Aws::EC2::PathComponent], array: true
  • #network_insights_analysis_arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the network insights analysis.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::NetworkInsightsAnalysis"
    • orig_name ⇒ 'network_insights_analysis_arn'
    

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

property :network_insights_analysis_arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) of the network insights analysis.', source: "MintPress::Aws::EC2::NetworkInsightsAnalysis", orig_name: 'network_insights_analysis_arn', type: [String]
  • #network_path_found ⇒ [TrueClass,FalseClass]
    'Indicates whether the destination is reachable from the source.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::NetworkInsightsAnalysis"
    • orig_name ⇒ 'network_path_found'
    

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

property :network_path_found, disposition: :attribute, description: 'Indicates whether the destination is reachable from the source.', source: "MintPress::Aws::EC2::NetworkInsightsAnalysis", orig_name: 'network_path_found', type: [TrueClass,FalseClass]
  • #return_path_components ⇒ Array of ⇒ [MintPress::Aws::EC2::PathComponent]
    'The components in the path from destination to source.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::NetworkInsightsAnalysis"
    • orig_name ⇒ 'return_path_components'
    

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

property :return_path_components, disposition: :attribute, description: 'The components in the path from destination to source.', source: "MintPress::Aws::EC2::NetworkInsightsAnalysis", orig_name: 'return_path_components', type: [MintPress::Aws::EC2::PathComponent], array: true
  • #start_date ⇒ [Time]
    'The time the analysis started.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::NetworkInsightsAnalysis"
    • orig_name ⇒ 'start_date'
    

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

property :start_date, disposition: :attribute, description: 'The time the analysis started.', source: "MintPress::Aws::EC2::NetworkInsightsAnalysis", orig_name: 'start_date', type: [Time]
  • #status ⇒ [String]
    'The status of the network insights analysis.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::NetworkInsightsAnalysis"
    • orig_name ⇒ 'status'
    

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

property :status, disposition: :attribute, description: 'The status of the network insights analysis.', source: "MintPress::Aws::EC2::NetworkInsightsAnalysis", orig_name: 'status', type: [String]
  • #status_message ⇒ [String]
    'The status message, if the status is failed.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::NetworkInsightsAnalysis"
    • orig_name ⇒ 'status_message'
    

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

property :status_message, disposition: :attribute, description: 'The status message, if the status is failed.', source: "MintPress::Aws::EC2::NetworkInsightsAnalysis", orig_name: 'status_message', type: [String]
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'The tags to apply.'
    Property Attributes
    • source ⇒ "start_network_insights_analysis"
    • orig_name ⇒ 'tags'
    • start_network_insights_analysis_prop ⇒ 'tag_specifications'
    • read_only ⇒ false
    

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

property :tags, description: 'The tags to apply.', source: "start_network_insights_analysis", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, start_network_insights_analysis_prop: 'tag_specifications', read_only: false, hash: true
  • #analysis_start_time ⇒ [Time,DateTime,Integer]
    'The time when the network insights analyses started.'
    Property Attributes
    • describe_network_insights_analyses_prop ⇒ 'analysis_start_time'
    • source ⇒ "describe_network_insights_analyses"
    

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

property :analysis_start_time, describe_network_insights_analyses_prop: 'analysis_start_time', type: [Time,DateTime,Integer], source: "describe_network_insights_analyses", description: 'The time when the network insights analyses started.'
  • #analysis_end_time ⇒ [Time,DateTime,Integer]
    'The time when the network insights analyses ended.'
    Property Attributes
    • describe_network_insights_analyses_prop ⇒ 'analysis_end_time'
    • source ⇒ "describe_network_insights_analyses"
    

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

property :analysis_end_time, describe_network_insights_analyses_prop: 'analysis_end_time', type: [Time,DateTime,Integer], source: "describe_network_insights_analyses", description: 'The time when the network insights analyses ended.'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'The filters. The following are possible values: PathFound - A Boolean value that indicates whether a feasible path is found. Status - The status of the analysis (running | succeeded | failed).'
    Property Attributes
    • describe_network_insights_analyses_prop ⇒ 'filters'
    • source ⇒ "describe_network_insights_analyses"
    

46
47
48
49
50
51
52
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/network_insights_analysis.rb', line 46

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


PathFound - A Boolean value that indicates whether a feasible path
is found.
Status - The status of the analysis (running | succeeded |
failed).', 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_analyses_prop ⇒ 'max_results'
    • source ⇒ "describe_network_insights_analyses"
    

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

property :max_results, describe_network_insights_analyses_prop: 'max_results', type: [Integer], source: "describe_network_insights_analyses", 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.'
  • #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
    • start_network_insights_analysis_prop ⇒ 'client_token'
    • read_only ⇒ false
    • source ⇒ "start_network_insights_analysis"
    

56
57
58
59
60
61
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/network_insights_analysis.rb', line 56

property :client_token, start_network_insights_analysis_prop: 'client_token', type: [String], read_only: false, source: "start_network_insights_analysis", 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.**'
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'The ID of the network insights analyses. You must specify either analysis IDs or a path ID.'
    Property Attributes
    • delete_network_insights_analysis_prop ⇒ 'network_insights_analysis_id'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "describe_network_insights_analyses"
    • orig_name ⇒ 'network_insights_analysis_id'
    • describe_network_insights_analyses_prop ⇒ 'network_insights_analysis_ids'
    • default ⇒ Proc.new { self.name }
    

62
63
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/network_insights_analysis.rb', line 62

property :id, delete_network_insights_analysis_prop: 'network_insights_analysis_id', type: [String], disposition: :attribute, read_only: false, source: "describe_network_insights_analyses", description: 'The ID of the network insights analyses. You must specify either
analysis IDs or a path ID.', orig_name: 'network_insights_analysis_id', array: false, hash: false, describe_network_insights_analyses_prop: 'network_insights_analysis_ids', default: Proc.new { self.name }
  • #network_insights_path ⇒ [MintPress::Aws::EC2::NetworkInsightsPath]
    'The ID of the path.'
    Property Attributes
    • source ⇒ "start_network_insights_analysis"
    • orig_name ⇒ 'network_insights_path_id'
    • describe_network_insights_analyses_prop ⇒ 'network_insights_path_id'
    • start_network_insights_analysis_prop ⇒ 'network_insights_path_id'
    • read_only ⇒ false
    • from ⇒ String
    

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

property :network_insights_path, description: 'The ID of the path.', source: "start_network_insights_analysis", orig_name: 'network_insights_path_id', type: [MintPress::Aws::EC2::NetworkInsightsPath], describe_network_insights_analyses_prop: 'network_insights_path_id', start_network_insights_analysis_prop: 'network_insights_path_id', read_only: false, from: String
  • #name ⇒ String

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Returns a new instance of NetworkInsightsAnalysis.

Instance Method Details

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#start ⇒ Object