Skip to content

Latest commit

 

History

History
1690 lines (1051 loc) · 77.6 KB

configUiCustomMessage.java.md

File metadata and controls

1690 lines (1051 loc) · 77.6 KB

configUiCustomMessage Submodule

Constructs

ConfigUiCustomMessage

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/config_ui_custom_message vault_config_ui_custom_message}.

Initializers 

import com.hashicorp.cdktf.providers.vault.config_ui_custom_message.ConfigUiCustomMessage;

ConfigUiCustomMessage.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .messageBase64(java.lang.String)
    .startTime(java.lang.String)
    .title(java.lang.String)
//  .authenticated(java.lang.Boolean)
//  .authenticated(IResolvable)
//  .endTime(java.lang.String)
//  .link(ConfigUiCustomMessageLink)
//  .namespace(java.lang.String)
//  .options(java.util.Map<java.lang.String, java.lang.String>)
//  .type(java.lang.String)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
messageBase64 java.lang.String The base64-encoded content of the custom message.
startTime java.lang.String The starting time of the active period of the custom message.
title java.lang.String The title of the custom message.
authenticated java.lang.Boolean OR com.hashicorp.cdktf.IResolvable A flag indicating whether the custom message is displayed pre-login (false) or post-login (true).
endTime java.lang.String The ending time of the active period of the custom message. Can be omitted for non-expiring message.
link ConfigUiCustomMessageLink link block.
namespace java.lang.String Target namespace. (requires Enterprise).
options java.util.Map<java.lang.String, java.lang.String> A map containing additional options for the custom message.
type java.lang.String The display type of custom message. Allowed values are banner and modal.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
messageBase64Required
  • Type: java.lang.String

The base64-encoded content of the custom message.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/config_ui_custom_message#message_base64 ConfigUiCustomMessage#message_base64}

startTimeRequired
  • Type: java.lang.String

The starting time of the active period of the custom message.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/config_ui_custom_message#start_time ConfigUiCustomMessage#start_time}

titleRequired
  • Type: java.lang.String

The title of the custom message.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/config_ui_custom_message#title ConfigUiCustomMessage#title}

authenticatedOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

A flag indicating whether the custom message is displayed pre-login (false) or post-login (true).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/config_ui_custom_message#authenticated ConfigUiCustomMessage#authenticated}

endTimeOptional
  • Type: java.lang.String

The ending time of the active period of the custom message. Can be omitted for non-expiring message.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/config_ui_custom_message#end_time ConfigUiCustomMessage#end_time}

linkOptional

link block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/config_ui_custom_message#link ConfigUiCustomMessage#link}

namespaceOptional
  • Type: java.lang.String

Target namespace. (requires Enterprise).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/config_ui_custom_message#namespace ConfigUiCustomMessage#namespace}

optionsOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

A map containing additional options for the custom message.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/config_ui_custom_message#options ConfigUiCustomMessage#options}

typeOptional
  • Type: java.lang.String

The display type of custom message. Allowed values are banner and modal.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/config_ui_custom_message#type ConfigUiCustomMessage#type}

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
putLink No description.
resetAuthenticated No description.
resetEndTime No description.
resetLink No description.
resetNamespace No description.
resetOptions No description.
resetType No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.String moveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.String id)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: java.lang.String

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: java.lang.String OR java.lang.Number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

moveToId 
public void moveToId(java.lang.String id)

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: java.lang.String

Full id of resource to move to, e.g. "aws_s3_bucket.example".

putLink 
public void putLink(ConfigUiCustomMessageLink value)
valueRequired
resetAuthenticated 
public void resetAuthenticated()
resetEndTime 
public void resetEndTime()
resetLink 
public void resetLink()
resetNamespace 
public void resetNamespace()
resetOptions 
public void resetOptions()
resetType 
public void resetType()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a ConfigUiCustomMessage resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.vault.config_ui_custom_message.ConfigUiCustomMessage;

