configuicustommessage

package
v13.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 20, 2024 License: MPL-2.0 Imports: 7 Imported by: 0

README

vault_config_ui_custom_message

Refer to the Terraform Registry for docs: vault_config_ui_custom_message.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ConfigUiCustomMessage_GenerateConfigForImport

func ConfigUiCustomMessage_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource

Generates CDKTF code for importing a ConfigUiCustomMessage resource upon running "cdktf plan <stack-name>".

func ConfigUiCustomMessage_IsConstruct

func ConfigUiCustomMessage_IsConstruct(x interface{}) *bool

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.

Returns: true if `x` is an object created from a class which extends `Construct`.

func ConfigUiCustomMessage_IsTerraformElement

func ConfigUiCustomMessage_IsTerraformElement(x interface{}) *bool

Experimental.

func ConfigUiCustomMessage_IsTerraformResource

func ConfigUiCustomMessage_IsTerraformResource(x interface{}) *bool

Experimental.

func ConfigUiCustomMessage_TfResourceType

func ConfigUiCustomMessage_TfResourceType() *string

func NewConfigUiCustomMessageLinkOutputReference_Override

func NewConfigUiCustomMessageLinkOutputReference_Override(c ConfigUiCustomMessageLinkOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)

func NewConfigUiCustomMessage_Override

func NewConfigUiCustomMessage_Override(c ConfigUiCustomMessage, scope constructs.Construct, id *string, config *ConfigUiCustomMessageConfig)

Create a new {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/config_ui_custom_message vault_config_ui_custom_message} Resource.

Types

type ConfigUiCustomMessage

