elasticsearchservice

package module
v0.26.0 Latest Latest
Warning

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

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

Documentation

Index

Constants

View Source
const ServiceAPIVersion = "2015-01-01"
View Source
const ServiceID = "Elasticsearch Service"

Variables

This section is empty.

Functions

func AddResolveEndpointMiddleware

func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func RemoveResolveEndpointMiddleware

func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error

Types

type AcceptInboundCrossClusterSearchConnectionInput

type AcceptInboundCrossClusterSearchConnectionInput struct {
	// The id of the inbound connection that you want to accept.
	CrossClusterSearchConnectionId *string
}

Container for the parameters to the AcceptInboundCrossClusterSearchConnection () operation.

type AcceptInboundCrossClusterSearchConnectionOutput

type AcceptInboundCrossClusterSearchConnectionOutput struct {
	// Specifies the InboundCrossClusterSearchConnection () of accepted inbound
	// connection.
	CrossClusterSearchConnection *types.InboundCrossClusterSearchConnection

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a AcceptInboundCrossClusterSearchConnection () operation. Contains details of accepted inbound connection.

type AddTagsInput

type AddTagsInput struct {
	// Specify the ARN for which you want to add the tags.
	ARN *string
	// List of Tag that need to be added for the Elasticsearch domain.
	TagList []*types.Tag
}

Container for the parameters to the AddTags () operation. Specify the tags that you want to attach to the Elasticsearch domain.

type AddTagsOutput

type AddTagsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AssociatePackageInput

type AssociatePackageInput struct {
	// Name of the domain that you want to associate the package with.
	DomainName *string
	// Internal ID of the package that you want to associate with a domain. Use
	// DescribePackages to find this value.
	PackageID *string
}

Container for request parameters to AssociatePackage () operation.

type AssociatePackageOutput

type AssociatePackageOutput struct {
	// DomainPackageDetails
	DomainPackageDetails *types.DomainPackageDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Container for response returned by AssociatePackage () operation.

type CancelElasticsearchServiceSoftwareUpdateInput

type CancelElasticsearchServiceSoftwareUpdateInput struct {
	// The name of the domain that you want to stop the latest service software update
	// on.
	DomainName *string
}

Container for the parameters to the CancelElasticsearchServiceSoftwareUpdate () operation. Specifies the name of the Elasticsearch domain that you wish to cancel a service software update on.

type CancelElasticsearchServiceSoftwareUpdateOutput

type CancelElasticsearchServiceSoftwareUpdateOutput struct {
	// The current status of the Elasticsearch service software update.
	ServiceSoftwareOptions *types.ServiceSoftwareOptions

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a CancelElasticsearchServiceSoftwareUpdate operation. Contains the status of the update.

type Client

type Client struct {
	// contains filtered or unexported fields
}

Amazon Elasticsearch Configuration Service Use the Amazon Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains. For sample code that uses the Configuration API, see the Amazon Elasticsearch Service Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-samples.html). The guide also contains sample code for sending signed HTTP requests to the Elasticsearch APIs (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-request-signing.html). The endpoint for configuration service requests is region-specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints (http://docs.aws.amazon.com/general/latest/gr/rande.html#elasticsearch-service-regions).

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AcceptInboundCrossClusterSearchConnection

func (c *Client) AcceptInboundCrossClusterSearchConnection(ctx context.Context, params *AcceptInboundCrossClusterSearchConnectionInput, optFns ...func(*Options)) (*AcceptInboundCrossClusterSearchConnectionOutput, error)

Allows the destination domain owner to accept an inbound cross-cluster search connection request.

func (*Client) AddTags

func (c *Client) AddTags(ctx context.Context, params *AddTagsInput, optFns ...func(*Options)) (*AddTagsOutput, error)

Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information. (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-awsresorcetagging)

func (*Client) AssociatePackage

func (c *Client) AssociatePackage(ctx context.Context, params *AssociatePackageInput, optFns ...func(*Options)) (*AssociatePackageOutput, error)

Associates a package with an Amazon ES domain.

func (*Client) CancelElasticsearchServiceSoftwareUpdate

func (c *Client) CancelElasticsearchServiceSoftwareUpdate(ctx context.Context, params *CancelElasticsearchServiceSoftwareUpdateInput, optFns ...func(*Options)) (*CancelElasticsearchServiceSoftwareUpdateOutput, error)

Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.

func (*Client) CreateElasticsearchDomain

func (c *Client) CreateElasticsearchDomain(ctx context.Context, params *CreateElasticsearchDomainInput, optFns ...func(*Options)) (*CreateElasticsearchDomainOutput, error)

Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains) in the Amazon Elasticsearch Service Developer Guide.

func (*Client) CreateOutboundCrossClusterSearchConnection

func (c *Client) CreateOutboundCrossClusterSearchConnection(ctx context.Context, params *CreateOutboundCrossClusterSearchConnectionInput, optFns ...func(*Options)) (*CreateOutboundCrossClusterSearchConnectionOutput, error)

Creates a new cross-cluster search connection from a source domain to a destination domain.

func (*Client) CreatePackage

func (c *Client) CreatePackage(ctx context.Context, params *CreatePackageInput, optFns ...func(*Options)) (*CreatePackageOutput, error)

Create a package for use with Amazon ES domains.

func (*Client) DeleteElasticsearchDomain

func (c *Client) DeleteElasticsearchDomain(ctx context.Context, params *DeleteElasticsearchDomainInput, optFns ...func(*Options)) (*DeleteElasticsearchDomainOutput, error)

Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.

func (*Client) DeleteElasticsearchServiceRole

func (c *Client) DeleteElasticsearchServiceRole(ctx context.Context, params *DeleteElasticsearchServiceRoleInput, optFns ...func(*Options)) (*DeleteElasticsearchServiceRoleOutput, error)

Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service Role (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-enabling-slr) in VPC Endpoints for Amazon Elasticsearch Service Domains.

func (*Client) DeleteInboundCrossClusterSearchConnection

func (c *Client) DeleteInboundCrossClusterSearchConnection(ctx context.Context, params *DeleteInboundCrossClusterSearchConnectionInput, optFns ...func(*Options)) (*DeleteInboundCrossClusterSearchConnectionOutput, error)

Allows the destination domain owner to delete an existing inbound cross-cluster search connection.

func (*Client) DeleteOutboundCrossClusterSearchConnection

func (c *Client) DeleteOutboundCrossClusterSearchConnection(ctx context.Context, params *DeleteOutboundCrossClusterSearchConnectionInput, optFns ...func(*Options)) (*DeleteOutboundCrossClusterSearchConnectionOutput, error)

Allows the source domain owner to delete an existing outbound cross-cluster search connection.

func (*Client) DeletePackage

func (c *Client) DeletePackage(ctx context.Context, params *DeletePackageInput, optFns ...func(*Options)) (*DeletePackageOutput, error)

Delete the package.

func (*Client) DescribeElasticsearchDomain

func (c *Client) DescribeElasticsearchDomain(ctx context.Context, params *DescribeElasticsearchDomainInput, optFns ...func(*Options)) (*DescribeElasticsearchDomainOutput, error)

Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.

func (*Client) DescribeElasticsearchDomainConfig

func (c *Client) DescribeElasticsearchDomainConfig(ctx context.Context, params *DescribeElasticsearchDomainConfigInput, optFns ...func(*Options)) (*DescribeElasticsearchDomainConfigOutput, error)

Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.

func (*Client) DescribeElasticsearchDomains

func (c *Client) DescribeElasticsearchDomains(ctx context.Context, params *DescribeElasticsearchDomainsInput, optFns ...func(*Options)) (*DescribeElasticsearchDomainsOutput, error)

Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.

func (*Client) DescribeElasticsearchInstanceTypeLimits

func (c *Client) DescribeElasticsearchInstanceTypeLimits(ctx context.Context, params *DescribeElasticsearchInstanceTypeLimitsInput, optFns ...func(*Options)) (*DescribeElasticsearchInstanceTypeLimitsOutput, error)

Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName () to know what Limits are supported for modifying.

func (*Client) DescribeInboundCrossClusterSearchConnections

func (c *Client) DescribeInboundCrossClusterSearchConnections(ctx context.Context, params *DescribeInboundCrossClusterSearchConnectionsInput, optFns ...func(*Options)) (*DescribeInboundCrossClusterSearchConnectionsOutput, error)

Lists all the inbound cross-cluster search connections for a destination domain.

func (*Client) DescribeOutboundCrossClusterSearchConnections

func (c *Client) DescribeOutboundCrossClusterSearchConnections(ctx context.Context, params *DescribeOutboundCrossClusterSearchConnectionsInput, optFns ...func(*Options)) (*DescribeOutboundCrossClusterSearchConnectionsOutput, error)

Lists all the outbound cross-cluster search connections for a source domain.

func (*Client) DescribePackages

func (c *Client) DescribePackages(ctx context.Context, params *DescribePackagesInput, optFns ...func(*Options)) (*DescribePackagesOutput, error)

Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.

func (*Client) DescribeReservedElasticsearchInstanceOfferings

func (c *Client) DescribeReservedElasticsearchInstanceOfferings(ctx context.Context, params *DescribeReservedElasticsearchInstanceOfferingsInput, optFns ...func(*Options)) (*DescribeReservedElasticsearchInstanceOfferingsOutput, error)

Lists available reserved Elasticsearch instance offerings.

func (*Client) DescribeReservedElasticsearchInstances

func (c *Client) DescribeReservedElasticsearchInstances(ctx context.Context, params *DescribeReservedElasticsearchInstancesInput, optFns ...func(*Options)) (*DescribeReservedElasticsearchInstancesOutput, error)

Returns information about reserved Elasticsearch instances for this account.

func (*Client) DissociatePackage

func (c *Client) DissociatePackage(ctx context.Context, params *DissociatePackageInput, optFns ...func(*Options)) (*DissociatePackageOutput, error)

Dissociates a package from the Amazon ES domain.

func (*Client) GetCompatibleElasticsearchVersions

func (c *Client) GetCompatibleElasticsearchVersions(ctx context.Context, params *GetCompatibleElasticsearchVersionsInput, optFns ...func(*Options)) (*GetCompatibleElasticsearchVersionsOutput, error)

Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a DomainName () to get all upgrade compatible Elasticsearch versions for that specific domain.

func (*Client) GetUpgradeHistory

func (c *Client) GetUpgradeHistory(ctx context.Context, params *GetUpgradeHistoryInput, optFns ...func(*Options)) (*GetUpgradeHistoryOutput, error)

Retrieves the complete history of the last 10 upgrades that were performed on the domain.

func (*Client) GetUpgradeStatus

func (c *Client) GetUpgradeStatus(ctx context.Context, params *GetUpgradeStatusInput, optFns ...func(*Options)) (*GetUpgradeStatusOutput, error)

Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.

func (*Client) ListDomainNames

func (c *Client) ListDomainNames(ctx context.Context, params *ListDomainNamesInput, optFns ...func(*Options)) (*ListDomainNamesOutput, error)

Returns the name of all Elasticsearch domains owned by the current user's account.

func (*Client) ListDomainsForPackage

func (c *Client) ListDomainsForPackage(ctx context.Context, params *ListDomainsForPackageInput, optFns ...func(*Options)) (*ListDomainsForPackageOutput, error)

Lists all Amazon ES domains associated with the package.

func (*Client) ListElasticsearchInstanceTypes

func (c *Client) ListElasticsearchInstanceTypes(ctx context.Context, params *ListElasticsearchInstanceTypesInput, optFns ...func(*Options)) (*ListElasticsearchInstanceTypesOutput, error)

List all Elasticsearch instance types that are supported for given ElasticsearchVersion

func (*Client) ListElasticsearchVersions

func (c *Client) ListElasticsearchVersions(ctx context.Context, params *ListElasticsearchVersionsInput, optFns ...func(*Options)) (*ListElasticsearchVersionsOutput, error)

List all supported Elasticsearch versions

func (*Client) ListPackagesForDomain

func (c *Client) ListPackagesForDomain(ctx context.Context, params *ListPackagesForDomainInput, optFns ...func(*Options)) (*ListPackagesForDomainOutput, error)

Lists all packages associated with the Amazon ES domain.

func (*Client) ListTags

func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ...func(*Options)) (*ListTagsOutput, error)

Returns all tags for the given Elasticsearch domain.

func (*Client) PurchaseReservedElasticsearchInstanceOffering

func (c *Client) PurchaseReservedElasticsearchInstanceOffering(ctx context.Context, params *PurchaseReservedElasticsearchInstanceOfferingInput, optFns ...func(*Options)) (*PurchaseReservedElasticsearchInstanceOfferingOutput, error)

Allows you to purchase reserved Elasticsearch instances.

func (*Client) RejectInboundCrossClusterSearchConnection

func (c *Client) RejectInboundCrossClusterSearchConnection(ctx context.Context, params *RejectInboundCrossClusterSearchConnectionInput, optFns ...func(*Options)) (*RejectInboundCrossClusterSearchConnectionOutput, error)

Allows the destination domain owner to reject an inbound cross-cluster search connection request.

func (*Client) RemoveTags

func (c *Client) RemoveTags(ctx context.Context, params *RemoveTagsInput, optFns ...func(*Options)) (*RemoveTagsOutput, error)

Removes the specified set of tags from the specified Elasticsearch domain.

func (*Client) StartElasticsearchServiceSoftwareUpdate

func (c *Client) StartElasticsearchServiceSoftwareUpdate(ctx context.Context, params *StartElasticsearchServiceSoftwareUpdateInput, optFns ...func(*Options)) (*StartElasticsearchServiceSoftwareUpdateOutput, error)

Schedules a service software update for an Amazon ES domain.

func (*Client) UpdateElasticsearchDomainConfig

func (c *Client) UpdateElasticsearchDomainConfig(ctx context.Context, params *UpdateElasticsearchDomainConfigInput, optFns ...func(*Options)) (*UpdateElasticsearchDomainConfigOutput, error)

Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.

func (*Client) UpgradeElasticsearchDomain

func (c *Client) UpgradeElasticsearchDomain(ctx context.Context, params *UpgradeElasticsearchDomainInput, optFns ...func(*Options)) (*UpgradeElasticsearchDomainOutput, error)

Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.

type CreateElasticsearchDomainInput

type CreateElasticsearchDomainInput struct {
	// IAM access policy as a JSON-formatted string.
	AccessPolicies *string
	// Options to specify configuration that will be applied to the domain endpoint.
	DomainEndpointOptions *types.DomainEndpointOptions
	// Options to enable, disable and specify the type and size of EBS storage volumes.
	EBSOptions *types.EBSOptions
	// String of format X.Y to specify version for the Elasticsearch domain eg. "1.5"
	// or "2.3". For more information, see Creating Elasticsearch Domains
	// (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains)
	// in the Amazon Elasticsearch Service Developer Guide.
	ElasticsearchVersion *string
	// Configuration options for an Elasticsearch domain. Specifies the instance type
	// and number of instances in the domain cluster.
	ElasticsearchClusterConfig *types.ElasticsearchClusterConfig
	// Option to set time, in UTC format, of the daily automated snapshot. Default
	// value is 0 hours.
	SnapshotOptions *types.SnapshotOptions
	// Specifies advanced security options.
	AdvancedSecurityOptions *types.AdvancedSecurityOptionsInput
	// Map of LogType and LogPublishingOption, each containing options to publish a
	// given type of Elasticsearch log.
	LogPublishingOptions map[string]*types.LogPublishingOption
	// Specifies the Encryption At Rest Options.
	EncryptionAtRestOptions *types.EncryptionAtRestOptions
	// 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).
	CognitoOptions *types.CognitoOptions
	// The name of the Elasticsearch domain that you are creating. Domain names are
	// unique across the domains owned by an account within an AWS region. Domain names
	// must start with a lowercase letter and can contain the following characters: a-z
	// (lowercase), 0-9, and - (hyphen).
	DomainName *string
	// Option to allow references to indices in an HTTP request body. Must be false
	// when configuring access to individual sub-resources. By default, the value is
	// true. See Configuration Advanced Options
	// (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options)
	// for more information.
	AdvancedOptions map[string]*string
	// Specifies the NodeToNodeEncryptionOptions.
	NodeToNodeEncryptionOptions *types.NodeToNodeEncryptionOptions
	// Options to specify the subnets and security groups for VPC endpoint. For more
	// information, see Creating a VPC
	// (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-creating-vpc)
	// in VPC Endpoints for Amazon Elasticsearch Service Domains
	VPCOptions *types.VPCOptions
}

type CreateElasticsearchDomainOutput

type CreateElasticsearchDomainOutput struct {
	// The status of the newly created Elasticsearch domain.
	DomainStatus *types.ElasticsearchDomainStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a CreateElasticsearchDomain operation. Contains the status of the newly created Elasticsearch domain.

type CreateOutboundCrossClusterSearchConnectionInput

type CreateOutboundCrossClusterSearchConnectionInput struct {
	// Specifies the DomainInformation () for the source Elasticsearch domain.
	SourceDomainInfo *types.DomainInformation
	// Specifies the connection alias that will be used by the customer for this
	// connection.
	ConnectionAlias *string
	// Specifies the DomainInformation () for the destination Elasticsearch domain.
	DestinationDomainInfo *types.DomainInformation
}

Container for the parameters to the CreateOutboundCrossClusterSearchConnection () operation.

type CreateOutboundCrossClusterSearchConnectionOutput

type CreateOutboundCrossClusterSearchConnectionOutput struct {
	// Specifies the DomainInformation () for the source Elasticsearch domain.
	SourceDomainInfo *types.DomainInformation
	// Specifies the DomainInformation () for the destination Elasticsearch domain.
	DestinationDomainInfo *types.DomainInformation
	// Specifies the OutboundCrossClusterSearchConnectionStatus () for the newly
	// created connection.
	ConnectionStatus *types.OutboundCrossClusterSearchConnectionStatus
	// Unique id for the created outbound connection, which is used for subsequent
	// operations on connection.
	CrossClusterSearchConnectionId *string
	// Specifies the connection alias provided during the create connection request.
	ConnectionAlias *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a CreateOutboundCrossClusterSearchConnection () request. Contains the details of the newly created cross-cluster search connection.

type CreatePackageInput

type CreatePackageInput struct {
	// The customer S3 location PackageSource for importing the package.
	PackageSource *types.PackageSource
	// Description of the package.
	PackageDescription *string
	// Unique identifier for the package.
	PackageName *string
	// Type of package. Currently supports only TXT-DICTIONARY.
	PackageType types.PackageType
}

Container for request parameters to CreatePackage () operation.

type CreatePackageOutput

type CreatePackageOutput struct {
	// Information about the package PackageDetails.
	PackageDetails *types.PackageDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Container for response returned by CreatePackage () operation.

type DeleteElasticsearchDomainInput

type DeleteElasticsearchDomainInput struct {
	// The name of the Elasticsearch domain that you want to permanently delete.
	DomainName *string
}

Container for the parameters to the DeleteElasticsearchDomain () operation. Specifies the name of the Elasticsearch domain that you want to delete.

type DeleteElasticsearchDomainOutput

type DeleteElasticsearchDomainOutput struct {
	// The status of the Elasticsearch domain being deleted.
	DomainStatus *types.ElasticsearchDomainStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a DeleteElasticsearchDomain request. Contains the status of the pending deletion, or no status if the domain and all of its resources have been deleted.

type DeleteElasticsearchServiceRoleInput

type DeleteElasticsearchServiceRoleInput struct {
}

type DeleteElasticsearchServiceRoleOutput

type DeleteElasticsearchServiceRoleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteInboundCrossClusterSearchConnectionInput

type DeleteInboundCrossClusterSearchConnectionInput struct {
	// The id of the inbound connection that you want to permanently delete.
	CrossClusterSearchConnectionId *string
}

Container for the parameters to the DeleteInboundCrossClusterSearchConnection () operation.

type DeleteInboundCrossClusterSearchConnectionOutput

type DeleteInboundCrossClusterSearchConnectionOutput struct {
	// Specifies the InboundCrossClusterSearchConnection () of deleted inbound
	// connection.
	CrossClusterSearchConnection *types.InboundCrossClusterSearchConnection

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a DeleteInboundCrossClusterSearchConnection () operation. Contains details of deleted inbound connection.

type DeleteOutboundCrossClusterSearchConnectionInput

type DeleteOutboundCrossClusterSearchConnectionInput struct {
	// The id of the outbound connection that you want to permanently delete.
	CrossClusterSearchConnectionId *string
}

Container for the parameters to the DeleteOutboundCrossClusterSearchConnection () operation.

type DeleteOutboundCrossClusterSearchConnectionOutput

type DeleteOutboundCrossClusterSearchConnectionOutput struct {
	// Specifies the OutboundCrossClusterSearchConnection () of deleted outbound
	// connection.
	CrossClusterSearchConnection *types.OutboundCrossClusterSearchConnection

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a DeleteOutboundCrossClusterSearchConnection () operation. Contains details of deleted outbound connection.

type DeletePackageInput

type DeletePackageInput struct {
	// Internal ID of the package that you want to delete. Use DescribePackages to find
	// this value.
	PackageID *string
}

Container for request parameters to DeletePackage () operation.

type DeletePackageOutput

type DeletePackageOutput struct {
	// PackageDetails
	PackageDetails *types.PackageDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Container for response parameters to DeletePackage () operation.

type DescribeElasticsearchDomainConfigInput

type DescribeElasticsearchDomainConfigInput struct {
	// The Elasticsearch domain that you want to get information about.
	DomainName *string
}

Container for the parameters to the DescribeElasticsearchDomainConfig operation. Specifies the domain name for which you want configuration information.

type DescribeElasticsearchDomainConfigOutput

type DescribeElasticsearchDomainConfigOutput struct {
	// The configuration information of the domain requested in the
	// DescribeElasticsearchDomainConfig request.
	DomainConfig *types.ElasticsearchDomainConfig

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a DescribeElasticsearchDomainConfig request. Contains the configuration information of the requested domain.

type DescribeElasticsearchDomainInput

type DescribeElasticsearchDomainInput struct {
	// The name of the Elasticsearch domain for which you want information.
	DomainName *string
}

Container for the parameters to the DescribeElasticsearchDomain () operation.

type DescribeElasticsearchDomainOutput

type DescribeElasticsearchDomainOutput struct {
	// The current status of the Elasticsearch domain.
	DomainStatus *types.ElasticsearchDomainStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a DescribeElasticsearchDomain request. Contains the status of the domain specified in the request.

type DescribeElasticsearchDomainsInput

type DescribeElasticsearchDomainsInput struct {
	// The Elasticsearch domains for which you want information.
	DomainNames []*string
}

Container for the parameters to the DescribeElasticsearchDomains () operation. By default, the API returns the status of all Elasticsearch domains.

type DescribeElasticsearchDomainsOutput

type DescribeElasticsearchDomainsOutput struct {
	// The status of the domains requested in the DescribeElasticsearchDomains request.
	DomainStatusList []*types.ElasticsearchDomainStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a DescribeElasticsearchDomains request. Contains the status of the specified domains or all domains owned by the account.

type DescribeElasticsearchInstanceTypeLimitsInput

type DescribeElasticsearchInstanceTypeLimitsInput struct {
	// The instance type for an Elasticsearch cluster for which Elasticsearch Limits ()
	// are needed.
	InstanceType types.ESPartitionInstanceType
	// Version of Elasticsearch for which Limits () are needed.
	ElasticsearchVersion *string
	// DomainName represents the name of the Domain that we are trying to modify. This
	// should be present only if we are querying for Elasticsearch Limits () for
	// existing domain.
	DomainName *string
}

Container for the parameters to DescribeElasticsearchInstanceTypeLimits () operation.

type DescribeElasticsearchInstanceTypeLimitsOutput

type DescribeElasticsearchInstanceTypeLimitsOutput struct {
	// Map of Role of the Instance and Limits that are applicable. Role performed by
	// given Instance in Elasticsearch can be one of the following:
	//
	//     * data: If the
	// given InstanceType is used as data node
	//
	//     * master: If the given InstanceType
	// is used as master node
	//
	//     * ultra_warm: If the given InstanceType is used as
	// warm node
	LimitsByRole map[string]*types.Limits

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Container for the parameters received from DescribeElasticsearchInstanceTypeLimits () operation.

type DescribeInboundCrossClusterSearchConnectionsInput

type DescribeInboundCrossClusterSearchConnectionsInput struct {
	// NextToken is sent in case the earlier API call results contain the NextToken. It
	// is used for pagination.
	NextToken *string
	// Set this value to limit the number of results returned. If not specified,
	// defaults to 100.
	MaxResults *int32
	// A list of filters used to match properties for inbound cross-cluster search
	// connection. Available Filter () names for this operation are:
	//
	//     *
	// cross-cluster-search-connection-id
	//
	//     * source-domain-info.domain-name
	//
	//     *
	// source-domain-info.owner-id
	//
	//     * source-domain-info.region
	//
	//     *
	// destination-domain-info.domain-name
	Filters []*types.Filter
}

Container for the parameters to the DescribeInboundCrossClusterSearchConnections () operation.

type DescribeInboundCrossClusterSearchConnectionsOutput

type DescribeInboundCrossClusterSearchConnectionsOutput struct {
	// If more results are available and NextToken is present, make the next request to
	// the same API with the received NextToken to paginate the remaining results.
	NextToken *string
	// Consists of list of InboundCrossClusterSearchConnection () matching the
	// specified filter criteria.
	CrossClusterSearchConnections []*types.InboundCrossClusterSearchConnection

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a DescribeInboundCrossClusterSearchConnections () request. Contains the list of connections matching the filter criteria.

type DescribeOutboundCrossClusterSearchConnectionsInput

type DescribeOutboundCrossClusterSearchConnectionsInput struct {
	// Set this value to limit the number of results returned. If not specified,
	// defaults to 100.
	MaxResults *int32
	// NextToken is sent in case the earlier API call results contain the NextToken. It
	// is used for pagination.
	NextToken *string
	// A list of filters used to match properties for outbound cross-cluster search
	// connection. Available Filter () names for this operation are:
	//
	//     *
	// cross-cluster-search-connection-id
	//
	//     * destination-domain-info.domain-name
	//
	//
	// * destination-domain-info.owner-id
	//
	//     * destination-domain-info.region
	//
	//     *
	// source-domain-info.domain-name
	Filters []*types.Filter
}

Container for the parameters to the DescribeOutboundCrossClusterSearchConnections () operation.

type DescribeOutboundCrossClusterSearchConnectionsOutput

type DescribeOutboundCrossClusterSearchConnectionsOutput struct {
	// If more results are available and NextToken is present, make the next request to
	// the same API with the received NextToken to paginate the remaining results.
	NextToken *string
	// Consists of list of OutboundCrossClusterSearchConnection () matching the
	// specified filter criteria.
	CrossClusterSearchConnections []*types.OutboundCrossClusterSearchConnection

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a DescribeOutboundCrossClusterSearchConnections () request. Contains the list of connections matching the filter criteria.

type DescribePackagesInput

type DescribePackagesInput struct {
	// Limits results to a maximum number of packages.
	MaxResults *int32
	// Used for pagination. Only necessary if a previous API call includes a non-null
	// NextToken value. If provided, returns results for the next page.
	NextToken *string
	// Only returns packages that match the DescribePackagesFilterList values.
	Filters []*types.DescribePackagesFilter
}

Container for request parameters to DescribePackage () operation.

type DescribePackagesOutput

type DescribePackagesOutput struct {
	// List of PackageDetails objects.
	PackageDetailsList []*types.PackageDetails
	NextToken          *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Container for response returned by DescribePackages () operation.

type DescribeReservedElasticsearchInstanceOfferingsInput

type DescribeReservedElasticsearchInstanceOfferingsInput struct {
	// NextToken should be sent in case if earlier API call produced result containing
	// NextToken. It is used for pagination.
	NextToken *string
	// Set this value to limit the number of results returned. If not specified,
	// defaults to 100.
	MaxResults *int32
	// The offering identifier filter value. Use this parameter to show only the
	// available offering that matches the specified reservation identifier.
	ReservedElasticsearchInstanceOfferingId *string
}

Container for parameters to DescribeReservedElasticsearchInstanceOfferings

type DescribeReservedElasticsearchInstanceOfferingsOutput

type DescribeReservedElasticsearchInstanceOfferingsOutput struct {
	// List of reserved Elasticsearch instance offerings
	ReservedElasticsearchInstanceOfferings []*types.ReservedElasticsearchInstanceOffering
	// Provides an identifier to allow retrieval of paginated results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Container for results from DescribeReservedElasticsearchInstanceOfferings

type DescribeReservedElasticsearchInstancesInput

type DescribeReservedElasticsearchInstancesInput struct {
	// NextToken should be sent in case if earlier API call produced result containing
	// NextToken. It is used for pagination.
	NextToken *string
	// The reserved instance identifier filter value. Use this parameter to show only
	// the reservation that matches the specified reserved Elasticsearch instance ID.
	ReservedElasticsearchInstanceId *string
	// Set this value to limit the number of results returned. If not specified,
	// defaults to 100.
	MaxResults *int32
}

Container for parameters to DescribeReservedElasticsearchInstances

type DescribeReservedElasticsearchInstancesOutput

type DescribeReservedElasticsearchInstancesOutput struct {
	// Provides an identifier to allow retrieval of paginated results.
	NextToken *string
	// List of reserved Elasticsearch instances.
	ReservedElasticsearchInstances []*types.ReservedElasticsearchInstance

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Container for results from DescribeReservedElasticsearchInstances

type DissociatePackageInput

type DissociatePackageInput struct {
	// Internal ID of the package that you want to associate with a domain. Use
	// DescribePackages to find this value.
	PackageID *string
	// Name of the domain that you want to associate the package with.
	DomainName *string
}

Container for request parameters to DissociatePackage () operation.

type DissociatePackageOutput

type DissociatePackageOutput struct {
	// DomainPackageDetails
	DomainPackageDetails *types.DomainPackageDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Container for response returned by DissociatePackage () operation.

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func WithEndpointResolver

func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver

WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options ResolverOptions) (endpoint aws.Endpoint, err error)

type GetCompatibleElasticsearchVersionsInput

type GetCompatibleElasticsearchVersionsInput 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).
	DomainName *string
}

Container for request parameters to GetCompatibleElasticsearchVersions () operation.

type GetCompatibleElasticsearchVersionsOutput

type GetCompatibleElasticsearchVersionsOutput struct {
	// A map of compatible Elasticsearch versions returned as part of the
	// GetCompatibleElasticsearchVersions () operation.
	CompatibleElasticsearchVersions []*types.CompatibleVersionsMap

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Container for response returned by GetCompatibleElasticsearchVersions () operation.

type GetUpgradeHistoryInput

type GetUpgradeHistoryInput struct {
	// Set this value to limit the number of results returned.
	MaxResults *int32
	// 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).
	DomainName *string
	// Paginated APIs accepts NextToken input to returns next page results and provides
	// a NextToken output in the response which can be used by the client to retrieve
	// more results.
	NextToken *string
}

Container for request parameters to GetUpgradeHistory () operation.

type GetUpgradeHistoryOutput

type GetUpgradeHistoryOutput struct {
	// Pagination token that needs to be supplied to the next call to get the next page
	// of results
	NextToken *string
	// A list of UpgradeHistory () objects corresponding to each Upgrade or Upgrade
	// Eligibility Check performed on a domain returned as part of
	// GetUpgradeHistoryResponse () object.
	UpgradeHistories []*types.UpgradeHistory

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Container for response returned by GetUpgradeHistory () operation.

type GetUpgradeStatusInput

type GetUpgradeStatusInput 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).
	DomainName *string
}

Container for request parameters to GetUpgradeStatus () operation.

type GetUpgradeStatusOutput

type GetUpgradeStatusOutput struct {
	// A string that describes the update briefly
	UpgradeName *string
	// Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does
	// through:
	//
	//     * PreUpgradeCheck
	//
	//     * Snapshot
	//
	//     * Upgrade
	UpgradeStep types.UpgradeStep
	// One of 4 statuses that a step can go through returned as part of the
	// GetUpgradeStatusResponse () object. The status can take one of the following
	// values:
	//
	//     * In Progress
	//
	//     * Succeeded
	//
	//     * Succeeded with Issues
	//
	//     *
	// Failed
	StepStatus types.UpgradeStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Container for response returned by GetUpgradeStatus () operation.

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error
}

type ListDomainNamesInput

type ListDomainNamesInput struct {
}

type ListDomainNamesOutput

type ListDomainNamesOutput struct {
	// List of Elasticsearch domain names.
	DomainNames []*types.DomainInfo

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a ListDomainNames operation. Contains the names of all Elasticsearch domains owned by this account.

type ListDomainsForPackageInput

type ListDomainsForPackageInput struct {
	// Used for pagination. Only necessary if a previous API call includes a non-null
	// NextToken value. If provided, returns results for the next page.
	NextToken *string
	// Limits results to a maximum number of domains.
	MaxResults *int32
	// The package for which to list domains.
	PackageID *string
}

Container for request parameters to ListDomainsForPackage () operation.

type ListDomainsForPackageOutput

type ListDomainsForPackageOutput struct {
	NextToken *string
	// List of DomainPackageDetails objects.
	DomainPackageDetailsList []*types.DomainPackageDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Container for response parameters to ListDomainsForPackage () operation.

type ListElasticsearchInstanceTypesInput

type ListElasticsearchInstanceTypesInput struct {
	// NextToken should be sent in case if earlier API call produced result containing
	// NextToken. It is used for pagination.
	NextToken *string
	// DomainName represents the name of the Domain that we are trying to modify. This
	// should be present only if we are querying for list of available Elasticsearch
	// instance types when modifying existing domain.
	DomainName *string
	// Set this value to limit the number of results returned. Value provided must be
	// greater than 30 else it wont be honored.
	MaxResults *int32
	// Version of Elasticsearch for which list of supported elasticsearch instance
	// types are needed.
	ElasticsearchVersion *string
}

Container for the parameters to the ListElasticsearchInstanceTypes () operation.

type ListElasticsearchInstanceTypesOutput

type ListElasticsearchInstanceTypesOutput struct {
	// List of instance types supported by Amazon Elasticsearch service for given
	// ElasticsearchVersion ()
	ElasticsearchInstanceTypes []types.ESPartitionInstanceType
	// In case if there are more results available NextToken would be present, make
	// further request to the same API with received NextToken to paginate remaining
	// results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Container for the parameters returned by ListElasticsearchInstanceTypes () operation.

type ListElasticsearchVersionsInput

type ListElasticsearchVersionsInput struct {
	// Set this value to limit the number of results returned. Value provided must be
	// greater than 10 else it wont be honored.
	MaxResults *int32
	// Paginated APIs accepts NextToken input to returns next page results and provides
	// a NextToken output in the response which can be used by the client to retrieve
	// more results.
	NextToken *string
}

Container for the parameters to the ListElasticsearchVersions () operation. Use MaxResults () to control the maximum number of results to retrieve in a single call. Use NextToken () in response to retrieve more results. If the received response does not contain a NextToken, then there are no more results to retrieve.

type ListElasticsearchVersionsOutput

type ListElasticsearchVersionsOutput struct {
	// Paginated APIs accepts NextToken input to returns next page results and provides
	// a NextToken output in the response which can be used by the client to retrieve
	// more results.
	NextToken *string
	// List of supported elastic search versions.
	ElasticsearchVersions []*string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Container for the parameters for response received from ListElasticsearchVersions () operation.

type ListPackagesForDomainInput

type ListPackagesForDomainInput struct {
	// The name of the domain for which you want to list associated packages.
	DomainName *string
	// Limits results to a maximum number of packages.
	MaxResults *int32
	// Used for pagination. Only necessary if a previous API call includes a non-null
	// NextToken value. If provided, returns results for the next page.
	NextToken *string
}

Container for request parameters to ListPackagesForDomain () operation.

type ListPackagesForDomainOutput

type ListPackagesForDomainOutput struct {
	// Pagination token that needs to be supplied to the next call to get the next page
	// of results.
	NextToken *string
	// List of DomainPackageDetails objects.
	DomainPackageDetailsList []*types.DomainPackageDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Container for response parameters to ListPackagesForDomain () operation.

type ListTagsInput

type ListTagsInput struct {
	// Specify the ARN for the Elasticsearch domain to which the tags are attached that
	// you want to view.
	ARN *string
}

Container for the parameters to the ListTags () operation. Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view are attached.

type ListTagsOutput

type ListTagsOutput struct {
	// List of Tag for the requested Elasticsearch domain.
	TagList []*types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a ListTags operation. Contains tags for all requested Elasticsearch domains.

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions ResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer retry.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetCredentials

func (o Options) GetCredentials() aws.CredentialsProvider

func (Options) GetEndpointOptions

func (o Options) GetEndpointOptions() ResolverOptions

func (Options) GetEndpointResolver

func (o Options) GetEndpointResolver() EndpointResolver

func (Options) GetHTTPSignerV4

func (o Options) GetHTTPSignerV4() HTTPSignerV4

func (Options) GetRegion

func (o Options) GetRegion() string

func (Options) GetRetryer

func (o Options) GetRetryer() retry.Retryer

type PurchaseReservedElasticsearchInstanceOfferingInput

type PurchaseReservedElasticsearchInstanceOfferingInput struct {
	// The number of Elasticsearch instances to reserve.
	InstanceCount *int32
	// The ID of the reserved Elasticsearch instance offering to purchase.
	ReservedElasticsearchInstanceOfferingId *string
	// A customer-specified identifier to track this reservation.
	ReservationName *string
}

Container for parameters to PurchaseReservedElasticsearchInstanceOffering

type PurchaseReservedElasticsearchInstanceOfferingOutput

type PurchaseReservedElasticsearchInstanceOfferingOutput struct {
	// Details of the reserved Elasticsearch instance which was purchased.
	ReservedElasticsearchInstanceId *string
	// The customer-specified identifier used to track this reservation.
	ReservationName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the output of a PurchaseReservedElasticsearchInstanceOffering operation.

type RejectInboundCrossClusterSearchConnectionInput

type RejectInboundCrossClusterSearchConnectionInput struct {
	// The id of the inbound connection that you want to reject.
	CrossClusterSearchConnectionId *string
}

Container for the parameters to the RejectInboundCrossClusterSearchConnection () operation.

type RejectInboundCrossClusterSearchConnectionOutput

type RejectInboundCrossClusterSearchConnectionOutput struct {
	// Specifies the InboundCrossClusterSearchConnection () of rejected inbound
	// connection.
	CrossClusterSearchConnection *types.InboundCrossClusterSearchConnection

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a RejectInboundCrossClusterSearchConnection () operation. Contains details of rejected inbound connection.

type RemoveTagsInput

type RemoveTagsInput struct {
	// Specifies the ARN for the Elasticsearch domain from which you want to delete the
	// specified tags.
	ARN *string
	// Specifies the TagKey list which you want to remove from the Elasticsearch
	// domain.
	TagKeys []*string
}

Container for the parameters to the RemoveTags () operation. Specify the ARN for the Elasticsearch domain from which you want to remove the specified TagKey.

type RemoveTagsOutput

type RemoveTagsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  ResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type ResolveEndpointMiddlewareOptions

type ResolveEndpointMiddlewareOptions interface {
	GetEndpointResolver() EndpointResolver
	GetEndpointOptions() ResolverOptions
}

type ResolverOptions

type ResolverOptions = internalendpoints.Options

ResolverOptions is the service endpoint resolver options

type StartElasticsearchServiceSoftwareUpdateInput

type StartElasticsearchServiceSoftwareUpdateInput struct {
	// The name of the domain that you want to update to the latest service software.
	DomainName *string
}

Container for the parameters to the StartElasticsearchServiceSoftwareUpdate () operation. Specifies the name of the Elasticsearch domain that you wish to schedule a service software update on.

type StartElasticsearchServiceSoftwareUpdateOutput

type StartElasticsearchServiceSoftwareUpdateOutput struct {
	// The current status of the Elasticsearch service software update.
	ServiceSoftwareOptions *types.ServiceSoftwareOptions

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a StartElasticsearchServiceSoftwareUpdate operation. Contains the status of the update.

type UpdateElasticsearchDomainConfigInput

type UpdateElasticsearchDomainConfigInput struct {
	// Specifies advanced security options.
	AdvancedSecurityOptions *types.AdvancedSecurityOptionsInput
	// IAM access policy as a JSON-formatted string.
	AccessPolicies *string
	// Options to specify configuration that will be applied to the domain endpoint.
	DomainEndpointOptions *types.DomainEndpointOptions
	// Options to specify the subnets and security groups for VPC endpoint. For more
	// information, see Creating a VPC
	// (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-creating-vpc)
	// in VPC Endpoints for Amazon Elasticsearch Service Domains
	VPCOptions *types.VPCOptions
	// The type and number of instances to instantiate for the domain cluster.
	ElasticsearchClusterConfig *types.ElasticsearchClusterConfig
	// The name of the Elasticsearch domain that you are updating.
	DomainName *string
	// Option to set the time, in UTC format, for the daily automated snapshot. Default
	// value is 0 hours.
	SnapshotOptions *types.SnapshotOptions
	// 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).
	CognitoOptions *types.CognitoOptions
	// Map of LogType and LogPublishingOption, each containing options to publish a
	// given type of Elasticsearch log.
	LogPublishingOptions map[string]*types.LogPublishingOption
	// Modifies the advanced option to allow references to indices in an HTTP request
	// body. Must be false when configuring access to individual sub-resources. By
	// default, the value is true. See Configuration Advanced Options
	// (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options)
	// for more information.
	AdvancedOptions map[string]*string
	// Specify the type and size of the EBS volume that you want to use.
	EBSOptions *types.EBSOptions
}

Container for the parameters to the UpdateElasticsearchDomain () operation. Specifies the type and number of instances in the domain cluster.

type UpdateElasticsearchDomainConfigOutput

type UpdateElasticsearchDomainConfigOutput struct {
	// The status of the updated Elasticsearch domain.
	DomainConfig *types.ElasticsearchDomainConfig

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of an UpdateElasticsearchDomain request. Contains the status of the Elasticsearch domain being updated.

type UpgradeElasticsearchDomainInput

type UpgradeElasticsearchDomainInput struct {
	// This flag, when set to True, indicates that an Upgrade Eligibility Check needs
	// to be performed. This will not actually perform the Upgrade.
	PerformCheckOnly *bool
	// The version of Elasticsearch that you intend to upgrade the domain to.
	TargetVersion *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).
	DomainName *string
}

Container for request parameters to UpgradeElasticsearchDomain () operation.

type UpgradeElasticsearchDomainOutput

type UpgradeElasticsearchDomainOutput struct {
	// This flag, when set to True, indicates that an Upgrade Eligibility Check needs
	// to be performed. This will not actually perform the Upgrade.
	PerformCheckOnly *bool
	// The version of Elasticsearch that you intend to upgrade the domain to.
	TargetVersion *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).
	DomainName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Container for response returned by UpgradeElasticsearchDomain () operation.

Source Files

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

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