aws-cdk-lib.aws_ec2.CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty

interface ClientLoginBannerOptionsProperty

LanguageType name
.NETAmazon.CDK.AWS.EC2.CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsec2#CfnClientVpnEndpoint_ClientLoginBannerOptionsProperty
Javasoftware.amazon.awscdk.services.ec2.CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty
Pythonaws_cdk.aws_ec2.CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty
TypeScript aws-cdk-lib » aws_ec2 » CfnClientVpnEndpoint » ClientLoginBannerOptionsProperty

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 { aws_ec2 as ec2 } from 'aws-cdk-lib';
const clientLoginBannerOptionsProperty: ec2.CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty = {
  enabled: false,

  // the properties below are optional
  bannerText: 'bannerText',
};

Properties

NameTypeDescription
enabledboolean | IResolvableEnable or disable a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
bannerText?stringCustomizable text that will be displayed in a banner on AWS provided clients when a VPN session is established.

enabled

Type: boolean | IResolvable

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


bannerText?

Type: string (optional)

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.