Class: MintPress::Aws::EC2::FlowLog

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/flow_log.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
    • create_flow_logs_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "describe_flow_logs"
    • delete_flow_logs_prop ⇒ 'dry_run'
    • describe_flow_logs_prop ⇒ 'dry_run'
    

23
24
25
26
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/flow_log.rb', line 23

property :dry_run, create_flow_logs_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "describe_flow_logs", 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_flow_logs_prop: 'dry_run', describe_flow_logs_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.'
    Property Attributes
    • create_flow_logs_prop ⇒ 'client_token'
    • read_only ⇒ false
    • source ⇒ "create_flow_logs"
    

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

property :client_token, create_flow_logs_prop: 'client_token', type: [String], read_only: false, source: "create_flow_logs", description: 'Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see How to Ensure
Idempotency.'
  • #deliver_logs_permission_arn ⇒ [String]
    'The ARN of the IAM role that posts logs to CloudWatch Logs.'
    Property Attributes
    • create_flow_logs_prop ⇒ 'deliver_logs_permission_arn'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::EC2::FlowLog"
    • orig_name ⇒ 'deliver_logs_permission_arn'
    

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

property :deliver_logs_permission_arn, create_flow_logs_prop: 'deliver_logs_permission_arn', type: [String], disposition: :attribute, read_only: false, source: "MintPress::Aws::EC2::FlowLog", description: 'The ARN of the IAM role that posts logs to CloudWatch Logs.', orig_name: 'deliver_logs_permission_arn'
  • #log_group_name ⇒ [String] (Default Value: Proc.new { self.name })
    'The name of the flow log group.'
    Property Attributes
    • create_flow_logs_prop ⇒ 'log_group_name'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::EC2::FlowLog"
    • orig_name ⇒ 'log_group_name'
    • default ⇒ Proc.new { self.name }
    

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

property :log_group_name, create_flow_logs_prop: 'log_group_name', type: [String], disposition: :attribute, read_only: false, source: "MintPress::Aws::EC2::FlowLog", description: 'The name of the flow log group.', orig_name: 'log_group_name', default: Proc.new { self.name }
  • #resource_type ⇒ [String]
    'The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.'
    Property Attributes
    • create_flow_logs_prop ⇒ 'resource_type'
    • read_only ⇒ false
    • source ⇒ "create_flow_logs"
    

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

property :resource_type, create_flow_logs_prop: 'resource_type', type: [String], read_only: false, source: "create_flow_logs", description: 'The type of resource for which to create the flow log. For example, if
you specified a VPC ID for the ResourceId property, specify VPC
for this property.'
  • #traffic_type ⇒ [String]
    'The type of traffic captured for the flow log.'
    Property Attributes
    • create_flow_logs_prop ⇒ 'traffic_type'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::EC2::FlowLog"
    • orig_name ⇒ 'traffic_type'
    

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

property :traffic_type, create_flow_logs_prop: 'traffic_type', type: [String], disposition: :attribute, read_only: false, source: "MintPress::Aws::EC2::FlowLog", description: 'The type of traffic captured for the flow log.', orig_name: 'traffic_type'
  • #log_destination_type ⇒ [String]
    'Specifies the type of destination to which the flow log data is published.'
    Property Attributes
    • create_flow_logs_prop ⇒ 'log_destination_type'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::EC2::FlowLog"
    • orig_name ⇒ 'log_destination_type'
    

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

property :log_destination_type, create_flow_logs_prop: 'log_destination_type', type: [String], disposition: :attribute, read_only: false, source: "MintPress::Aws::EC2::FlowLog", description: 'Specifies the type of destination to which the flow log data is published.', orig_name: 'log_destination_type'
  • #log_destination ⇒ [String]
    'Specifies the destination to which the flow log data is published.'
    Property Attributes
    • create_flow_logs_prop ⇒ 'log_destination'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::EC2::FlowLog"
    • orig_name ⇒ 'log_destination'
    

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

property :log_destination, create_flow_logs_prop: 'log_destination', type: [String], disposition: :attribute, read_only: false, source: "MintPress::Aws::EC2::FlowLog", description: 'Specifies the destination to which the flow log data is published.', orig_name: 'log_destination'
  • #log_format ⇒ [String]
    'The format of the flow log record.'
    Property Attributes
    • create_flow_logs_prop ⇒ 'log_format'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::EC2::FlowLog"
    • orig_name ⇒ 'log_format'
    

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

property :log_format, create_flow_logs_prop: 'log_format', type: [String], disposition: :attribute, read_only: false, source: "MintPress::Aws::EC2::FlowLog", description: 'The format of the flow log record.', orig_name: 'log_format'
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'The tags for the flow log.'
    Property Attributes
    • create_flow_logs_prop ⇒ 'tag_specifications'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::EC2::FlowLog"
    • orig_name ⇒ 'tags'
    

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

property :tags, create_flow_logs_prop: 'tag_specifications', type: [MintPress::Aws::EC2::Tag], array: false, disposition: :attribute, read_only: false, source: "MintPress::Aws::EC2::FlowLog", description: 'The tags for the flow log.', orig_name: 'tags', hash: true
  • #max_aggregation_interval ⇒ [Integer]
    'The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.'
    Property Attributes
    • create_flow_logs_prop ⇒ 'max_aggregation_interval'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::EC2::FlowLog"
    • orig_name ⇒ 'max_aggregation_interval'
    

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