ConfigUiCustomMessage.isConstruct(java.lang.Object x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.vault.config_ui_custom_message.ConfigUiCustomMessage;

ConfigUiCustomMessage.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.vault.config_ui_custom_message.ConfigUiCustomMessage;

ConfigUiCustomMessage.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.vault.config_ui_custom_message.ConfigUiCustomMessage;

ConfigUiCustomMessage.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),ConfigUiCustomMessage.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

Generates CDKTF code for importing a ConfigUiCustomMessage resource upon running "cdktf plan ".

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

The construct id used in the generated config for the ConfigUiCustomMessage to import.

importFromIdRequired
  • Type: java.lang.String

The id of the existing ConfigUiCustomMessage that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/config_ui_custom_message#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

? Optional instance of the provider where the ConfigUiCustomMessage to import is found.

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
id java.lang.String No description.
link ConfigUiCustomMessageLinkOutputReference No description.
authenticatedInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
endTimeInput java.lang.String No description.
linkInput ConfigUiCustomMessageLink No description.
messageBase64Input java.lang.String No description.
namespaceInput java.lang.String No description.
optionsInput java.util.Map<java.lang.String, java.lang.String> No description.
startTimeInput java.lang.String No description.
titleInput java.lang.String No description.
typeInput java.lang.String No description.
authenticated java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
endTime java.lang.String No description.
messageBase64 java.lang.String No description.
namespace java.lang.String No description.
options java.util.Map<java.lang.String, java.lang.String> No description.
startTime java.lang.String No description.
title java.lang.String No description.
type java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
linkRequired 
public ConfigUiCustomMessageLinkOutputReference getLink();
authenticatedInputOptional 
public java.lang.Object getAuthenticatedInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
endTimeInputOptional 
public java.lang.String getEndTimeInput();
  • Type: java.lang.String
linkInputOptional 
public ConfigUiCustomMessageLink getLinkInput();
messageBase64InputOptional 
public java.lang.String getMessageBase64Input();
  • Type: java.lang.String
namespaceInputOptional 
public java.lang.String getNamespaceInput();
  • Type: java.lang.String
optionsInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getOptionsInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
startTimeInputOptional 
public java.lang.String getStartTimeInput();
  • Type: java.lang.String
titleInputOptional 
public java.lang.String getTitleInput();
  • Type: java.lang.String
typeInputOptional 
public java.lang.String getTypeInput();
  • Type: java.lang.String
authenticatedRequired 
public java.lang.Object getAuthenticated();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
endTimeRequired 
public java.lang.String getEndTime();
  • Type: java.lang.String
messageBase64Required 
public java.lang.String getMessageBase64();
  • Type: java.lang.String
namespaceRequired 
public java.lang.String getNamespace();
  • Type: java.lang.String
optionsRequired 
public java.util.Map<java.lang.String, java.lang.String> getOptions();
  • Type: java.util.Map<java.lang.String, java.lang.String>
startTimeRequired 
public java.lang.String getStartTime();
  • Type: java.lang.String
titleRequired 
public java.lang.String getTitle();
  • Type: java.lang.String
typeRequired 
public java.lang.String getType();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

ConfigUiCustomMessageConfig

Initializer 

import com.hashicorp.cdktf.providers.vault.config_ui_custom_message.ConfigUiCustomMessageConfig;

ConfigUiCustomMessageConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .messageBase64(java.lang.String)
    .startTime(java.lang.String)
    .title(java.lang.String)
//  .authenticated(java.lang.Boolean)
//  .authenticated(IResolvable)
//  .endTime(java.lang.String)
//  .link(ConfigUiCustomMessageLink)
//  .namespace(java.lang.String)
//  .options(java.util.Map<java.lang.String, java.lang.String>)
//  .type(java.lang.String)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
messageBase64 java.lang.String The base64-encoded content of the custom message.
startTime java.lang.String The starting time of the active period of the custom message.
title java.lang.String The title of the custom message.
authenticated java.lang.Boolean OR com.hashicorp.cdktf.IResolvable A flag indicating whether the custom message is displayed pre-login (false) or post-login (true).
endTime java.lang.String The ending time of the active period of the custom message. Can be omitted for non-expiring message.
link ConfigUiCustomMessageLink link block.
namespace java.lang.String Target namespace. (requires Enterprise).
options java.util.Map<java.lang.String, java.lang.String> A map containing additional options for the custom message.
type java.lang.String The display type of custom message. Allowed values are banner and modal.
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
messageBase64Required 
public java.lang.String getMessageBase64();
  • Type: java.lang.String

