redisinstance

package
v0.23.0 Latest Latest
Warning

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

Go to latest
Published: Nov 10, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

README

stackit_redis_instance

Refer to the Terraform Registry for docs: stackit_redis_instance.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewRedisInstanceParametersOutputReference_Override

func NewRedisInstanceParametersOutputReference_Override(r RedisInstanceParametersOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)

func NewRedisInstance_Override

func NewRedisInstance_Override(r RedisInstance, scope constructs.Construct, id *string, config *RedisInstanceConfig)

Create a new {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance stackit_redis_instance} Resource.

func RedisInstance_GenerateConfigForImport

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

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

func RedisInstance_IsConstruct

func RedisInstance_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 RedisInstance_IsTerraformElement

func RedisInstance_IsTerraformElement(x interface{}) *bool

Experimental.

func RedisInstance_IsTerraformResource

func RedisInstance_IsTerraformResource(x interface{}) *bool

Experimental.

func RedisInstance_TfResourceType

func RedisInstance_TfResourceType() *string

Types

type RedisInstance

type RedisInstance interface {
	cdktf.TerraformResource
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	CfGuid() *string
	CfOrganizationGuid() *string
	CfSpaceGuid() *string
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	DashboardUrl() *string
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Id() *string
	ImageUrl() *string
	InstanceId() *string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	Name() *string
	SetName(val *string)
	NameInput() *string
	// The tree node.
	Node() constructs.Node
	Parameters() RedisInstanceParametersOutputReference
	ParametersInput() interface{}
	PlanId() *string
	PlanName() *string
	SetPlanName(val *string)
	PlanNameInput() *string
	ProjectId() *string
	SetProjectId(val *string)
	ProjectIdInput() *string
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	Provisioners() *[]interface{}
	// Experimental.
	SetProvisioners(val *[]interface{})
	// Experimental.
	RawOverrides() interface{}
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	Version() *string
	SetVersion(val *string)
	VersionInput() *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)
	PutParameters(value *RedisInstanceParameters)
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetParameters()
	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.23.0/docs/resources/redis_instance stackit_redis_instance}.

type RedisInstanceConfig

type RedisInstanceConfig 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"`
	// Instance name.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance#name RedisInstance#name}
	Name *string `field:"required" json:"name" yaml:"name"`
	// The selected plan name.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance#plan_name RedisInstance#plan_name}
	PlanName *string `field:"required" json:"planName" yaml:"planName"`
	// STACKIT project ID to which the instance is associated.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance#project_id RedisInstance#project_id}
	ProjectId *string `field:"required" json:"projectId" yaml:"projectId"`
	// The service version.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance#version RedisInstance#version}
	Version *string `field:"required" json:"version" yaml:"version"`
	// Configuration parameters.
	//
	// Please note that removing a previously configured field from your Terraform configuration won't replace its value in the API. To update a previously configured field, explicitly set a new value for it.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance#parameters RedisInstance#parameters}
	Parameters *RedisInstanceParameters `field:"optional" json:"parameters" yaml:"parameters"`
}

type RedisInstanceParameters

