Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ElasticSearch.UpdateElasticsearchDomainConfig

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

Creating a Request

data UpdateElasticsearchDomainConfig Source #

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

See: newUpdateElasticsearchDomainConfig smart constructor.

Constructors

UpdateElasticsearchDomainConfig'

Fields

accessPolicies :: Maybe Text
IAM access policy as a JSON-formatted string.
advancedOptions :: Maybe (HashMap Text Text)
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 for more information.
advancedSecurityOptions :: Maybe AdvancedSecurityOptionsInput
Specifies advanced security options.
autoTuneOptions :: Maybe AutoTuneOptions
Specifies Auto-Tune options.
cognitoOptions :: Maybe CognitoOptions
Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.
domainEndpointOptions :: Maybe DomainEndpointOptions
Options to specify configuration that will be applied to the domain endpoint.
dryRun :: Maybe Bool
This flag, when set to True, specifies whether the UpdateElasticsearchDomain request should return the results of validation checks without actually applying the change. This flag, when set to True, specifies the deployment mechanism through which the update shall be applied on the domain. This will not actually perform the Update.
eBSOptions :: Maybe EBSOptions
Specify the type and size of the EBS volume that you want to use.
elasticsearchClusterConfig :: Maybe ElasticsearchClusterConfig
The type and number of instances to instantiate for the domain cluster.
encryptionAtRestOptions :: Maybe EncryptionAtRestOptions
Specifies the Encryption At Rest Options.
logPublishingOptions :: Maybe (HashMap LogType LogPublishingOption)
Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.
nodeToNodeEncryptionOptions :: Maybe NodeToNodeEncryptionOptions
Specifies the NodeToNodeEncryptionOptions.
snapshotOptions :: Maybe SnapshotOptions
Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.
vPCOptions :: Maybe VPCOptions
Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains
domainName :: Text
The name of the Elasticsearch domain that you are updating.

Instances

Instances details

