Package software.amazon.awssdk.services.ec2.model

Class ClientLoginBannerOptions

java.lang.Object

software.amazon.awssdk.services.ec2.model.ClientLoginBannerOptions

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ClientLoginBannerOptions.Builder,ClientLoginBannerOptions>

@Generated("software.amazon.awssdk:codegen")
public final class ClientLoginBannerOptions
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ClientLoginBannerOptions.Builder,ClientLoginBannerOptions>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ClientLoginBannerOptions.Builder

Method Summary

Modifier and Type	Method	Description
String	bannerText()	Customizable text that will be displayed in a banner on Amazon Web Services provided clients when a VPN session is established.
static ClientLoginBannerOptions.Builder	builder()
Boolean	enabled()	Enable or disable a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ClientLoginBannerOptions.Builder>	serializableBuilderClass()
ClientLoginBannerOptions.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

enabled

public final Boolean enabled()

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:

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

bannerText

public final String bannerText()

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:

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.

toBuilder

public ClientLoginBannerOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ClientLoginBannerOptions.Builder,ClientLoginBannerOptions>

builder

public static ClientLoginBannerOptions.Builder builder()

serializableBuilderClass

public static Class<? extends ClientLoginBannerOptions.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo