AWS::EC2::ClientVpnEndpoint ClientLoginBannerOptions - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::EC2::ClientVpnEndpoint ClientLoginBannerOptions

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

Syntax

To declare this entity in your Amazon 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 Amazon 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 Amazon provided clients when a VPN session is established.

Valid values: true | false

Default value: false

Required: Yes

Type: Boolean

Update requires: No interruption