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.OpenSearch.UpdateDomainConfig

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.

Synopsis

Creating a Request

data UpdateDomainConfig Source #

Container for the request parameters to the UpdateDomain operation.

See: newUpdateDomainConfig smart constructor.

Constructors

UpdateDomainConfig'

Fields

accessPolicies :: Maybe Text
Identity and Access Management (IAM) access policy as a JSON-formatted string.
advancedOptions :: Maybe (HashMap Text Text)
Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:
- "rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.
- "indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.
- "indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.
- "override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.
For more information, see Advanced cluster parameters.
advancedSecurityOptions :: Maybe AdvancedSecurityOptionsInput
Options for fine-grained access control.
autoTuneOptions :: Maybe AutoTuneOptions
Options for Auto-Tune.
clusterConfig :: Maybe ClusterConfig
Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.
cognitoOptions :: Maybe CognitoOptions
Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
domainEndpointOptions :: Maybe DomainEndpointOptions
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
dryRun :: Maybe Bool
This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation check without actually applying the change.
eBSOptions :: Maybe EBSOptions
The type and size of the EBS volume to attach to instances in the domain.
encryptionAtRestOptions :: Maybe EncryptionAtRestOptions
Encryption at rest options for the domain.
logPublishingOptions :: Maybe (HashMap LogType LogPublishingOption)
Options to publish OpenSearch lots to Amazon CloudWatch Logs.
nodeToNodeEncryptionOptions :: Maybe NodeToNodeEncryptionOptions
Node-To-Node Encryption options for the domain.
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 a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
domainName :: Text
The name of the domain that you're updating.

Instances

Instances details