The base64-encoded content of the custom message.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/config_ui_custom_message#message_base64 ConfigUiCustomMessage#message_base64}

startTimeRequired 
public java.lang.String getStartTime();
  • Type: java.lang.String

The starting time of the active period of the custom message.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/config_ui_custom_message#start_time ConfigUiCustomMessage#start_time}

titleRequired 
public java.lang.String getTitle();
  • Type: java.lang.String

The title of the custom message.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/config_ui_custom_message#title ConfigUiCustomMessage#title}

authenticatedOptional 
public java.lang.Object getAuthenticated();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

A flag indicating whether the custom message is displayed pre-login (false) or post-login (true).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/config_ui_custom_message#authenticated ConfigUiCustomMessage#authenticated}

endTimeOptional 
public java.lang.String getEndTime();
  • Type: java.lang.String

The ending time of the active period of the custom message. Can be omitted for non-expiring message.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/config_ui_custom_message#end_time ConfigUiCustomMessage#end_time}

linkOptional 
public ConfigUiCustomMessageLink getLink();

link block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/config_ui_custom_message#link ConfigUiCustomMessage#link}

namespaceOptional 
public java.lang.String getNamespace();
  • Type: java.lang.String

Target namespace. (requires Enterprise).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/config_ui_custom_message#namespace ConfigUiCustomMessage#namespace}

optionsOptional 
public java.util.Map<java.lang.String, java.lang.String> getOptions();
  • Type: java.util.Map<java.lang.String, java.lang.String>

A map containing additional options for the custom message.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/config_ui_custom_message#options ConfigUiCustomMessage#options}

typeOptional 
public java.lang.String getType();
  • Type: java.lang.String

The display type of custom message. Allowed values are banner and modal.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/config_ui_custom_message#type ConfigUiCustomMessage#type}

ConfigUiCustomMessageLink

Initializer 

import com.hashicorp.cdktf.providers.vault.config_ui_custom_message.ConfigUiCustomMessageLink;

ConfigUiCustomMessageLink.builder()
    .href(java.lang.String)
    .title(java.lang.String)
    .build();

Properties

Name Type Description
href java.lang.String The URL of the hyperlink.
title java.lang.String The title of the hyperlink.
hrefRequired 
public java.lang.String getHref();
  • Type: java.lang.String

The URL of the hyperlink.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/config_ui_custom_message#href ConfigUiCustomMessage#href}

titleRequired 
public java.lang.String getTitle();
  • Type: java.lang.String

The title of the hyperlink.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/config_ui_custom_message#title ConfigUiCustomMessage#title}

Classes

ConfigUiCustomMessageLinkOutputReference

Initializers 

import com.hashicorp.cdktf.providers.vault.config_ui_custom_message.ConfigUiCustomMessageLinkOutputReference;

new ConfigUiCustomMessageLinkOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
computeFqn 
public java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
hrefInput java.lang.String No description.
titleInput java.lang.String No description.
href java.lang.String No description.
title java.lang.String No description.
internalValue ConfigUiCustomMessageLink No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.String>

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
hrefInputOptional 
public java.lang.String getHrefInput();
  • Type: java.lang.String
titleInputOptional 
public java.lang.String getTitleInput();
  • Type: java.lang.String
hrefRequired 
public java.lang.String getHref();
  • Type: java.lang.String
titleRequired 
public java.lang.String getTitle();
  • Type: java.lang.String
internalValueOptional 
public ConfigUiCustomMessageLink getInternalValue();