types

package
v1.5.0 Latest Latest
Warning

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

 Go to latest Published: Sep 30, 2024 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

The request conflicts with an existing resource in Timestream for InfluxDB.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type DbInstanceSummary 

type DbInstanceSummary struct {

	// The Amazon Resource Name (ARN) of the DB instance.
	//
	// This member is required.
	Arn *string

	// The service-generated unique identifier of the DB instance.
	//
	// This member is required.
	Id *string

	// This customer-supplied name uniquely identifies the DB instance when
	// interacting with the Amazon Timestream for InfluxDB API and AWS CLI commands.
	//
	// This member is required.
	Name *string

	// The amount of storage to allocate for your DbStorageType in GiB (gibibytes).
	AllocatedStorage *int32

	// The Timestream for InfluxDB instance type to run InfluxDB on.
	DbInstanceType DbInstanceType

	// The storage type for your DB instance.
	DbStorageType DbStorageType

	// Single-Instance or with a MultiAZ Standby for High availability.
	DeploymentType DeploymentType

	// The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
	Endpoint *string

	// The port number on which InfluxDB accepts connections.
	Port *int32

	// The status of the DB instance.
	Status Status
	// contains filtered or unexported fields
}

Contains a summary of a DB instance.

type DbInstanceType 

type DbInstanceType string
const (
	DbInstanceTypeDbInfluxMedium   DbInstanceType = "db.influx.medium"
	DbInstanceTypeDbInfluxLarge    DbInstanceType = "db.influx.large"
	DbInstanceTypeDbInfluxXlarge   DbInstanceType = "db.influx.xlarge"
	DbInstanceTypeDbInflux2xlarge  DbInstanceType = "db.influx.2xlarge"
	DbInstanceTypeDbInflux4xlarge  DbInstanceType = "db.influx.4xlarge"
	DbInstanceTypeDbInflux8xlarge  DbInstanceType = "db.influx.8xlarge"
	DbInstanceTypeDbInflux12xlarge DbInstanceType = "db.influx.12xlarge"
	DbInstanceTypeDbInflux16xlarge DbInstanceType = "db.influx.16xlarge"
)

Enum values for DbInstanceType

func (DbInstanceType) Values 

func (DbInstanceType) Values() []DbInstanceType

Values returns all known values for DbInstanceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DbParameterGroupSummary 

type DbParameterGroupSummary struct {

	// The Amazon Resource Name (ARN) of the DB parameter group.
	//
	// This member is required.
	Arn *string

	// A service-generated unique identifier.
	//
	// This member is required.
	Id *string

	// This customer-supplied name uniquely identifies the parameter group.
	//
	// This member is required.
	Name *string

	// A description of the DB parameter group.
	Description *string
	// contains filtered or unexported fields
}

Contains a summary of a DB parameter group.

type DbStorageType 

type DbStorageType string
const (
	DbStorageTypeInfluxIoIncludedT1 DbStorageType = "InfluxIOIncludedT1"
	DbStorageTypeInfluxIoIncludedT2 DbStorageType = "InfluxIOIncludedT2"
	DbStorageTypeInfluxIoIncludedT3 DbStorageType = "InfluxIOIncludedT3"
)

Enum values for DbStorageType

func (DbStorageType) Values 

func (DbStorageType) Values() []DbStorageType

Values returns all known values for DbStorageType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DeploymentType 

type DeploymentType string
const (
	DeploymentTypeSingleAz           DeploymentType = "SINGLE_AZ"
	DeploymentTypeWithMultiazStandby DeploymentType = "WITH_MULTIAZ_STANDBY"
)

Enum values for DeploymentType

func (DeploymentType) Values 

func (DeploymentType) Values() []DeploymentType

Values returns all known values for DeploymentType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Duration added in v1.5.0 

type Duration struct {

	// The type of duration for InfluxDB parameters.
	//
	// This member is required.
	DurationType DurationType

	// The value of duration for InfluxDB parameters.
	//
	// This member is required.
	Value *int64
	// contains filtered or unexported fields
}

Duration for InfluxDB parameters in Timestream for InfluxDB.

type DurationType added in v1.5.0 

type DurationType string
const (
	DurationTypeHours        DurationType = "hours"
	DurationTypeMinutes      DurationType = "minutes"
	DurationTypeSeconds      DurationType = "seconds"
	DurationTypeMilliseconds DurationType = "milliseconds"
)

Enum values for DurationType

func (DurationType) Values added in v1.5.0 

func (DurationType) Values() []DurationType

Values returns all known values for DurationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type InfluxDBv2Parameters 

