amazonka-globalaccelerator-2.0: Amazon Global Accelerator SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.GlobalAccelerator.UpdateAccelerator

Description

Update an accelerator.

Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2 on AWS CLI commands.

Synopsis

Creating a Request

data UpdateAccelerator Source #

See: newUpdateAccelerator smart constructor.

Constructors

UpdateAccelerator' 

Fields

  • enabled :: Maybe Bool

    Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

    If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.

  • ipAddressType :: Maybe IpAddressType

    The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.

  • name :: Maybe Text

    The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end with a hyphen or period.

  • acceleratorArn :: Text

    The Amazon Resource Name (ARN) of the accelerator to update.

Instances

Instances details
ToJSON UpdateAccelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateAccelerator

Methods

toJSON :: UpdateAccelerator -> Value #

toEncoding :: UpdateAccelerator -> Encoding #

toJSONList :: [UpdateAccelerator] -> Value #

toEncodingList :: [UpdateAccelerator] -> Encoding #

ToHeaders UpdateAccelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateAccelerator

Methods

toHeaders :: UpdateAccelerator -> [Header] #

ToPath UpdateAccelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateAccelerator

Methods

toPath :: UpdateAccelerator -> ByteString #

ToQuery UpdateAccelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateAccelerator

Methods

toQuery :: UpdateAccelerator -> QueryString #

AWSRequest UpdateAccelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateAccelerator

Associated Types

type AWSResponse UpdateAccelerator #

Methods

request :: (Service -> Service) -> UpdateAccelerator -> Request UpdateAccelerator #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateAccelerator -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateAccelerator))) #

Generic UpdateAccelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateAccelerator

Associated Types

type Rep UpdateAccelerator :: Type -> Type #

Methods

from :: UpdateAccelerator -> Rep UpdateAccelerator x #

to :: Rep UpdateAccelerator x -> UpdateAccelerator #

Read UpdateAccelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateAccelerator

Methods

readsPrec :: Int -> ReadS UpdateAccelerator #

readList :: ReadS [UpdateAccelerator] #

readPrec :: ReadPrec UpdateAccelerator #

readListPrec :: ReadPrec [UpdateAccelerator] #

Show UpdateAccelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateAccelerator

Methods

showsPrec :: Int -> UpdateAccelerator -> ShowS #

show :: UpdateAccelerator -> String #

showList :: [UpdateAccelerator] -> ShowS #

NFData UpdateAccelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateAccelerator

Methods

rnf :: UpdateAccelerator -> () #

Eq UpdateAccelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateAccelerator

Methods

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

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

Hashable UpdateAccelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateAccelerator

Methods

hashWithSalt :: Int -> UpdateAccelerator -> Int #

hash :: UpdateAccelerator -> Int #

type AWSResponse UpdateAccelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateAccelerator

type AWSResponse UpdateAccelerator = UpdateAcceleratorResponse
type Rep UpdateAccelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateAccelerator

type Rep UpdateAccelerator = D1 ('MetaData "UpdateAccelerator" "Amazonka.GlobalAccelerator.UpdateAccelerator" "amazonka-globalaccelerator-2.0-5CEURNOKFgU1mORtBGQfFs" 'False) (C1 ('MetaCons "UpdateAccelerator'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "ipAddressType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IpAddressType))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "acceleratorArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateAccelerator Source #

Arguments

:: Text

UpdateAccelerator

-> UpdateAccelerator 

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

UpdateAccelerator, updateAccelerator_enabled - Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.

UpdateAccelerator, updateAccelerator_ipAddressType - The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.

UpdateAccelerator, updateAccelerator_name - The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end with a hyphen or period.

UpdateAccelerator, updateAccelerator_acceleratorArn - The Amazon Resource Name (ARN) of the accelerator to update.

Request Lenses

updateAccelerator_enabled :: Lens' UpdateAccelerator (Maybe Bool) Source #

Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.

updateAccelerator_ipAddressType :: Lens' UpdateAccelerator (Maybe IpAddressType) Source #

The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.

updateAccelerator_name :: Lens' UpdateAccelerator (Maybe Text) Source #

The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end with a hyphen or period.

updateAccelerator_acceleratorArn :: Lens' UpdateAccelerator Text Source #

The Amazon Resource Name (ARN) of the accelerator to update.

Destructuring the Response

data UpdateAcceleratorResponse Source #

See: newUpdateAcceleratorResponse smart constructor.

Constructors

UpdateAcceleratorResponse' 

Fields

Instances

Instances details
Generic UpdateAcceleratorResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateAccelerator

Associated Types

type Rep UpdateAcceleratorResponse :: Type -> Type #

Methods

from :: UpdateAcceleratorResponse -> Rep UpdateAcceleratorResponse x #

to :: Rep UpdateAcceleratorResponse x -> UpdateAcceleratorResponse #

Read UpdateAcceleratorResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateAccelerator

Methods

readsPrec :: Int -> ReadS UpdateAcceleratorResponse #

readList :: ReadS [UpdateAcceleratorResponse] #

readPrec :: ReadPrec UpdateAcceleratorResponse #

readListPrec :: ReadPrec [UpdateAcceleratorResponse] #

Show UpdateAcceleratorResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateAccelerator

Methods

showsPrec :: Int -> UpdateAcceleratorResponse -> ShowS #

show :: UpdateAcceleratorResponse -> String #

showList :: [UpdateAcceleratorResponse] -> ShowS #

NFData UpdateAcceleratorResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateAccelerator

Methods

rnf :: UpdateAcceleratorResponse -> () #

Eq UpdateAcceleratorResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateAccelerator

Methods

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

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

type Rep UpdateAcceleratorResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateAccelerator

type Rep UpdateAcceleratorResponse = D1 ('MetaData "UpdateAcceleratorResponse" "Amazonka.GlobalAccelerator.UpdateAccelerator" "amazonka-globalaccelerator-2.0-5CEURNOKFgU1mORtBGQfFs" 'False) (C1 ('MetaCons "UpdateAcceleratorResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accelerator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Accelerator)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateAcceleratorResponse Source #

Arguments

:: Int

$sel:httpStatus:UpdateAcceleratorResponse'

-> UpdateAcceleratorResponse 

Create a value of UpdateAcceleratorResponse 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:accelerator:UpdateAcceleratorResponse', updateAcceleratorResponse_accelerator - Information about the updated accelerator.

$sel:httpStatus:UpdateAcceleratorResponse', updateAcceleratorResponse_httpStatus - The response's http status code.

Response Lenses

updateAcceleratorResponse_accelerator :: Lens' UpdateAcceleratorResponse (Maybe Accelerator) Source #

Information about the updated accelerator.

updateAcceleratorResponse_httpStatus :: Lens' UpdateAcceleratorResponse Int Source #

The response's http status code.