type RedisInstanceParameters struct {
	// The number of milliseconds after which the instance is considered down.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance#down_after_milliseconds RedisInstance#down_after_milliseconds}
	DownAfterMilliseconds *float64 `field:"optional" json:"downAfterMilliseconds" yaml:"downAfterMilliseconds"`
	// Enable monitoring.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance#enable_monitoring RedisInstance#enable_monitoring}
	EnableMonitoring interface{} `field:"optional" json:"enableMonitoring" yaml:"enableMonitoring"`
	// The failover timeout in milliseconds.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance#failover_timeout RedisInstance#failover_timeout}
	FailoverTimeout *float64 `field:"optional" json:"failoverTimeout" yaml:"failoverTimeout"`
	// Graphite server URL (host and port). If set, monitoring with Graphite will be enabled.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance#graphite RedisInstance#graphite}
	Graphite *string `field:"optional" json:"graphite" yaml:"graphite"`
	// The lazy eviction enablement (yes or no).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance#lazyfree_lazy_eviction RedisInstance#lazyfree_lazy_eviction}
	LazyfreeLazyEviction *string `field:"optional" json:"lazyfreeLazyEviction" yaml:"lazyfreeLazyEviction"`
	// The lazy expire enablement (yes or no).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance#lazyfree_lazy_expire RedisInstance#lazyfree_lazy_expire}
	LazyfreeLazyExpire *string `field:"optional" json:"lazyfreeLazyExpire" yaml:"lazyfreeLazyExpire"`
	// The Lua time limit.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance#lua_time_limit RedisInstance#lua_time_limit}
	LuaTimeLimit *float64 `field:"optional" json:"luaTimeLimit" yaml:"luaTimeLimit"`
	// The maximum number of clients.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance#maxclients RedisInstance#maxclients}
	Maxclients *float64 `field:"optional" json:"maxclients" yaml:"maxclients"`
	// The maximum disk threshold in MB. If the disk usage exceeds this threshold, the instance will be stopped.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance#max_disk_threshold RedisInstance#max_disk_threshold}
	MaxDiskThreshold *float64 `field:"optional" json:"maxDiskThreshold" yaml:"maxDiskThreshold"`
	// The policy to handle the maximum memory (volatile-lru, noeviction, etc).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance#maxmemory_policy RedisInstance#maxmemory_policy}
	MaxmemoryPolicy *string `field:"optional" json:"maxmemoryPolicy" yaml:"maxmemoryPolicy"`
	// The maximum memory samples.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance#maxmemory_samples RedisInstance#maxmemory_samples}
	MaxmemorySamples *float64 `field:"optional" json:"maxmemorySamples" yaml:"maxmemorySamples"`
	// The frequency in seconds at which metrics are emitted.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance#metrics_frequency RedisInstance#metrics_frequency}
	MetricsFrequency *float64 `field:"optional" json:"metricsFrequency" yaml:"metricsFrequency"`
	// The prefix for the metrics.
	//
	// Could be useful when using Graphite monitoring to prefix the metrics with a certain value, like an API key
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance#metrics_prefix RedisInstance#metrics_prefix}
	MetricsPrefix *string `field:"optional" json:"metricsPrefix" yaml:"metricsPrefix"`
	// The minimum replicas maximum lag.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance#min_replicas_max_lag RedisInstance#min_replicas_max_lag}
	MinReplicasMaxLag *float64 `field:"optional" json:"minReplicasMaxLag" yaml:"minReplicasMaxLag"`
	// The ID of the STACKIT monitoring instance.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance#monitoring_instance_id RedisInstance#monitoring_instance_id}
	MonitoringInstanceId *string `field:"optional" json:"monitoringInstanceId" yaml:"monitoringInstanceId"`
	// The notify keyspace events.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance#notify_keyspace_events RedisInstance#notify_keyspace_events}
	NotifyKeyspaceEvents *string `field:"optional" json:"notifyKeyspaceEvents" yaml:"notifyKeyspaceEvents"`
	// Comma separated list of IP networks in CIDR notation which are allowed to access this instance.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance#sgw_acl RedisInstance#sgw_acl}
	SgwAcl *string `field:"optional" json:"sgwAcl" yaml:"sgwAcl"`
	// The snapshot configuration.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance#snapshot RedisInstance#snapshot}
	Snapshot *string `field:"optional" json:"snapshot" yaml:"snapshot"`
	// List of syslog servers to send logs to.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance#syslog RedisInstance#syslog}
	Syslog *[]*string `field:"optional" json:"syslog" yaml:"syslog"`
	// List of TLS ciphers to use.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance#tls_ciphers RedisInstance#tls_ciphers}
	TlsCiphers *[]*string `field:"optional" json:"tlsCiphers" yaml:"tlsCiphers"`
	// TLS cipher suites to use.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance#tls_ciphersuites RedisInstance#tls_ciphersuites}
	TlsCiphersuites *string `field:"optional" json:"tlsCiphersuites" yaml:"tlsCiphersuites"`
	// TLS protocol to use.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/redis_instance#tls_protocols RedisInstance#tls_protocols}
	TlsProtocols *string `field:"optional" json:"tlsProtocols" yaml:"tlsProtocols"`
}

