Package software.amazon.awscdk.services.ec2

Interface CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty.Jsii$Proxy

Enclosing class:

CfnClientVpnEndpoint

@Stability(Stable)
public static interface CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 ClientLoginBannerOptionsProperty clientLoginBannerOptionsProperty = ClientLoginBannerOptionsProperty.builder()
         .enabled(false)
         // the properties below are optional
         .bannerText("bannerText")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientloginbanneroptions.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty.Builder	A builder for CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty
static final class	CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty.Jsii$Proxy	An implementation for CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty

Method Summary

Modifier and Type	Method	Description
static CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty.Builder	builder()
default String	getBannerText()	Customizable text that will be displayed in a banner on AWS provided clients when a VPN session is established.
Object	getEnabled()	Enable or disable a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnabled

@Stability(Stable)
@NotNull
Object getEnabled()

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

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientloginbanneroptions.html#cfn-ec2-clientvpnendpoint-clientloginbanneroptions-enabled

getBannerText

@Stability(Stable)
@Nullable
default String getBannerText()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientloginbanneroptions.html#cfn-ec2-clientvpnendpoint-clientloginbanneroptions-bannertext

builder

@Stability(Stable)
static CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty.Builder builder()

Returns:

a CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty.Builder of CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty