libZSservicesZSamazonka-cloudsearchZSamazonka-cloudsearch
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.CloudSearch.UpdateAvailabilityOptions

Description

Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

Synopsis

Creating a Request

data UpdateAvailabilityOptions Source #

Container for the parameters to the UpdateAvailabilityOptions operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.

See: newUpdateAvailabilityOptions smart constructor.

Constructors

UpdateAvailabilityOptions' 

Fields

  • domainName :: Text
     
  • multiAZ :: Bool

    You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to false.

Instances

Instances details
Eq UpdateAvailabilityOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.UpdateAvailabilityOptions

Methods

(==) :: UpdateAvailabilityOptions -> UpdateAvailabilityOptions -> Bool #

(/=) :: UpdateAvailabilityOptions -> UpdateAvailabilityOptions -> Bool #

Read UpdateAvailabilityOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.UpdateAvailabilityOptions

Methods

readsPrec :: Int -> ReadS UpdateAvailabilityOptions #

readList :: ReadS [UpdateAvailabilityOptions] #

readPrec :: ReadPrec UpdateAvailabilityOptions #

readListPrec :: ReadPrec [UpdateAvailabilityOptions] #

Show UpdateAvailabilityOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.UpdateAvailabilityOptions

Methods

showsPrec :: Int -> UpdateAvailabilityOptions -> ShowS #

show :: UpdateAvailabilityOptions -> String #

showList :: [UpdateAvailabilityOptions] -> ShowS #

Generic UpdateAvailabilityOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.UpdateAvailabilityOptions

Associated Types

type Rep UpdateAvailabilityOptions :: Type -> Type #

Methods

from :: UpdateAvailabilityOptions -> Rep UpdateAvailabilityOptions x #

to :: Rep UpdateAvailabilityOptions x -> UpdateAvailabilityOptions #

NFData UpdateAvailabilityOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.UpdateAvailabilityOptions

Methods

rnf :: UpdateAvailabilityOptions -> () #

Hashable UpdateAvailabilityOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.UpdateAvailabilityOptions

Methods

hashWithSalt :: Int -> UpdateAvailabilityOptions -> Int #

hash :: UpdateAvailabilityOptions -> Int #

AWSRequest UpdateAvailabilityOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.UpdateAvailabilityOptions

Associated Types

type AWSResponse UpdateAvailabilityOptions #

Methods

request :: UpdateAvailabilityOptions -> Request UpdateAvailabilityOptions #

response :: MonadResource m => Logger -> Service -> Proxy UpdateAvailabilityOptions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateAvailabilityOptions))) #

ToHeaders UpdateAvailabilityOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.UpdateAvailabilityOptions

Methods

toHeaders :: UpdateAvailabilityOptions -> [Header] #

ToPath UpdateAvailabilityOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.UpdateAvailabilityOptions

Methods

toPath :: UpdateAvailabilityOptions -> ByteString #

ToQuery UpdateAvailabilityOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.UpdateAvailabilityOptions

Methods

toQuery :: UpdateAvailabilityOptions -> QueryString #

type Rep UpdateAvailabilityOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.UpdateAvailabilityOptions

