types

package
v1.28.4 Latest Latest
Warning

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

 Go to latest Published: Mar 29, 2024 License: Apache-2.0 Imports: 4 Imported by: 8

Documentation

Index

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
}

An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

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 AccessPoliciesStatus 

type AccessPoliciesStatus struct {

	// The access policy configured for the Elasticsearch domain. Access policies may
	// be resource-based, IP-based, or IAM-based. See Configuring Access Policies (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-access-policies)
	// for more information.
	//
	// This member is required.
	Options *string

	// The status of the access policy for the Elasticsearch domain. See OptionStatus
	// for the status information that's included.
	//
	// This member is required.
	Status *OptionStatus
	// contains filtered or unexported fields
}

The configured access rules for the domain's document and search endpoints, and the current status of those rules.

type AdditionalLimit 

type AdditionalLimit struct {

	// Name of Additional Limit is specific to a given InstanceType and for each of
	// it's InstanceRole etc.
	//
	// Attributes and their details:
	//
	//   - MaximumNumberOfDataNodesSupported This attribute will be present in Master
	//   node only to specify how much data nodes upto which given
	//   ESPartitionInstanceType can support as master node.
	//   - MaximumNumberOfDataNodesWithoutMasterNode This attribute will be present in
	//   Data node only to specify how much data nodes of given ESPartitionInstanceType
	//   upto which you don't need any master nodes to govern them.
	LimitName *string

	// Value for given AdditionalLimit$LimitName .
	LimitValues []string
	// contains filtered or unexported fields
}

List of limits that are specific to a given InstanceType and for each of it's InstanceRole .

type AdvancedOptionsStatus 

type AdvancedOptionsStatus struct {

	// Specifies the status of advanced options for the specified Elasticsearch domain.
	//
	// This member is required.
	Options map[string]string

	// Specifies the status of OptionStatus for advanced options for the specified
	// Elasticsearch domain.
	//
	// This member is required.
	Status *OptionStatus
	// contains filtered or unexported fields
}

Status of the advanced options for the specified Elasticsearch domain. Currently, the following advanced options are available:

For more information, see Configuring Advanced Options (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options) .

type AdvancedSecurityOptions 

type AdvancedSecurityOptions struct {

	// Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.
	AnonymousAuthDisableDate *time.Time

	// True if Anonymous auth is enabled. Anonymous auth can be enabled only when
	// AdvancedSecurity is enabled on existing domains.
	AnonymousAuthEnabled *bool

	// True if advanced security is enabled.
	Enabled *bool

	// True if the internal user database is enabled.
	InternalUserDatabaseEnabled *bool

	// Describes the SAML application configured for a domain.
	SAMLOptions *SAMLOptionsOutput
	// contains filtered or unexported fields
}

Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled.

type AdvancedSecurityOptionsInput 

type AdvancedSecurityOptionsInput struct {

	// True if Anonymous auth is enabled. Anonymous auth can be enabled only when
	// AdvancedSecurity is enabled on existing domains.
	AnonymousAuthEnabled *bool

	// True if advanced security is enabled.
	Enabled *bool

	// True if the internal user database is enabled.
	InternalUserDatabaseEnabled *bool

	// Credentials for the master user: username and password, ARN, or both.
	MasterUserOptions *MasterUserOptions

	// Specifies the SAML application configuration for the domain.
	SAMLOptions *SAMLOptionsInput
	// contains filtered or unexported fields
}

Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled, master username and password (if internal database is enabled), and master user ARN (if IAM is enabled).

type AdvancedSecurityOptionsStatus 

type AdvancedSecurityOptionsStatus struct {

	// Specifies advanced security options for the specified Elasticsearch domain.
	//
	// This member is required.
	Options *AdvancedSecurityOptions

	// Status of the advanced security options for the specified Elasticsearch domain.
	//
	// This member is required.
	Status *OptionStatus
	// contains filtered or unexported fields
}

Specifies the status of advanced security options for the specified Elasticsearch domain.

type AuthorizedPrincipal added in v1.17.0 

type AuthorizedPrincipal struct {

	// The IAM principal that is allowed access to the domain.
	Principal *string

	// The type of principal.
	PrincipalType PrincipalType
	// contains filtered or unexported fields
}

Information about an account or service that has access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

type AutoTune added in v1.2.0 

type AutoTune struct {

	// Specifies details of the Auto-Tune action. See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html)
	// for more information.
	AutoTuneDetails *AutoTuneDetails

	// Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION.
	AutoTuneType AutoTuneType
	// contains filtered or unexported fields
}

Specifies Auto-Tune type and Auto-Tune action details.

type AutoTuneDesiredState added in v1.2.0 

type AutoTuneDesiredState string
const (
	AutoTuneDesiredStateEnabled  AutoTuneDesiredState = "ENABLED"
	AutoTuneDesiredStateDisabled AutoTuneDesiredState = "DISABLED"
)

Enum values for AutoTuneDesiredState

func (AutoTuneDesiredState) Values added in v1.2.0 

func (AutoTuneDesiredState) Values() []AutoTuneDesiredState

Values returns all known values for AutoTuneDesiredState. 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 AutoTuneDetails added in v1.2.0 

type AutoTuneDetails struct {

	// Specifies details of the scheduled Auto-Tune action. See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html)
	// for more information.
	ScheduledAutoTuneDetails *ScheduledAutoTuneDetails
	// contains filtered or unexported fields
}

Specifies details of the Auto-Tune action. See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) for more information.

type AutoTuneMaintenanceSchedule added in v1.2.0 

type AutoTuneMaintenanceSchedule struct {

	// Specifies cron expression for a recurring maintenance schedule. See the
	// Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html)
	// for more information.
	CronExpressionForRecurrence *string

	// Specifies maintenance schedule duration: duration value and duration unit. See
	// the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html)
	// for more information.
	Duration *Duration

	// Specifies timestamp at which Auto-Tune maintenance schedule start.
	StartAt *time.Time
	// contains filtered or unexported fields
}

Specifies Auto-Tune maitenance schedule. See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) for more information.

type AutoTuneOptions added in v1.2.0 

type AutoTuneOptions struct {

	// Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.
	DesiredState AutoTuneDesiredState

	// Specifies list of maitenance schedules. See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html)
	// for more information.
	MaintenanceSchedules []AutoTuneMaintenanceSchedule

	// Specifies the rollback state while disabling Auto-Tune for the domain. Valid
	// values are NO_ROLLBACK, DEFAULT_ROLLBACK.
	RollbackOnDisable RollbackOnDisable
	// contains filtered or unexported fields
}

Specifies the Auto-Tune options: the Auto-Tune desired state for the domain, rollback state when disabling Auto-Tune options and list of maintenance schedules.

type AutoTuneOptionsInput added in v1.2.0 

type AutoTuneOptionsInput struct {

	// Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.
	DesiredState AutoTuneDesiredState

	// Specifies list of maitenance schedules. See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html)
	// for more information.
	MaintenanceSchedules []AutoTuneMaintenanceSchedule
	// contains filtered or unexported fields
}

Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.

type AutoTuneOptionsOutput added in v1.2.0 

type AutoTuneOptionsOutput struct {

	// Specifies the error message while enabling or disabling the Auto-Tune.
	ErrorMessage *string

	// Specifies the AutoTuneState for the Elasticsearch domain.
	State AutoTuneState
	// contains filtered or unexported fields
}

Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.

type AutoTuneOptionsStatus added in v1.2.0 

type AutoTuneOptionsStatus struct {

	// Specifies Auto-Tune options for the specified Elasticsearch domain.
	Options *AutoTuneOptions

	// Specifies Status of the Auto-Tune options for the specified Elasticsearch
	// domain.
	Status *AutoTuneStatus
	// contains filtered or unexported fields
}

Specifies the status of Auto-Tune options for the specified Elasticsearch domain.

type AutoTuneState added in v1.2.0 

type AutoTuneState string
const (
	AutoTuneStateEnabled                       AutoTuneState = "ENABLED"
	AutoTuneStateDisabled                      AutoTuneState = "DISABLED"
	AutoTuneStateEnableInProgress              AutoTuneState = "ENABLE_IN_PROGRESS"
	AutoTuneStateDisableInProgress             AutoTuneState = "DISABLE_IN_PROGRESS"
	AutoTuneStateDisabledAndRollbackScheduled  AutoTuneState = "DISABLED_AND_ROLLBACK_SCHEDULED"
	AutoTuneStateDisabledAndRollbackInProgress AutoTuneState = "DISABLED_AND_ROLLBACK_IN_PROGRESS"
	AutoTuneStateDisabledAndRollbackComplete   AutoTuneState = "DISABLED_AND_ROLLBACK_COMPLETE"
	AutoTuneStateDisabledAndRollbackError      AutoTuneState = "DISABLED_AND_ROLLBACK_ERROR"
	AutoTuneStateError                         AutoTuneState = "ERROR"
)

Enum values for AutoTuneState

func (AutoTuneState) Values added in v1.2.0 

func (AutoTuneState) Values() []AutoTuneState

Values returns all known values for AutoTuneState. 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 AutoTuneStatus added in v1.2.0 

type AutoTuneStatus struct {

	// Timestamp which tells Auto-Tune options creation date .
	//
	// This member is required.
	CreationDate *time.Time

	// Specifies the AutoTuneState for the Elasticsearch domain.
	//
	// This member is required.
	State AutoTuneState

	// Timestamp which tells Auto-Tune options last updated time.
	//
	// This member is required.
	UpdateDate *time.Time

	// Specifies the error message while enabling or disabling the Auto-Tune options.
	ErrorMessage *string

	// Indicates whether the Elasticsearch domain is being deleted.
	PendingDeletion *bool

	// Specifies the Auto-Tune options latest version.
	UpdateVersion int32
	// contains filtered or unexported fields
}

Provides the current status of the Auto-Tune options.

type AutoTuneType added in v1.2.0 

type AutoTuneType string
const (
	AutoTuneTypeScheduledAction AutoTuneType = "SCHEDULED_ACTION"
)

Enum values for AutoTuneType

func (AutoTuneType) Values added in v1.2.0 

func (AutoTuneType) Values() []AutoTuneType

Values returns all known values for AutoTuneType. 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 BaseException 

type BaseException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An error occurred while processing the request.

func (*BaseException) Error 

func (e *BaseException) Error() string

func (*BaseException) ErrorCode 

