Class: Aws::EC2::Types::ClientLoginBannerOptions

Inherits:

Struct

Object
Struct
Aws::EC2::Types::ClientLoginBannerOptions

Includes:: Structure

Defined in:: lib/aws-sdk-ec2/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#banner_text ⇒ String

Customizable text that will be displayed in a banner on Amazon Web Services provided clients when a VPN session is established.
#enabled ⇒ Boolean

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

Instance Attribute Details

#banner_text ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 5289

class ClientLoginBannerOptions < Struct.new(
  :enabled,
  :banner_text)
  SENSITIVE = []
  include Aws::Structure
end

#enabled ⇒ `Boolean`

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

Valid values: ‘true | false`

Default value: ‘false`