interface ClientLoginBannerOptionsProperty

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.EC2.CfnClientVpnEndpointPropsMixin.ClientLoginBannerOptionsProperty
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsec2#CfnClientVpnEndpointPropsMixin_ClientLoginBannerOptionsProperty
Java	software.amazon.awscdk.cfnpropertymixins.services.ec2.CfnClientVpnEndpointPropsMixin.ClientLoginBannerOptionsProperty
Python	aws_cdk.cfn_property_mixins.aws_ec2.CfnClientVpnEndpointPropsMixin.ClientLoginBannerOptionsProperty
TypeScript	@aws-cdk/cfn-property-mixins » aws_ec2 » CfnClientVpnEndpointPropsMixin » ClientLoginBannerOptionsProperty

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

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

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/cfn-property-mixins';
const clientLoginBannerOptionsProperty: ec2.CfnClientVpnEndpointPropsMixin.ClientLoginBannerOptionsProperty = {
  bannerText: 'bannerText',
  enabled: false,
};

Properties

Name	Type	Description
bannerText?	string	Customizable text that will be displayed in a banner on AWS provided clients when a VPN session is established.
enabled?	boolean | IResolvable	Enable or disable a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.

---

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.

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

---

enabled?

Type: boolean | IResolvable (optional)

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

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