func (e *BaseException) ErrorCode() string

func (*BaseException) ErrorFault 

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

func (*BaseException) ErrorMessage 

func (e *BaseException) ErrorMessage() string

type CancelledChangeProperty added in v1.26.0 

type CancelledChangeProperty struct {

	// The current value of the property, after the change was cancelled.
	ActiveValue *string

	// The pending value of the property that was cancelled. This would have been the
	// eventual value of the property if the chance had not been cancelled.
	CancelledValue *string

	// The name of the property whose change was cancelled.
	PropertyName *string
	// contains filtered or unexported fields
}

A property change that was cancelled for an Amazon OpenSearch Service domain.

type ChangeProgressDetails added in v1.14.0 

type ChangeProgressDetails struct {

	// The unique change identifier associated with a specific domain configuration
	// change.
	ChangeId *string

	// The current status of the configuration change.
	ConfigChangeStatus ConfigChangeStatus

	// The IAM principal who initiated the configuration change.
	InitiatedBy InitiatedBy

	// The last time that the configuration change was updated.
	LastUpdatedTime *time.Time

	// Contains an optional message associated with the domain configuration change.
	Message *string

	// The time that the configuration change was initiated, in Universal Coordinated
	// Time (UTC).
	StartTime *time.Time
	// contains filtered or unexported fields
}

Specifies change details of the domain configuration change.

type ChangeProgressStage added in v1.14.0 

type ChangeProgressStage struct {

	// The description of the progress stage.
	Description *string

	// The last updated timestamp of the progress stage.
	LastUpdated *time.Time

	// The name of the specific progress stage.
	Name *string

	// The overall status of a specific progress stage.
	Status *string
	// contains filtered or unexported fields
}

A progress stage details of a specific domain configuration change.

type ChangeProgressStatusDetails added in v1.14.0 

type ChangeProgressStatusDetails struct {

	// The unique change identifier associated with a specific domain configuration
	// change.
	ChangeId *string

	// The specific stages that the domain is going through to perform the
	// configuration change.
	ChangeProgressStages []ChangeProgressStage

	// The list of properties involved in the domain configuration change that are
	// completed.
	CompletedProperties []string

	// The current status of the configuration change.
	ConfigChangeStatus ConfigChangeStatus

	// The IAM principal who initiated the configuration change.
	InitiatedBy InitiatedBy

	// The last time that the status of the configuration change was updated.
	LastUpdatedTime *time.Time

	// The list of properties involved in the domain configuration change that are
	// still in pending.
	PendingProperties []string

	// The time at which the configuration change is made on the domain.
	StartTime *time.Time

	// The overall status of the domain configuration change. This field can take the
	// following values: PENDING , PROCESSING , COMPLETED and FAILED
	Status OverallChangeStatus

	// The total number of stages required for the configuration change.
	TotalNumberOfStages int32
	// contains filtered or unexported fields
}

The progress details of a specific domain configuration change.

type CognitoOptions 

type CognitoOptions struct {

	// Specifies the option to enable Cognito for Kibana authentication.
	Enabled *bool

	// Specifies the Cognito identity pool ID for Kibana authentication.
	IdentityPoolId *string

	// Specifies the role ARN that provides Elasticsearch permissions for accessing
	// Cognito resources.
	RoleArn *string

	// Specifies the Cognito user pool ID for Kibana authentication.
	UserPoolId *string
	// contains filtered or unexported fields
}

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html) .

type CognitoOptionsStatus 

type CognitoOptionsStatus struct {

	// Specifies the Cognito options for the specified Elasticsearch domain.
	//
	// This member is required.
	Options *CognitoOptions

	// Specifies the status of the Cognito options for the specified Elasticsearch
	// domain.
	//
	// This member is required.
	Status *OptionStatus
	// contains filtered or unexported fields
}

Status of the Cognito options for the specified Elasticsearch domain.

type ColdStorageOptions added in v1.4.0 

type ColdStorageOptions struct {

	// Enable cold storage option. Accepted values true or false
	//
	// This member is required.
	Enabled *bool
	// contains filtered or unexported fields
}

Specifies the configuration for cold storage options such as enabled

type CompatibleVersionsMap 

type CompatibleVersionsMap struct {

	// The current version of Elasticsearch on which a domain is.
	SourceVersion *string

	// List of supported elastic search versions.
	TargetVersions []string
	// contains filtered or unexported fields
}

A map from an ElasticsearchVersion to a list of compatible ElasticsearchVersion s to which the domain can be upgraded.

type ConfigChangeStatus added in v1.26.0 

type ConfigChangeStatus string
const (
	ConfigChangeStatusPending          ConfigChangeStatus = "Pending"
	ConfigChangeStatusInitializing     ConfigChangeStatus = "Initializing"
	ConfigChangeStatusValidating       ConfigChangeStatus = "Validating"
	ConfigChangeStatusValidationFailed ConfigChangeStatus = "ValidationFailed"
	ConfigChangeStatusApplyingChanges  ConfigChangeStatus = "ApplyingChanges"
	ConfigChangeStatusCompleted        ConfigChangeStatus = "Completed"
	ConfigChangeStatusPendingUserInput ConfigChangeStatus = "PendingUserInput"
	ConfigChangeStatusCancelled        ConfigChangeStatus = "Cancelled"
)

Enum values for ConfigChangeStatus

func (ConfigChangeStatus) Values added in v1.26.0 

func (ConfigChangeStatus) Values() []ConfigChangeStatus

Values returns all known values for ConfigChangeStatus. 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 ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

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 DeploymentStatus 

type DeploymentStatus string
const (
	DeploymentStatusPendingUpdate DeploymentStatus = "PENDING_UPDATE"
	DeploymentStatusInProgress    DeploymentStatus = "IN_PROGRESS"
	DeploymentStatusCompleted     DeploymentStatus = "COMPLETED"
	DeploymentStatusNotEligible   DeploymentStatus = "NOT_ELIGIBLE"
	DeploymentStatusEligible      DeploymentStatus = "ELIGIBLE"
)

Enum values for DeploymentStatus

func (DeploymentStatus) Values added in v0.29.0 

func (DeploymentStatus) Values() []DeploymentStatus

Values returns all known values for DeploymentStatus. 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 DescribePackagesFilter 

type DescribePackagesFilter struct {

	// Any field from PackageDetails .
	Name DescribePackagesFilterName

	// A non-empty list of values for the specified field.
	Value []string
	// contains filtered or unexported fields
}

Filter to apply in DescribePackage response.

type DescribePackagesFilterName 

type DescribePackagesFilterName string
const (
	DescribePackagesFilterNamePackageID     DescribePackagesFilterName = "PackageID"
	DescribePackagesFilterNamePackageName   DescribePackagesFilterName = "PackageName"
	DescribePackagesFilterNamePackageStatus DescribePackagesFilterName = "PackageStatus"
)

Enum values for DescribePackagesFilterName

func (DescribePackagesFilterName) Values added in v0.29.0 

func (DescribePackagesFilterName) Values() []DescribePackagesFilterName

Values returns all known values for DescribePackagesFilterName. 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 DisabledOperationException 

type DisabledOperationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

func (*DisabledOperationException) Error 

func (e *DisabledOperationException) Error() string

func (*DisabledOperationException) ErrorCode 

func (e *DisabledOperationException) ErrorCode() string

func (*DisabledOperationException) ErrorFault 

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

func (*DisabledOperationException) ErrorMessage 

func (e *DisabledOperationException) ErrorMessage() string

type DomainEndpointOptions 

type DomainEndpointOptions struct {

	// Specify the fully qualified domain for your custom endpoint.
	CustomEndpoint *string

	// Specify ACM certificate ARN for your custom endpoint.
	CustomEndpointCertificateArn *string

	// Specify if custom endpoint should be enabled for the Elasticsearch domain.
	CustomEndpointEnabled *bool

	// Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.
	EnforceHTTPS *bool

	// Specify the TLS security policy that needs to be applied to the HTTPS endpoint
	// of Elasticsearch domain.
	//
	// It can be one of the following values:
	//   - Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version
	//   1.0 to TLS version 1.2
	//   - Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS
	//   version 1.2
	//   - Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS
	//   version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites
	TLSSecurityPolicy TLSSecurityPolicy
	// contains filtered or unexported fields
}

Options to configure endpoint for the Elasticsearch domain.

type DomainEndpointOptionsStatus 

type DomainEndpointOptionsStatus struct {

	// Options to configure endpoint for the Elasticsearch domain.
	//
	// This member is required.
	Options *DomainEndpointOptions

	// The status of the endpoint options for the Elasticsearch domain. See
	// OptionStatus for the status information that's included.
	//
	// This member is required.
	Status *OptionStatus
	// contains filtered or unexported fields
}

The configured endpoint options for the domain and their current status.

type DomainInfo 

type DomainInfo struct {

	// Specifies the DomainName .
	DomainName *string

	// Specifies the EngineType of the domain.
	EngineType EngineType
	// contains filtered or unexported fields
}

type DomainInformation 

type DomainInformation struct {

	// The name of an Elasticsearch domain. Domain names are unique across the domains
	// owned by an account within an AWS region. Domain names start with a letter or
	// number and can contain the following characters: a-z (lowercase), 0-9, and -
	// (hyphen).
	//
	// This member is required.
	DomainName *string

	OwnerId *string

	Region *string
	// contains filtered or unexported fields
}

type DomainPackageDetails 

type DomainPackageDetails struct {

	// Name of the domain you've associated a package with.
	DomainName *string

	// State of the association. Values are
	// ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.
	DomainPackageStatus DomainPackageStatus

	// Additional information if the package is in an error state. Null otherwise.
	ErrorDetails *ErrorDetails

	// Timestamp of the most-recent update to the association status.
	LastUpdated *time.Time

	// Internal ID of the package.
	PackageID *string

	// User specified name of the package.
	PackageName *string

	// Currently supports only TXT-DICTIONARY.
	PackageType PackageType

	PackageVersion *string

	// The relative path on Amazon ES nodes, which can be used as synonym_path when
	// the package is synonym file.
	ReferencePath *string
	// contains filtered or unexported fields
}

Information on a package that is associated with a domain.

type DomainPackageStatus 