type InfluxDBv2Parameters struct {

	// Include option to show detailed logs for Flux queries.
	//
	// Default: false
	FluxLogEnabled *bool

	// Maximum duration the server should keep established connections alive while
	// waiting for new requests. Set to 0 for no timeout.
	//
	// Default: 3 minutes
	HttpIdleTimeout *Duration

	// Maximum duration the server should try to read HTTP headers for new requests.
	// Set to 0 for no timeout.
	//
	// Default: 10 seconds
	HttpReadHeaderTimeout *Duration

	// Maximum duration the server should try to read the entirety of new requests.
	// Set to 0 for no timeout.
	//
	// Default: 0
	HttpReadTimeout *Duration

	// Maximum duration the server should spend processing and responding to write
	// requests. Set to 0 for no timeout.
	//
	// Default: 0
	HttpWriteTimeout *Duration

	// Maximum number of group by time buckets a SELECT statement can create. 0 allows
	// an unlimited number of buckets.
	//
	// Default: 0
	InfluxqlMaxSelectBuckets *int64

	// Maximum number of points a SELECT statement can process. 0 allows an unlimited
	// number of points. InfluxDB checks the point count every second (so queries
	// exceeding the maximum aren’t immediately aborted).
	//
	// Default: 0
	InfluxqlMaxSelectPoint *int64

	// Maximum number of series a SELECT statement can return. 0 allows an unlimited
	// number of series.
	//
	// Default: 0
	InfluxqlMaxSelectSeries *int64

	// Log output level. InfluxDB outputs log entries with severity levels greater
	// than or equal to the level specified.
	//
	// Default: info
	LogLevel LogLevel

	// Disable the HTTP /metrics endpoint which exposes [internal InfluxDB metrics].
	//
	// Default: false
	//
	// [internal InfluxDB metrics]: https://docs.influxdata.com/influxdb/v2/reference/internals/metrics/
	MetricsDisabled *bool

	// Disable the task scheduler. If problematic tasks prevent InfluxDB from
	// starting, use this option to start InfluxDB without scheduling or executing
	// tasks.
	//
	// Default: false
	NoTasks *bool

	// Disable the /debug/pprof HTTP endpoint. This endpoint provides runtime
	// profiling data and can be helpful when debugging.
	//
	// Default: false
	PprofDisabled *bool

	// Number of queries allowed to execute concurrently. Setting to 0 allows an
	// unlimited number of concurrent queries.
	//
	// Default: 0
	QueryConcurrency *int32

	// Initial bytes of memory allocated for a query.
	//
	// Default: 0
	QueryInitialMemoryBytes *int64

	// Maximum number of queries allowed in execution queue. When queue limit is
	// reached, new queries are rejected. Setting to 0 allows an unlimited number of
	// queries in the queue.
	//
	// Default: 0
	QueryMaxMemoryBytes *int64

	// Maximum bytes of memory allowed for a single query. Must be greater or equal to
	// queryInitialMemoryBytes.
	//
	// Default: 0
	QueryMemoryBytes *int64

	// Maximum number of queries allowed in execution queue. When queue limit is
	// reached, new queries are rejected. Setting to 0 allows an unlimited number of
	// queries in the queue.
	//
	// Default: 0
	QueryQueueSize *int32

	// Specifies the Time to Live (TTL) in minutes for newly created user sessions.
	//
	// Default: 60
	SessionLength *int32

	// Disables automatically extending a user’s session TTL on each request. By
	// default, every request sets the session’s expiration time to five minutes from
	// now. When disabled, sessions expire after the specified [session length]and the user is
	// redirected to the login page, even if recently active.
	//
	// Default: false
	//
	// [session length]: https://docs.influxdata.com/influxdb/v2/reference/config-options/#session-length
	SessionRenewDisabled *bool

	// Maximum size (in bytes) a shard’s cache can reach before it starts rejecting
	// writes. Must be greater than storageCacheSnapShotMemorySize and lower than
	// instance’s total memory capacity. We recommend setting it to below 15% of the
	// total memory capacity.
	//
	// Default: 1073741824
	StorageCacheMaxMemorySize *int64

	// Size (in bytes) at which the storage engine will snapshot the cache and write
	// it to a TSM file to make more memory available. Must not be greater than
	// storageCacheMaxMemorySize.
	//
	// Default: 26214400
	StorageCacheSnapshotMemorySize *int64

	// Duration at which the storage engine will snapshot the cache and write it to a
	// new TSM file if the shard hasn’t received writes or deletes.
	//
	// Default: 10 minutes
	StorageCacheSnapshotWriteColdDuration *Duration

	// Duration at which the storage engine will compact all TSM files in a shard if
	// it hasn't received writes or deletes.
	//
	// Default: 4 hours
	StorageCompactFullWriteColdDuration *Duration

	// Rate limit (in bytes per second) that TSM compactions can write to disk.
	//
	// Default: 50331648
	StorageCompactThroughputBurst *int64

	// Maximum number of full and level compactions that can run concurrently. A value
	// of 0 results in 50% of runtime.GOMAXPROCS(0) used at runtime. Any number greater
	// than zero limits compactions to that value. This setting does not apply to cache
	// snapshotting.
	//
	// Default: 0
	StorageMaxConcurrentCompactions *int32

	// Size (in bytes) at which an index write-ahead log (WAL) file will compact into
	// an index file. Lower sizes will cause log files to be compacted more quickly and
	// result in lower heap usage at the expense of write throughput.
	//
	// Default: 1048576
	StorageMaxIndexLogFileSize *int64

	// Skip field size validation on incoming write requests.
	//
	// Default: false
	StorageNoValidateFieldSize *bool

	// Interval of retention policy enforcement checks. Must be greater than 0.
	//
	// Default: 30 minutes
	StorageRetentionCheckInterval *Duration

	// Maximum number of snapshot compactions that can run concurrently across all
	// series partitions in a database.
	//
	// Default: 0
	StorageSeriesFileMaxConcurrentSnapshotCompactions *int32

	// Size of the internal cache used in the TSI index to store previously calculated
	// series results. Cached results are returned quickly rather than needing to be
	// recalculated when a subsequent query with the same tag key/value predicate is
	// executed. Setting this value to 0 will disable the cache and may decrease query
	// performance.
	//
	// Default: 100
	StorageSeriesIdSetCacheSize *int64

	// Maximum number writes to the WAL directory to attempt at the same time. Setting
	// this value to 0 results in number of processing units available x2.
	//
	// Default: 0
	StorageWalMaxConcurrentWrites *int32

	// Maximum amount of time a write request to the WAL directory will wait when the [maximum number of concurrent active writes to the WAL directory has been met]
	// . Set to 0 to disable the timeout.
	//
	// Default: 10 minutes
	//
	// [maximum number of concurrent active writes to the WAL directory has been met]: https://docs.influxdata.com/influxdb/v2/reference/config-options/#storage-wal-max-concurrent-writes
	StorageWalMaxWriteDelay *Duration

	// Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled
	// by default.
	TracingType TracingType

	// Disable the InfluxDB user interface (UI). The UI is enabled by default.
	//
	// Default: false
	UiDisabled *bool
	// contains filtered or unexported fields
}

