Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.OpenSearch.UpdateDomainConfig

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

Creating a Request

data UpdateDomainConfig Source #

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

See: newUpdateDomainConfig smart constructor.

Constructors

UpdateDomainConfig'

Fields

eBSOptions :: Maybe EBSOptions
Specify the type and size of the EBS volume to use.
nodeToNodeEncryptionOptions :: Maybe NodeToNodeEncryptionOptions
Specifies node-to-node encryption options.
accessPolicies :: Maybe Text
IAM access policy as a JSON-formatted string.
autoTuneOptions :: Maybe AutoTuneOptions
Specifies Auto-Tune options.
logPublishingOptions :: Maybe (HashMap LogType LogPublishingOption)
Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.
clusterConfig :: Maybe ClusterConfig
The type and number of instances to instantiate for the domain cluster.
advancedSecurityOptions :: Maybe AdvancedSecurityOptionsInput
Specifies advanced security options.
snapshotOptions :: Maybe SnapshotOptions
Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.
cognitoOptions :: Maybe CognitoOptions
Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
encryptionAtRestOptions :: Maybe EncryptionAtRestOptions
Specifies encryption of data at rest options.
vPCOptions :: Maybe VPCOptions
Options to specify the subnets and security groups for the VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .
domainEndpointOptions :: Maybe DomainEndpointOptions
Options to specify configuration that will be applied to the domain endpoint.
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 Advanced options for more information.
domainName :: Text
The name of the domain you're updating.

Instances

Instances details

