Class: MintPress::Aws::EC2::TrafficMirrorTarget

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

Properties (Read/Write)

  • #description ⇒ [String]
    'Information about the Traffic Mirror target.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::TrafficMirrorTarget"
    • orig_name ⇒ 'description'
    • create_traffic_mirror_target_prop ⇒ 'description'
    • read_only ⇒ false
    

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

property :description, disposition: :attribute, description: 'Information about the Traffic Mirror target.', source: "MintPress::Aws::EC2::TrafficMirrorTarget", orig_name: 'description', type: [String], create_traffic_mirror_target_prop: 'description', read_only: false
  • #network_load_balancer_arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the Network Load Balancer.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::TrafficMirrorTarget"
    • orig_name ⇒ 'network_load_balancer_arn'
    • create_traffic_mirror_target_prop ⇒ 'network_load_balancer_arn'
    • read_only ⇒ false
    

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

property :network_load_balancer_arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) of the Network Load Balancer.', source: "MintPress::Aws::EC2::TrafficMirrorTarget", orig_name: 'network_load_balancer_arn', type: [String], create_traffic_mirror_target_prop: 'network_load_balancer_arn', read_only: false
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'The tags assigned to the Traffic Mirror target.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::TrafficMirrorTarget"
    • orig_name ⇒ 'tags'
    • create_traffic_mirror_target_prop ⇒ 'tag_specifications'
    • read_only ⇒ false
    

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

property :tags, disposition: :attribute, description: 'The tags assigned to the Traffic Mirror target.', source: "MintPress::Aws::EC2::TrafficMirrorTarget", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, create_traffic_mirror_target_prop: 'tag_specifications', read_only: false, hash: true
  • #type ⇒ [String]
    'The type of Traffic Mirror target.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::TrafficMirrorTarget"
    • orig_name ⇒ 'type'
    

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

property :type, disposition: :attribute, description: 'The type of Traffic Mirror target.', source: "MintPress::Aws::EC2::TrafficMirrorTarget", orig_name: 'type', type: [String]
  • #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_target_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "describe_traffic_mirror_targets"
    • delete_traffic_mirror_target_prop ⇒ 'dry_run'
    • describe_traffic_mirror_targets_prop ⇒ 'dry_run'
    

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

property :dry_run, create_traffic_mirror_target_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "describe_traffic_mirror_targets", 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_target_prop: 'dry_run', describe_traffic_mirror_targets_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_target_prop ⇒ 'client_token'
    • read_only ⇒ false
    • source ⇒ "create_traffic_mirror_target"
    

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

property :client_token, create_traffic_mirror_target_prop: 'client_token', type: [String], read_only: false, source: "create_traffic_mirror_target", 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 target description. network-interface-id: The ID of the Traffic Mirror session network interface. network-load-balancer-arn: The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the session. owner-id: The ID of the account that owns the Traffic Mirror session. traffic-mirror-target-id: The ID of the Traffic Mirror target.'
    Property Attributes
    • describe_traffic_mirror_targets_prop ⇒ 'filters'
    • source ⇒ "describe_traffic_mirror_targets"
    

38
39
40
41
42
43
44
45
46
47
48
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/traffic_mirror_target.rb', line 38

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


description: The Traffic Mirror target description.
network-interface-id: The ID of the Traffic Mirror session
network interface.
network-load-balancer-arn: The Amazon Resource Name (ARN) of the
Network Load Balancer that is associated with the session.
owner-id: The ID of the account that owns the Traffic Mirror
session.
traffic-mirror-target-id: The ID of the Traffic Mirror target.', 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_targets_prop ⇒ 'max_results'
    • source ⇒ "describe_traffic_mirror_targets"
    

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

property :max_results, describe_traffic_mirror_targets_prop: 'max_results', type: [Integer], source: "describe_traffic_mirror_targets", 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.'
  • #network_interface ⇒ [MintPress::Aws::EC2::NetworkInterface]
    'The network interface ID that is attached to the target.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::TrafficMirrorTarget"
    • orig_name ⇒ 'network_interface_id'
    • create_traffic_mirror_target_prop ⇒ 'network_interface_id'
    • read_only ⇒ false
    • from ⇒ String
    

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

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

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

property :owner, disposition: :attribute, description: 'The ID of the account that owns the Traffic Mirror target.', source: "MintPress::Aws::EC2::TrafficMirrorTarget", orig_name: 'owner_id', type: [String]
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'The ID of the Traffic Mirror targets.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "describe_traffic_mirror_targets"
    • orig_name ⇒ 'traffic_mirror_target_id'
    • delete_traffic_mirror_target_prop ⇒ 'traffic_mirror_target_id'
    • read_only ⇒ false
    • describe_traffic_mirror_targets_prop ⇒ 'traffic_mirror_target_ids'
    • default ⇒ Proc.new { self.name }
    

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

property :id, disposition: :attribute, description: 'The ID of the Traffic Mirror targets.', source: "describe_traffic_mirror_targets", orig_name: 'traffic_mirror_target_id', type: [String], delete_traffic_mirror_target_prop: 'traffic_mirror_target_id', read_only: false, array: false, hash: false, describe_traffic_mirror_targets_prop: 'traffic_mirror_target_ids', default: Proc.new { self.name }
  • #name ⇒ String

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Returns a new instance of TrafficMirrorTarget.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object