type DomainPackageStatus string
const (
	DomainPackageStatusAssociating        DomainPackageStatus = "ASSOCIATING"
	DomainPackageStatusAssociationFailed  DomainPackageStatus = "ASSOCIATION_FAILED"
	DomainPackageStatusActive             DomainPackageStatus = "ACTIVE"
	DomainPackageStatusDissociating       DomainPackageStatus = "DISSOCIATING"
	DomainPackageStatusDissociationFailed DomainPackageStatus = "DISSOCIATION_FAILED"
)

Enum values for DomainPackageStatus

func (DomainPackageStatus) Values added in v0.29.0 

func (DomainPackageStatus) Values() []DomainPackageStatus

Values returns all known values for DomainPackageStatus. 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 DomainProcessingStatusType added in v1.26.0 

type DomainProcessingStatusType string
const (
	DomainProcessingStatusTypeCreating  DomainProcessingStatusType = "Creating"
	DomainProcessingStatusTypeActive    DomainProcessingStatusType = "Active"
	DomainProcessingStatusTypeModifying DomainProcessingStatusType = "Modifying"
	DomainProcessingStatusTypeUpgrading DomainProcessingStatusType = "UpgradingEngineVersion"
	DomainProcessingStatusTypeUpdating  DomainProcessingStatusType = "UpdatingServiceSoftware"
	DomainProcessingStatusTypeIsolated  DomainProcessingStatusType = "Isolated"
	DomainProcessingStatusTypeDeleting  DomainProcessingStatusType = "Deleting"
)

Enum values for DomainProcessingStatusType

func (DomainProcessingStatusType) Values added in v1.26.0 

func (DomainProcessingStatusType) Values() []DomainProcessingStatusType

Values returns all known values for DomainProcessingStatusType. 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 DryRunResults added in v1.10.0 

type DryRunResults struct {

	// Specifies the deployment mechanism through which the update shall be applied on
	// the domain. Possible responses are Blue/Green (The update will require a
	// blue/green deployment.) DynamicUpdate (The update can be applied in-place
	// without a Blue/Green deployment required.) Undetermined (The domain is
	// undergoing an update which needs to complete before the deployment type can be
	// predicted.) None (The configuration change matches the current configuration
	// and will not result in any update.)
	DeploymentType *string

	// Contains an optional message associated with the DryRunResults.
	Message *string
	// contains filtered or unexported fields
}

type Duration added in v1.2.0 

type Duration struct {

	// Specifies the unit of a maintenance schedule duration. Valid value is HOURS.
	// See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html)
	// for more information.
	Unit TimeUnit

	// Integer to specify the value of a maintenance schedule duration. See the
	// Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html)
	// for more information.
	Value *int64
	// contains filtered or unexported fields
}

Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) for more information.

type EBSOptions 

type EBSOptions struct {

	// Specifies whether EBS-based storage is enabled.
	EBSEnabled *bool

	// Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).
	Iops *int32

	// Specifies the Throughput for GP3 EBS volume (SSD).
	Throughput *int32

	// Integer to specify the size of an EBS volume.
	VolumeSize *int32

	// Specifies the volume type for EBS-based storage.
	VolumeType VolumeType
	// contains filtered or unexported fields
}

Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see Configuring EBS-based Storage (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs) .

type EBSOptionsStatus 

type EBSOptionsStatus struct {

	// Specifies the EBS options for the specified Elasticsearch domain.
	//
	// This member is required.
	Options *EBSOptions

	// Specifies the status of the EBS options for the specified Elasticsearch domain.
	//
	// This member is required.
	Status *OptionStatus
	// contains filtered or unexported fields
}

Status of the EBS options for the specified Elasticsearch domain.

type ESPartitionInstanceType 

type ESPartitionInstanceType string
const (
	ESPartitionInstanceTypeM3MediumElasticsearch         ESPartitionInstanceType = "m3.medium.elasticsearch"
	ESPartitionInstanceTypeM3LargeElasticsearch          ESPartitionInstanceType = "m3.large.elasticsearch"
	ESPartitionInstanceTypeM3XlargeElasticsearch         ESPartitionInstanceType = "m3.xlarge.elasticsearch"
	ESPartitionInstanceTypeM32xlargeElasticsearch        ESPartitionInstanceType = "m3.2xlarge.elasticsearch"
	ESPartitionInstanceTypeM4LargeElasticsearch          ESPartitionInstanceType = "m4.large.elasticsearch"
	ESPartitionInstanceTypeM4XlargeElasticsearch         ESPartitionInstanceType = "m4.xlarge.elasticsearch"
	ESPartitionInstanceTypeM42xlargeElasticsearch        ESPartitionInstanceType = "m4.2xlarge.elasticsearch"
	ESPartitionInstanceTypeM44xlargeElasticsearch        ESPartitionInstanceType = "m4.4xlarge.elasticsearch"
	ESPartitionInstanceTypeM410xlargeElasticsearch       ESPartitionInstanceType = "m4.10xlarge.elasticsearch"
	ESPartitionInstanceTypeM5LargeElasticsearch          ESPartitionInstanceType = "m5.large.elasticsearch"
	ESPartitionInstanceTypeM5XlargeElasticsearch         ESPartitionInstanceType = "m5.xlarge.elasticsearch"
	ESPartitionInstanceTypeM52xlargeElasticsearch        ESPartitionInstanceType = "m5.2xlarge.elasticsearch"
	ESPartitionInstanceTypeM54xlargeElasticsearch        ESPartitionInstanceType = "m5.4xlarge.elasticsearch"
	ESPartitionInstanceTypeM512xlargeElasticsearch       ESPartitionInstanceType = "m5.12xlarge.elasticsearch"
	ESPartitionInstanceTypeR5LargeElasticsearch          ESPartitionInstanceType = "r5.large.elasticsearch"
	ESPartitionInstanceTypeR5XlargeElasticsearch         ESPartitionInstanceType = "r5.xlarge.elasticsearch"
	ESPartitionInstanceTypeR52xlargeElasticsearch        ESPartitionInstanceType = "r5.2xlarge.elasticsearch"
	ESPartitionInstanceTypeR54xlargeElasticsearch        ESPartitionInstanceType = "r5.4xlarge.elasticsearch"
	ESPartitionInstanceTypeR512xlargeElasticsearch       ESPartitionInstanceType = "r5.12xlarge.elasticsearch"
	ESPartitionInstanceTypeC5LargeElasticsearch          ESPartitionInstanceType = "c5.large.elasticsearch"
	ESPartitionInstanceTypeC5XlargeElasticsearch         ESPartitionInstanceType = "c5.xlarge.elasticsearch"
	ESPartitionInstanceTypeC52xlargeElasticsearch        ESPartitionInstanceType = "c5.2xlarge.elasticsearch"
	ESPartitionInstanceTypeC54xlargeElasticsearch        ESPartitionInstanceType = "c5.4xlarge.elasticsearch"
	ESPartitionInstanceTypeC59xlargeElasticsearch        ESPartitionInstanceType = "c5.9xlarge.elasticsearch"
	ESPartitionInstanceTypeC518xlargeElasticsearch       ESPartitionInstanceType = "c5.18xlarge.elasticsearch"
	ESPartitionInstanceTypeUltrawarm1MediumElasticsearch ESPartitionInstanceType = "ultrawarm1.medium.elasticsearch"
	ESPartitionInstanceTypeUltrawarm1LargeElasticsearch  ESPartitionInstanceType = "ultrawarm1.large.elasticsearch"
	ESPartitionInstanceTypeT2MicroElasticsearch          ESPartitionInstanceType = "t2.micro.elasticsearch"
	ESPartitionInstanceTypeT2SmallElasticsearch          ESPartitionInstanceType = "t2.small.elasticsearch"
	ESPartitionInstanceTypeT2MediumElasticsearch         ESPartitionInstanceType = "t2.medium.elasticsearch"
	ESPartitionInstanceTypeR3LargeElasticsearch          ESPartitionInstanceType = "r3.large.elasticsearch"
	ESPartitionInstanceTypeR3XlargeElasticsearch         ESPartitionInstanceType = "r3.xlarge.elasticsearch"
	ESPartitionInstanceTypeR32xlargeElasticsearch        ESPartitionInstanceType = "r3.2xlarge.elasticsearch"
	ESPartitionInstanceTypeR34xlargeElasticsearch        ESPartitionInstanceType = "r3.4xlarge.elasticsearch"
	ESPartitionInstanceTypeR38xlargeElasticsearch        ESPartitionInstanceType = "r3.8xlarge.elasticsearch"
	ESPartitionInstanceTypeI2XlargeElasticsearch         ESPartitionInstanceType = "i2.xlarge.elasticsearch"
	ESPartitionInstanceTypeI22xlargeElasticsearch        ESPartitionInstanceType = "i2.2xlarge.elasticsearch"
	ESPartitionInstanceTypeD2XlargeElasticsearch         ESPartitionInstanceType = "d2.xlarge.elasticsearch"
	ESPartitionInstanceTypeD22xlargeElasticsearch        ESPartitionInstanceType = "d2.2xlarge.elasticsearch"
	ESPartitionInstanceTypeD24xlargeElasticsearch        ESPartitionInstanceType = "d2.4xlarge.elasticsearch"
	ESPartitionInstanceTypeD28xlargeElasticsearch        ESPartitionInstanceType = "d2.8xlarge.elasticsearch"
	ESPartitionInstanceTypeC4LargeElasticsearch          ESPartitionInstanceType = "c4.large.elasticsearch"
	ESPartitionInstanceTypeC4XlargeElasticsearch         ESPartitionInstanceType = "c4.xlarge.elasticsearch"
	ESPartitionInstanceTypeC42xlargeElasticsearch        ESPartitionInstanceType = "c4.2xlarge.elasticsearch"
	ESPartitionInstanceTypeC44xlargeElasticsearch        ESPartitionInstanceType = "c4.4xlarge.elasticsearch"
	ESPartitionInstanceTypeC48xlargeElasticsearch        ESPartitionInstanceType = "c4.8xlarge.elasticsearch"
	ESPartitionInstanceTypeR4LargeElasticsearch          ESPartitionInstanceType = "r4.large.elasticsearch"
	ESPartitionInstanceTypeR4XlargeElasticsearch         ESPartitionInstanceType = "r4.xlarge.elasticsearch"
	ESPartitionInstanceTypeR42xlargeElasticsearch        ESPartitionInstanceType = "r4.2xlarge.elasticsearch"
	ESPartitionInstanceTypeR44xlargeElasticsearch        ESPartitionInstanceType = "r4.4xlarge.elasticsearch"
	ESPartitionInstanceTypeR48xlargeElasticsearch        ESPartitionInstanceType = "r4.8xlarge.elasticsearch"
	ESPartitionInstanceTypeR416xlargeElasticsearch       ESPartitionInstanceType = "r4.16xlarge.elasticsearch"
	ESPartitionInstanceTypeI3LargeElasticsearch          ESPartitionInstanceType = "i3.large.elasticsearch"
	ESPartitionInstanceTypeI3XlargeElasticsearch         ESPartitionInstanceType = "i3.xlarge.elasticsearch"
	ESPartitionInstanceTypeI32xlargeElasticsearch        ESPartitionInstanceType = "i3.2xlarge.elasticsearch"
	ESPartitionInstanceTypeI34xlargeElasticsearch        ESPartitionInstanceType = "i3.4xlarge.elasticsearch"
	ESPartitionInstanceTypeI38xlargeElasticsearch        ESPartitionInstanceType = "i3.8xlarge.elasticsearch"
	ESPartitionInstanceTypeI316xlargeElasticsearch       ESPartitionInstanceType = "i3.16xlarge.elasticsearch"
)

