Class: MintPress::Aws::EC2::TrafficMirrorSession

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

Properties (Read/Write)

  • #description ⇒ [String]
    'The description to assign to the Traffic Mirror session.'
    Property Attributes
    • source ⇒ "modify_traffic_mirror_session"
    • orig_name ⇒ 'description'
    • create_traffic_mirror_session_prop ⇒ 'description'
    • read_only ⇒ false
    • modify_traffic_mirror_session_prop ⇒ 'description'
    

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

property :description, description: 'The description to assign to the Traffic Mirror session.', source: "modify_traffic_mirror_session", orig_name: 'description', type: [String], create_traffic_mirror_session_prop: 'description', read_only: false, modify_traffic_mirror_session_prop: 'description'
  • #packet_length ⇒ [Integer]
    'The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet.'
    Property Attributes
    • source ⇒ "modify_traffic_mirror_session"
    • orig_name ⇒ 'packet_length'
    • create_traffic_mirror_session_prop ⇒ 'packet_length'
    • read_only ⇒ false
    • modify_traffic_mirror_session_prop ⇒ 'packet_length'
    

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

property :packet_length, description: 'The number of bytes in each packet to mirror. These are bytes after
the VXLAN header. To mirror a subset, set this to the length (in
bytes) to mirror. For example, if you set this value to 100, then the
first 100 bytes that meet the filter criteria are copied to the
target. Do not specify this parameter when you want to mirror the
entire packet.', source: "modify_traffic_mirror_session", orig_name: 'packet_length', type: [Integer], create_traffic_mirror_session_prop: 'packet_length', read_only: false, modify_traffic_mirror_session_prop: 'packet_length'
  • #session_number ⇒ [Integer]
    'The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets. Valid values are 1-32766.'
    Property Attributes
    • source ⇒ "modify_traffic_mirror_session"
    • orig_name ⇒ 'session_number'
    • create_traffic_mirror_session_prop ⇒ 'session_number'
    • read_only ⇒ false
    • modify_traffic_mirror_session_prop ⇒ 'session_number'
    

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

property :session_number, description: 'The session number determines the order in which sessions are
evaluated when an interface is used by multiple sessions. The first
session with a matching filter is the one that mirrors the packets.

Valid values are 1-32766.', source: "modify_traffic_mirror_session", orig_name: 'session_number', type: [Integer], create_traffic_mirror_session_prop: 'session_number', read_only: false, modify_traffic_mirror_session_prop: 'session_number'
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'The tags assigned to the Traffic Mirror session.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::TrafficMirrorSession"
    • orig_name ⇒ 'tags'
    • create_traffic_mirror_session_prop ⇒ 'tag_specifications'
    • read_only ⇒ false
    

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

property :tags, disposition: :attribute, description: 'The tags assigned to the Traffic Mirror session.', source: "MintPress::Aws::EC2::TrafficMirrorSession", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, create_traffic_mirror_session_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_traffic_mirror_session_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "modify_traffic_mirror_session"
    • delete_traffic_mirror_session_prop ⇒ 'dry_run'
    • describe_traffic_mirror_sessions_prop ⇒ 'dry_run'
    • modify_traffic_mirror_session_prop ⇒ 'dry_run'
    

41
42
43
44
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/traffic_mirror_session.rb', line 41

property :dry_run, create_traffic_mirror_session_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "modify_traffic_mirror_session", 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_traffic_mirror_session_prop: 'dry_run', describe_traffic_mirror_sessions_prop: 'dry_run', modify_traffic_mirror_session_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_traffic_mirror_session_prop ⇒ 'client_token'
    • read_only ⇒ false
    • source ⇒ "create_traffic_mirror_session"
    

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

property :client_token, create_traffic_mirror_session_prop: 'client_token', type: [String], read_only: false, source: "create_traffic_mirror_session", 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]
    'One or more filters. The possible values are: description: The Traffic Mirror session description. network-interface-id: The ID of the Traffic Mirror session network interface. owner-id: The ID of the account that owns the Traffic Mirror session. packet-length: The assigned number of packets to mirror. session-number: The assigned session number. traffic-mirror-filter-id: The ID of the Traffic Mirror filter. traffic-mirror-session-id: The ID of the Traffic Mirror session. traffic-mirror-target-id: The ID of the Traffic Mirror target. virtual-network-id: The virtual network ID of the Traffic Mirror session.'
    Property Attributes
    • describe_traffic_mirror_sessions_prop ⇒ 'filters'
    • source ⇒ "describe_traffic_mirror_sessions"
    

51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/traffic_mirror_session.rb', line 51

property :filters, describe_traffic_mirror_sessions_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_traffic_mirror_sessions", description: 'One or more filters. The possible values are:


description: The Traffic Mirror session description.
network-interface-id: The ID of the Traffic Mirror session
network interface.
owner-id: The ID of the account that owns the Traffic Mirror
session.
packet-length: The assigned number of packets to mirror.
session-number: The assigned session number.
traffic-mirror-filter-id: The ID of the Traffic Mirror filter.
traffic-mirror-session-id: The ID of the Traffic Mirror session.
traffic-mirror-target-id: The ID of the Traffic Mirror target.
virtual-network-id: The virtual network ID of the Traffic Mirror
session.', 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_traffic_mirror_sessions_prop ⇒ 'max_results'
    • source ⇒ "describe_traffic_mirror_sessions"
    

66
67
68
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/traffic_mirror_session.rb', line 66