property :max_aggregation_interval, create_flow_logs_prop: 'max_aggregation_interval', type: [Integer], disposition: :attribute, read_only: false, source: "MintPress::Aws::EC2::FlowLog", description: 'The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.', orig_name: 'max_aggregation_interval'
  • #creation_time ⇒ [Time]
    'The date and time the flow log was created.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::FlowLog"
    • orig_name ⇒ 'creation_time'
    

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

property :creation_time, disposition: :attribute, description: 'The date and time the flow log was created.', source: "MintPress::Aws::EC2::FlowLog", orig_name: 'creation_time', type: [Time]
  • #deliver_logs_error_message ⇒ [String]
    'Information about the error that occurred.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::FlowLog"
    • orig_name ⇒ 'deliver_logs_error_message'
    

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

property :deliver_logs_error_message, disposition: :attribute, description: 'Information about the error that occurred.', source: "MintPress::Aws::EC2::FlowLog", orig_name: 'deliver_logs_error_message', type: [String]
  • #deliver_logs_status ⇒ [String]
    'The status of the logs delivery (SUCCESS | FAILED).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::FlowLog"
    • orig_name ⇒ 'deliver_logs_status'
    

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

property :deliver_logs_status, disposition: :attribute, description: 'The status of the logs delivery (SUCCESS | FAILED).', source: "MintPress::Aws::EC2::FlowLog", orig_name: 'deliver_logs_status', type: [String]
  • #flow_log_status ⇒ [String]
    'The status of the flow log (ACTIVE).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::FlowLog"
    • orig_name ⇒ 'flow_log_status'
    

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

property :flow_log_status, disposition: :attribute, description: 'The status of the flow log (ACTIVE).', source: "MintPress::Aws::EC2::FlowLog", orig_name: 'flow_log_status', type: [String]
  • #filter ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'One or more filters. deliver-log-status - The status of the logs delivery (SUCCESS | FAILED). log-destination-type - The type of destination to which the flow log publishes data. Possible destination types include cloud-watch-logs and s3. flow-log-id - The ID of the flow log. log-group-name - The name of the log group. resource-id - The ID of the VPC, subnet, or network interface. traffic-type - The type of traffic (ACCEPT | REJECT | ALL). 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.'
    Property Attributes
    • describe_flow_logs_prop ⇒ 'filter'
    • source ⇒ "describe_flow_logs"
    

45
46
47
48
49
50
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/flow_log.rb', line 45

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


deliver-log-status - The status of the logs delivery (SUCCESS |
FAILED).
log-destination-type - The type of destination to which the flow
log publishes data. Possible destination types include
cloud-watch-logs and s3.
flow-log-id - The ID of the flow log.
log-group-name - The name of the log group.
resource-id - The ID of the VPC, subnet, or network interface.
traffic-type - The type of traffic (ACCEPT | REJECT |
ALL).
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.', 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_flow_logs_prop ⇒ 'max_results'
    • source ⇒ "describe_flow_logs"
    

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

property :max_results, describe_flow_logs_prop: 'max_results', type: [Integer], source: "describe_flow_logs", 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.'
  • #resources ⇒ Array of ⇒ [String] (Default Value: Proc.new { [self.parent.id] })
    'The ID of the subnet, network interface, or VPC for which you want to create a flow log. Constraints: Maximum of 1000 resources'
    Property Attributes
    • create_flow_logs_prop ⇒ 'resource_ids'
    • read_only ⇒ false
    • source ⇒ "create_flow_logs"
    • default ⇒ Proc.new { [self.parent.id] }
    

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

property :resources, create_flow_logs_prop: 'resource_ids', type: [String], array: true, read_only: false, source: "create_flow_logs", description: 'The ID of the subnet, network interface, or VPC for which you want to
create a flow log.

Constraints: Maximum of 1000 resources', default: Proc.new { [self.parent.id] }
  • #id ⇒ [String]
    'The flow log ID.'
    Property Attributes
    • delete_flow_logs_prop ⇒ 'flow_log_ids'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::EC2::FlowLog"
    • describe_flow_logs_prop ⇒ 'flow_log_ids'
    • orig_name ⇒ 'flow_log_id'
    

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

property :id, delete_flow_logs_prop: 'flow_log_ids', type: [String], array: false, disposition: :attribute, read_only: false, source: "MintPress::Aws::EC2::FlowLog", description: 'The flow log ID.', describe_flow_logs_prop: 'flow_log_ids', hash: false, orig_name: 'flow_log_id'
  • #resource ⇒ [String]
    'The ID of the resource on which the flow log was created.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::FlowLog"
    • orig_name ⇒ 'resource_id'
    

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

property :resource, disposition: :attribute, description: 'The ID of the resource on which the flow log was created.', source: "MintPress::Aws::EC2::FlowLog", orig_name: 'resource_id', type: [String]
  • #name ⇒ [String]

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Returns a new instance of FlowLog.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object