Enum values for ESPartitionInstanceType

func (ESPartitionInstanceType) Values added in v0.29.0 

func (ESPartitionInstanceType) Values() []ESPartitionInstanceType

Values returns all known values for ESPartitionInstanceType. 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 ESWarmPartitionInstanceType 

type ESWarmPartitionInstanceType string
const (
	ESWarmPartitionInstanceTypeUltrawarm1MediumElasticsearch ESWarmPartitionInstanceType = "ultrawarm1.medium.elasticsearch"
	ESWarmPartitionInstanceTypeUltrawarm1LargeElasticsearch  ESWarmPartitionInstanceType = "ultrawarm1.large.elasticsearch"
)

Enum values for ESWarmPartitionInstanceType

func (ESWarmPartitionInstanceType) Values added in v0.29.0 

func (ESWarmPartitionInstanceType) Values() []ESWarmPartitionInstanceType

Values returns all known values for ESWarmPartitionInstanceType. 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 ElasticsearchClusterConfig 

type ElasticsearchClusterConfig struct {

	// Specifies the ColdStorageOptions config for Elasticsearch Domain
	ColdStorageOptions *ColdStorageOptions

	// Total number of dedicated master nodes, active and on standby, for the cluster.
	DedicatedMasterCount *int32

	// A boolean value to indicate whether a dedicated master node is enabled. See
	// About Dedicated Master Nodes (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-dedicatedmasternodes)
	// for more information.
	DedicatedMasterEnabled *bool

	// The instance type for a dedicated master node.
	DedicatedMasterType ESPartitionInstanceType

	// The number of instances in the specified domain cluster.
	InstanceCount *int32

	// The instance type for an Elasticsearch cluster. UltraWarm instance types are
	// not supported for data instances.
	InstanceType ESPartitionInstanceType

	// The number of warm nodes in the cluster.
	WarmCount *int32

	// True to enable warm storage.
	WarmEnabled *bool

	// The instance type for the Elasticsearch cluster's warm nodes.
	WarmType ESWarmPartitionInstanceType

	// Specifies the zone awareness configuration for a domain when zone awareness is
	// enabled.
	ZoneAwarenessConfig *ZoneAwarenessConfig

	// A boolean value to indicate whether zone awareness is enabled. See About Zone
	// Awareness (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-zoneawareness)
	// for more information.
	ZoneAwarenessEnabled *bool
	// contains filtered or unexported fields
}

Specifies the configuration for the domain cluster, such as the type and number of instances.

type ElasticsearchClusterConfigStatus 

type ElasticsearchClusterConfigStatus struct {

	// Specifies the cluster configuration for the specified Elasticsearch domain.
	//
	// This member is required.
	Options *ElasticsearchClusterConfig

	// Specifies the status of the configuration for the specified Elasticsearch
	// domain.
	//
	// This member is required.
	Status *OptionStatus
	// contains filtered or unexported fields
}

Specifies the configuration status for the specified Elasticsearch domain.

type ElasticsearchDomainConfig 

type ElasticsearchDomainConfig struct {

	// IAM access policy as a JSON-formatted string.
	AccessPolicies *AccessPoliciesStatus

	// Specifies the AdvancedOptions for the domain. See Configuring Advanced Options (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options)
	// for more information.
	AdvancedOptions *AdvancedOptionsStatus

	// Specifies AdvancedSecurityOptions for the domain.
	AdvancedSecurityOptions *AdvancedSecurityOptionsStatus

	// Specifies AutoTuneOptions for the domain.
	AutoTuneOptions *AutoTuneOptionsStatus

	// Specifies change details of the domain configuration change.
	ChangeProgressDetails *ChangeProgressDetails

	// The CognitoOptions for the specified domain. For more information, see Amazon
	// Cognito Authentication for Kibana (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html)
	// .
	CognitoOptions *CognitoOptionsStatus

	// Specifies the DomainEndpointOptions for the Elasticsearch domain.
	DomainEndpointOptions *DomainEndpointOptionsStatus

	// Specifies the EBSOptions for the Elasticsearch domain.
	EBSOptions *EBSOptionsStatus

	// Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.
	ElasticsearchClusterConfig *ElasticsearchClusterConfigStatus

	// String of format X.Y to specify version for the Elasticsearch domain.
	ElasticsearchVersion *ElasticsearchVersionStatus

	// Specifies the EncryptionAtRestOptions for the Elasticsearch domain.
	EncryptionAtRestOptions *EncryptionAtRestOptionsStatus

	// Log publishing options for the given domain.
	LogPublishingOptions *LogPublishingOptionsStatus

	// Information about the domain properties that are currently being modified.
	ModifyingProperties []ModifyingProperties

	// Specifies the NodeToNodeEncryptionOptions for the Elasticsearch domain.
	NodeToNodeEncryptionOptions *NodeToNodeEncryptionOptionsStatus

	// Specifies the SnapshotOptions for the Elasticsearch domain.
	SnapshotOptions *SnapshotOptionsStatus

	// The VPCOptions for the specified domain. For more information, see VPC
	// Endpoints for Amazon Elasticsearch Service Domains (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html)
	// .
	VPCOptions *VPCDerivedInfoStatus
	// contains filtered or unexported fields
}

The configuration of an Elasticsearch domain.

type ElasticsearchDomainStatus 

type ElasticsearchDomainStatus struct {

	// The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for
	// IAM Entities (http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html)
	// in Using AWS Identity and Access Management for more information.
	//
	// This member is required.
	ARN *string

	// The unique identifier for the specified Elasticsearch domain.
	//
	// This member is required.
	DomainId *string

	// The name of an Elasticsearch domain. Domain names are unique across the domains
	// owned by an account within an AWS region. Domain names start with a letter or
	// number and can contain the following characters: a-z (lowercase), 0-9, and -
	// (hyphen).
	//
	// This member is required.
	DomainName *string

	// The type and number of instances in the domain cluster.
	//
	// This member is required.
	ElasticsearchClusterConfig *ElasticsearchClusterConfig

	// IAM access policy as a JSON-formatted string.
	AccessPolicies *string

	// Specifies the status of the AdvancedOptions
	AdvancedOptions map[string]string

	// The current status of the Elasticsearch domain's advanced security options.
	AdvancedSecurityOptions *AdvancedSecurityOptions

	// The current status of the Elasticsearch domain's Auto-Tune options.
	AutoTuneOptions *AutoTuneOptionsOutput

	// Specifies change details of the domain configuration change.
	ChangeProgressDetails *ChangeProgressDetails

	// The CognitoOptions for the specified domain. For more information, see Amazon
	// Cognito Authentication for Kibana (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html)
	// .
	CognitoOptions *CognitoOptions

	// The domain creation status. True if the creation of an Elasticsearch domain is
	// complete. False if domain creation is still in progress.
	Created *bool

	// The domain deletion status. True if a delete request has been received for the
	// domain but resource cleanup is still in progress. False if the domain has not
	// been deleted. Once domain deletion is complete, the status of the domain is no
	// longer returned.
	Deleted *bool

	// The current status of the Elasticsearch domain's endpoint options.
	DomainEndpointOptions *DomainEndpointOptions

	// The status of any changes that are currently in progress for the domain.
	DomainProcessingStatus DomainProcessingStatusType

	// The EBSOptions for the specified domain. See Configuring EBS-based Storage (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs)
	// for more information.
	EBSOptions *EBSOptions

	ElasticsearchVersion *string

	// Specifies the status of the EncryptionAtRestOptions .
	EncryptionAtRestOptions *EncryptionAtRestOptions

	// The Elasticsearch domain endpoint that you use to submit index and search
	// requests.
	Endpoint *string

	// Map containing the Elasticsearch domain endpoints used to submit index and
	// search requests. Example key, value :
	// 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com' .
	Endpoints map[string]string

	// Log publishing options for the given domain.
	LogPublishingOptions map[string]LogPublishingOption

	// Information about the domain properties that are currently being modified.
	ModifyingProperties []ModifyingProperties

	// Specifies the status of the NodeToNodeEncryptionOptions .
	NodeToNodeEncryptionOptions *NodeToNodeEncryptionOptions

	// The status of the Elasticsearch domain configuration. True if Amazon
	// Elasticsearch Service is processing configuration changes. False if the
	// configuration is active.
	Processing *bool

	// The current status of the Elasticsearch domain's service software.
	ServiceSoftwareOptions *ServiceSoftwareOptions

	// Specifies the status of the SnapshotOptions
	SnapshotOptions *SnapshotOptions

	// The status of an Elasticsearch domain version upgrade. True if Amazon
	// Elasticsearch Service is undergoing a version upgrade. False if the
	// configuration is active.
	UpgradeProcessing *bool

	// The VPCOptions for the specified domain. For more information, see VPC
	// Endpoints for Amazon Elasticsearch Service Domains (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html)
	// .
	VPCOptions *VPCDerivedInfo
	// contains filtered or unexported fields
}

The current status of an Elasticsearch domain.

type ElasticsearchVersionStatus 

