Documentation
¶
Index ¶
- func GitlabProvider_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
- func GitlabProvider_IsConstruct(x interface{}) *bool
- func GitlabProvider_IsTerraformElement(x interface{}) *bool
- func GitlabProvider_IsTerraformProvider(x interface{}) *bool
- func GitlabProvider_TfResourceType() *string
- func NewGitlabProvider_Override(g GitlabProvider, scope constructs.Construct, id *string, ...)
- type GitlabProvider
- type GitlabProviderConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GitlabProvider_GenerateConfigForImport ¶
func GitlabProvider_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource
Generates CDKTF code for importing a GitlabProvider resource upon running "cdktf plan <stack-name>".
func GitlabProvider_IsConstruct ¶
func GitlabProvider_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 GitlabProvider_IsTerraformElement ¶
func GitlabProvider_IsTerraformElement(x interface{}) *bool
Experimental.
func GitlabProvider_IsTerraformProvider ¶
func GitlabProvider_IsTerraformProvider(x interface{}) *bool
Experimental.
func GitlabProvider_TfResourceType ¶
func GitlabProvider_TfResourceType() *string
func NewGitlabProvider_Override ¶
func NewGitlabProvider_Override(g GitlabProvider, scope constructs.Construct, id *string, config *GitlabProviderConfig)
Create a new {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs gitlab} Resource.
Types ¶
type GitlabProvider ¶
type GitlabProvider interface {
cdktf.TerraformProvider
Alias() *string
SetAlias(val *string)
AliasInput() *string
BaseUrl() *string
SetBaseUrl(val *string)
BaseUrlInput() *string
CacertFile() *string
SetCacertFile(val *string)
CacertFileInput() *string
// Experimental.
CdktfStack() cdktf.TerraformStack
ClientCert() *string
SetClientCert(val *string)
ClientCertInput() *string
ClientKey() *string
SetClientKey(val *string)
ClientKeyInput() *string
// Experimental.
ConstructNodeMetadata() *map[string]interface{}
EarlyAuthCheck() interface{}
SetEarlyAuthCheck(val interface{})
EarlyAuthCheckInput() interface{}
// Experimental.
Fqn() *string
// Experimental.
FriendlyUniqueId() *string
Insecure() interface{}
SetInsecure(val interface{})
InsecureInput() interface{}
// Experimental.
MetaAttributes() *map[string]interface{}
// The tree node.
Node() constructs.Node
// Experimental.
RawOverrides() interface{}
// Experimental.
TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
// Experimental.
TerraformProviderSource() *string
// Experimental.
TerraformResourceType() *string
Token() *string
SetToken(val *string)
TokenInput() *string
// Experimental.
AddOverride(path *string, value interface{})
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
ResetAlias()
ResetBaseUrl()
ResetCacertFile()
ResetClientCert()
ResetClientKey()
ResetEarlyAuthCheck()
ResetInsecure()
// Resets a previously passed logical Id to use the auto-generated logical id again.
// Experimental.
ResetOverrideLogicalId()
ResetToken()
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.0.1/docs gitlab}.
func NewGitlabProvider ¶
func NewGitlabProvider(scope constructs.Construct, id *string, config *GitlabProviderConfig) GitlabProvider
Create a new {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs gitlab} Resource.
type GitlabProviderConfig ¶
type GitlabProviderConfig struct {
// Alias name.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs#alias GitlabProvider#alias}
Alias *string `field:"optional" json:"alias" yaml:"alias"`
// This is the target GitLab base API endpoint.
//
// Providing a value is a requirement when working with GitLab CE or GitLab Enterprise e.g. `https://my.gitlab.server/api/v4/`. It is optional to provide this value and it can also be sourced from the `GITLAB_BASE_URL` environment variable. The value must end with a slash.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs#base_url GitlabProvider#base_url}
BaseUrl *string `field:"optional" json:"baseUrl" yaml:"baseUrl"`
// This is a file containing the ca cert to verify the gitlab instance.
//
// This is available for use when working with GitLab CE or Gitlab Enterprise with a locally-issued or self-signed certificate chain.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs#cacert_file GitlabProvider#cacert_file}
CacertFile *string `field:"optional" json:"cacertFile" yaml:"cacertFile"`
// File path to client certificate when GitLab instance is behind company proxy. File must contain PEM encoded data.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs#client_cert GitlabProvider#client_cert}
ClientCert *string `field:"optional" json:"clientCert" yaml:"clientCert"`
// File path to client key when GitLab instance is behind company proxy.
//
// File must contain PEM encoded data. Required when `client_cert` is set.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs#client_key GitlabProvider#client_key}
ClientKey *string `field:"optional" json:"clientKey" yaml:"clientKey"`
// (Experimental) By default the provider does a dummy request to get the current user in order to verify that the provider configuration is correct and the GitLab API is reachable.
//
// Set this to `false` to skip this check. This may be useful if the GitLab instance does not yet exist and is created within the same terraform module. It may be sourced from the `GITLAB_EARLY_AUTH_CHECK`. This is an experimental feature and may change in the future. Please make sure to always keep backups of your state.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs#early_auth_check GitlabProvider#early_auth_check}
EarlyAuthCheck interface{} `field:"optional" json:"earlyAuthCheck" yaml:"earlyAuthCheck"`
// When set to true this disables SSL verification of the connection to the GitLab instance.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs#insecure GitlabProvider#insecure}
Insecure interface{} `field:"optional" json:"insecure" yaml:"insecure"`
// The OAuth2 Token, Project, Group, Personal Access Token or CI Job Token used to connect to GitLab.
//
// The OAuth method is used in this provider for authentication (using Bearer authorization token). See https://docs.gitlab.com/ee/api/#authentication for details. It may be sourced from the `GITLAB_TOKEN` environment variable.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs#token GitlabProvider#token}
Token *string `field:"optional" json:"token" yaml:"token"`
}