opensearchinstance

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_opensearch_instance

Refer to the Terraform Registry for docs: stackit_opensearch_instance.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewOpensearchInstanceParametersOutputReference_Override

func NewOpensearchInstanceParametersOutputReference_Override(o OpensearchInstanceParametersOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)

func OpensearchInstance_GenerateConfigForImport

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

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

func OpensearchInstance_IsConstruct

func OpensearchInstance_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 OpensearchInstance_IsTerraformElement

func OpensearchInstance_IsTerraformElement(x interface{}) *bool

Experimental.

func OpensearchInstance_IsTerraformResource

func OpensearchInstance_IsTerraformResource(x interface{}) *bool

Experimental.

func OpensearchInstance_TfResourceType

func OpensearchInstance_TfResourceType() *string

Types

type OpensearchInstance

type OpensearchInstance 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() OpensearchInstanceParametersOutputReference
	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 *OpensearchInstanceParameters)
	// 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/opensearch_instance stackit_opensearch_instance}.

type OpensearchInstanceConfig

type OpensearchInstanceConfig 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/opensearch_instance#name OpensearchInstance#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/opensearch_instance#plan_name OpensearchInstance#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/opensearch_instance#project_id OpensearchInstance#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/opensearch_instance#version OpensearchInstance#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/opensearch_instance#parameters OpensearchInstance#parameters}
	Parameters *OpensearchInstanceParameters `field:"optional" json:"parameters" yaml:"parameters"`
}

type OpensearchInstanceParameters

type OpensearchInstanceParameters struct {
	// Enable monitoring.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/opensearch_instance#enable_monitoring OpensearchInstance#enable_monitoring}
	EnableMonitoring interface{} `field:"optional" json:"enableMonitoring" yaml:"enableMonitoring"`
	// If set, monitoring with Graphite will be enabled.
	//
	// Expects the host and port where the Graphite metrics should be sent to (host:port).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/opensearch_instance#graphite OpensearchInstance#graphite}
	Graphite *string `field:"optional" json:"graphite" yaml:"graphite"`
	// The garbage collector to use for OpenSearch.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/opensearch_instance#java_garbage_collector OpensearchInstance#java_garbage_collector}
	JavaGarbageCollector *string `field:"optional" json:"javaGarbageCollector" yaml:"javaGarbageCollector"`
	// The amount of memory (in MB) allocated as heap by the JVM for OpenSearch.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/opensearch_instance#java_heapspace OpensearchInstance#java_heapspace}
	JavaHeapspace *float64 `field:"optional" json:"javaHeapspace" yaml:"javaHeapspace"`
	// The amount of memory (in MB) used by the JVM to store metadata for OpenSearch.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/opensearch_instance#java_maxmetaspace OpensearchInstance#java_maxmetaspace}
	JavaMaxmetaspace *float64 `field:"optional" json:"javaMaxmetaspace" yaml:"javaMaxmetaspace"`
	// 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/opensearch_instance#max_disk_threshold OpensearchInstance#max_disk_threshold}
	MaxDiskThreshold *float64 `field:"optional" json:"maxDiskThreshold" yaml:"maxDiskThreshold"`
	// The frequency in seconds at which metrics are emitted (in seconds).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/opensearch_instance#metrics_frequency OpensearchInstance#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/opensearch_instance#metrics_prefix OpensearchInstance#metrics_prefix}
	MetricsPrefix *string `field:"optional" json:"metricsPrefix" yaml:"metricsPrefix"`
	// The ID of the STACKIT monitoring instance.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/opensearch_instance#monitoring_instance_id OpensearchInstance#monitoring_instance_id}
	MonitoringInstanceId *string `field:"optional" json:"monitoringInstanceId" yaml:"monitoringInstanceId"`
	// List of plugins to install.
	//
	// Must be a supported plugin name. The plugins `repository-s3` and `repository-azure` are enabled by default and cannot be disabled.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/opensearch_instance#plugins OpensearchInstance#plugins}
	Plugins *[]*string `field:"optional" json:"plugins" yaml:"plugins"`
	// 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/opensearch_instance#sgw_acl OpensearchInstance#sgw_acl}
	SgwAcl *string `field:"optional" json:"sgwAcl" yaml:"sgwAcl"`
	// 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/opensearch_instance#syslog OpensearchInstance#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/opensearch_instance#tls_ciphers OpensearchInstance#tls_ciphers}
	TlsCiphers *[]*string `field:"optional" json:"tlsCiphers" yaml:"tlsCiphers"`
	// The TLS protocol to use.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.23.0/docs/resources/opensearch_instance#tls_protocols OpensearchInstance#tls_protocols}
	TlsProtocols *string `field:"optional" json:"tlsProtocols" yaml:"tlsProtocols"`
}

type OpensearchInstanceParametersOutputReference

type OpensearchInstanceParametersOutputReference 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
	EnableMonitoring() interface{}
	SetEnableMonitoring(val interface{})
	EnableMonitoringInput() interface{}
	// Experimental.
	Fqn() *string
	Graphite() *string
	SetGraphite(val *string)
	GraphiteInput() *string
	InternalValue() interface{}
	SetInternalValue(val interface{})
	JavaGarbageCollector() *string
	SetJavaGarbageCollector(val *string)
	JavaGarbageCollectorInput() *string
	JavaHeapspace() *float64
	SetJavaHeapspace(val *float64)
	JavaHeapspaceInput() *float64
	JavaMaxmetaspace() *float64
	SetJavaMaxmetaspace(val *float64)
	JavaMaxmetaspaceInput() *float64
	MaxDiskThreshold() *float64
	SetMaxDiskThreshold(val *float64)
	MaxDiskThresholdInput() *float64
	MetricsFrequency() *float64
	SetMetricsFrequency(val *float64)
	MetricsFrequencyInput() *float64
	MetricsPrefix() *string
	SetMetricsPrefix(val *string)
	MetricsPrefixInput() *string
	MonitoringInstanceId() *string
	SetMonitoringInstanceId(val *string)
	MonitoringInstanceIdInput() *string
	Plugins() *[]*string
	SetPlugins(val *[]*string)
	PluginsInput() *[]*string
	SgwAcl() *string
	SetSgwAcl(val *string)
	SgwAclInput() *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
	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
	ResetEnableMonitoring()
	ResetGraphite()
	ResetJavaGarbageCollector()
	ResetJavaHeapspace()
	ResetJavaMaxmetaspace()
	ResetMaxDiskThreshold()
	ResetMetricsFrequency()
	ResetMetricsPrefix()
	ResetMonitoringInstanceId()
	ResetPlugins()
	ResetSgwAcl()
	ResetSyslog()
	ResetTlsCiphers()
	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 NewOpensearchInstanceParametersOutputReference

func NewOpensearchInstanceParametersOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) OpensearchInstanceParametersOutputReference

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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