All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request processing has failed because of an unknown error, exception or failure.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type LogDeliveryConfiguration 

type LogDeliveryConfiguration struct {

	// Configuration for S3 bucket log delivery.
	//
	// This member is required.
	S3Configuration *S3Configuration
	// contains filtered or unexported fields
}

Configuration for sending InfluxDB engine logs to send to specified S3 bucket.

type LogLevel 

type LogLevel string
const (
	LogLevelDebug LogLevel = "debug"
	LogLevelInfo  LogLevel = "info"
	LogLevelError LogLevel = "error"
)

Enum values for LogLevel

func (LogLevel) Values 

func (LogLevel) Values() []LogLevel

Values returns all known values for LogLevel. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Parameters 

type Parameters interface {
	// contains filtered or unexported methods
}

The parameters that comprise the parameter group.

The following types satisfy this interface: 

ParametersMemberInfluxDBv2
Example (OutputUsage) 
// Code generated by smithy-go-codegen DO NOT EDIT.

package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/timestreaminfluxdb/types"
)

func main() {
	var union types.Parameters
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ParametersMemberInfluxDBv2:
		_ = v.Value // Value is types.InfluxDBv2Parameters

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

var _ *types.InfluxDBv2Parameters

Output:

type ParametersMemberInfluxDBv2 

type ParametersMemberInfluxDBv2 struct {
	Value InfluxDBv2Parameters
	// contains filtered or unexported fields
}

All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

The requested resource was not found or does not exist.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type S3Configuration 

type S3Configuration struct {

	// The name of the S3 bucket to deliver logs to.
	//
	// This member is required.
	BucketName *string

	// Indicates whether log delivery to the S3 bucket is enabled.
	//
	// This member is required.
	Enabled *bool
	// contains filtered or unexported fields
}

Configuration for S3 bucket log delivery.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request exceeds the service quota.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type Status 

type Status string
const (
	StatusCreating               Status = "CREATING"
	StatusAvailable              Status = "AVAILABLE"
	StatusDeleting               Status = "DELETING"
	StatusModifying              Status = "MODIFYING"
	StatusUpdating               Status = "UPDATING"
	StatusDeleted                Status = "DELETED"
	StatusFailed                 Status = "FAILED"
	StatusUpdatingDeploymentType Status = "UPDATING_DEPLOYMENT_TYPE"
	StatusUpdatingInstanceType   Status = "UPDATING_INSTANCE_TYPE"
)

Enum values for Status

func (Status) Values 

func (Status) Values() []Status

Values returns all known values for Status. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	RetryAfterSeconds *int32
	// contains filtered or unexported fields
}

The request was denied due to request throttling.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type TracingType 

type TracingType string
const (
	TracingTypeLog    TracingType = "log"
	TracingTypeJaeger TracingType = "jaeger"
)

Enum values for TracingType

func (TracingType) Values 

func (TracingType) Values() []TracingType

Values returns all known values for TracingType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type UnknownUnionMember 

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	Reason ValidationExceptionReason
	// contains filtered or unexported fields
}

The input fails to satisfy the constraints specified by Timestream for InfluxDB.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type ValidationExceptionReason 

type ValidationExceptionReason string
const (
	ValidationExceptionReasonFieldValidationFailed ValidationExceptionReason = "FIELD_VALIDATION_FAILED"
	ValidationExceptionReasonOther                 ValidationExceptionReason = "OTHER"
)

Enum values for ValidationExceptionReason

func (ValidationExceptionReason) Values 

func (ValidationExceptionReason) Values() []ValidationExceptionReason

Values returns all known values for ValidationExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.