Class: MintPress::Aws::EC2::ClientVpnConnection

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

Properties (Read/Write)

  • #client_ip ⇒ [String]
    'The IP address of the client.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ClientVpnConnection"
    • orig_name ⇒ 'client_ip'
    

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

property :client_ip, disposition: :attribute, description: 'The IP address of the client.', source: "MintPress::Aws::EC2::ClientVpnConnection", orig_name: 'client_ip', type: [String]
  • #common_name ⇒ [String] (Default Value: Proc.new { self.name })
    'The common name associated with the client.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ClientVpnConnection"
    • orig_name ⇒ 'common_name'
    • default ⇒ Proc.new { self.name }
    

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

property :common_name, disposition: :attribute, description: 'The common name associated with the client.', source: "MintPress::Aws::EC2::ClientVpnConnection", orig_name: 'common_name', type: [String], default: Proc.new { self.name }
  • #connection_end_time ⇒ [String]
    'The date and time the client connection was terminated.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ClientVpnConnection"
    • orig_name ⇒ 'connection_end_time'
    

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

property :connection_end_time, disposition: :attribute, description: 'The date and time the client connection was terminated.', source: "MintPress::Aws::EC2::ClientVpnConnection", orig_name: 'connection_end_time', type: [String]
  • #connection_established_time ⇒ [String]
    'The date and time the client connection was established.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ClientVpnConnection"
    • orig_name ⇒ 'connection_established_time'
    

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

property :connection_established_time, disposition: :attribute, description: 'The date and time the client connection was established.', source: "MintPress::Aws::EC2::ClientVpnConnection", orig_name: 'connection_established_time', type: [String]
  • #egress_bytes ⇒ [String]
    'The number of bytes received by the client.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ClientVpnConnection"
    • orig_name ⇒ 'egress_bytes'
    

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

property :egress_bytes, disposition: :attribute, description: 'The number of bytes received by the client.', source: "MintPress::Aws::EC2::ClientVpnConnection", orig_name: 'egress_bytes', type: [String]
  • #egress_packets ⇒ [String]
    'The number of packets received by the client.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ClientVpnConnection"
    • orig_name ⇒ 'egress_packets'
    

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

property :egress_packets, disposition: :attribute, description: 'The number of packets received by the client.', source: "MintPress::Aws::EC2::ClientVpnConnection", orig_name: 'egress_packets', type: [String]
  • #ingress_bytes ⇒ [String]
    'The number of bytes sent by the client.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ClientVpnConnection"
    • orig_name ⇒ 'ingress_bytes'
    

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

property :ingress_bytes, disposition: :attribute, description: 'The number of bytes sent by the client.', source: "MintPress::Aws::EC2::ClientVpnConnection", orig_name: 'ingress_bytes', type: [String]
  • #ingress_packets ⇒ [String]
    'The number of packets sent by the client.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ClientVpnConnection"
    • orig_name ⇒ 'ingress_packets'
    

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

property :ingress_packets, disposition: :attribute, description: 'The number of packets sent by the client.', source: "MintPress::Aws::EC2::ClientVpnConnection", orig_name: 'ingress_packets', type: [String]
  • #posture_compliance_statuses ⇒ Array of ⇒ [String]
    'The statuses returned by the client connect handler for posture compliance, if applicable.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ClientVpnConnection"
    • orig_name ⇒ 'posture_compliance_statuses'
    

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

property :posture_compliance_statuses, disposition: :attribute, description: 'The statuses returned by the client connect handler for posture compliance, if applicable.', source: "MintPress::Aws::EC2::ClientVpnConnection", orig_name: 'posture_compliance_statuses', type: [String], array: true
  • #status ⇒ [MintPress::Aws::EC2::ClientVpnConnectionStatus] (Default Value: MintPress::Aws::EC2::ClientVpnConnectionStatus.new)
    'The current state of the client connection.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ClientVpnConnection"
    • orig_name ⇒ 'status'
    • default ⇒ MintPress::Aws::EC2::ClientVpnConnectionStatus.new
    

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

property :status, disposition: :attribute, description: 'The current state of the client connection.', source: "MintPress::Aws::EC2::ClientVpnConnection", orig_name: 'status', type: [MintPress::Aws::EC2::ClientVpnConnectionStatus], default: MintPress::Aws::EC2::ClientVpnConnectionStatus.new
  • #timestamp ⇒ [String]
    'The current date and time.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ClientVpnConnection"
    • orig_name ⇒ 'timestamp'
    

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

