Class: MintPress::Aws::EC2::ClientVpnRoute

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

Properties (Read/Write)

  • #destination_cidr_block ⇒ [String]
    'The IPv4 address range, in CIDR notation, of the route to be deleted.'
    Property Attributes
    • create_client_vpn_route_prop ⇒ 'destination_cidr_block'
    • read_only ⇒ false
    • source ⇒ "delete_client_vpn_route"
    • delete_client_vpn_route_prop ⇒ 'destination_cidr_block'
    

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

property :destination_cidr_block, create_client_vpn_route_prop: 'destination_cidr_block', type: [String], read_only: false, source: "delete_client_vpn_route", description: 'The IPv4 address range, in CIDR notation, of the route to be deleted.', delete_client_vpn_route_prop: 'destination_cidr_block'
  • #description ⇒ [String]
    'A brief description of the route.'
    Property Attributes
    • create_client_vpn_route_prop ⇒ 'description'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::EC2::ClientVpnRoute"
    • orig_name ⇒ 'description'
    

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

property :description, create_client_vpn_route_prop: 'description', type: [String], disposition: :attribute, read_only: false, source: "MintPress::Aws::EC2::ClientVpnRoute", description: 'A brief description of the route.', orig_name: 'description'
  • #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_client_vpn_route_prop ⇒ 'client_token'
    • read_only ⇒ false
    • source ⇒ "create_client_vpn_route"
    

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

property :client_token, create_client_vpn_route_prop: 'client_token', type: [String], read_only: false, source: "create_client_vpn_route", 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.**'
  • #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_client_vpn_route_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "describe_client_vpn_routes"
    • delete_client_vpn_route_prop ⇒ 'dry_run'
    • describe_client_vpn_routes_prop ⇒ 'dry_run'
    

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

property :dry_run, create_client_vpn_route_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "describe_client_vpn_routes", 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_client_vpn_route_prop: 'dry_run', describe_client_vpn_routes_prop: 'dry_run'
  • #destination_cidr ⇒ [String]
    'The IPv4 address range, in CIDR notation, of the route destination.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ClientVpnRoute"
    • orig_name ⇒ 'destination_cidr'
    

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

property :destination_cidr, disposition: :attribute, description: 'The IPv4 address range, in CIDR notation, of the route destination.', source: "MintPress::Aws::EC2::ClientVpnRoute", orig_name: 'destination_cidr', type: [String]
  • #origin ⇒ [String]
    'Indicates how the route was associated with the Client VPN endpoint.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ClientVpnRoute"
    • orig_name ⇒ 'origin'
    

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

property :origin, disposition: :attribute, description: 'Indicates how the route was associated with the Client VPN endpoint.', source: "MintPress::Aws::EC2::ClientVpnRoute", orig_name: 'origin', type: [String]
  • #status ⇒ [MintPress::Aws::EC2::ClientVpnRouteStatus] (Default Value: MintPress::Aws::EC2::ClientVpnRouteStatus.new)
    'The current state of the route.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ClientVpnRoute"
    • orig_name ⇒ 'status'
    • default ⇒ MintPress::Aws::EC2::ClientVpnRouteStatus.new
    

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

property :status, disposition: :attribute, description: 'The current state of the route.', source: "MintPress::Aws::EC2::ClientVpnRoute", orig_name: 'status', type: [MintPress::Aws::EC2::ClientVpnRouteStatus], default: MintPress::Aws::EC2::ClientVpnRouteStatus.new
  • #target_subnet ⇒ [String]
    'The ID of the subnet through which traffic is routed.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ClientVpnRoute"
    • orig_name ⇒ 'target_subnet'
    

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

property :target_subnet, disposition: :attribute, description: 'The ID of the subnet through which traffic is routed.', source: "MintPress::Aws::EC2::ClientVpnRoute", orig_name: 'target_subnet', type: [String]
  • #type ⇒ [String]
    'The route type.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ClientVpnRoute"
    • orig_name ⇒ 'type'
    

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

property :type, disposition: :attribute, description: 'The route type.', source: "MintPress::Aws::EC2::ClientVpnRoute", orig_name: 'type', type: [String]
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'One or more filters. Filter names and values are case-sensitive. destination-cidr - The CIDR of the route destination. origin - How the route was associated with the Client VPN endpoint (associate | add-route). target-subnet - The ID of the subnet through which traffic is routed.'
    Property Attributes
    • describe_client_vpn_routes_prop ⇒ 'filters'
    • source ⇒ "describe_client_vpn_routes"
    

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

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


destination-cidr - The CIDR of the route destination.
origin - How the route was associated with the Client VPN endpoint
(associate | add-route).
target-subnet - The ID of the subnet through which traffic is
routed.', 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_routes_prop ⇒ 'max_results'
    • source ⇒ "describe_client_vpn_routes"
    

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

property :max_results, describe_client_vpn_routes_prop: 'max_results', type: [Integer], source: "describe_client_vpn_routes", 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.'
  • #client_vpn_endpoint ⇒ [MintPress::Aws::EC2::ClientVpnEndpoint]
    'The ID of the Client VPN endpoint.'
    Property Attributes
    • create_client_vpn_route_prop ⇒ 'client_vpn_endpoint_id'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "describe_client_vpn_routes"
    • delete_client_vpn_route_prop ⇒ 'client_vpn_endpoint_id'
    • orig_name ⇒ 'client_vpn_endpoint_id'
    • describe_client_vpn_routes_prop ⇒ 'client_vpn_endpoint_id'
    • from ⇒ String
    

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

property :client_vpn_endpoint, create_client_vpn_route_prop: 'client_vpn_endpoint_id', type: [MintPress::Aws::EC2::ClientVpnEndpoint], disposition: :attribute, read_only: false, source: "describe_client_vpn_routes", description: 'The ID of the Client VPN endpoint.', delete_client_vpn_route_prop: 'client_vpn_endpoint_id', orig_name: 'client_vpn_endpoint_id', describe_client_vpn_routes_prop: 'client_vpn_endpoint_id', from: String
  • #target_vpc_subnet ⇒ [String]
    'The ID of the target subnet used by the route.'
    Property Attributes
    • create_client_vpn_route_prop ⇒ 'target_vpc_subnet_id'
    • read_only ⇒ false
    • source ⇒ "delete_client_vpn_route"
    • delete_client_vpn_route_prop ⇒ 'target_vpc_subnet_id'
    

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

property :target_vpc_subnet, create_client_vpn_route_prop: 'target_vpc_subnet_id', type: [String], read_only: false, source: "delete_client_vpn_route", description: 'The ID of the target subnet used by the route.', delete_client_vpn_route_prop: 'target_vpc_subnet_id'
  • #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 
    

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

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
    

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

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

Returns a new instance of ClientVpnRoute.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object