Class: MintPress::Aws::EC2::ClientVpnAuthorizationRule

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/client_vpn_authorization_rule.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
    • describe_client_vpn_authorization_rules_prop ⇒ 'dry_run'
    • source ⇒ "describe_client_vpn_authorization_rules"
    

19
20
21
22
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/client_vpn_authorization_rule.rb', line 19

property :dry_run, describe_client_vpn_authorization_rules_prop: 'dry_run', type: [TrueClass,FalseClass], source: "describe_client_vpn_authorization_rules", 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.'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'One or more filters. Filter names and values are case-sensitive. description - The description of the authorization rule. destination-cidr - The CIDR of the network to which the authorization rule applies. group-id - The ID of the Active Directory group to which the authorization rule grants access.'
    Property Attributes
    • describe_client_vpn_authorization_rules_prop ⇒ 'filters'
    • source ⇒ "describe_client_vpn_authorization_rules"
    

23
24
25
26
27
28
29
30
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/client_vpn_authorization_rule.rb', line 23

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


description - The description of the authorization rule.
destination-cidr - The CIDR of the network to which the
authorization rule applies.
group-id - The ID of the Active Directory group to which the
authorization rule grants access.', 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_authorization_rules_prop ⇒ 'max_results'
    • source ⇒ "describe_client_vpn_authorization_rules"
    

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

property :max_results, describe_client_vpn_authorization_rules_prop: 'max_results', type: [Integer], source: "describe_client_vpn_authorization_rules", 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
    • describe_client_vpn_authorization_rules_prop ⇒ 'client_vpn_endpoint_id'
    • source ⇒ "describe_client_vpn_authorization_rules"
    • from ⇒ String
    

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

property :client_vpn_endpoint, describe_client_vpn_authorization_rules_prop: 'client_vpn_endpoint_id', type: [MintPress::Aws::EC2::ClientVpnEndpoint], source: "describe_client_vpn_authorization_rules", description: 'The ID of the Client VPN endpoint.', from: 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 
    

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

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
    

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

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

Returns a new instance of ClientVpnAuthorizationRule.

Instance Method Details

#describe ⇒ Object