Class: MintPress::Aws::EC2::ClientVpnIngress

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

Properties (Read/Write)

  • #target_network_cidr ⇒ [String]
    'The IPv4 address range, in CIDR notation, of the network for which access is being removed.'
    Property Attributes
    • authorize_client_vpn_ingress_prop ⇒ 'target_network_cidr'
    • read_only ⇒ false
    • source ⇒ "revoke_client_vpn_ingress"
    • revoke_client_vpn_ingress_prop ⇒ 'target_network_cidr'
    

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

property :target_network_cidr, authorize_client_vpn_ingress_prop: 'target_network_cidr', type: [String], read_only: false, source: "revoke_client_vpn_ingress", description: 'The IPv4 address range, in CIDR notation, of the network for which
access is being removed.', revoke_client_vpn_ingress_prop: 'target_network_cidr'
  • #authorize_all_groups ⇒ [TrueClass,FalseClass]
    'Indicates whether to grant access to all clients. Specify true to grant all clients who successfully establish a VPN connection access to the network. Must be set to true if AccessGroupId is not specified.'
    Property Attributes
    • authorize_client_vpn_ingress_prop ⇒ 'authorize_all_groups'
    • read_only ⇒ false
    • source ⇒ "authorize_client_vpn_ingress"
    

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

property :authorize_all_groups, authorize_client_vpn_ingress_prop: 'authorize_all_groups', type: [TrueClass,FalseClass], read_only: false, source: "authorize_client_vpn_ingress", description: 'Indicates whether to grant access to all clients. Specify true to
grant all clients who successfully establish a VPN connection access
to the network. Must be set to true if AccessGroupId is not
specified.'
  • #description ⇒ [String]
    'A brief description of the authorization rule.'
    Property Attributes
    • authorize_client_vpn_ingress_prop ⇒ 'description'
    • read_only ⇒ false
    • source ⇒ "authorize_client_vpn_ingress"
    

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

property :description, authorize_client_vpn_ingress_prop: 'description', type: [String], read_only: false, source: "authorize_client_vpn_ingress", description: 'A brief description of the authorization rule.'
  • #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
    • authorize_client_vpn_ingress_prop ⇒ 'client_token'
    • read_only ⇒ false
    • source ⇒ "authorize_client_vpn_ingress"
    

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

property :client_token, authorize_client_vpn_ingress_prop: 'client_token', type: [String], read_only: false, source: "authorize_client_vpn_ingress", 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
    • authorize_client_vpn_ingress_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "revoke_client_vpn_ingress"
    • revoke_client_vpn_ingress_prop ⇒ 'dry_run'
    

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

property :dry_run, authorize_client_vpn_ingress_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "revoke_client_vpn_ingress", 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.', revoke_client_vpn_ingress_prop: 'dry_run'
  • #revoke_all_groups ⇒ [TrueClass,FalseClass]
    'Indicates whether access should be revoked for all clients.'
    Property Attributes
    • revoke_client_vpn_ingress_prop ⇒ 'revoke_all_groups'
    • read_only ⇒ false
    • source ⇒ "revoke_client_vpn_ingress"
    

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

property :revoke_all_groups, revoke_client_vpn_ingress_prop: 'revoke_all_groups', type: [TrueClass,FalseClass], read_only: false, source: "revoke_client_vpn_ingress", description: 'Indicates whether access should be revoked for all clients.'
  • #client_vpn_endpoint ⇒ [MintPress::Aws::EC2::ClientVpnEndpoint]
    'The ID of the Client VPN endpoint with which the authorization rule is associated.'
    Property Attributes
    • authorize_client_vpn_ingress_prop ⇒ 'client_vpn_endpoint_id'
    • read_only ⇒ false
    • source ⇒ "revoke_client_vpn_ingress"
    • revoke_client_vpn_ingress_prop ⇒ 'client_vpn_endpoint_id'
    • from ⇒ String
    

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

property :client_vpn_endpoint, authorize_client_vpn_ingress_prop: 'client_vpn_endpoint_id', type: [MintPress::Aws::EC2::ClientVpnEndpoint], read_only: false, source: "revoke_client_vpn_ingress", description: 'The ID of the Client VPN endpoint with which the authorization rule is
associated.', revoke_client_vpn_ingress_prop: 'client_vpn_endpoint_id', from: String
  • #access_group ⇒ [String]
    'The ID of the Active Directory group for which to revoke access.'
    Property Attributes
    • authorize_client_vpn_ingress_prop ⇒ 'access_group_id'
    • read_only ⇒ false
    • source ⇒ "revoke_client_vpn_ingress"
    • revoke_client_vpn_ingress_prop ⇒ 'access_group_id'
    

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

property :access_group, authorize_client_vpn_ingress_prop: 'access_group_id', type: [String], read_only: false, source: "revoke_client_vpn_ingress", description: 'The ID of the Active Directory group for which to revoke access.', revoke_client_vpn_ingress_prop: 'access_group_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 
    

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

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
    

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

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

Returns a new instance of ClientVpnIngress.

Instance Method Details

#authorize ⇒ Object

#revoke ⇒ Object