type ConfigUiCustomMessage interface {
	cdktf.TerraformResource
	Authenticated() interface{}
	SetAuthenticated(val interface{})
	AuthenticatedInput() interface{}
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	EndTime() *string
	SetEndTime(val *string)
	EndTimeInput() *string
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Id() *string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	Link() ConfigUiCustomMessageLinkOutputReference
	LinkInput() *ConfigUiCustomMessageLink
	MessageBase64() *string
	SetMessageBase64(val *string)
	MessageBase64Input() *string
	Namespace() *string
	SetNamespace(val *string)
	NamespaceInput() *string
	// The tree node.
	Node() constructs.Node
	Options() *map[string]*string
	SetOptions(val *map[string]*string)
	OptionsInput() *map[string]*string
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	Provisioners() *[]interface{}
	// Experimental.
	SetProvisioners(val *[]interface{})
	// Experimental.
	RawOverrides() interface{}
	StartTime() *string
	SetStartTime(val *string)
	StartTimeInput() *string
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	Title() *string
	SetTitle(val *string)
	TitleInput() *string
	Type() *string
	SetType(val *string)
	TypeInput() *string
	// Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
	// Experimental.
	AddMoveTarget(moveTarget *string)
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	HasResourceMove() interface{}
	// Experimental.
	ImportFrom(id *string, provider cdktf.TerraformProvider)
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// 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.
	// Experimental.
	MoveFromId(id *string)
	// Moves this resource to the target resource given by moveTarget.
	// Experimental.
	MoveTo(moveTarget *string, index interface{})
	// Moves this resource to the resource corresponding to "id".
	// Experimental.
	MoveToId(id *string)
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	PutLink(value *ConfigUiCustomMessageLink)
	ResetAuthenticated()
	ResetEndTime()
	ResetLink()
	ResetNamespace()
	ResetOptions()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetType()
	SynthesizeAttributes() *map[string]interface{}
	SynthesizeHclAttributes() *map[string]interface{}
	// Experimental.
	ToHclTerraform() interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

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

func NewConfigUiCustomMessage

func NewConfigUiCustomMessage(scope constructs.Construct, id *string, config *ConfigUiCustomMessageConfig) ConfigUiCustomMessage

Create a new {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/config_ui_custom_message vault_config_ui_custom_message} Resource.

type ConfigUiCustomMessageConfig

type ConfigUiCustomMessageConfig struct {
	// Experimental.
	Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
	// Experimental.
	Count interface{} `field:"optional" json:"count" yaml:"count"`
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
	// Experimental.
	Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
	// Experimental.
	Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
	// The base64-encoded content of the custom message.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/config_ui_custom_message#message_base64 ConfigUiCustomMessage#message_base64}
	MessageBase64 *string `field:"required" json:"messageBase64" yaml:"messageBase64"`
	// The starting time of the active period of the custom message.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/config_ui_custom_message#start_time ConfigUiCustomMessage#start_time}
	StartTime *string `field:"required" json:"startTime" yaml:"startTime"`
	// The title of the custom message.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/config_ui_custom_message#title ConfigUiCustomMessage#title}
	Title *string `field:"required" json:"title" yaml:"title"`
	// 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.5.0/docs/resources/config_ui_custom_message#authenticated ConfigUiCustomMessage#authenticated}
	Authenticated interface{} `field:"optional" json:"authenticated" yaml:"authenticated"`
	// 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.5.0/docs/resources/config_ui_custom_message#end_time ConfigUiCustomMessage#end_time}
	EndTime *string `field:"optional" json:"endTime" yaml:"endTime"`
	// link block.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/config_ui_custom_message#link ConfigUiCustomMessage#link}
	Link *ConfigUiCustomMessageLink `field:"optional" json:"link" yaml:"link"`
	// Target namespace. (requires Enterprise).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/config_ui_custom_message#namespace ConfigUiCustomMessage#namespace}
	Namespace *string `field:"optional" json:"namespace" yaml:"namespace"`
	// A map containing additional options for the custom message.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/config_ui_custom_message#options ConfigUiCustomMessage#options}
	Options *map[string]*string `field:"optional" json:"options" yaml:"options"`
	// 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.5.0/docs/resources/config_ui_custom_message#type ConfigUiCustomMessage#type}
	Type *string `field:"optional" json:"type" yaml:"type"`
}
type ConfigUiCustomMessageLink struct {
	// The URL of the hyperlink.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/config_ui_custom_message#href ConfigUiCustomMessage#href}
	Href *string `field:"required" json:"href" yaml:"href"`
	// The title of the hyperlink.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/config_ui_custom_message#title ConfigUiCustomMessage#title}
	Title *string `field:"required" json:"title" yaml:"title"`
}

type ConfigUiCustomMessageLinkOutputReference

type ConfigUiCustomMessageLinkOutputReference interface {
	cdktf.ComplexObject
	// the index of the complex object in a list.
	// Experimental.
	ComplexObjectIndex() interface{}
	// Experimental.
	SetComplexObjectIndex(val interface{})
	// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
	// Experimental.
	ComplexObjectIsFromSet() *bool
	// Experimental.
	SetComplexObjectIsFromSet(val *bool)
	// 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.
	// Experimental.
	CreationStack() *[]*string
	// Experimental.
	Fqn() *string
	Href() *string
	SetHref(val *string)
	HrefInput() *string
	InternalValue() *ConfigUiCustomMessageLink
	SetInternalValue(val *ConfigUiCustomMessageLink)
	// Experimental.
	TerraformAttribute() *string
	// Experimental.
	SetTerraformAttribute(val *string)
	// Experimental.
	TerraformResource() cdktf.IInterpolatingParent
	// Experimental.
	SetTerraformResource(val cdktf.IInterpolatingParent)
	Title() *string
	SetTitle(val *string)
	TitleInput() *string
	// Experimental.
	ComputeFqn() *string
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationAsList() cdktf.IResolvable
	// Experimental.
	InterpolationForAttribute(property *string) cdktf.IResolvable
	// Produce the Token's value at resolution time.
	// Experimental.
	Resolve(_context cdktf.IResolveContext) interface{}
	// Return a string representation of this resolvable object.
	//
	// Returns a reversible string representation.
	// Experimental.
	ToString() *string
}

func NewConfigUiCustomMessageLinkOutputReference

func NewConfigUiCustomMessageLinkOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) ConfigUiCustomMessageLinkOutputReference

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL