Using roles for connection authorization in Client VPN;
AWS Client VPN uses AWS Identity and Access Management (IAM) service-linked roles. A service-linked role is a unique type of IAM role that is linked directly to Client VPN. Service-linked roles are predefined by Client VPN and include all the permissions that the service requires to call other AWS services on your behalf.
A service-linked role makes setting up Client VPN easier because you don’t have to manually add the necessary permissions. Client VPN defines the permissions of its service-linked roles, and unless defined otherwise, only Client VPN can assume its roles. The defined permissions include the trust policy and the permissions policy, and that permissions policy cannot be attached to any other IAM entity.
You can delete a service-linked role only after first deleting their related resources. This protects your Client VPN resources because you can't inadvertently remove permission to access the resources.
For information about other services that support service-linked roles, see AWS services that work with IAM and look for the services that have Yes in the Service-linked roles column. Choose a Yes with a link to view the service-linked role documentation for that service.
Service-linked role permissions for Client VPN
Client VPN uses the service-linked role named AWSServiceRoleForClientVPNConnections – Service Linked Role for Client VPN connections.
The AWSServiceRoleForClientVPNConnections service-linked role trusts the following services to assume the role:
-
clientvpn-connections.amazonaws.com
The role permissions policy named ClientVPNServiceConnectionsRolePolicy allows Client VPN to complete the following actions on the specified resources:
-
Action:
lambda:InvokeFunction
onarn:aws:lambda:*:*:function:AWSClientVPN-*
You must configure permissions to allow an IAM entity (such as a user, group, or role) to create, edit, or delete a service-linked role. For more information, see Service-linked role permissions in the IAM User Guide.
Creating a service-linked role for Client VPN
You don't need to manually create a service-linked role. When you create the first Client VPN endpoint in your account with the AWS Management Console, the AWS CLI, or the AWS API, Client VPN creates the service-linked role for you.
If you delete this service-linked role, and then need to create it again, you can use the same process to recreate the role in your account. When you create the first Client VPN endpoint in your account, Client VPN creates the service-linked role for you again.
Editing a service-linked role for Client VPN
Client VPN does not allow you to edit the AWSServiceRoleForClientVPNConnections service-linked role. After you create a service-linked role, you cannot change the name of the role because various entities might reference the role. However, you can edit the description of the role using IAM. For more information, see Editing a service-linked role in the IAM User Guide.
Deleting a service-linked role for Client VPN
If you no longer need to use Client VPN, we recommend that you delete the AWSServiceRoleForClientVPNConnections service-linked role.
You must first delete the related Client VPN resources. This ensures that you do not inadvertently remove permission to access the resources.
Use the IAM console, the IAM CLI, or the IAM API to delete the service-linked roles. For more information, see Deleting a Service-Linked Role in the IAM User Guide.
Supported Regions for Client VPN service-linked roles
Client VPN supports using service-linked roles in all of the Regions where the service is available. For more information, see AWS regions and endpoints.