libZSservicesZSamazonka-opensearchZSamazonka-opensearch
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.OpenSearch.UpdateDomainConfig

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

Instances

Instances details
Eq UpdateDomainConfig Source # 
Instance details

Defined in Amazonka.OpenSearch.UpdateDomainConfig

Show UpdateDomainConfig Source # 
Instance details

Defined in Amazonka.OpenSearch.UpdateDomainConfig

Generic UpdateDomainConfig Source # 
Instance details

Defined in Amazonka.OpenSearch.UpdateDomainConfig

Associated Types

type Rep UpdateDomainConfig :: Type -> Type #

NFData UpdateDomainConfig Source # 
Instance details

Defined in Amazonka.OpenSearch.UpdateDomainConfig

Methods

rnf :: UpdateDomainConfig -> () #

Hashable UpdateDomainConfig Source # 
Instance details

Defined in Amazonka.OpenSearch.UpdateDomainConfig

ToJSON UpdateDomainConfig Source # 
Instance details

Defined in Amazonka.OpenSearch.UpdateDomainConfig

AWSRequest UpdateDomainConfig Source # 
Instance details

Defined in Amazonka.OpenSearch.UpdateDomainConfig

Associated Types

type AWSResponse UpdateDomainConfig #

ToHeaders UpdateDomainConfig Source # 
Instance details

Defined in Amazonka.OpenSearch.UpdateDomainConfig

ToPath UpdateDomainConfig Source # 
Instance details

Defined in Amazonka.OpenSearch.UpdateDomainConfig

ToQuery UpdateDomainConfig Source # 
Instance details

Defined in Amazonka.OpenSearch.UpdateDomainConfig

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

newUpdateDomainConfig Source #

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

IAM access policy as a JSON-formatted string.

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_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_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

Instances

Instances details
Eq UpdateDomainConfigResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.UpdateDomainConfig

Read UpdateDomainConfigResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.UpdateDomainConfig

Show UpdateDomainConfigResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.UpdateDomainConfig

Generic UpdateDomainConfigResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.UpdateDomainConfig

Associated Types

type Rep UpdateDomainConfigResponse :: Type -> Type #

NFData UpdateDomainConfigResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.UpdateDomainConfig

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 #

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