Eq UpdateDomainConfig Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig Methods (==) :: UpdateDomainConfig -> UpdateDomainConfig -> Bool # (/=) :: UpdateDomainConfig -> UpdateDomainConfig -> Bool #
Show UpdateDomainConfig Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig Methods showsPrec :: Int -> UpdateDomainConfig -> ShowS # show :: UpdateDomainConfig -> String # showList :: [UpdateDomainConfig] -> ShowS #
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 #
NFData UpdateDomainConfig Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig Methods rnf :: UpdateDomainConfig -> () #
Hashable UpdateDomainConfig Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig Methods hashWithSalt :: Int -> UpdateDomainConfig -> Int # hash :: UpdateDomainConfig -> Int #
ToJSON UpdateDomainConfig Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig Methods toJSON :: UpdateDomainConfig -> Value # toEncoding :: UpdateDomainConfig -> Encoding # toJSONList :: [UpdateDomainConfig] -> Value # toEncodingList :: [UpdateDomainConfig] -> Encoding #
AWSRequest UpdateDomainConfig Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig Associated Types type AWSResponse UpdateDomainConfig # Methods request :: UpdateDomainConfig -> Request UpdateDomainConfig # response :: MonadResource m => Logger -> Service -> Proxy UpdateDomainConfig -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDomainConfig))) #
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 #
type Rep UpdateDomainConfig Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig type Rep UpdateDomainConfig = D1 ('MetaData "UpdateDomainConfig" "Amazonka.OpenSearch.UpdateDomainConfig" "libZSservicesZSamazonka-opensearchZSamazonka-opensearch" 'False) (C1 ('MetaCons "UpdateDomainConfig'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "eBSOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EBSOptions)) :: (S1 ('MetaSel ('Just "nodeToNodeEncryptionOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NodeToNodeEncryptionOptions)) :: S1 ('MetaSel ('Just "accessPolicies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "autoTuneOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoTuneOptions)) :: S1 ('MetaSel ('Just "logPublishingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap LogType LogPublishingOption)))) :: (S1 ('MetaSel ('Just "clusterConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClusterConfig)) :: S1 ('MetaSel ('Just "advancedSecurityOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AdvancedSecurityOptionsInput))))) :: ((S1 ('MetaSel ('Just "snapshotOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SnapshotOptions)) :: (S1 ('MetaSel ('Just "cognitoOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CognitoOptions)) :: S1 ('MetaSel ('Just "encryptionAtRestOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionAtRestOptions)))) :: ((S1 ('MetaSel ('Just "vPCOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VPCOptions)) :: S1 ('MetaSel ('Just "domainEndpointOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DomainEndpointOptions))) :: (S1 ('MetaSel ('Just "advancedOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse UpdateDomainConfig Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig type AWSResponse UpdateDomainConfig = UpdateDomainConfigResponse

newUpdateDomainConfig Source #

Arguments

:: Text	`$sel:domainName: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:

$sel:eBSOptions:UpdateDomainConfig', updateDomainConfig_eBSOptions - Specify the type and size of the EBS volume to use.

$sel:nodeToNodeEncryptionOptions:UpdateDomainConfig', updateDomainConfig_nodeToNodeEncryptionOptions - Specifies node-to-node encryption options.

$sel:accessPolicies:UpdateDomainConfig', updateDomainConfig_accessPolicies - IAM access policy as a JSON-formatted string.

$sel:autoTuneOptions:UpdateDomainConfig', updateDomainConfig_autoTuneOptions - Specifies Auto-Tune options.

$sel:logPublishingOptions:UpdateDomainConfig', updateDomainConfig_logPublishingOptions - Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.

$sel:clusterConfig:UpdateDomainConfig', updateDomainConfig_clusterConfig - The type and number of instances to instantiate for the domain cluster.

$sel:advancedSecurityOptions:UpdateDomainConfig', updateDomainConfig_advancedSecurityOptions - Specifies advanced security options.

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

$sel:cognitoOptions:UpdateDomainConfig', updateDomainConfig_cognitoOptions - Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

$sel:encryptionAtRestOptions:UpdateDomainConfig', updateDomainConfig_encryptionAtRestOptions - Specifies encryption of data at rest options.

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

$sel:domainEndpointOptions:UpdateDomainConfig', updateDomainConfig_domainEndpointOptions - Options to specify configuration that will be applied to the domain endpoint.

$sel:advancedOptions:UpdateDomainConfig', updateDomainConfig_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 Advanced options for more information.

$sel:domainName:UpdateDomainConfig', updateDomainConfig_domainName - The name of the domain you're updating.

Request Lenses

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

Specify the type and size of the EBS volume to use.

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

Specifies node-to-node encryption options.

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

IAM access policy as a JSON-formatted string.

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

Specifies Auto-Tune options.

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

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

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

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

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

Specifies advanced security options.

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_cognitoOptions :: Lens' UpdateDomainConfig (Maybe CognitoOptions) Source #

Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

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

Specifies encryption of data at rest options.

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

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

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

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

updateDomainConfig_advancedOptions :: Lens' UpdateDomainConfig (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 Advanced options for more information.

updateDomainConfig_domainName :: Lens' UpdateDomainConfig Text Source #

The name of the domain you're updating.

Destructuring the Response

data UpdateDomainConfigResponse Source #

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

See: newUpdateDomainConfigResponse smart constructor.

Constructors

UpdateDomainConfigResponse'
Fields httpStatus :: Int The response's http status code. domainConfig :: DomainConfig The status of the updated domain.

Instances

Instances details

Eq UpdateDomainConfigResponse Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig Methods (==) :: UpdateDomainConfigResponse -> UpdateDomainConfigResponse -> Bool # (/=) :: UpdateDomainConfigResponse -> UpdateDomainConfigResponse -> Bool #
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 #
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 #
NFData UpdateDomainConfigResponse Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig Methods rnf :: UpdateDomainConfigResponse -> () #
type Rep UpdateDomainConfigResponse Source #
Instance details Defined in Amazonka.OpenSearch.UpdateDomainConfig type Rep UpdateDomainConfigResponse = D1 ('MetaData "UpdateDomainConfigResponse" "Amazonka.OpenSearch.UpdateDomainConfig" "libZSservicesZSamazonka-opensearchZSamazonka-opensearch" 'False) (C1 ('MetaCons "UpdateDomainConfigResponse'" 'PrefixI 'True) (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:httpStatus:UpdateDomainConfigResponse', updateDomainConfigResponse_httpStatus - The response's http status code.

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

Response Lenses

updateDomainConfigResponse_httpStatus :: Lens' UpdateDomainConfigResponse Int Source #

The response's http status code.

updateDomainConfigResponse_domainConfig :: Lens' UpdateDomainConfigResponse DomainConfig Source #

The status of the updated domain.