Documentation
¶
Index ¶
- func NewStackitProvider_Override(s StackitProvider, scope constructs.Construct, id *string, ...)
- func StackitProvider_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
- func StackitProvider_IsConstruct(x interface{}) *bool
- func StackitProvider_IsTerraformElement(x interface{}) *bool
- func StackitProvider_IsTerraformProvider(x interface{}) *bool
- func StackitProvider_TfResourceType() *string
- type StackitProvider
- type StackitProviderConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewStackitProvider_Override ¶
func NewStackitProvider_Override(s StackitProvider, scope constructs.Construct, id *string, config *StackitProviderConfig)
Create a new {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs stackit} Resource.
func StackitProvider_GenerateConfigForImport ¶
func StackitProvider_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource
Generates CDKTF code for importing a StackitProvider resource upon running "cdktf plan <stack-name>".
func StackitProvider_IsConstruct ¶
func StackitProvider_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 StackitProvider_IsTerraformElement ¶
func StackitProvider_IsTerraformElement(x interface{}) *bool
Experimental.
func StackitProvider_IsTerraformProvider ¶
func StackitProvider_IsTerraformProvider(x interface{}) *bool
Experimental.
func StackitProvider_TfResourceType ¶
func StackitProvider_TfResourceType() *string
Types ¶
type StackitProvider ¶
type StackitProvider interface {
cdktf.TerraformProvider
Alias() *string
SetAlias(val *string)
AliasInput() *string
ArgusCustomEndpoint() *string
SetArgusCustomEndpoint(val *string)
ArgusCustomEndpointInput() *string
AuthorizationCustomEndpoint() *string
SetAuthorizationCustomEndpoint(val *string)
AuthorizationCustomEndpointInput() *string
// Experimental.
CdktfStack() cdktf.TerraformStack
// Experimental.
ConstructNodeMetadata() *map[string]interface{}
CredentialsPath() *string
SetCredentialsPath(val *string)
CredentialsPathInput() *string
DnsCustomEndpoint() *string
SetDnsCustomEndpoint(val *string)
DnsCustomEndpointInput() *string
EnableBetaResources() interface{}
SetEnableBetaResources(val interface{})
EnableBetaResourcesInput() interface{}
// Experimental.
Fqn() *string
// Experimental.
FriendlyUniqueId() *string
IaasCustomEndpoint() *string
SetIaasCustomEndpoint(val *string)
IaasCustomEndpointInput() *string
LoadbalancerCustomEndpoint() *string
SetLoadbalancerCustomEndpoint(val *string)
LoadbalancerCustomEndpointInput() *string
LogmeCustomEndpoint() *string
SetLogmeCustomEndpoint(val *string)
LogmeCustomEndpointInput() *string
MariadbCustomEndpoint() *string
SetMariadbCustomEndpoint(val *string)
MariadbCustomEndpointInput() *string
// Experimental.
MetaAttributes() *map[string]interface{}
MongodbflexCustomEndpoint() *string
SetMongodbflexCustomEndpoint(val *string)
MongodbflexCustomEndpointInput() *string
// The tree node.
Node() constructs.Node
ObjectstorageCustomEndpoint() *string
SetObjectstorageCustomEndpoint(val *string)
ObjectstorageCustomEndpointInput() *string
ObservabilityCustomEndpoint() *string
SetObservabilityCustomEndpoint(val *string)
ObservabilityCustomEndpointInput() *string
OpensearchCustomEndpoint() *string
SetOpensearchCustomEndpoint(val *string)
OpensearchCustomEndpointInput() *string
PostgresflexCustomEndpoint() *string
SetPostgresflexCustomEndpoint(val *string)
PostgresflexCustomEndpointInput() *string
PrivateKey() *string
SetPrivateKey(val *string)
PrivateKeyInput() *string
PrivateKeyPath() *string
SetPrivateKeyPath(val *string)
PrivateKeyPathInput() *string
RabbitmqCustomEndpoint() *string
SetRabbitmqCustomEndpoint(val *string)
RabbitmqCustomEndpointInput() *string
// Experimental.
RawOverrides() interface{}
RedisCustomEndpoint() *string
SetRedisCustomEndpoint(val *string)
RedisCustomEndpointInput() *string
Region() *string
SetRegion(val *string)
RegionInput() *string
ResourcemanagerCustomEndpoint() *string
SetResourcemanagerCustomEndpoint(val *string)
ResourcemanagerCustomEndpointInput() *string
SecretsmanagerCustomEndpoint() *string
SetSecretsmanagerCustomEndpoint(val *string)
SecretsmanagerCustomEndpointInput() *string
ServerBackupCustomEndpoint() *string
SetServerBackupCustomEndpoint(val *string)
ServerBackupCustomEndpointInput() *string
ServiceAccountEmail() *string
SetServiceAccountEmail(val *string)
ServiceAccountEmailInput() *string
ServiceAccountKey() *string
SetServiceAccountKey(val *string)
ServiceAccountKeyInput() *string
ServiceAccountKeyPath() *string
SetServiceAccountKeyPath(val *string)
ServiceAccountKeyPathInput() *string
ServiceAccountToken() *string
SetServiceAccountToken(val *string)
ServiceAccountTokenInput() *string
ServiceEnablementCustomEndpoint() *string
SetServiceEnablementCustomEndpoint(val *string)
ServiceEnablementCustomEndpointInput() *string
SkeCustomEndpoint() *string
SetSkeCustomEndpoint(val *string)
SkeCustomEndpointInput() *string
SqlserverflexCustomEndpoint() *string
SetSqlserverflexCustomEndpoint(val *string)
SqlserverflexCustomEndpointInput() *string
// Experimental.
TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
// Experimental.
TerraformProviderSource() *string
// Experimental.
TerraformResourceType() *string
TokenCustomEndpoint() *string
SetTokenCustomEndpoint(val *string)
TokenCustomEndpointInput() *string
// Experimental.
AddOverride(path *string, value interface{})
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
ResetAlias()
ResetArgusCustomEndpoint()
ResetAuthorizationCustomEndpoint()
ResetCredentialsPath()
ResetDnsCustomEndpoint()
ResetEnableBetaResources()
ResetIaasCustomEndpoint()
ResetLoadbalancerCustomEndpoint()
ResetLogmeCustomEndpoint()
ResetMariadbCustomEndpoint()
ResetMongodbflexCustomEndpoint()
ResetObjectstorageCustomEndpoint()
ResetObservabilityCustomEndpoint()
ResetOpensearchCustomEndpoint()
// Resets a previously passed logical Id to use the auto-generated logical id again.
// Experimental.
ResetOverrideLogicalId()
ResetPostgresflexCustomEndpoint()
ResetPrivateKey()
ResetPrivateKeyPath()
ResetRabbitmqCustomEndpoint()
ResetRedisCustomEndpoint()
ResetRegion()
ResetResourcemanagerCustomEndpoint()
ResetSecretsmanagerCustomEndpoint()
ResetServerBackupCustomEndpoint()
ResetServiceAccountEmail()
ResetServiceAccountKey()
ResetServiceAccountKeyPath()
ResetServiceAccountToken()
ResetServiceEnablementCustomEndpoint()
ResetSkeCustomEndpoint()
ResetSqlserverflexCustomEndpoint()
ResetTokenCustomEndpoint()
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/stackitcloud/stackit/0.34.2/docs stackit}.
func NewStackitProvider ¶
func NewStackitProvider(scope constructs.Construct, id *string, config *StackitProviderConfig) StackitProvider
Create a new {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs stackit} Resource.
type StackitProviderConfig ¶
type StackitProviderConfig struct {
// Alias name.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#alias StackitProvider#alias}
Alias *string `field:"optional" json:"alias" yaml:"alias"`
// Custom endpoint for the Argus service.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#argus_custom_endpoint StackitProvider#argus_custom_endpoint}
ArgusCustomEndpoint *string `field:"optional" json:"argusCustomEndpoint" yaml:"argusCustomEndpoint"`
// Custom endpoint for the Membership service.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#authorization_custom_endpoint StackitProvider#authorization_custom_endpoint}
AuthorizationCustomEndpoint *string `field:"optional" json:"authorizationCustomEndpoint" yaml:"authorizationCustomEndpoint"`
// Path of JSON from where the credentials are read.
//
// Takes precedence over the env var `STACKIT_CREDENTIALS_PATH`. Default value is `~/.stackit/credentials.json`.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#credentials_path StackitProvider#credentials_path}
CredentialsPath *string `field:"optional" json:"credentialsPath" yaml:"credentialsPath"`
// Custom endpoint for the DNS service.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#dns_custom_endpoint StackitProvider#dns_custom_endpoint}
DnsCustomEndpoint *string `field:"optional" json:"dnsCustomEndpoint" yaml:"dnsCustomEndpoint"`
// Enable beta resources. Default is false.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#enable_beta_resources StackitProvider#enable_beta_resources}
EnableBetaResources interface{} `field:"optional" json:"enableBetaResources" yaml:"enableBetaResources"`
// Custom endpoint for the IaaS service.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#iaas_custom_endpoint StackitProvider#iaas_custom_endpoint}
IaasCustomEndpoint *string `field:"optional" json:"iaasCustomEndpoint" yaml:"iaasCustomEndpoint"`
// Custom endpoint for the Load Balancer service.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#loadbalancer_custom_endpoint StackitProvider#loadbalancer_custom_endpoint}
LoadbalancerCustomEndpoint *string `field:"optional" json:"loadbalancerCustomEndpoint" yaml:"loadbalancerCustomEndpoint"`
// Custom endpoint for the LogMe service.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#logme_custom_endpoint StackitProvider#logme_custom_endpoint}
LogmeCustomEndpoint *string `field:"optional" json:"logmeCustomEndpoint" yaml:"logmeCustomEndpoint"`
// Custom endpoint for the MariaDB service.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#mariadb_custom_endpoint StackitProvider#mariadb_custom_endpoint}
MariadbCustomEndpoint *string `field:"optional" json:"mariadbCustomEndpoint" yaml:"mariadbCustomEndpoint"`
// Custom endpoint for the MongoDB Flex service.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#mongodbflex_custom_endpoint StackitProvider#mongodbflex_custom_endpoint}
MongodbflexCustomEndpoint *string `field:"optional" json:"mongodbflexCustomEndpoint" yaml:"mongodbflexCustomEndpoint"`
// Custom endpoint for the Object Storage service.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#objectstorage_custom_endpoint StackitProvider#objectstorage_custom_endpoint}
ObjectstorageCustomEndpoint *string `field:"optional" json:"objectstorageCustomEndpoint" yaml:"objectstorageCustomEndpoint"`
// Custom endpoint for the Observability service.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#observability_custom_endpoint StackitProvider#observability_custom_endpoint}
ObservabilityCustomEndpoint *string `field:"optional" json:"observabilityCustomEndpoint" yaml:"observabilityCustomEndpoint"`
// Custom endpoint for the OpenSearch service.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#opensearch_custom_endpoint StackitProvider#opensearch_custom_endpoint}
OpensearchCustomEndpoint *string `field:"optional" json:"opensearchCustomEndpoint" yaml:"opensearchCustomEndpoint"`
// Custom endpoint for the PostgresFlex service.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#postgresflex_custom_endpoint StackitProvider#postgresflex_custom_endpoint}
PostgresflexCustomEndpoint *string `field:"optional" json:"postgresflexCustomEndpoint" yaml:"postgresflexCustomEndpoint"`
// Private RSA key used for authentication, relevant for the key flow.
//
// It takes precedence over the private key that is included in the service account key.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#private_key StackitProvider#private_key}
PrivateKey *string `field:"optional" json:"privateKey" yaml:"privateKey"`
// Path for the private RSA key used for authentication, relevant for the key flow.
//
// It takes precedence over the private key that is included in the service account key.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#private_key_path StackitProvider#private_key_path}
PrivateKeyPath *string `field:"optional" json:"privateKeyPath" yaml:"privateKeyPath"`
// Custom endpoint for the RabbitMQ service.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#rabbitmq_custom_endpoint StackitProvider#rabbitmq_custom_endpoint}
RabbitmqCustomEndpoint *string `field:"optional" json:"rabbitmqCustomEndpoint" yaml:"rabbitmqCustomEndpoint"`
// Custom endpoint for the Redis service.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#redis_custom_endpoint StackitProvider#redis_custom_endpoint}
RedisCustomEndpoint *string `field:"optional" json:"redisCustomEndpoint" yaml:"redisCustomEndpoint"`
// Region will be used as the default location for regional services.
//
// Not all services require a region, some are global
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#region StackitProvider#region}
Region *string `field:"optional" json:"region" yaml:"region"`
// Custom endpoint for the Resource Manager service.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#resourcemanager_custom_endpoint StackitProvider#resourcemanager_custom_endpoint}
ResourcemanagerCustomEndpoint *string `field:"optional" json:"resourcemanagerCustomEndpoint" yaml:"resourcemanagerCustomEndpoint"`
// Custom endpoint for the Secrets Manager service.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#secretsmanager_custom_endpoint StackitProvider#secretsmanager_custom_endpoint}
SecretsmanagerCustomEndpoint *string `field:"optional" json:"secretsmanagerCustomEndpoint" yaml:"secretsmanagerCustomEndpoint"`
// Custom endpoint for the Server Backup service.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#server_backup_custom_endpoint StackitProvider#server_backup_custom_endpoint}
ServerBackupCustomEndpoint *string `field:"optional" json:"serverBackupCustomEndpoint" yaml:"serverBackupCustomEndpoint"`
// Service account email.
//
// It can also be set using the environment variable STACKIT_SERVICE_ACCOUNT_EMAIL. It is required if you want to use the resource manager project resource.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#service_account_email StackitProvider#service_account_email}
ServiceAccountEmail *string `field:"optional" json:"serviceAccountEmail" yaml:"serviceAccountEmail"`
// Service account key used for authentication. If set, the key flow will be used to authenticate all operations.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#service_account_key StackitProvider#service_account_key}
ServiceAccountKey *string `field:"optional" json:"serviceAccountKey" yaml:"serviceAccountKey"`
// Path for the service account key used for authentication.
//
// If set, the key flow will be used to authenticate all operations.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#service_account_key_path StackitProvider#service_account_key_path}
ServiceAccountKeyPath *string `field:"optional" json:"serviceAccountKeyPath" yaml:"serviceAccountKeyPath"`
// Token used for authentication. If set, the token flow will be used to authenticate all operations.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#service_account_token StackitProvider#service_account_token}
ServiceAccountToken *string `field:"optional" json:"serviceAccountToken" yaml:"serviceAccountToken"`
// Custom endpoint for the Service Enablement API.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#service_enablement_custom_endpoint StackitProvider#service_enablement_custom_endpoint}
ServiceEnablementCustomEndpoint *string `field:"optional" json:"serviceEnablementCustomEndpoint" yaml:"serviceEnablementCustomEndpoint"`
// Custom endpoint for the Kubernetes Engine (SKE) service.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#ske_custom_endpoint StackitProvider#ske_custom_endpoint}
SkeCustomEndpoint *string `field:"optional" json:"skeCustomEndpoint" yaml:"skeCustomEndpoint"`
// Custom endpoint for the SQL Server Flex service.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#sqlserverflex_custom_endpoint StackitProvider#sqlserverflex_custom_endpoint}
SqlserverflexCustomEndpoint *string `field:"optional" json:"sqlserverflexCustomEndpoint" yaml:"sqlserverflexCustomEndpoint"`
// Custom endpoint for the token API, which is used to request access tokens when using the key flow.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.34.2/docs#token_custom_endpoint StackitProvider#token_custom_endpoint}
TokenCustomEndpoint *string `field:"optional" json:"tokenCustomEndpoint" yaml:"tokenCustomEndpoint"`
}