type Rep UpdateAvailabilityOptions = D1 ('MetaData "UpdateAvailabilityOptions" "Amazonka.CloudSearch.UpdateAvailabilityOptions" "libZSservicesZSamazonka-cloudsearchZSamazonka-cloudsearch" 'False) (C1 ('MetaCons "UpdateAvailabilityOptions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "multiAZ") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))
type AWSResponse UpdateAvailabilityOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.UpdateAvailabilityOptions

type AWSResponse UpdateAvailabilityOptions = UpdateAvailabilityOptionsResponse

newUpdateAvailabilityOptions Source #

Arguments

:: Text

$sel:domainName:UpdateAvailabilityOptions'

-> Bool

$sel:multiAZ:UpdateAvailabilityOptions'

-> UpdateAvailabilityOptions 

Create a value of UpdateAvailabilityOptions 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:domainName:UpdateAvailabilityOptions', updateAvailabilityOptions_domainName - Undocumented member.

$sel:multiAZ:UpdateAvailabilityOptions', updateAvailabilityOptions_multiAZ - You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to false.

Request Lenses

updateAvailabilityOptions_domainName :: Lens' UpdateAvailabilityOptions Text Source #

Undocumented member.

updateAvailabilityOptions_multiAZ :: Lens' UpdateAvailabilityOptions Bool Source #

You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to false.

Destructuring the Response

data UpdateAvailabilityOptionsResponse Source #

The result of a UpdateAvailabilityOptions request. Contains the status of the domain's availability options.

See: newUpdateAvailabilityOptionsResponse smart constructor.

Constructors

UpdateAvailabilityOptionsResponse' 

Fields

Instances

Instances details
Eq UpdateAvailabilityOptionsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.UpdateAvailabilityOptions

Methods

(==) :: UpdateAvailabilityOptionsResponse -> UpdateAvailabilityOptionsResponse -> Bool #

(/=) :: UpdateAvailabilityOptionsResponse -> UpdateAvailabilityOptionsResponse -> Bool #

Read UpdateAvailabilityOptionsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.UpdateAvailabilityOptions

Methods

readsPrec :: Int -> ReadS UpdateAvailabilityOptionsResponse #

readList :: ReadS [UpdateAvailabilityOptionsResponse] #

readPrec :: ReadPrec UpdateAvailabilityOptionsResponse #

readListPrec :: ReadPrec [UpdateAvailabilityOptionsResponse] #

Show UpdateAvailabilityOptionsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.UpdateAvailabilityOptions

Methods

showsPrec :: Int -> UpdateAvailabilityOptionsResponse -> ShowS #

show :: UpdateAvailabilityOptionsResponse -> String #

showList :: [UpdateAvailabilityOptionsResponse] -> ShowS #

Generic UpdateAvailabilityOptionsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.UpdateAvailabilityOptions

Associated Types

type Rep UpdateAvailabilityOptionsResponse :: Type -> Type #

Methods

from :: UpdateAvailabilityOptionsResponse -> Rep UpdateAvailabilityOptionsResponse x #

to :: Rep UpdateAvailabilityOptionsResponse x -> UpdateAvailabilityOptionsResponse #

NFData UpdateAvailabilityOptionsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.UpdateAvailabilityOptions

Methods

rnf :: UpdateAvailabilityOptionsResponse -> () #

type Rep UpdateAvailabilityOptionsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.UpdateAvailabilityOptions

type Rep UpdateAvailabilityOptionsResponse = D1 ('MetaData "UpdateAvailabilityOptionsResponse" "Amazonka.CloudSearch.UpdateAvailabilityOptions" "libZSservicesZSamazonka-cloudsearchZSamazonka-cloudsearch" 'False) (C1 ('MetaCons "UpdateAvailabilityOptionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "availabilityOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AvailabilityOptionsStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateAvailabilityOptionsResponse Source #

Arguments

:: Int

$sel:httpStatus:UpdateAvailabilityOptionsResponse'

-> UpdateAvailabilityOptionsResponse 

Create a value of UpdateAvailabilityOptionsResponse 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:availabilityOptions:UpdateAvailabilityOptionsResponse', updateAvailabilityOptionsResponse_availabilityOptions - The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain.

$sel:httpStatus:UpdateAvailabilityOptionsResponse', updateAvailabilityOptionsResponse_httpStatus - The response's http status code.

Response Lenses

updateAvailabilityOptionsResponse_availabilityOptions :: Lens' UpdateAvailabilityOptionsResponse (Maybe AvailabilityOptionsStatus) Source #

The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain.

updateAvailabilityOptionsResponse_httpStatus :: Lens' UpdateAvailabilityOptionsResponse Int Source #

The response's http status code.