type RedisInstanceParametersOutputReference

type RedisInstanceParametersOutputReference 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
	DownAfterMilliseconds() *float64
	SetDownAfterMilliseconds(val *float64)
	DownAfterMillisecondsInput() *float64
	EnableMonitoring() interface{}
	SetEnableMonitoring(val interface{})
	EnableMonitoringInput() interface{}
	FailoverTimeout() *float64
	SetFailoverTimeout(val *float64)
	FailoverTimeoutInput() *float64
	// Experimental.
	Fqn() *string
	Graphite() *string
	SetGraphite(val *string)
	GraphiteInput() *string
	InternalValue() interface{}
	SetInternalValue(val interface{})
	LazyfreeLazyEviction() *string
	SetLazyfreeLazyEviction(val *string)
	LazyfreeLazyEvictionInput() *string
	LazyfreeLazyExpire() *string
	SetLazyfreeLazyExpire(val *string)
	LazyfreeLazyExpireInput() *string
	LuaTimeLimit() *float64
	SetLuaTimeLimit(val *float64)
	LuaTimeLimitInput() *float64
	Maxclients() *float64
	SetMaxclients(val *float64)
	MaxclientsInput() *float64
	MaxDiskThreshold() *float64
	SetMaxDiskThreshold(val *float64)
	MaxDiskThresholdInput() *float64
	MaxmemoryPolicy() *string
	SetMaxmemoryPolicy(val *string)
	MaxmemoryPolicyInput() *string
	MaxmemorySamples() *float64
	SetMaxmemorySamples(val *float64)
	MaxmemorySamplesInput() *float64
	MetricsFrequency() *float64
	SetMetricsFrequency(val *float64)
	MetricsFrequencyInput() *float64
	MetricsPrefix() *string
	SetMetricsPrefix(val *string)
	MetricsPrefixInput() *string
	MinReplicasMaxLag() *float64
	SetMinReplicasMaxLag(val *float64)
	MinReplicasMaxLagInput() *float64
	MonitoringInstanceId() *string
	SetMonitoringInstanceId(val *string)
	MonitoringInstanceIdInput() *string
	NotifyKeyspaceEvents() *string
	SetNotifyKeyspaceEvents(val *string)
	NotifyKeyspaceEventsInput() *string
	SgwAcl() *string
	SetSgwAcl(val *string)
	SgwAclInput() *string
	Snapshot() *string
	SetSnapshot(val *string)
	SnapshotInput() *string
	Syslog() *[]*string
	SetSyslog(val *[]*string)
	SyslogInput() *[]*string
	// Experimental.
	TerraformAttribute() *string
	// Experimental.
	SetTerraformAttribute(val *string)
	// Experimental.
	TerraformResource() cdktf.IInterpolatingParent
	// Experimental.
	SetTerraformResource(val cdktf.IInterpolatingParent)
	TlsCiphers() *[]*string
	SetTlsCiphers(val *[]*string)
	TlsCiphersInput() *[]*string
	TlsCiphersuites() *string
	SetTlsCiphersuites(val *string)
	TlsCiphersuitesInput() *string
	TlsProtocols() *string
	SetTlsProtocols(val *string)
	TlsProtocolsInput() *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
	ResetDownAfterMilliseconds()
	ResetEnableMonitoring()
	ResetFailoverTimeout()
	ResetGraphite()
	ResetLazyfreeLazyEviction()
	ResetLazyfreeLazyExpire()
	ResetLuaTimeLimit()
	ResetMaxclients()
	ResetMaxDiskThreshold()
	ResetMaxmemoryPolicy()
	ResetMaxmemorySamples()
	ResetMetricsFrequency()
	ResetMetricsPrefix()
	ResetMinReplicasMaxLag()
	ResetMonitoringInstanceId()
	ResetNotifyKeyspaceEvents()
	ResetSgwAcl()
	ResetSnapshot()
	ResetSyslog()
	ResetTlsCiphers()
	ResetTlsCiphersuites()
	ResetTlsProtocols()
	// 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 NewRedisInstanceParametersOutputReference

func NewRedisInstanceParametersOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) RedisInstanceParametersOutputReference

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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