type ElasticsearchVersionStatus struct {

	// Specifies the Elasticsearch version for the specified Elasticsearch domain.
	//
	// This member is required.
	Options *string

	// Specifies the status of the Elasticsearch version options for the specified
	// Elasticsearch domain.
	//
	// This member is required.
	Status *OptionStatus
	// contains filtered or unexported fields
}

Status of the Elasticsearch version options for the specified Elasticsearch domain.

type EncryptionAtRestOptions 

type EncryptionAtRestOptions struct {

	// Specifies the option to enable Encryption At Rest.
	Enabled *bool

	// Specifies the KMS Key ID for Encryption At Rest options.
	KmsKeyId *string
	// contains filtered or unexported fields
}

Specifies the Encryption At Rest Options.

type EncryptionAtRestOptionsStatus 

type EncryptionAtRestOptionsStatus struct {

	// Specifies the Encryption At Rest options for the specified Elasticsearch domain.
	//
	// This member is required.
	Options *EncryptionAtRestOptions

	// Specifies the status of the Encryption At Rest options for the specified
	// Elasticsearch domain.
	//
	// This member is required.
	Status *OptionStatus
	// contains filtered or unexported fields
}

Status of the Encryption At Rest options for the specified Elasticsearch domain.

type EngineType added in v1.7.0 

type EngineType string
const (
	EngineTypeOpenSearch    EngineType = "OpenSearch"
	EngineTypeElasticsearch EngineType = "Elasticsearch"
)

Enum values for EngineType

func (EngineType) Values added in v1.7.0 

func (EngineType) Values() []EngineType

Values returns all known values for EngineType. 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 ErrorDetails 

type ErrorDetails struct {
	ErrorMessage *string

	ErrorType *string
	// contains filtered or unexported fields
}

type Filter 

type Filter struct {

	// Specifies the name of the filter.
	Name *string

	// Contains one or more values for the filter.
	Values []string
	// contains filtered or unexported fields
}

A filter used to limit results when describing inbound or outbound cross-cluster search connections. Multiple values can be specified per filter. A cross-cluster search connection must match at least one of the specified values for it to be returned from an operation.

type InboundCrossClusterSearchConnection 

type InboundCrossClusterSearchConnection struct {

	// Specifies the InboundCrossClusterSearchConnectionStatus for the outbound
	// connection.
	ConnectionStatus *InboundCrossClusterSearchConnectionStatus

	// Specifies the connection id for the inbound cross-cluster search connection.
	CrossClusterSearchConnectionId *string

	// Specifies the DomainInformation for the destination Elasticsearch domain.
	DestinationDomainInfo *DomainInformation

	// Specifies the DomainInformation for the source Elasticsearch domain.
	SourceDomainInfo *DomainInformation
	// contains filtered or unexported fields
}

Specifies details of an inbound connection.

type InboundCrossClusterSearchConnectionStatus 

type InboundCrossClusterSearchConnectionStatus struct {

	// Specifies verbose information for the inbound connection status.
	Message *string

	// The state code for inbound connection. This can be one of the following:
	//   - PENDING_ACCEPTANCE: Inbound connection is not yet accepted by destination
	//   domain owner.
	//   - APPROVED: Inbound connection is pending acceptance by destination domain
	//   owner.
	//   - REJECTING: Inbound connection rejection is in process.
	//   - REJECTED: Inbound connection is rejected.
	//   - DELETING: Inbound connection deletion is in progress.
	//   - DELETED: Inbound connection is deleted and cannot be used further.
	StatusCode InboundCrossClusterSearchConnectionStatusCode
	// contains filtered or unexported fields
}

Specifies the coonection status of an inbound cross-cluster search connection.

type InboundCrossClusterSearchConnectionStatusCode 

type InboundCrossClusterSearchConnectionStatusCode string
const (
	InboundCrossClusterSearchConnectionStatusCodePendingAcceptance InboundCrossClusterSearchConnectionStatusCode = "PENDING_ACCEPTANCE"
	InboundCrossClusterSearchConnectionStatusCodeApproved          InboundCrossClusterSearchConnectionStatusCode = "APPROVED"
	InboundCrossClusterSearchConnectionStatusCodeRejecting         InboundCrossClusterSearchConnectionStatusCode = "REJECTING"
	InboundCrossClusterSearchConnectionStatusCodeRejected          InboundCrossClusterSearchConnectionStatusCode = "REJECTED"
	InboundCrossClusterSearchConnectionStatusCodeDeleting          InboundCrossClusterSearchConnectionStatusCode = "DELETING"
	InboundCrossClusterSearchConnectionStatusCodeDeleted           InboundCrossClusterSearchConnectionStatusCode = "DELETED"
)

Enum values for InboundCrossClusterSearchConnectionStatusCode

func (InboundCrossClusterSearchConnectionStatusCode) Values added in v0.29.0 

func (InboundCrossClusterSearchConnectionStatusCode) Values() []InboundCrossClusterSearchConnectionStatusCode

Values returns all known values for InboundCrossClusterSearchConnectionStatusCode. 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 InitiatedBy added in v1.26.0 

type InitiatedBy string
const (
	InitiatedByCustomer InitiatedBy = "CUSTOMER"
	InitiatedByService  InitiatedBy = "SERVICE"
)

Enum values for InitiatedBy

func (InitiatedBy) Values added in v1.26.0 

func (InitiatedBy) Values() []InitiatedBy

Values returns all known values for InitiatedBy. 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 InstanceCountLimits 

type InstanceCountLimits struct {

	// Maximum number of Instances that can be instantiated for given InstanceType.
	MaximumInstanceCount int32

	// Minimum number of Instances that can be instantiated for given InstanceType.
	MinimumInstanceCount int32
	// contains filtered or unexported fields
}

InstanceCountLimits represents the limits on number of instances that be created in Amazon Elasticsearch for given InstanceType.

type InstanceLimits 

type InstanceLimits struct {

	// InstanceCountLimits represents the limits on number of instances that be
	// created in Amazon Elasticsearch for given InstanceType.
	InstanceCountLimits *InstanceCountLimits
	// contains filtered or unexported fields
}

InstanceLimits represents the list of instance related attributes that are available for given InstanceType.

type InternalException 

type InternalException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

func (*InternalException) Error 

func (e *InternalException) Error() string

func (*InternalException) ErrorCode 

func (e *InternalException) ErrorCode() string

func (*InternalException) ErrorFault 

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

func (*InternalException) ErrorMessage 

func (e *InternalException) ErrorMessage() string

type InvalidPaginationTokenException 

type InvalidPaginationTokenException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.

func (*InvalidPaginationTokenException) Error 

func (e *InvalidPaginationTokenException) Error() string

func (*InvalidPaginationTokenException) ErrorCode 

func (e *InvalidPaginationTokenException) ErrorCode() string

func (*InvalidPaginationTokenException) ErrorFault 

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

func (*InvalidPaginationTokenException) ErrorMessage 

func (e *InvalidPaginationTokenException) ErrorMessage() string

type InvalidTypeException 

type InvalidTypeException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.

func (*InvalidTypeException) Error 

func (e *InvalidTypeException) Error() string

func (*InvalidTypeException) ErrorCode 

func (e *InvalidTypeException) ErrorCode() string

func (*InvalidTypeException) ErrorFault 

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

func (*InvalidTypeException) ErrorMessage 

func (e *InvalidTypeException) ErrorMessage() string

type LimitExceededException 

type LimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.

func (*LimitExceededException) Error 

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode 

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault 

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

func (*LimitExceededException) ErrorMessage 

func (e *LimitExceededException) ErrorMessage() string

type Limits 

type Limits struct {

	// List of additional limits that are specific to a given InstanceType and for
	// each of it's InstanceRole .
	AdditionalLimits []AdditionalLimit

	// InstanceLimits represents the list of instance related attributes that are
	// available for given InstanceType.
	InstanceLimits *InstanceLimits

	// StorageType represents the list of storage related types and attributes that
	// are available for given InstanceType.
	StorageTypes []StorageType
	// contains filtered or unexported fields
}

Limits for given InstanceType and for each of it's role.

Limits contains following StorageTypes, InstanceLimits and AdditionalLimits

type LogPublishingOption 

type LogPublishingOption struct {

	// ARN of the Cloudwatch log group to which log needs to be published.
	CloudWatchLogsLogGroupArn *string

	// Specifies whether given log publishing option is enabled or not.
	Enabled *bool
	// contains filtered or unexported fields
}

Log Publishing option that is set for given domain.

Attributes and their details:

  • CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to which log needs to be published.
  • Enabled: Whether the log publishing for given log type is enabled or not

type LogPublishingOptionsStatus 

type LogPublishingOptionsStatus struct {

	// The log publishing options configured for the Elasticsearch domain.
	Options map[string]LogPublishingOption

	// The status of the log publishing options for the Elasticsearch domain. See
	// OptionStatus for the status information that's included.
	Status *OptionStatus
	// contains filtered or unexported fields
}

The configured log publishing options for the domain and their current status.

type LogType 

type LogType string
const (
	LogTypeIndexSlowLogs     LogType = "INDEX_SLOW_LOGS"
	LogTypeSearchSlowLogs    LogType = "SEARCH_SLOW_LOGS"
	LogTypeEsApplicationLogs LogType = "ES_APPLICATION_LOGS"
	LogTypeAuditLogs         LogType = "AUDIT_LOGS"
)

Enum values for LogType

func (LogType) Values added in v0.29.0 

func (LogType) Values() []LogType

Values returns all known values for LogType. 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 MasterUserOptions 

type MasterUserOptions struct {

	// ARN for the master user (if IAM is enabled).
	MasterUserARN *string

	// The master user's username, which is stored in the Amazon Elasticsearch Service
	// domain's internal database.
	MasterUserName *string

	// The master user's password, which is stored in the Amazon Elasticsearch Service
	// domain's internal database.
	MasterUserPassword *string
	// contains filtered or unexported fields
}

Credentials for the master user: username and password, ARN, or both.

type ModifyingProperties added in v1.26.0 

type ModifyingProperties struct {

	// The current value of the domain property that is being modified.
	ActiveValue *string

	// The name of the property that is currently being modified.
	Name *string

	// The value that the property that is currently being modified will eventually
	// have.
	PendingValue *string

	// The type of value that is currently being modified. Properties can have two
	// types:
	//   - PLAIN_TEXT: Contain direct values such as "1", "True", or "c5.large.search".
	//   - STRINGIFIED_JSON: Contain content in JSON format, such as
	//   {"Enabled":"True"}".
	ValueType PropertyValueType
	// contains filtered or unexported fields
}