ToJSON UpdateDomainConfig Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig Methods toJSON :: UpdateDomainConfig -> Value # toEncoding :: UpdateDomainConfig -> Encoding # toJSONList :: [UpdateDomainConfig] -> Value # toEncodingList :: [UpdateDomainConfig] -> Encoding #
ToHeaders UpdateDomainConfig Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig Methods toHeaders :: UpdateDomainConfig -> [Header] #
ToPath UpdateDomainConfig Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig Methods toPath :: UpdateDomainConfig -> ByteString #
ToQuery UpdateDomainConfig Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig Methods toQuery :: UpdateDomainConfig -> QueryString #
AWSRequest UpdateDomainConfig Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig Associated Types type AWSResponse UpdateDomainConfig # Methods request :: (Service -> Service) -> UpdateDomainConfig -> Request UpdateDomainConfig # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateDomainConfig -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDomainConfig))) #
Generic UpdateDomainConfig Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig Associated Types type Rep UpdateDomainConfig :: Type -> Type # Methods from :: UpdateDomainConfig -> Rep UpdateDomainConfig x # to :: Rep UpdateDomainConfig x -> UpdateDomainConfig #
Show UpdateDomainConfig Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig Methods showsPrec :: Int -> UpdateDomainConfig -> ShowS # show :: UpdateDomainConfig -> String # showList :: [UpdateDomainConfig] -> ShowS #
NFData UpdateDomainConfig Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig Methods rnf :: UpdateDomainConfig -> () #
Eq UpdateDomainConfig Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig Methods (==) :: UpdateDomainConfig -> UpdateDomainConfig -> Bool # (/=) :: UpdateDomainConfig -> UpdateDomainConfig -> Bool #
Hashable UpdateDomainConfig Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig Methods hashWithSalt :: Int -> UpdateDomainConfig -> Int # hash :: UpdateDomainConfig -> Int #
type AWSResponse UpdateDomainConfig Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig type AWSResponse UpdateDomainConfig = UpdateDomainConfigResponse
type Rep UpdateDomainConfig Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig type Rep UpdateDomainConfig = D1 ('MetaData "UpdateDomainConfig" "Amazonka.OpenSearch.UpdateDomainConfig" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "UpdateDomainConfig'" '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 "clusterConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClusterConfig))) :: (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 "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))))))

newUpdateDomainConfig Source #

Arguments

:: Text	`UpdateDomainConfig`
-> UpdateDomainConfig

Create a value of UpdateDomainConfig 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:

UpdateDomainConfig, updateDomainConfig_accessPolicies - Identity and Access Management (IAM) access policy as a JSON-formatted string.

UpdateDomainConfig, updateDomainConfig_advancedOptions - Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:

"rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.
"indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.
"indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.
"override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.

For more information, see Advanced cluster parameters.

UpdateDomainConfig, updateDomainConfig_advancedSecurityOptions - Options for fine-grained access control.

UpdateDomainConfig, updateDomainConfig_autoTuneOptions - Options for Auto-Tune.

UpdateDomainConfig, updateDomainConfig_clusterConfig - Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.

UpdateDomainConfig, updateDomainConfig_cognitoOptions - Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

UpdateDomainConfig, updateDomainConfig_domainEndpointOptions - Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

$sel:dryRun:UpdateDomainConfig', updateDomainConfig_dryRun - This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation check without actually applying the change.

UpdateDomainConfig, updateDomainConfig_eBSOptions - The type and size of the EBS volume to attach to instances in the domain.

UpdateDomainConfig, updateDomainConfig_encryptionAtRestOptions - Encryption at rest options for the domain.

UpdateDomainConfig, updateDomainConfig_logPublishingOptions - Options to publish OpenSearch lots to Amazon CloudWatch Logs.

UpdateDomainConfig, updateDomainConfig_nodeToNodeEncryptionOptions - Node-To-Node Encryption options for the domain.

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

UpdateDomainConfig, updateDomainConfig_vPCOptions - Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

UpdateDomainConfig, updateDomainConfig_domainName - The name of the domain that you're updating.

Request Lenses

updateDomainConfig_accessPolicies :: Lens' UpdateDomainConfig (Maybe Text) Source #

Identity and Access Management (IAM) access policy as a JSON-formatted string.

updateDomainConfig_advancedOptions :: Lens' UpdateDomainConfig (Maybe (HashMap Text Text)) Source #

Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:

"rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.
"indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.
"indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.
"override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.

For more information, see Advanced cluster parameters.

updateDomainConfig_advancedSecurityOptions :: Lens' UpdateDomainConfig (Maybe AdvancedSecurityOptionsInput) Source #

Options for fine-grained access control.

updateDomainConfig_autoTuneOptions :: Lens' UpdateDomainConfig (Maybe AutoTuneOptions) Source #

Options for Auto-Tune.

updateDomainConfig_clusterConfig :: Lens' UpdateDomainConfig (Maybe ClusterConfig) Source #

Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.

updateDomainConfig_cognitoOptions :: Lens' UpdateDomainConfig (Maybe CognitoOptions) Source #

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

updateDomainConfig_domainEndpointOptions :: Lens' UpdateDomainConfig (Maybe DomainEndpointOptions) Source #

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

updateDomainConfig_dryRun :: Lens' UpdateDomainConfig (Maybe Bool) Source #

This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation check without actually applying the change.

updateDomainConfig_eBSOptions :: Lens' UpdateDomainConfig (Maybe EBSOptions) Source #

The type and size of the EBS volume to attach to instances in the domain.

updateDomainConfig_encryptionAtRestOptions :: Lens' UpdateDomainConfig (Maybe EncryptionAtRestOptions) Source #

Encryption at rest options for the domain.

updateDomainConfig_logPublishingOptions :: Lens' UpdateDomainConfig (Maybe (HashMap LogType LogPublishingOption)) Source #

Options to publish OpenSearch lots to Amazon CloudWatch Logs.

updateDomainConfig_nodeToNodeEncryptionOptions :: Lens' UpdateDomainConfig (Maybe NodeToNodeEncryptionOptions) Source #

Node-To-Node Encryption options for the domain.

updateDomainConfig_snapshotOptions :: Lens' UpdateDomainConfig (Maybe SnapshotOptions) Source #

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

updateDomainConfig_vPCOptions :: Lens' UpdateDomainConfig (Maybe VPCOptions) Source #

Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

updateDomainConfig_domainName :: Lens' UpdateDomainConfig Text Source #

The name of the domain that you're updating.

Destructuring the Response

data UpdateDomainConfigResponse Source #

The results of an UpdateDomain request. Contains the status of the domain being updated.

See: newUpdateDomainConfigResponse smart constructor.

Constructors

UpdateDomainConfigResponse'
Fields dryRunResults :: Maybe DryRunResults Results of a dry run performed in an update domain request. httpStatus :: Int The response's http status code. domainConfig :: DomainConfig The status of the updated domain.

Instances

Instances details

Generic UpdateDomainConfigResponse Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig Associated Types type Rep UpdateDomainConfigResponse :: Type -> Type # Methods from :: UpdateDomainConfigResponse -> Rep UpdateDomainConfigResponse x # to :: Rep UpdateDomainConfigResponse x -> UpdateDomainConfigResponse #
Read UpdateDomainConfigResponse Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig Methods readsPrec :: Int -> ReadS UpdateDomainConfigResponse # readList :: ReadS [UpdateDomainConfigResponse] # readPrec :: ReadPrec UpdateDomainConfigResponse # readListPrec :: ReadPrec [UpdateDomainConfigResponse] #
Show UpdateDomainConfigResponse Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig Methods showsPrec :: Int -> UpdateDomainConfigResponse -> ShowS # show :: UpdateDomainConfigResponse -> String # showList :: [UpdateDomainConfigResponse] -> ShowS #
NFData UpdateDomainConfigResponse Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig Methods rnf :: UpdateDomainConfigResponse -> () #
Eq UpdateDomainConfigResponse Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig Methods (==) :: UpdateDomainConfigResponse -> UpdateDomainConfigResponse -> Bool # (/=) :: UpdateDomainConfigResponse -> UpdateDomainConfigResponse -> Bool #
type Rep UpdateDomainConfigResponse Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig type Rep UpdateDomainConfigResponse = D1 ('MetaData "UpdateDomainConfigResponse" "Amazonka.OpenSearch.UpdateDomainConfig" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "UpdateDomainConfigResponse'" '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 DomainConfig))))

newUpdateDomainConfigResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateDomainConfigResponse'`
-> DomainConfig	`$sel:domainConfig:UpdateDomainConfigResponse'`
-> UpdateDomainConfigResponse

Create a value of UpdateDomainConfigResponse 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:UpdateDomainConfigResponse', updateDomainConfigResponse_dryRunResults - Results of a dry run performed in an update domain request.

$sel:httpStatus:UpdateDomainConfigResponse', updateDomainConfigResponse_httpStatus - The response's http status code.

$sel:domainConfig:UpdateDomainConfigResponse', updateDomainConfigResponse_domainConfig - The status of the updated domain.

Response Lenses

updateDomainConfigResponse_dryRunResults :: Lens' UpdateDomainConfigResponse (Maybe DryRunResults) Source #

Results of a dry run performed in an update domain request.

updateDomainConfigResponse_httpStatus :: Lens' UpdateDomainConfigResponse Int Source #

The response's http status code.

updateDomainConfigResponse_domainConfig :: Lens' UpdateDomainConfigResponse DomainConfig Source #

The status of the updated domain.