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

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

Overview

Note:

When making an API call, you may pass ClientLoginBannerOptions data as a hash:

{
  enabled: false,
  banner_text: "String",
}

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

Instance Attribute Details

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)


5249
5250
5251
5252
5253
5254
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5249

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

#enabledBoolean

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

Returns:

  • (Boolean)


5249
5250
5251
5252
5253
5254
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5249

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