Information about the domain properties that are currently being modified.

type NodeToNodeEncryptionOptions 

type NodeToNodeEncryptionOptions struct {

	// Specify true to enable node-to-node encryption.
	Enabled *bool
	// contains filtered or unexported fields
}

Specifies the node-to-node encryption options.

type NodeToNodeEncryptionOptionsStatus 

type NodeToNodeEncryptionOptionsStatus struct {

	// Specifies the node-to-node encryption options for the specified Elasticsearch
	// domain.
	//
	// This member is required.
	Options *NodeToNodeEncryptionOptions

	// Specifies the status of the node-to-node encryption options for the specified
	// Elasticsearch domain.
	//
	// This member is required.
	Status *OptionStatus
	// contains filtered or unexported fields
}

Status of the node-to-node encryption options for the specified Elasticsearch domain.

type OptionState 

type OptionState string
const (
	OptionStateRequiresIndexDocuments OptionState = "RequiresIndexDocuments"
	OptionStateProcessing             OptionState = "Processing"
	OptionStateActive                 OptionState = "Active"
)

Enum values for OptionState

func (OptionState) Values added in v0.29.0 

func (OptionState) Values() []OptionState

Values returns all known values for OptionState. 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 OptionStatus 

type OptionStatus struct {

	// Timestamp which tells the creation date for the entity.
	//
	// This member is required.
	CreationDate *time.Time

	// Provides the OptionState for the Elasticsearch domain.
	//
	// This member is required.
	State OptionState

	// Timestamp which tells the last updated time for the entity.
	//
	// This member is required.
	UpdateDate *time.Time

	// Indicates whether the Elasticsearch domain is being deleted.
	PendingDeletion *bool

	// Specifies the latest version for the entity.
	UpdateVersion int32
	// contains filtered or unexported fields
}

Provides the current status of the entity.

type OutboundCrossClusterSearchConnection 

type OutboundCrossClusterSearchConnection struct {

	// Specifies the connection alias for the outbound cross-cluster search connection.
	ConnectionAlias *string

	// Specifies the OutboundCrossClusterSearchConnectionStatus for the outbound
	// connection.
	ConnectionStatus *OutboundCrossClusterSearchConnectionStatus

	// Specifies the connection id for the outbound cross-cluster search connection.
	CrossClusterSearchConnectionId *string

	// Specifies the DomainInformation for the destination Elasticsearch domain.
	DestinationDomainInfo *DomainInformation

	// Specifies the DomainInformation for the source Elasticsearch domain.
	SourceDomainInfo *DomainInformation
	// contains filtered or unexported fields
}

Specifies details of an outbound connection.

type OutboundCrossClusterSearchConnectionStatus 

type OutboundCrossClusterSearchConnectionStatus struct {

	// Specifies verbose information for the outbound connection status.
	Message *string

	// The state code for outbound connection. This can be one of the following:
	//   - VALIDATING: The outbound connection request is being validated.
	//   - VALIDATION_FAILED: Validation failed for the connection request.
	//   - PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet
	//   accepted by destination domain owner.
	//   - PROVISIONING: Outbound connection request is in process.
	//   - ACTIVE: Outbound connection is active and ready to use.
	//   - REJECTED: Outbound connection request is rejected by destination domain
	//   owner.
	//   - DELETING: Outbound connection deletion is in progress.
	//   - DELETED: Outbound connection is deleted and cannot be used further.
	StatusCode OutboundCrossClusterSearchConnectionStatusCode
	// contains filtered or unexported fields
}

Specifies the connection status of an outbound cross-cluster search connection.

type OutboundCrossClusterSearchConnectionStatusCode 

type OutboundCrossClusterSearchConnectionStatusCode string
const (
	OutboundCrossClusterSearchConnectionStatusCodePendingAcceptance OutboundCrossClusterSearchConnectionStatusCode = "PENDING_ACCEPTANCE"
	OutboundCrossClusterSearchConnectionStatusCodeValidating        OutboundCrossClusterSearchConnectionStatusCode = "VALIDATING"
	OutboundCrossClusterSearchConnectionStatusCodeValidationFailed  OutboundCrossClusterSearchConnectionStatusCode = "VALIDATION_FAILED"
	OutboundCrossClusterSearchConnectionStatusCodeProvisioning      OutboundCrossClusterSearchConnectionStatusCode = "PROVISIONING"
	OutboundCrossClusterSearchConnectionStatusCodeActive            OutboundCrossClusterSearchConnectionStatusCode = "ACTIVE"
	OutboundCrossClusterSearchConnectionStatusCodeRejected          OutboundCrossClusterSearchConnectionStatusCode = "REJECTED"
	OutboundCrossClusterSearchConnectionStatusCodeDeleting          OutboundCrossClusterSearchConnectionStatusCode = "DELETING"
	OutboundCrossClusterSearchConnectionStatusCodeDeleted           OutboundCrossClusterSearchConnectionStatusCode = "DELETED"
)

Enum values for OutboundCrossClusterSearchConnectionStatusCode

func (OutboundCrossClusterSearchConnectionStatusCode) Values added in v0.29.0 

func (OutboundCrossClusterSearchConnectionStatusCode) Values() []OutboundCrossClusterSearchConnectionStatusCode

Values returns all known values for OutboundCrossClusterSearchConnectionStatusCode. 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 OverallChangeStatus added in v1.14.0 

type OverallChangeStatus string
const (
	OverallChangeStatusPending    OverallChangeStatus = "PENDING"
	OverallChangeStatusProcessing OverallChangeStatus = "PROCESSING"
	OverallChangeStatusCompleted  OverallChangeStatus = "COMPLETED"
	OverallChangeStatusFailed     OverallChangeStatus = "FAILED"
)

Enum values for OverallChangeStatus

func (OverallChangeStatus) Values added in v1.14.0 

func (OverallChangeStatus) Values() []OverallChangeStatus

Values returns all known values for OverallChangeStatus. 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 PackageDetails 

type PackageDetails struct {
	AvailablePackageVersion *string

	// Timestamp which tells creation date of the package.
	CreatedAt *time.Time

	// Additional information if the package is in an error state. Null otherwise.
	ErrorDetails *ErrorDetails

	LastUpdatedAt *time.Time

	// User-specified description of the package.
	PackageDescription *string

	// Internal ID of the package.
	PackageID *string

	// User specified name of the package.
	PackageName *string

	// Current state of the package. Values are
	// COPYING/COPY_FAILED/AVAILABLE/DELETING/DELETE_FAILED
	PackageStatus PackageStatus

	// Currently supports only TXT-DICTIONARY.
	PackageType PackageType
	// contains filtered or unexported fields
}

Basic information about a package.

type PackageSource 

type PackageSource struct {

	// Name of the bucket containing the package.
	S3BucketName *string

	// Key (file name) of the package.
	S3Key *string
	// contains filtered or unexported fields
}

The S3 location for importing the package specified as S3BucketName and S3Key

type PackageStatus 

type PackageStatus string
const (
	PackageStatusCopying          PackageStatus = "COPYING"
	PackageStatusCopyFailed       PackageStatus = "COPY_FAILED"
	PackageStatusValidating       PackageStatus = "VALIDATING"
	PackageStatusValidationFailed PackageStatus = "VALIDATION_FAILED"
	PackageStatusAvailable        PackageStatus = "AVAILABLE"
	PackageStatusDeleting         PackageStatus = "DELETING"
	PackageStatusDeleted          PackageStatus = "DELETED"
	PackageStatusDeleteFailed     PackageStatus = "DELETE_FAILED"
)

Enum values for PackageStatus

func (PackageStatus) Values added in v0.29.0 

func (PackageStatus) Values() []PackageStatus

Values returns all known values for PackageStatus. 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 PackageType 

type PackageType string
const (
	PackageTypeTxtDictionary PackageType = "TXT-DICTIONARY"
)

Enum values for PackageType

func (PackageType) Values added in v0.29.0 

func (PackageType) Values() []PackageType

Values returns all known values for PackageType. 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 PackageVersionHistory added in v0.30.0 

type PackageVersionHistory struct {

	// A message associated with the version.
	CommitMessage *string

	// Timestamp which tells creation time of the package version.
	CreatedAt *time.Time

	// Version of the package.
	PackageVersion *string
	// contains filtered or unexported fields
}

Details of a package version.

type PrincipalType added in v1.17.0 

type PrincipalType string
const (
	PrincipalTypeAwsAccount PrincipalType = "AWS_ACCOUNT"
	PrincipalTypeAwsService PrincipalType = "AWS_SERVICE"
)

Enum values for PrincipalType

func (PrincipalType) Values added in v1.17.0 

func (PrincipalType) Values() []PrincipalType

Values returns all known values for PrincipalType. 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 PropertyValueType added in v1.26.0 

type PropertyValueType string
const (
	PropertyValueTypePlainText       PropertyValueType = "PLAIN_TEXT"
	PropertyValueTypeStringifiedJson PropertyValueType = "STRINGIFIED_JSON"
)

Enum values for PropertyValueType

func (PropertyValueType) Values added in v1.26.0 

func (PropertyValueType) Values() []PropertyValueType

Values returns all known values for PropertyValueType. 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 RecurringCharge 

type RecurringCharge struct {

	// The monetary amount of the recurring charge.
	RecurringChargeAmount *float64

	// The frequency of the recurring charge.
	RecurringChargeFrequency *string
	// contains filtered or unexported fields
}

Contains the specific price and frequency of a recurring charges for a reserved Elasticsearch instance, or for a reserved Elasticsearch instance offering.

type ReservedElasticsearchInstance 

