Documentation
¶
Index ¶
- func ApplicationAppearance_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
- func ApplicationAppearance_IsConstruct(x interface{}) *bool
- func ApplicationAppearance_IsTerraformElement(x interface{}) *bool
- func ApplicationAppearance_IsTerraformResource(x interface{}) *bool
- func ApplicationAppearance_TfResourceType() *string
- func NewApplicationAppearance_Override(a ApplicationAppearance, scope constructs.Construct, id *string, ...)
- type ApplicationAppearance
- type ApplicationAppearanceConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ApplicationAppearance_GenerateConfigForImport ¶
func ApplicationAppearance_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource
Generates CDKTF code for importing a ApplicationAppearance resource upon running "cdktf plan <stack-name>".
func ApplicationAppearance_IsConstruct ¶
func ApplicationAppearance_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 ApplicationAppearance_IsTerraformElement ¶
func ApplicationAppearance_IsTerraformElement(x interface{}) *bool
Experimental.
func ApplicationAppearance_IsTerraformResource ¶
func ApplicationAppearance_IsTerraformResource(x interface{}) *bool
Experimental.
func ApplicationAppearance_TfResourceType ¶
func ApplicationAppearance_TfResourceType() *string
func NewApplicationAppearance_Override ¶
func NewApplicationAppearance_Override(a ApplicationAppearance, scope constructs.Construct, id *string, config *ApplicationAppearanceConfig)
Create a new {@link https://registry.terraform.io/providers/gitlabhq/gitlab/18.6.1/docs/resources/application_appearance gitlab_application_appearance} Resource.
Types ¶
type ApplicationAppearance ¶
type ApplicationAppearance interface {
cdktf.TerraformResource
// 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)
Description() *string
SetDescription(val *string)
DescriptionInput() *string
// Experimental.
ForEach() cdktf.ITerraformIterator
// Experimental.
SetForEach(val cdktf.ITerraformIterator)
// Experimental.
Fqn() *string
// Experimental.
FriendlyUniqueId() *string
HeaderMessage() *string
SetHeaderMessage(val *string)
HeaderMessageInput() *string
Id() *string
KeepSettingsOnDestroy() interface{}
SetKeepSettingsOnDestroy(val interface{})
KeepSettingsOnDestroyInput() interface{}
// Experimental.
Lifecycle() *cdktf.TerraformResourceLifecycle
// Experimental.
SetLifecycle(val *cdktf.TerraformResourceLifecycle)
MemberGuidelines() *string
SetMemberGuidelines(val *string)
MemberGuidelinesInput() *string
MessageBackgroundColor() *string
SetMessageBackgroundColor(val *string)
MessageBackgroundColorInput() *string
MessageFontColor() *string
SetMessageFontColor(val *string)
MessageFontColorInput() *string
NewProjectGuidelines() *string
SetNewProjectGuidelines(val *string)
NewProjectGuidelinesInput() *string
// The tree node.
Node() constructs.Node
ProfileImageGuidelines() *string
SetProfileImageGuidelines(val *string)
ProfileImageGuidelinesInput() *string
// Experimental.
Provider() cdktf.TerraformProvider
// Experimental.
SetProvider(val cdktf.TerraformProvider)
// Experimental.
Provisioners() *[]interface{}
// Experimental.
SetProvisioners(val *[]interface{})
PwaDescription() *string
SetPwaDescription(val *string)
PwaDescriptionInput() *string
PwaName() *string
SetPwaName(val *string)
PwaNameInput() *string
PwaShortName() *string
SetPwaShortName(val *string)
PwaShortNameInput() *string
// Experimental.
RawOverrides() interface{}
// Experimental.
TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
// Experimental.
TerraformMetaArguments() *map[string]interface{}
// Experimental.
TerraformResourceType() *string
Title() *string
SetTitle(val *string)
TitleInput() *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)
ResetDescription()
ResetHeaderMessage()
ResetKeepSettingsOnDestroy()
ResetMemberGuidelines()
ResetMessageBackgroundColor()
ResetMessageFontColor()
ResetNewProjectGuidelines()
// Resets a previously passed logical Id to use the auto-generated logical id again.
// Experimental.
ResetOverrideLogicalId()
ResetProfileImageGuidelines()
ResetPwaDescription()
ResetPwaName()
ResetPwaShortName()
ResetTitle()
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/gitlabhq/gitlab/18.6.1/docs/resources/application_appearance gitlab_application_appearance}.
func NewApplicationAppearance ¶
func NewApplicationAppearance(scope constructs.Construct, id *string, config *ApplicationAppearanceConfig) ApplicationAppearance
Create a new {@link https://registry.terraform.io/providers/gitlabhq/gitlab/18.6.1/docs/resources/application_appearance gitlab_application_appearance} Resource.
type ApplicationAppearanceConfig ¶
type ApplicationAppearanceConfig 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"`
// Markdown text shown on the sign-in and sign-up page.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/18.6.1/docs/resources/application_appearance#description ApplicationAppearance#description}
Description *string `field:"optional" json:"description" yaml:"description"`
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/18.6.1/docs/resources/application_appearance#email_header_and_footer_enabled ApplicationAppearance#email_header_and_footer_enabled}
EmailHeaderAndFooterEnabled interface{} `field:"optional" json:"emailHeaderAndFooterEnabled" yaml:"emailHeaderAndFooterEnabled"`
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/18.6.1/docs/resources/application_appearance#footer_message ApplicationAppearance#footer_message}
FooterMessage *string `field:"optional" json:"footerMessage" yaml:"footerMessage"`
// Message in the system header bar.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/18.6.1/docs/resources/application_appearance#header_message ApplicationAppearance#header_message}
HeaderMessage *string `field:"optional" json:"headerMessage" yaml:"headerMessage"`
// Set to true if the appearance settings should not be reset to their pre-terraform defaults on destroy.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/18.6.1/docs/resources/application_appearance#keep_settings_on_destroy ApplicationAppearance#keep_settings_on_destroy}
KeepSettingsOnDestroy interface{} `field:"optional" json:"keepSettingsOnDestroy" yaml:"keepSettingsOnDestroy"`
// Markdown text shown on the group or project member page for users with permission to change members.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/18.6.1/docs/resources/application_appearance#member_guidelines ApplicationAppearance#member_guidelines}
MemberGuidelines *string `field:"optional" json:"memberGuidelines" yaml:"memberGuidelines"`
// Background color for the system header or footer bar, in CSS hex notation.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/18.6.1/docs/resources/application_appearance#message_background_color ApplicationAppearance#message_background_color}
MessageBackgroundColor *string `field:"optional" json:"messageBackgroundColor" yaml:"messageBackgroundColor"`
// Font color for the system header or footer bar, in CSS hex notation.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/18.6.1/docs/resources/application_appearance#message_font_color ApplicationAppearance#message_font_color}
MessageFontColor *string `field:"optional" json:"messageFontColor" yaml:"messageFontColor"`
// Markdown text shown on the new project page.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/18.6.1/docs/resources/application_appearance#new_project_guidelines ApplicationAppearance#new_project_guidelines}
NewProjectGuidelines *string `field:"optional" json:"newProjectGuidelines" yaml:"newProjectGuidelines"`
// Markdown text shown on the profile page below the Public Avatar.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/18.6.1/docs/resources/application_appearance#profile_image_guidelines ApplicationAppearance#profile_image_guidelines}
ProfileImageGuidelines *string `field:"optional" json:"profileImageGuidelines" yaml:"profileImageGuidelines"`
// An explanation of what the Progressive Web App does. Used for the attribute `description` in `manifest.json`.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/18.6.1/docs/resources/application_appearance#pwa_description ApplicationAppearance#pwa_description}
PwaDescription *string `field:"optional" json:"pwaDescription" yaml:"pwaDescription"`
// Full name of the Progressive Web App. Used for the attribute `name` in `manifest.json`.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/18.6.1/docs/resources/application_appearance#pwa_name ApplicationAppearance#pwa_name}
PwaName *string `field:"optional" json:"pwaName" yaml:"pwaName"`
// Short name for Progressive Web App.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/18.6.1/docs/resources/application_appearance#pwa_short_name ApplicationAppearance#pwa_short_name}
PwaShortName *string `field:"optional" json:"pwaShortName" yaml:"pwaShortName"`
// Application title on the sign-in and sign-up page.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/18.6.1/docs/resources/application_appearance#title ApplicationAppearance#title}
Title *string `field:"optional" json:"title" yaml:"title"`
}