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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_group_idString

The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group. Required if ‘AuthorizeAllGroups` is `false` or not specified.

Returns:

  • (String)


3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
# File 'lib/aws-sdk-ec2/types.rb', line 3175

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

#authorize_all_groupsBoolean

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.

Returns:

  • (Boolean)


3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
# File 'lib/aws-sdk-ec2/types.rb', line 3175

class AuthorizeClientVpnIngressRequest < Struct.new(
  :client_vpn_endpoint_id,
  :target_network_cidr,
  :access_group_id,
  :authorize_all_groups,
  :description,
  :client_token,
  :dry_run)
  SENSITIVE = []
  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.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

Returns:

  • (String)


3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
# File 'lib/aws-sdk-ec2/types.rb', line 3175

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

#client_vpn_endpoint_idString

The ID of the Client VPN endpoint.

Returns:

  • (String)


3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
# File 'lib/aws-sdk-ec2/types.rb', line 3175

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

#descriptionString

A brief description of the authorization rule.

Returns:

  • (String)


3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
# File 'lib/aws-sdk-ec2/types.rb', line 3175

class AuthorizeClientVpnIngressRequest < Struct.new(
  :client_vpn_endpoint_id,
  :target_network_cidr,
  :access_group_id,
  :authorize_all_groups,
  :description,
  :client_token,
  :dry_run)
  SENSITIVE = []
  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)


3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
# File 'lib/aws-sdk-ec2/types.rb', line 3175

class AuthorizeClientVpnIngressRequest < Struct.new(
  :client_vpn_endpoint_id,
  :target_network_cidr,
  :access_group_id,
  :authorize_all_groups,
  :description,
  :client_token,
  :dry_run)
  SENSITIVE = []
  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)


3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
# File 'lib/aws-sdk-ec2/types.rb', line 3175

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