type ReservedElasticsearchInstance struct {

	// The currency code for the reserved Elasticsearch instance offering.
	CurrencyCode *string

	// The duration, in seconds, for which the Elasticsearch instance is reserved.
	Duration int32

	// The number of Elasticsearch instances that have been reserved.
	ElasticsearchInstanceCount int32

	// The Elasticsearch instance type offered by the reserved instance offering.
	ElasticsearchInstanceType ESPartitionInstanceType

	// The upfront fixed charge you will paid to purchase the specific reserved
	// Elasticsearch instance offering.
	FixedPrice *float64

	// The payment option as defined in the reserved Elasticsearch instance offering.
	PaymentOption ReservedElasticsearchInstancePaymentOption

	// The charge to your account regardless of whether you are creating any domains
	// using the instance offering.
	RecurringCharges []RecurringCharge

	// The customer-specified identifier to track this reservation.
	ReservationName *string

	// The unique identifier for the reservation.
	ReservedElasticsearchInstanceId *string

	// The offering identifier.
	ReservedElasticsearchInstanceOfferingId *string

	// The time the reservation started.
	StartTime *time.Time

	// The state of the reserved Elasticsearch instance.
	State *string

	// The rate you are charged for each hour for the domain that is using this
	// reserved instance.
	UsagePrice *float64
	// contains filtered or unexported fields
}

Details of a reserved Elasticsearch instance.

type ReservedElasticsearchInstanceOffering 

type ReservedElasticsearchInstanceOffering struct {

	// The currency code for the reserved Elasticsearch instance offering.
	CurrencyCode *string

	// The duration, in seconds, for which the offering will reserve the Elasticsearch
	// instance.
	Duration int32

	// The Elasticsearch instance type offered by the reserved instance offering.
	ElasticsearchInstanceType ESPartitionInstanceType

	// The upfront fixed charge you will pay to purchase the specific reserved
	// Elasticsearch instance offering.
	FixedPrice *float64

	// Payment option for the reserved Elasticsearch instance offering
	PaymentOption ReservedElasticsearchInstancePaymentOption

	// The charge to your account regardless of whether you are creating any domains
	// using the instance offering.
	RecurringCharges []RecurringCharge

	// The Elasticsearch reserved instance offering identifier.
	ReservedElasticsearchInstanceOfferingId *string

	// The rate you are charged for each hour the domain that is using the offering is
	// running.
	UsagePrice *float64
	// contains filtered or unexported fields
}

Details of a reserved Elasticsearch instance offering.

type ReservedElasticsearchInstancePaymentOption 

type ReservedElasticsearchInstancePaymentOption string
const (
	ReservedElasticsearchInstancePaymentOptionAllUpfront     ReservedElasticsearchInstancePaymentOption = "ALL_UPFRONT"
	ReservedElasticsearchInstancePaymentOptionPartialUpfront ReservedElasticsearchInstancePaymentOption = "PARTIAL_UPFRONT"
	ReservedElasticsearchInstancePaymentOptionNoUpfront      ReservedElasticsearchInstancePaymentOption = "NO_UPFRONT"
)

Enum values for ReservedElasticsearchInstancePaymentOption

func (ReservedElasticsearchInstancePaymentOption) Values added in v0.29.0 

func (ReservedElasticsearchInstancePaymentOption) Values() []ReservedElasticsearchInstancePaymentOption

Values returns all known values for ReservedElasticsearchInstancePaymentOption. 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 ResourceAlreadyExistsException 

type ResourceAlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An exception for creating a resource that already exists. Gives http status code of 400.

func (*ResourceAlreadyExistsException) Error 

func (e *ResourceAlreadyExistsException) Error() string

func (*ResourceAlreadyExistsException) ErrorCode 

func (e *ResourceAlreadyExistsException) ErrorCode() string

func (*ResourceAlreadyExistsException) ErrorFault 

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

func (*ResourceAlreadyExistsException) ErrorMessage 

func (e *ResourceAlreadyExistsException) ErrorMessage() string

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

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 RollbackOnDisable added in v1.2.0 

type RollbackOnDisable string
const (
	RollbackOnDisableNoRollback      RollbackOnDisable = "NO_ROLLBACK"
	RollbackOnDisableDefaultRollback RollbackOnDisable = "DEFAULT_ROLLBACK"
)

Enum values for RollbackOnDisable

func (RollbackOnDisable) Values added in v1.2.0 

func (RollbackOnDisable) Values() []RollbackOnDisable

Values returns all known values for RollbackOnDisable. 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 SAMLIdp added in v0.30.0 

type SAMLIdp struct {

	// The unique Entity ID of the application in SAML Identity Provider.
	//
	// This member is required.
	EntityId *string

	// The Metadata of the SAML application in xml format.
	//
	// This member is required.
	MetadataContent *string
	// contains filtered or unexported fields
}

Specifies the SAML Identity Provider's information.

type SAMLOptionsInput added in v0.30.0 

type SAMLOptionsInput struct {

	// True if SAML is enabled.
	Enabled *bool

	// Specifies the SAML Identity Provider's information.
	Idp *SAMLIdp

	// The backend role to which the SAML master user is mapped to.
	MasterBackendRole *string

	// The SAML master username, which is stored in the Amazon Elasticsearch Service
	// domain's internal database.
	MasterUserName *string

	// The key to use for matching the SAML Roles attribute.
	RolesKey *string

	// The duration, in minutes, after which a user session becomes inactive.
	// Acceptable values are between 1 and 1440, and the default value is 60.
	SessionTimeoutMinutes *int32

	// The key to use for matching the SAML Subject attribute.
	SubjectKey *string
	// contains filtered or unexported fields
}

Specifies the SAML application configuration for the domain.

type SAMLOptionsOutput added in v0.30.0 

type SAMLOptionsOutput struct {

	// True if SAML is enabled.
	Enabled *bool

	// Describes the SAML Identity Provider's information.
	Idp *SAMLIdp

	// The key used for matching the SAML Roles attribute.
	RolesKey *string

	// The duration, in minutes, after which a user session becomes inactive.
	SessionTimeoutMinutes *int32

	// The key used for matching the SAML Subject attribute.
	SubjectKey *string
	// contains filtered or unexported fields
}

Describes the SAML application configured for the domain.

type ScheduledAutoTuneActionType added in v1.2.0 

type ScheduledAutoTuneActionType string
const (
	ScheduledAutoTuneActionTypeJvmHeapSizeTuning ScheduledAutoTuneActionType = "JVM_HEAP_SIZE_TUNING"
	ScheduledAutoTuneActionTypeJvmYoungGenTuning ScheduledAutoTuneActionType = "JVM_YOUNG_GEN_TUNING"
)

Enum values for ScheduledAutoTuneActionType

func (ScheduledAutoTuneActionType) Values added in v1.2.0 

func (ScheduledAutoTuneActionType) Values() []ScheduledAutoTuneActionType

Values returns all known values for ScheduledAutoTuneActionType. 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 ScheduledAutoTuneDetails added in v1.2.0 

type ScheduledAutoTuneDetails struct {

	// Specifies Auto-Tune action description.
	Action *string

	// Specifies Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and
	// JVM_YOUNG_GEN_TUNING.
	ActionType ScheduledAutoTuneActionType

	// Specifies timestamp for the Auto-Tune action scheduled for the domain.
	Date *time.Time

	// Specifies Auto-Tune action severity. Valid values are LOW, MEDIUM and HIGH.
	Severity ScheduledAutoTuneSeverityType
	// contains filtered or unexported fields
}

Specifies details of the scheduled Auto-Tune action. See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) for more information.

type ScheduledAutoTuneSeverityType added in v1.2.0 

type ScheduledAutoTuneSeverityType string
const (
	ScheduledAutoTuneSeverityTypeLow    ScheduledAutoTuneSeverityType = "LOW"
	ScheduledAutoTuneSeverityTypeMedium ScheduledAutoTuneSeverityType = "MEDIUM"
	ScheduledAutoTuneSeverityTypeHigh   ScheduledAutoTuneSeverityType = "HIGH"
)

Enum values for ScheduledAutoTuneSeverityType

func (ScheduledAutoTuneSeverityType) Values added in v1.2.0 

func (ScheduledAutoTuneSeverityType) Values() []ScheduledAutoTuneSeverityType

Values returns all known values for ScheduledAutoTuneSeverityType. 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 ServiceSoftwareOptions 

type ServiceSoftwareOptions struct {

	// Timestamp, in Epoch time, until which you can manually request a service
	// software update. After this date, we automatically update your service software.
	AutomatedUpdateDate *time.Time

	// True if you are able to cancel your service software version update. False if
	// you are not able to cancel your service software version.
	Cancellable *bool

	// The current service software version that is present on the domain.
	CurrentVersion *string

	// The description of the UpdateStatus .
	Description *string

	// The new service software version if one is available.
	NewVersion *string

	// True if a service software is never automatically updated. False if a service
	// software is automatically updated after AutomatedUpdateDate .
	OptionalDeployment *bool

	// True if you are able to update you service software version. False if you are
	// not able to update your service software version.
	UpdateAvailable *bool

	// The status of your service software update. This field can take the following
	// values: ELIGIBLE , PENDING_UPDATE , IN_PROGRESS , COMPLETED , and NOT_ELIGIBLE .
	UpdateStatus DeploymentStatus
	// contains filtered or unexported fields
}

The current options of an Elasticsearch domain service software options.

type SnapshotOptions 

type SnapshotOptions struct {

	// Specifies the time, in UTC format, when the service takes a daily automated
	// snapshot of the specified Elasticsearch domain. Default value is 0 hours.
	AutomatedSnapshotStartHour *int32
	// contains filtered or unexported fields
}

Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.

type SnapshotOptionsStatus 

type SnapshotOptionsStatus struct {

	// Specifies the daily snapshot options specified for the Elasticsearch domain.
	//
	// This member is required.
	Options *SnapshotOptions

	// Specifies the status of a daily automated snapshot.
	//
	// This member is required.
	Status *OptionStatus
	// contains filtered or unexported fields
}

Status of a daily automated snapshot.

type StorageType 

type StorageType struct {

	// SubType of the given storage type. List of available sub-storage options: For
	// "instance" storageType we wont have any storageSubType, in case of "ebs"
	// storageType we will have following valid storageSubTypes
	//   - standard
	//   - gp2
	//   - gp3
	//   - io1
	// Refer VolumeType for more information regarding above EBS storage options.
	StorageSubTypeName *string

	// List of limits that are applicable for given storage type.
	StorageTypeLimits []StorageTypeLimit

	// Type of the storage. List of available storage options:
	//   - instance Inbuilt storage available for the given Instance
	//   - ebs Elastic block storage that would be attached to the given Instance
	StorageTypeName *string
	// contains filtered or unexported fields
}

StorageTypes represents the list of storage related types and their attributes that are available for given InstanceType.

type StorageTypeLimit 

