You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EC2::Types::AuthorizeClientVpnIngressRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass AuthorizeClientVpnIngressRequest data as a hash:

{
  client_vpn_endpoint_id: "String", # required
  target_network_cidr: "String", # required
  access_group_id: "String",
  authorize_all_groups: false,
  description: "String",
  client_token: "String",
  dry_run: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#access_group_idString

The ID of the Active Directory group to grant access.

Returns:

  • (String)


1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1513

class AuthorizeClientVpnIngressRequest < Struct.new(
  :client_vpn_endpoint_id,
  :target_network_cidr,
  :access_group_id,
  :authorize_all_groups,
  :description,
  :client_token,
  :dry_run)
  include Aws::Structure
end

#authorize_all_groupsBoolean

Indicates whether to grant access to all clients. Use true to grant all clients who successfully establish a VPN connection access to the network.

Returns:

  • (Boolean)


1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1513

class AuthorizeClientVpnIngressRequest < Struct.new(
  :client_vpn_endpoint_id,
  :target_network_cidr,
  :access_group_id,
  :authorize_all_groups,
  :description,
  :client_token,
  :dry_run)
  include Aws::Structure
end

#client_tokenString

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.

Returns:

  • (String)


1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1513

class AuthorizeClientVpnIngressRequest < Struct.new(
  :client_vpn_endpoint_id,
  :target_network_cidr,
  :access_group_id,
  :authorize_all_groups,
  :description,
  :client_token,
  :dry_run)
  include Aws::Structure
end

#client_vpn_endpoint_idString

The ID of the Client VPN endpoint.

Returns:

  • (String)


1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1513

class AuthorizeClientVpnIngressRequest < Struct.new(
  :client_vpn_endpoint_id,
  :target_network_cidr,
  :access_group_id,
  :authorize_all_groups,
  :description,
  :client_token,
  :dry_run)
  include Aws::Structure
end

#descriptionString

A brief description of the authorization rule.

Returns:

  • (String)


1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1513

class AuthorizeClientVpnIngressRequest < Struct.new(
  :client_vpn_endpoint_id,
  :target_network_cidr,
  :access_group_id,
  :authorize_all_groups,
  :description,
  :client_token,
  :dry_run)
  include Aws::Structure
end

#dry_runBoolean

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.

Returns:

  • (Boolean)


1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1513

class AuthorizeClientVpnIngressRequest < Struct.new(
  :client_vpn_endpoint_id,
  :target_network_cidr,
  :access_group_id,
  :authorize_all_groups,
  :description,
  :client_token,
  :dry_run)
  include Aws::Structure
end

#target_network_cidrString

The IPv4 address range, in CIDR notation, of the network for which access is being authorized.

Returns:

  • (String)


1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1513

class AuthorizeClientVpnIngressRequest < Struct.new(
  :client_vpn_endpoint_id,
  :target_network_cidr,
  :access_group_id,
  :authorize_all_groups,
  :description,
  :client_token,
  :dry_run)
  include Aws::Structure
end