ToJSON UpdateElasticsearchDomainConfig Source #
Instance details Defined in Amazonka.ElasticSearch.UpdateElasticsearchDomainConfig Methods toJSON :: UpdateElasticsearchDomainConfig -> Value # toEncoding :: UpdateElasticsearchDomainConfig -> Encoding # toJSONList :: [UpdateElasticsearchDomainConfig] -> Value # toEncodingList :: [UpdateElasticsearchDomainConfig] -> Encoding #
ToHeaders UpdateElasticsearchDomainConfig Source #
Instance details Defined in Amazonka.ElasticSearch.UpdateElasticsearchDomainConfig Methods toHeaders :: UpdateElasticsearchDomainConfig -> [Header] #
ToPath UpdateElasticsearchDomainConfig Source #
Instance details Defined in Amazonka.ElasticSearch.UpdateElasticsearchDomainConfig Methods toPath :: UpdateElasticsearchDomainConfig -> ByteString #
ToQuery UpdateElasticsearchDomainConfig Source #
Instance details Defined in Amazonka.ElasticSearch.UpdateElasticsearchDomainConfig Methods toQuery :: UpdateElasticsearchDomainConfig -> QueryString #
AWSRequest UpdateElasticsearchDomainConfig Source #
Instance details Defined in Amazonka.ElasticSearch.UpdateElasticsearchDomainConfig Associated Types type AWSResponse UpdateElasticsearchDomainConfig # Methods request :: (Service -> Service) -> UpdateElasticsearchDomainConfig -> Request UpdateElasticsearchDomainConfig # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateElasticsearchDomainConfig -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateElasticsearchDomainConfig))) #
Generic UpdateElasticsearchDomainConfig Source #
Instance details Defined in Amazonka.ElasticSearch.UpdateElasticsearchDomainConfig Associated Types type Rep UpdateElasticsearchDomainConfig :: Type -> Type # Methods from :: UpdateElasticsearchDomainConfig -> Rep UpdateElasticsearchDomainConfig x # to :: Rep UpdateElasticsearchDomainConfig x -> UpdateElasticsearchDomainConfig #
Show UpdateElasticsearchDomainConfig Source #
Instance details Defined in Amazonka.ElasticSearch.UpdateElasticsearchDomainConfig Methods showsPrec :: Int -> UpdateElasticsearchDomainConfig -> ShowS # show :: UpdateElasticsearchDomainConfig -> String # showList :: [UpdateElasticsearchDomainConfig] -> ShowS #
NFData UpdateElasticsearchDomainConfig Source #
Instance details Defined in Amazonka.ElasticSearch.UpdateElasticsearchDomainConfig Methods rnf :: UpdateElasticsearchDomainConfig -> () #
Eq UpdateElasticsearchDomainConfig Source #
Instance details Defined in Amazonka.ElasticSearch.UpdateElasticsearchDomainConfig Methods (==) :: UpdateElasticsearchDomainConfig -> UpdateElasticsearchDomainConfig -> Bool # (/=) :: UpdateElasticsearchDomainConfig -> UpdateElasticsearchDomainConfig -> Bool #
Hashable UpdateElasticsearchDomainConfig Source #
Instance details Defined in Amazonka.ElasticSearch.UpdateElasticsearchDomainConfig Methods hashWithSalt :: Int -> UpdateElasticsearchDomainConfig -> Int # hash :: UpdateElasticsearchDomainConfig -> Int #
type AWSResponse UpdateElasticsearchDomainConfig Source #
Instance details Defined in Amazonka.ElasticSearch.UpdateElasticsearchDomainConfig type AWSResponse UpdateElasticsearchDomainConfig = UpdateElasticsearchDomainConfigResponse
type Rep UpdateElasticsearchDomainConfig Source #
Instance details Defined in Amazonka.ElasticSearch.UpdateElasticsearchDomainConfig type Rep UpdateElasticsearchDomainConfig = D1 ('MetaData "UpdateElasticsearchDomainConfig" "Amazonka.ElasticSearch.UpdateElasticsearchDomainConfig" "amazonka-elasticsearch-2.0-BmZjovliTfgJWgrJ3fCf5z" 'False) (C1 ('MetaCons "UpdateElasticsearchDomainConfig'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "accessPolicies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "advancedOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "advancedSecurityOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AdvancedSecurityOptionsInput)))) :: ((S1 ('MetaSel ('Just "autoTuneOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoTuneOptions)) :: S1 ('MetaSel ('Just "cognitoOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CognitoOptions))) :: (S1 ('MetaSel ('Just "domainEndpointOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DomainEndpointOptions)) :: S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :: (((S1 ('MetaSel ('Just "eBSOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EBSOptions)) :: S1 ('MetaSel ('Just "elasticsearchClusterConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ElasticsearchClusterConfig))) :: (S1 ('MetaSel ('Just "encryptionAtRestOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionAtRestOptions)) :: S1 ('MetaSel ('Just "logPublishingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap LogType LogPublishingOption))))) :: ((S1 ('MetaSel ('Just "nodeToNodeEncryptionOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NodeToNodeEncryptionOptions)) :: S1 ('MetaSel ('Just "snapshotOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SnapshotOptions))) :: (S1 ('MetaSel ('Just "vPCOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VPCOptions)) :: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateElasticsearchDomainConfig Source #

Arguments

:: Text	`UpdateElasticsearchDomainConfig`
-> UpdateElasticsearchDomainConfig

Create a value of UpdateElasticsearchDomainConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateElasticsearchDomainConfig, updateElasticsearchDomainConfig_accessPolicies - IAM access policy as a JSON-formatted string.

UpdateElasticsearchDomainConfig, updateElasticsearchDomainConfig_advancedOptions - 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 for more information.

UpdateElasticsearchDomainConfig, updateElasticsearchDomainConfig_advancedSecurityOptions - Specifies advanced security options.

UpdateElasticsearchDomainConfig, updateElasticsearchDomainConfig_autoTuneOptions - Specifies Auto-Tune options.

UpdateElasticsearchDomainConfig, updateElasticsearchDomainConfig_cognitoOptions - Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

UpdateElasticsearchDomainConfig, updateElasticsearchDomainConfig_domainEndpointOptions - Options to specify configuration that will be applied to the domain endpoint.

$sel:dryRun:UpdateElasticsearchDomainConfig', updateElasticsearchDomainConfig_dryRun - This flag, when set to True, specifies whether the UpdateElasticsearchDomain request should return the results of validation checks without actually applying the change. This flag, when set to True, specifies the deployment mechanism through which the update shall be applied on the domain. This will not actually perform the Update.

UpdateElasticsearchDomainConfig, updateElasticsearchDomainConfig_eBSOptions - Specify the type and size of the EBS volume that you want to use.

UpdateElasticsearchDomainConfig, updateElasticsearchDomainConfig_elasticsearchClusterConfig - The type and number of instances to instantiate for the domain cluster.

UpdateElasticsearchDomainConfig, updateElasticsearchDomainConfig_encryptionAtRestOptions - Specifies the Encryption At Rest Options.

UpdateElasticsearchDomainConfig, updateElasticsearchDomainConfig_logPublishingOptions - Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.

UpdateElasticsearchDomainConfig, updateElasticsearchDomainConfig_nodeToNodeEncryptionOptions - Specifies the NodeToNodeEncryptionOptions.

UpdateElasticsearchDomainConfig, updateElasticsearchDomainConfig_snapshotOptions - Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

UpdateElasticsearchDomainConfig, updateElasticsearchDomainConfig_vPCOptions - Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

UpdateElasticsearchDomainConfig, updateElasticsearchDomainConfig_domainName - The name of the Elasticsearch domain that you are updating.

Request Lenses

updateElasticsearchDomainConfig_accessPolicies :: Lens' UpdateElasticsearchDomainConfig (Maybe Text) Source #

IAM access policy as a JSON-formatted string.

updateElasticsearchDomainConfig_advancedOptions :: Lens' UpdateElasticsearchDomainConfig (Maybe (HashMap Text Text)) Source #

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 for more information.

updateElasticsearchDomainConfig_advancedSecurityOptions :: Lens' UpdateElasticsearchDomainConfig (Maybe AdvancedSecurityOptionsInput) Source #

Specifies advanced security options.

updateElasticsearchDomainConfig_autoTuneOptions :: Lens' UpdateElasticsearchDomainConfig (Maybe AutoTuneOptions) Source #

Specifies Auto-Tune options.

updateElasticsearchDomainConfig_cognitoOptions :: Lens' UpdateElasticsearchDomainConfig (Maybe CognitoOptions) Source #

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

updateElasticsearchDomainConfig_domainEndpointOptions :: Lens' UpdateElasticsearchDomainConfig (Maybe DomainEndpointOptions) Source #

Options to specify configuration that will be applied to the domain endpoint.

updateElasticsearchDomainConfig_dryRun :: Lens' UpdateElasticsearchDomainConfig (Maybe Bool) Source #

This flag, when set to True, specifies whether the UpdateElasticsearchDomain request should return the results of validation checks without actually applying the change. This flag, when set to True, specifies the deployment mechanism through which the update shall be applied on the domain. This will not actually perform the Update.

updateElasticsearchDomainConfig_eBSOptions :: Lens' UpdateElasticsearchDomainConfig (Maybe EBSOptions) Source #

Specify the type and size of the EBS volume that you want to use.

updateElasticsearchDomainConfig_elasticsearchClusterConfig :: Lens' UpdateElasticsearchDomainConfig (Maybe ElasticsearchClusterConfig) Source #

The type and number of instances to instantiate for the domain cluster.

updateElasticsearchDomainConfig_encryptionAtRestOptions :: Lens' UpdateElasticsearchDomainConfig (Maybe EncryptionAtRestOptions) Source #

Specifies the Encryption At Rest Options.

updateElasticsearchDomainConfig_logPublishingOptions :: Lens' UpdateElasticsearchDomainConfig (Maybe (HashMap LogType LogPublishingOption)) Source #

Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.

updateElasticsearchDomainConfig_nodeToNodeEncryptionOptions :: Lens' UpdateElasticsearchDomainConfig (Maybe NodeToNodeEncryptionOptions) Source #

Specifies the NodeToNodeEncryptionOptions.

updateElasticsearchDomainConfig_snapshotOptions :: Lens' UpdateElasticsearchDomainConfig (Maybe SnapshotOptions) Source #

Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

updateElasticsearchDomainConfig_vPCOptions :: Lens' UpdateElasticsearchDomainConfig (Maybe VPCOptions) Source #

Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

updateElasticsearchDomainConfig_domainName :: Lens' UpdateElasticsearchDomainConfig Text Source #

The name of the Elasticsearch domain that you are updating.

Destructuring the Response

data UpdateElasticsearchDomainConfigResponse Source #

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

See: newUpdateElasticsearchDomainConfigResponse smart constructor.

Constructors

UpdateElasticsearchDomainConfigResponse'
Fields dryRunResults :: Maybe DryRunResults Contains result of DryRun. httpStatus :: Int The response's http status code. domainConfig :: ElasticsearchDomainConfig The status of the updated Elasticsearch domain.

Instances

Instances details

Generic UpdateElasticsearchDomainConfigResponse Source #
Instance details Defined in Amazonka.ElasticSearch.UpdateElasticsearchDomainConfig Associated Types type Rep UpdateElasticsearchDomainConfigResponse :: Type -> Type # Methods from :: UpdateElasticsearchDomainConfigResponse -> Rep UpdateElasticsearchDomainConfigResponse x # to :: Rep UpdateElasticsearchDomainConfigResponse x -> UpdateElasticsearchDomainConfigResponse #
Read UpdateElasticsearchDomainConfigResponse Source #
Instance details Defined in Amazonka.ElasticSearch.UpdateElasticsearchDomainConfig Methods readsPrec :: Int -> ReadS UpdateElasticsearchDomainConfigResponse # readList :: ReadS [UpdateElasticsearchDomainConfigResponse] # readPrec :: ReadPrec UpdateElasticsearchDomainConfigResponse # readListPrec :: ReadPrec [UpdateElasticsearchDomainConfigResponse] #
Show UpdateElasticsearchDomainConfigResponse Source #
Instance details Defined in Amazonka.ElasticSearch.UpdateElasticsearchDomainConfig Methods showsPrec :: Int -> UpdateElasticsearchDomainConfigResponse -> ShowS # show :: UpdateElasticsearchDomainConfigResponse -> String # showList :: [UpdateElasticsearchDomainConfigResponse] -> ShowS #
NFData UpdateElasticsearchDomainConfigResponse Source #
Instance details Defined in Amazonka.ElasticSearch.UpdateElasticsearchDomainConfig Methods rnf :: UpdateElasticsearchDomainConfigResponse -> () #
Eq UpdateElasticsearchDomainConfigResponse Source #
Instance details Defined in Amazonka.ElasticSearch.UpdateElasticsearchDomainConfig Methods (==) :: UpdateElasticsearchDomainConfigResponse -> UpdateElasticsearchDomainConfigResponse -> Bool # (/=) :: UpdateElasticsearchDomainConfigResponse -> UpdateElasticsearchDomainConfigResponse -> Bool #
type Rep UpdateElasticsearchDomainConfigResponse Source #
Instance details Defined in Amazonka.ElasticSearch.UpdateElasticsearchDomainConfig type Rep UpdateElasticsearchDomainConfigResponse = D1 ('MetaData "UpdateElasticsearchDomainConfigResponse" "Amazonka.ElasticSearch.UpdateElasticsearchDomainConfig" "amazonka-elasticsearch-2.0-BmZjovliTfgJWgrJ3fCf5z" 'False) (C1 ('MetaCons "UpdateElasticsearchDomainConfigResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dryRunResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DryRunResults)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "domainConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ElasticsearchDomainConfig))))

newUpdateElasticsearchDomainConfigResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateElasticsearchDomainConfigResponse'`
-> ElasticsearchDomainConfig	`$sel:domainConfig:UpdateElasticsearchDomainConfigResponse'`
-> UpdateElasticsearchDomainConfigResponse

Create a value of UpdateElasticsearchDomainConfigResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dryRunResults:UpdateElasticsearchDomainConfigResponse', updateElasticsearchDomainConfigResponse_dryRunResults - Contains result of DryRun.

$sel:httpStatus:UpdateElasticsearchDomainConfigResponse', updateElasticsearchDomainConfigResponse_httpStatus - The response's http status code.

$sel:domainConfig:UpdateElasticsearchDomainConfigResponse', updateElasticsearchDomainConfigResponse_domainConfig - The status of the updated Elasticsearch domain.

Response Lenses

updateElasticsearchDomainConfigResponse_dryRunResults :: Lens' UpdateElasticsearchDomainConfigResponse (Maybe DryRunResults) Source #

Contains result of DryRun.

updateElasticsearchDomainConfigResponse_httpStatus :: Lens' UpdateElasticsearchDomainConfigResponse Int Source #

The response's http status code.

updateElasticsearchDomainConfigResponse_domainConfig :: Lens' UpdateElasticsearchDomainConfigResponse ElasticsearchDomainConfig Source #

The status of the updated Elasticsearch domain.