type StorageTypeLimit struct {

	// Name of storage limits that are applicable for given storage type. If
	// StorageType is ebs, following storage options are applicable
	//   - MinimumVolumeSize Minimum amount of volume size that is applicable for given
	//   storage type.It can be empty if it is not applicable.
	//   - MaximumVolumeSize Maximum amount of volume size that is applicable for given
	//   storage type.It can be empty if it is not applicable.
	//   - MaximumIops Maximum amount of Iops that is applicable for given storage
	//   type.It can be empty if it is not applicable.
	//   - MinimumIops Minimum amount of Iops that is applicable for given storage
	//   type.It can be empty if it is not applicable.
	//   - MaximumThroughput Maximum amount of Throughput that is applicable for given
	//   storage type.It can be empty if it is not applicable.
	//   - MinimumThroughput Minimum amount of Throughput that is applicable for given
	//   storage type.It can be empty if it is not applicable.
	LimitName *string

	// Values for the StorageTypeLimit$LimitName .
	LimitValues []string
	// contains filtered or unexported fields
}

Limits that are applicable for given storage type.

type TLSSecurityPolicy 

type TLSSecurityPolicy string
const (
	TLSSecurityPolicyPolicyMinTls10201907    TLSSecurityPolicy = "Policy-Min-TLS-1-0-2019-07"
	TLSSecurityPolicyPolicyMinTls12201907    TLSSecurityPolicy = "Policy-Min-TLS-1-2-2019-07"
	TLSSecurityPolicyPolicyMinTls12Pfs202310 TLSSecurityPolicy = "Policy-Min-TLS-1-2-PFS-2023-10"
)

Enum values for TLSSecurityPolicy

func (TLSSecurityPolicy) Values added in v0.29.0 

func (TLSSecurityPolicy) Values() []TLSSecurityPolicy

Values returns all known values for TLSSecurityPolicy. 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 Tag 

type Tag struct {

	// Specifies the TagKey , the name of the tag. Tag keys must be unique for the
	// Elasticsearch domain to which they are attached.
	//
	// This member is required.
	Key *string

	// Specifies the TagValue , the value assigned to the corresponding tag key. Tag
	// values can be null and do not have to be unique in a tag set. For example, you
	// can have a key value pair in a tag set of project : Trinity and cost-center :
	// Trinity
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

Specifies a key value pair for a resource tag.

type TimeUnit added in v1.2.0 

type TimeUnit string
const (
	TimeUnitHours TimeUnit = "HOURS"
)

Enum values for TimeUnit

func (TimeUnit) Values added in v1.2.0 

func (TimeUnit) Values() []TimeUnit

Values returns all known values for TimeUnit. 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 UpgradeHistory 

type UpgradeHistory struct {

	// UTC Timestamp at which the Upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ"
	// format.
	StartTimestamp *time.Time

	// A list of UpgradeStepItem s representing information about each step performed
	// as pard of a specific Upgrade or Upgrade Eligibility Check.
	StepsList []UpgradeStepItem

	// A string that describes the update briefly
	UpgradeName *string

	// The overall status of the update. The status can take one of the following
	// values:
	//   - In Progress
	//   - Succeeded
	//   - Succeeded with Issues
	//   - Failed
	UpgradeStatus UpgradeStatus
	// contains filtered or unexported fields
}

History of the last 10 Upgrades and Upgrade Eligibility Checks.

type UpgradeStatus 

type UpgradeStatus string
const (
	UpgradeStatusInProgress          UpgradeStatus = "IN_PROGRESS"
	UpgradeStatusSucceeded           UpgradeStatus = "SUCCEEDED"
	UpgradeStatusSucceededWithIssues UpgradeStatus = "SUCCEEDED_WITH_ISSUES"
	UpgradeStatusFailed              UpgradeStatus = "FAILED"
)

Enum values for UpgradeStatus

func (UpgradeStatus) Values added in v0.29.0 

func (UpgradeStatus) Values() []UpgradeStatus

Values returns all known values for UpgradeStatus. 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 UpgradeStep 

type UpgradeStep string
const (
	UpgradeStepPreUpgradeCheck UpgradeStep = "PRE_UPGRADE_CHECK"
	UpgradeStepSnapshot        UpgradeStep = "SNAPSHOT"
	UpgradeStepUpgrade         UpgradeStep = "UPGRADE"
)

Enum values for UpgradeStep

func (UpgradeStep) Values added in v0.29.0 

func (UpgradeStep) Values() []UpgradeStep

Values returns all known values for UpgradeStep. 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 UpgradeStepItem 

type UpgradeStepItem struct {

	// A list of strings containing detailed information about the errors encountered
	// in a particular step.
	Issues []string

	// The Floating point value representing progress percentage of a particular step.
	ProgressPercent *float64

	// Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does
	// through:
	//   - PreUpgradeCheck
	//   - Snapshot
	//   - Upgrade
	UpgradeStep UpgradeStep

	// The status of a particular step during an upgrade. The status can take one of
	// the following values:
	//   - In Progress
	//   - Succeeded
	//   - Succeeded with Issues
	//   - Failed
	UpgradeStepStatus UpgradeStatus
	// contains filtered or unexported fields
}

Represents a single step of the Upgrade or Upgrade Eligibility Check workflow.

type VPCDerivedInfo 

type VPCDerivedInfo struct {

	// The availability zones for the Elasticsearch domain. Exists only if the domain
	// was created with VPCOptions.
	AvailabilityZones []string

	// Specifies the security groups for VPC endpoint.
	SecurityGroupIds []string

	// Specifies the subnets for VPC endpoint.
	SubnetIds []string

	// The VPC Id for the Elasticsearch domain. Exists only if the domain was created
	// with VPCOptions.
	VPCId *string
	// contains filtered or unexported fields
}

Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html) .

type VPCDerivedInfoStatus 

type VPCDerivedInfoStatus struct {

	// Specifies the VPC options for the specified Elasticsearch domain.
	//
	// This member is required.
	Options *VPCDerivedInfo

	// Specifies the status of the VPC options for the specified Elasticsearch domain.
	//
	// This member is required.
	Status *OptionStatus
	// contains filtered or unexported fields
}

Status of the VPC options for the specified Elasticsearch domain.

type VPCOptions 

type VPCOptions struct {

	// Specifies the security groups for VPC endpoint.
	SecurityGroupIds []string

	// Specifies the subnets for VPC endpoint.
	SubnetIds []string
	// contains filtered or unexported fields
}

Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html) .

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An exception for missing / invalid input fields. Gives http status code of 400.

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 VolumeType 

type VolumeType string
const (
	VolumeTypeStandard VolumeType = "standard"
	VolumeTypeGp2      VolumeType = "gp2"
	VolumeTypeIo1      VolumeType = "io1"
	VolumeTypeGp3      VolumeType = "gp3"
)

Enum values for VolumeType

func (VolumeType) Values added in v0.29.0 

func (VolumeType) Values() []VolumeType

Values returns all known values for VolumeType. 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 VpcEndpoint added in v1.17.0 

type VpcEndpoint struct {

	// The Amazon Resource Name (ARN) of the domain associated with the endpoint.
	DomainArn *string

	// The connection endpoint ID for connecting to the domain.
	Endpoint *string

	// The current status of the endpoint.
	Status VpcEndpointStatus

	// The unique identifier of the endpoint.
	VpcEndpointId *string

	// The creator of the endpoint.
	VpcEndpointOwner *string

	// Options to specify the subnets and security groups for an Amazon OpenSearch
	// Service VPC endpoint.
	VpcOptions *VPCDerivedInfo
	// contains filtered or unexported fields
}

The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy.

type VpcEndpointError added in v1.17.0 

type VpcEndpointError struct {

	// The code associated with the error.
	ErrorCode VpcEndpointErrorCode

	// A message describing the error.
	ErrorMessage *string

	// The unique identifier of the endpoint.
	VpcEndpointId *string
	// contains filtered or unexported fields
}

Error information when attempting to describe an Amazon OpenSearch Service-managed VPC endpoint.

type VpcEndpointErrorCode added in v1.17.0 

type VpcEndpointErrorCode string
const (
	VpcEndpointErrorCodeEndpointNotFound VpcEndpointErrorCode = "ENDPOINT_NOT_FOUND"
	VpcEndpointErrorCodeServerError      VpcEndpointErrorCode = "SERVER_ERROR"
)

Enum values for VpcEndpointErrorCode

func (VpcEndpointErrorCode) Values added in v1.17.0 

func (VpcEndpointErrorCode) Values() []VpcEndpointErrorCode

Values returns all known values for VpcEndpointErrorCode. 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 VpcEndpointStatus added in v1.17.0 

type VpcEndpointStatus string
const (
	VpcEndpointStatusCreating     VpcEndpointStatus = "CREATING"
	VpcEndpointStatusCreateFailed VpcEndpointStatus = "CREATE_FAILED"
	VpcEndpointStatusActive       VpcEndpointStatus = "ACTIVE"
	VpcEndpointStatusUpdating     VpcEndpointStatus = "UPDATING"
	VpcEndpointStatusUpdateFailed VpcEndpointStatus = "UPDATE_FAILED"
	VpcEndpointStatusDeleting     VpcEndpointStatus = "DELETING"
	VpcEndpointStatusDeleteFailed VpcEndpointStatus = "DELETE_FAILED"
)

Enum values for VpcEndpointStatus

func (VpcEndpointStatus) Values added in v1.17.0 

func (VpcEndpointStatus) Values() []VpcEndpointStatus

Values returns all known values for VpcEndpointStatus. 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 VpcEndpointSummary added in v1.17.0 

type VpcEndpointSummary struct {

	// The Amazon Resource Name (ARN) of the domain associated with the endpoint.
	DomainArn *string

	// The current status of the endpoint.
	Status VpcEndpointStatus

	// The unique identifier of the endpoint.
	VpcEndpointId *string

	// The creator of the endpoint.
	VpcEndpointOwner *string
	// contains filtered or unexported fields
}

Summary information for an Amazon OpenSearch Service-managed VPC endpoint.

type ZoneAwarenessConfig 

type ZoneAwarenessConfig struct {

	// An integer value to indicate the number of availability zones for a domain when
	// zone awareness is enabled. This should be equal to number of subnets if VPC
	// endpoints is enabled
	AvailabilityZoneCount *int32
	// contains filtered or unexported fields
}

Specifies the zone awareness configuration for the domain cluster, such as the number of availability zones.

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.