property :max_results, describe_traffic_mirror_sessions_prop: 'max_results', type: [Integer], source: "describe_traffic_mirror_sessions", 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.'
  • #remove_fields ⇒ Array of ⇒ [String]
    'The properties that you want to remove from the Traffic Mirror session. When you remove a property from a Traffic Mirror session, the property is set to the default.'
    Property Attributes
    • modify_traffic_mirror_session_prop ⇒ 'remove_fields'
    • read_only ⇒ false
    • source ⇒ "modify_traffic_mirror_session"
    

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

property :remove_fields, modify_traffic_mirror_session_prop: 'remove_fields', type: [String], array: true, read_only: false, source: "modify_traffic_mirror_session", description: 'The properties that you want to remove from the Traffic Mirror
session.

When you remove a property from a Traffic Mirror session, the property
is set to the default.'
  • #network_interface ⇒ [MintPress::Aws::EC2::NetworkInterface]
    'The ID of the Traffic Mirror session"s network interface.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::TrafficMirrorSession"
    • orig_name ⇒ 'network_interface_id'
    • create_traffic_mirror_session_prop ⇒ 'network_interface_id'
    • read_only ⇒ false
    • from ⇒ String
    

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

property :network_interface, disposition: :attribute, description: 'The ID of the Traffic Mirror session"s network interface.', source: "MintPress::Aws::EC2::TrafficMirrorSession", orig_name: 'network_interface_id', type: [MintPress::Aws::EC2::NetworkInterface], create_traffic_mirror_session_prop: 'network_interface_id', read_only: false, from: String
  • #owner ⇒ [String]
    'The ID of the account that owns the Traffic Mirror session.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::TrafficMirrorSession"
    • orig_name ⇒ 'owner_id'
    

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

property :owner, disposition: :attribute, description: 'The ID of the account that owns the Traffic Mirror session.', source: "MintPress::Aws::EC2::TrafficMirrorSession", orig_name: 'owner_id', type: [String]
  • #traffic_mirror_filter ⇒ [MintPress::Aws::EC2::TrafficMirrorFilter]
    'The ID of the Traffic Mirror filter.'
    Property Attributes
    • source ⇒ "modify_traffic_mirror_session"
    • orig_name ⇒ 'traffic_mirror_filter_id'
    • create_traffic_mirror_session_prop ⇒ 'traffic_mirror_filter_id'
    • read_only ⇒ false
    • modify_traffic_mirror_session_prop ⇒ 'traffic_mirror_filter_id'
    • from ⇒ String
    

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

property :traffic_mirror_filter, description: 'The ID of the Traffic Mirror filter.', source: "modify_traffic_mirror_session", orig_name: 'traffic_mirror_filter_id', type: [MintPress::Aws::EC2::TrafficMirrorFilter], create_traffic_mirror_session_prop: 'traffic_mirror_filter_id', read_only: false, modify_traffic_mirror_session_prop: 'traffic_mirror_filter_id', from: String
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'The ID of the Traffic Mirror session.'
    Property Attributes
    • source ⇒ "describe_traffic_mirror_sessions"
    • orig_name ⇒ 'traffic_mirror_session_id'
    • delete_traffic_mirror_session_prop ⇒ 'traffic_mirror_session_id'
    • read_only ⇒ false
    • modify_traffic_mirror_session_prop ⇒ 'traffic_mirror_session_id'
    • describe_traffic_mirror_sessions_prop ⇒ 'traffic_mirror_session_ids'
    • default ⇒ Proc.new { self.name }
    

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

property :id, description: 'The ID of the Traffic Mirror session.', source: "describe_traffic_mirror_sessions", orig_name: 'traffic_mirror_session_id', type: [String], delete_traffic_mirror_session_prop: 'traffic_mirror_session_id', read_only: false, modify_traffic_mirror_session_prop: 'traffic_mirror_session_id', array: false, hash: false, describe_traffic_mirror_sessions_prop: 'traffic_mirror_session_ids', default: Proc.new { self.name }
  • #traffic_mirror_target ⇒ [MintPress::Aws::EC2::TrafficMirrorTarget]
    'The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.'
    Property Attributes
    • source ⇒ "modify_traffic_mirror_session"
    • orig_name ⇒ 'traffic_mirror_target_id'
    • create_traffic_mirror_session_prop ⇒ 'traffic_mirror_target_id'
    • read_only ⇒ false
    • modify_traffic_mirror_session_prop ⇒ 'traffic_mirror_target_id'
    • from ⇒ String
    

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

property :traffic_mirror_target, description: 'The Traffic Mirror target. The target must be in the same VPC as the
source, or have a VPC peering connection with the source.', source: "modify_traffic_mirror_session", orig_name: 'traffic_mirror_target_id', type: [MintPress::Aws::EC2::TrafficMirrorTarget], create_traffic_mirror_session_prop: 'traffic_mirror_target_id', read_only: false, modify_traffic_mirror_session_prop: 'traffic_mirror_target_id', from: String
  • #virtual_network ⇒ [Integer]
    'The virtual network ID of the Traffic Mirror session.'
    Property Attributes
    • source ⇒ "modify_traffic_mirror_session"
    • orig_name ⇒ 'virtual_network_id'
    • create_traffic_mirror_session_prop ⇒ 'virtual_network_id'
    • read_only ⇒ false
    • modify_traffic_mirror_session_prop ⇒ 'virtual_network_id'
    

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

property :virtual_network, description: 'The virtual network ID of the Traffic Mirror session.', source: "modify_traffic_mirror_session", orig_name: 'virtual_network_id', type: [Integer], create_traffic_mirror_session_prop: 'virtual_network_id', read_only: false, modify_traffic_mirror_session_prop: 'virtual_network_id'
  • #name ⇒ String

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Returns a new instance of TrafficMirrorSession.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#modify ⇒ Object