property :timestamp, disposition: :attribute, description: 'The current date and time.', source: "MintPress::Aws::EC2::ClientVpnConnection", orig_name: 'timestamp', type: [String]
  • #username ⇒ [String]
    'The name of the user who initiated the connection. Use this option to terminate all active connections for the specified user. This option can only be used if the user has established up to five connections.'
    Property Attributes
    • source ⇒ "terminate_client_vpn_connections"
    • orig_name ⇒ 'username'
    • terminate_client_vpn_connections_prop ⇒ 'username'
    • read_only ⇒ false
    

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

property :username, description: 'The name of the user who initiated the connection. Use this option to
terminate all active connections for the specified user. This option
can only be used if the user has established up to five connections.', source: "terminate_client_vpn_connections", orig_name: 'username', type: [String], terminate_client_vpn_connections_prop: 'username', read_only: false
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'One or more filters. Filter names and values are case-sensitive. connection-id - The ID of the connection. username - For Active Directory client authentication, the user name of the client who established the client connection.'
    Property Attributes
    • describe_client_vpn_connections_prop ⇒ 'filters'
    • source ⇒ "describe_client_vpn_connections"
    

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

property :filters, describe_client_vpn_connections_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_client_vpn_connections", description: 'One or more filters. Filter names and values are case-sensitive.


connection-id - The ID of the connection.
username - For Active Directory client authentication, the user
name of the client who established the client connection.', hash: true
  • #max_results ⇒ [Integer]
    'The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.'
    Property Attributes
    • describe_client_vpn_connections_prop ⇒ 'max_results'
    • source ⇒ "describe_client_vpn_connections"
    

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

property :max_results, describe_client_vpn_connections_prop: 'max_results', type: [Integer], source: "describe_client_vpn_connections", description: 'The maximum number of results to return for the request in a single
page. The remaining results can be seen by sending another request
with the nextToken value.'
  • #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
    • describe_client_vpn_connections_prop ⇒ 'dry_run'
    • source ⇒ "terminate_client_vpn_connections"
    • terminate_client_vpn_connections_prop ⇒ 'dry_run'
    • read_only ⇒ false
    

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

property :dry_run, describe_client_vpn_connections_prop: 'dry_run', type: [TrueClass,FalseClass], source: "terminate_client_vpn_connections", 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.', terminate_client_vpn_connections_prop: 'dry_run', read_only: false
  • #client_vpn_endpoint ⇒ [MintPress::Aws::EC2::ClientVpnEndpoint]
    'The ID of the Client VPN endpoint to which the client is connected.'
    Property Attributes
    • source ⇒ "terminate_client_vpn_connections"
    • orig_name ⇒ 'client_vpn_endpoint_id'
    • describe_client_vpn_connections_prop ⇒ 'client_vpn_endpoint_id'
    • terminate_client_vpn_connections_prop ⇒ 'client_vpn_endpoint_id'
    • read_only ⇒ false
    • from ⇒ String
    

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

property :client_vpn_endpoint, description: 'The ID of the Client VPN endpoint to which the client is connected.', source: "terminate_client_vpn_connections", orig_name: 'client_vpn_endpoint_id', type: [MintPress::Aws::EC2::ClientVpnEndpoint], describe_client_vpn_connections_prop: 'client_vpn_endpoint_id', terminate_client_vpn_connections_prop: 'client_vpn_endpoint_id', read_only: false, from: String
  • #id ⇒ [String]
    'The ID of the client connection to be terminated.'
    Property Attributes
    • source ⇒ "terminate_client_vpn_connections"
    • orig_name ⇒ 'connection_id'
    • terminate_client_vpn_connections_prop ⇒ 'connection_id'
    • read_only ⇒ false
    

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

property :id, description: 'The ID of the client connection to be terminated.', source: "terminate_client_vpn_connections", orig_name: 'connection_id', type: [String], terminate_client_vpn_connections_prop: 'connection_id', read_only: false, array: false, hash: false
  • #name ⇒ [String]

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Returns a new instance of ClientVpnConnection.

Instance Method Details

#delete_cascade ⇒ Object

#describe ⇒ Object

#terminate ⇒ Object