AWS::EC2::ClientVpnEndpoint ClientLoginBannerOptions

Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "BannerText" : String,
  "Enabled" : Boolean
}

YAML

  BannerText: String
  Enabled: Boolean

Properties

BannerText

Customizable text that will be displayed in a banner on AWS provided clients when a VPN session is established. UTF-8 encoded characters only. Maximum of 1400 characters.

Required: No

Type: String

Update requires: No interruption

Enabled

Enable or disable a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.

Valid values: true | false

Default value: false

Required: Yes

Type: Boolean

Update requires: No interruption