Documentation
¶
Index ¶
- func NewProjectHookCustomHeadersList_Override(p ProjectHookCustomHeadersList, terraformResource cdktf.IInterpolatingParent, ...)
- func NewProjectHookCustomHeadersOutputReference_Override(p ProjectHookCustomHeadersOutputReference, ...)
- func NewProjectHook_Override(p ProjectHook, scope constructs.Construct, id *string, ...)
- func ProjectHook_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
- func ProjectHook_IsConstruct(x interface{}) *bool
- func ProjectHook_IsTerraformElement(x interface{}) *bool
- func ProjectHook_IsTerraformResource(x interface{}) *bool
- func ProjectHook_TfResourceType() *string
- type ProjectHook
- type ProjectHookConfig
- type ProjectHookCustomHeaders
- type ProjectHookCustomHeadersList
- type ProjectHookCustomHeadersOutputReference
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewProjectHookCustomHeadersList_Override ¶
func NewProjectHookCustomHeadersList_Override(p ProjectHookCustomHeadersList, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, wrapsSet *bool)
func NewProjectHookCustomHeadersOutputReference_Override ¶
func NewProjectHookCustomHeadersOutputReference_Override(p ProjectHookCustomHeadersOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, complexObjectIndex *float64, complexObjectIsFromSet *bool)
func NewProjectHook_Override ¶
func NewProjectHook_Override(p ProjectHook, scope constructs.Construct, id *string, config *ProjectHookConfig)
Create a new {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.11.0/docs/resources/project_hook gitlab_project_hook} Resource.
func ProjectHook_GenerateConfigForImport ¶
func ProjectHook_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource
Generates CDKTF code for importing a ProjectHook resource upon running "cdktf plan <stack-name>".
func ProjectHook_IsConstruct ¶
func ProjectHook_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 ProjectHook_IsTerraformElement ¶
func ProjectHook_IsTerraformElement(x interface{}) *bool
Experimental.
func ProjectHook_IsTerraformResource ¶
func ProjectHook_IsTerraformResource(x interface{}) *bool
Experimental.
func ProjectHook_TfResourceType ¶
func ProjectHook_TfResourceType() *string
Types ¶
type ProjectHook ¶
type ProjectHook interface {
cdktf.TerraformResource
// Experimental.
CdktfStack() cdktf.TerraformStack
ConfidentialIssuesEvents() interface{}
SetConfidentialIssuesEvents(val interface{})
ConfidentialIssuesEventsInput() interface{}
ConfidentialNoteEvents() interface{}
SetConfidentialNoteEvents(val interface{})
ConfidentialNoteEventsInput() interface{}
// Experimental.
Connection() interface{}
// Experimental.
SetConnection(val interface{})
// Experimental.
ConstructNodeMetadata() *map[string]interface{}
// Experimental.
Count() interface{}
// Experimental.
SetCount(val interface{})
CustomHeaders() ProjectHookCustomHeadersList
CustomHeadersInput() interface{}
CustomWebhookTemplate() *string
SetCustomWebhookTemplate(val *string)
CustomWebhookTemplateInput() *string
// Experimental.
DependsOn() *[]*string
// Experimental.
SetDependsOn(val *[]*string)
DeploymentEvents() interface{}
SetDeploymentEvents(val interface{})
DeploymentEventsInput() interface{}
Description() *string
SetDescription(val *string)
DescriptionInput() *string
EnableSslVerification() interface{}
SetEnableSslVerification(val interface{})
EnableSslVerificationInput() interface{}
// Experimental.
ForEach() cdktf.ITerraformIterator
// Experimental.
SetForEach(val cdktf.ITerraformIterator)
// Experimental.
Fqn() *string
// Experimental.
FriendlyUniqueId() *string
HookId() *float64
Id() *string
IssuesEvents() interface{}
SetIssuesEvents(val interface{})
IssuesEventsInput() interface{}
JobEvents() interface{}
SetJobEvents(val interface{})
JobEventsInput() interface{}
// Experimental.
Lifecycle() *cdktf.TerraformResourceLifecycle
// Experimental.
SetLifecycle(val *cdktf.TerraformResourceLifecycle)
MergeRequestsEvents() interface{}
SetMergeRequestsEvents(val interface{})
MergeRequestsEventsInput() interface{}
Name() *string
SetName(val *string)
NameInput() *string
// The tree node.
Node() constructs.Node
NoteEvents() interface{}
SetNoteEvents(val interface{})
NoteEventsInput() interface{}
PipelineEvents() interface{}
SetPipelineEvents(val interface{})
PipelineEventsInput() interface{}
Project() *string
SetProject(val *string)
ProjectId() *float64
ProjectInput() *string
// Experimental.
Provider() cdktf.TerraformProvider
// Experimental.
SetProvider(val cdktf.TerraformProvider)
// Experimental.
Provisioners() *[]interface{}
// Experimental.
SetProvisioners(val *[]interface{})
PushEvents() interface{}
SetPushEvents(val interface{})
PushEventsBranchFilter() *string
SetPushEventsBranchFilter(val *string)
PushEventsBranchFilterInput() *string
PushEventsInput() interface{}
// Experimental.
RawOverrides() interface{}
ReleasesEvents() interface{}
SetReleasesEvents(val interface{})
ReleasesEventsInput() interface{}
ResourceAccessTokenEvents() interface{}
SetResourceAccessTokenEvents(val interface{})
ResourceAccessTokenEventsInput() interface{}
TagPushEvents() interface{}
SetTagPushEvents(val interface{})
TagPushEventsInput() interface{}
// Experimental.
TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
// Experimental.
TerraformMetaArguments() *map[string]interface{}
// Experimental.
TerraformResourceType() *string
Token() *string
SetToken(val *string)
TokenInput() *string
Url() *string
SetUrl(val *string)
UrlInput() *string
WikiPageEvents() interface{}
SetWikiPageEvents(val interface{})
WikiPageEventsInput() interface{}
// 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)
PutCustomHeaders(value interface{})
ResetConfidentialIssuesEvents()
ResetConfidentialNoteEvents()
ResetCustomHeaders()
ResetCustomWebhookTemplate()
ResetDeploymentEvents()
ResetDescription()
ResetEnableSslVerification()
ResetIssuesEvents()
ResetJobEvents()
ResetMergeRequestsEvents()
ResetName()
ResetNoteEvents()
// Resets a previously passed logical Id to use the auto-generated logical id again.
// Experimental.
ResetOverrideLogicalId()
ResetPipelineEvents()
ResetPushEvents()
ResetPushEventsBranchFilter()
ResetReleasesEvents()
ResetResourceAccessTokenEvents()
ResetTagPushEvents()
ResetToken()
ResetWikiPageEvents()
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/17.11.0/docs/resources/project_hook gitlab_project_hook}.
func NewProjectHook ¶
func NewProjectHook(scope constructs.Construct, id *string, config *ProjectHookConfig) ProjectHook
Create a new {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.11.0/docs/resources/project_hook gitlab_project_hook} Resource.
type ProjectHookConfig ¶
type ProjectHookConfig 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 name or id of the project to add the hook to.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.11.0/docs/resources/project_hook#project ProjectHook#project}
Project *string `field:"required" json:"project" yaml:"project"`
// The url of the hook to invoke. Forces re-creation to preserve `token`.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.11.0/docs/resources/project_hook#url ProjectHook#url}
Url *string `field:"required" json:"url" yaml:"url"`
// Invoke the hook for confidential issues events.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.11.0/docs/resources/project_hook#confidential_issues_events ProjectHook#confidential_issues_events}
ConfidentialIssuesEvents interface{} `field:"optional" json:"confidentialIssuesEvents" yaml:"confidentialIssuesEvents"`
// Invoke the hook for confidential note events.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.11.0/docs/resources/project_hook#confidential_note_events ProjectHook#confidential_note_events}
ConfidentialNoteEvents interface{} `field:"optional" json:"confidentialNoteEvents" yaml:"confidentialNoteEvents"`
// Custom headers for the project webhook.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.11.0/docs/resources/project_hook#custom_headers ProjectHook#custom_headers}
CustomHeaders interface{} `field:"optional" json:"customHeaders" yaml:"customHeaders"`
// Custom webhook template.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.11.0/docs/resources/project_hook#custom_webhook_template ProjectHook#custom_webhook_template}
CustomWebhookTemplate *string `field:"optional" json:"customWebhookTemplate" yaml:"customWebhookTemplate"`
// Invoke the hook for deployment events.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.11.0/docs/resources/project_hook#deployment_events ProjectHook#deployment_events}
DeploymentEvents interface{} `field:"optional" json:"deploymentEvents" yaml:"deploymentEvents"`
// Description of the webhook.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.11.0/docs/resources/project_hook#description ProjectHook#description}
Description *string `field:"optional" json:"description" yaml:"description"`
// Enable SSL verification when invoking the hook.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.11.0/docs/resources/project_hook#enable_ssl_verification ProjectHook#enable_ssl_verification}
EnableSslVerification interface{} `field:"optional" json:"enableSslVerification" yaml:"enableSslVerification"`
// Invoke the hook for issues events.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.11.0/docs/resources/project_hook#issues_events ProjectHook#issues_events}
IssuesEvents interface{} `field:"optional" json:"issuesEvents" yaml:"issuesEvents"`
// Invoke the hook for job events.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.11.0/docs/resources/project_hook#job_events ProjectHook#job_events}
JobEvents interface{} `field:"optional" json:"jobEvents" yaml:"jobEvents"`
// Invoke the hook for merge requests events.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.11.0/docs/resources/project_hook#merge_requests_events ProjectHook#merge_requests_events}
MergeRequestsEvents interface{} `field:"optional" json:"mergeRequestsEvents" yaml:"mergeRequestsEvents"`
// Name of the project webhook.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.11.0/docs/resources/project_hook#name ProjectHook#name}
Name *string `field:"optional" json:"name" yaml:"name"`
// Invoke the hook for note events.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.11.0/docs/resources/project_hook#note_events ProjectHook#note_events}
NoteEvents interface{} `field:"optional" json:"noteEvents" yaml:"noteEvents"`
// Invoke the hook for pipeline events.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.11.0/docs/resources/project_hook#pipeline_events ProjectHook#pipeline_events}
PipelineEvents interface{} `field:"optional" json:"pipelineEvents" yaml:"pipelineEvents"`
// Invoke the hook for push events.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.11.0/docs/resources/project_hook#push_events ProjectHook#push_events}
PushEvents interface{} `field:"optional" json:"pushEvents" yaml:"pushEvents"`
// Invoke the hook for push events on matching branches only.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.11.0/docs/resources/project_hook#push_events_branch_filter ProjectHook#push_events_branch_filter}
PushEventsBranchFilter *string `field:"optional" json:"pushEventsBranchFilter" yaml:"pushEventsBranchFilter"`
// Invoke the hook for release events.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.11.0/docs/resources/project_hook#releases_events ProjectHook#releases_events}
ReleasesEvents interface{} `field:"optional" json:"releasesEvents" yaml:"releasesEvents"`
// Invoke the hook for project access token expiry events.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.11.0/docs/resources/project_hook#resource_access_token_events ProjectHook#resource_access_token_events}
ResourceAccessTokenEvents interface{} `field:"optional" json:"resourceAccessTokenEvents" yaml:"resourceAccessTokenEvents"`
// Invoke the hook for tag push events.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.11.0/docs/resources/project_hook#tag_push_events ProjectHook#tag_push_events}
TagPushEvents interface{} `field:"optional" json:"tagPushEvents" yaml:"tagPushEvents"`
// A token to present when invoking the hook. The token is not available for imported resources.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.11.0/docs/resources/project_hook#token ProjectHook#token}
Token *string `field:"optional" json:"token" yaml:"token"`
// Invoke the hook for wiki page events.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.11.0/docs/resources/project_hook#wiki_page_events ProjectHook#wiki_page_events}
WikiPageEvents interface{} `field:"optional" json:"wikiPageEvents" yaml:"wikiPageEvents"`
}
type ProjectHookCustomHeaders ¶
type ProjectHookCustomHeaders struct {
// Key of the custom header.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.11.0/docs/resources/project_hook#key ProjectHook#key}
Key *string `field:"required" json:"key" yaml:"key"`
// Value of the custom header. This value cannot be imported.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.11.0/docs/resources/project_hook#value ProjectHook#value}
Value *string `field:"required" json:"value" yaml:"value"`
}
type ProjectHookCustomHeadersList ¶
type ProjectHookCustomHeadersList interface {
cdktf.ComplexList
// 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
InternalValue() interface{}
SetInternalValue(val interface{})
// The attribute on the parent resource this class is referencing.
TerraformAttribute() *string
SetTerraformAttribute(val *string)
// The parent resource.
TerraformResource() cdktf.IInterpolatingParent
SetTerraformResource(val cdktf.IInterpolatingParent)
// whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
WrapsSet() *bool
SetWrapsSet(val *bool)
// Creating an iterator for this complex list.
//
// The list will be converted into a map with the mapKeyAttributeName as the key.
// Experimental.
AllWithMapKey(mapKeyAttributeName *string) cdktf.DynamicListTerraformIterator
// Experimental.
ComputeFqn() *string
Get(index *float64) ProjectHookCustomHeadersOutputReference
// 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 NewProjectHookCustomHeadersList ¶
func NewProjectHookCustomHeadersList(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) ProjectHookCustomHeadersList
type ProjectHookCustomHeadersOutputReference ¶
type ProjectHookCustomHeadersOutputReference 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
InternalValue() interface{}
SetInternalValue(val interface{})
Key() *string
SetKey(val *string)
KeyInput() *string
// Experimental.
TerraformAttribute() *string
// Experimental.
SetTerraformAttribute(val *string)
// Experimental.
TerraformResource() cdktf.IInterpolatingParent
// Experimental.
SetTerraformResource(val cdktf.IInterpolatingParent)
Value() *string
SetValue(val *string)
ValueInput() *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 NewProjectHookCustomHeadersOutputReference ¶
func NewProjectHookCustomHeadersOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, complexObjectIndex *float64, complexObjectIsFromSet *bool) ProjectHookCustomHeadersOutputReference