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.Lightsail.UpdateLoadBalancerAttribute

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the specified attribute for a load balancer. You can only update one attribute at a time.

The update load balancer attribute operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.

Synopsis

Creating a Request

data UpdateLoadBalancerAttribute Source #

See: newUpdateLoadBalancerAttribute smart constructor.

Constructors

UpdateLoadBalancerAttribute'

Fields

loadBalancerName :: Text
The name of the load balancer that you want to modify (e.g., my-load-balancer.
attributeName :: LoadBalancerAttributeName
The name of the attribute you want to update.
attributeValue :: Text
The value that you want to specify for the attribute name.
The following values are supported depending on what you specify for the attributeName request parameter:
- If you specify HealthCheckPath for the attributeName request parameter, then the attributeValue request parameter must be the path to ping on the target (for example, /weather/us/wa/seattle).
- If you specify SessionStickinessEnabled for the attributeName request parameter, then the attributeValue request parameter must be true to activate session stickiness or false to deactivate session stickiness.
- If you specify SessionStickiness_LB_CookieDurationSeconds for the attributeName request parameter, then the attributeValue request parameter must be an interger that represents the cookie duration in seconds.
- If you specify HttpsRedirectionEnabled for the attributeName request parameter, then the attributeValue request parameter must be true to activate HTTP to HTTPS redirection or false to deactivate HTTP to HTTPS redirection.
- If you specify TlsPolicyName for the attributeName request parameter, then the attributeValue request parameter must be the name of the TLS policy.
  Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can specify.

Instances

Instances details

ToJSON UpdateLoadBalancerAttribute Source #
Instance details Defined in Amazonka.Lightsail.UpdateLoadBalancerAttribute Methods toJSON :: UpdateLoadBalancerAttribute -> Value # toEncoding :: UpdateLoadBalancerAttribute -> Encoding # toJSONList :: [UpdateLoadBalancerAttribute] -> Value # toEncodingList :: [UpdateLoadBalancerAttribute] -> Encoding #
ToHeaders UpdateLoadBalancerAttribute Source #
Instance details Defined in Amazonka.Lightsail.UpdateLoadBalancerAttribute Methods toHeaders :: UpdateLoadBalancerAttribute -> [Header] #
ToPath UpdateLoadBalancerAttribute Source #
Instance details Defined in Amazonka.Lightsail.UpdateLoadBalancerAttribute Methods toPath :: UpdateLoadBalancerAttribute -> ByteString #
ToQuery UpdateLoadBalancerAttribute Source #
Instance details Defined in Amazonka.Lightsail.UpdateLoadBalancerAttribute Methods toQuery :: UpdateLoadBalancerAttribute -> QueryString #
AWSRequest UpdateLoadBalancerAttribute Source #
Instance details Defined in Amazonka.Lightsail.UpdateLoadBalancerAttribute Associated Types type AWSResponse UpdateLoadBalancerAttribute # Methods request :: (Service -> Service) -> UpdateLoadBalancerAttribute -> Request UpdateLoadBalancerAttribute # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateLoadBalancerAttribute -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateLoadBalancerAttribute))) #
Generic UpdateLoadBalancerAttribute Source #
Instance details Defined in Amazonka.Lightsail.UpdateLoadBalancerAttribute Associated Types type Rep UpdateLoadBalancerAttribute :: Type -> Type # Methods from :: UpdateLoadBalancerAttribute -> Rep UpdateLoadBalancerAttribute x # to :: Rep UpdateLoadBalancerAttribute x -> UpdateLoadBalancerAttribute #
Read UpdateLoadBalancerAttribute Source #
Instance details Defined in Amazonka.Lightsail.UpdateLoadBalancerAttribute Methods readsPrec :: Int -> ReadS UpdateLoadBalancerAttribute # readList :: ReadS [UpdateLoadBalancerAttribute] # readPrec :: ReadPrec UpdateLoadBalancerAttribute # readListPrec :: ReadPrec [UpdateLoadBalancerAttribute] #
Show UpdateLoadBalancerAttribute Source #
Instance details Defined in Amazonka.Lightsail.UpdateLoadBalancerAttribute Methods showsPrec :: Int -> UpdateLoadBalancerAttribute -> ShowS # show :: UpdateLoadBalancerAttribute -> String # showList :: [UpdateLoadBalancerAttribute] -> ShowS #
NFData UpdateLoadBalancerAttribute Source #
Instance details Defined in Amazonka.Lightsail.UpdateLoadBalancerAttribute Methods rnf :: UpdateLoadBalancerAttribute -> () #
Eq UpdateLoadBalancerAttribute Source #
Instance details Defined in Amazonka.Lightsail.UpdateLoadBalancerAttribute Methods (==) :: UpdateLoadBalancerAttribute -> UpdateLoadBalancerAttribute -> Bool # (/=) :: UpdateLoadBalancerAttribute -> UpdateLoadBalancerAttribute -> Bool #
Hashable UpdateLoadBalancerAttribute Source #
Instance details Defined in Amazonka.Lightsail.UpdateLoadBalancerAttribute Methods hashWithSalt :: Int -> UpdateLoadBalancerAttribute -> Int # hash :: UpdateLoadBalancerAttribute -> Int #
type AWSResponse UpdateLoadBalancerAttribute Source #
Instance details Defined in Amazonka.Lightsail.UpdateLoadBalancerAttribute type AWSResponse UpdateLoadBalancerAttribute = UpdateLoadBalancerAttributeResponse
type Rep UpdateLoadBalancerAttribute Source #
Instance details Defined in Amazonka.Lightsail.UpdateLoadBalancerAttribute type Rep UpdateLoadBalancerAttribute = D1 ('MetaData "UpdateLoadBalancerAttribute" "Amazonka.Lightsail.UpdateLoadBalancerAttribute" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "UpdateLoadBalancerAttribute'" 'PrefixI 'True) (S1 ('MetaSel ('Just "loadBalancerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "attributeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LoadBalancerAttributeName) :: S1 ('MetaSel ('Just "attributeValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateLoadBalancerAttribute Source #

Arguments

:: Text	`UpdateLoadBalancerAttribute`
-> LoadBalancerAttributeName	`$sel:attributeName:UpdateLoadBalancerAttribute'`
-> Text	`$sel:attributeValue:UpdateLoadBalancerAttribute'`
-> UpdateLoadBalancerAttribute

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

UpdateLoadBalancerAttribute, updateLoadBalancerAttribute_loadBalancerName - The name of the load balancer that you want to modify (e.g., my-load-balancer.

$sel:attributeName:UpdateLoadBalancerAttribute', updateLoadBalancerAttribute_attributeName - The name of the attribute you want to update.

$sel:attributeValue:UpdateLoadBalancerAttribute', updateLoadBalancerAttribute_attributeValue - The value that you want to specify for the attribute name.

The following values are supported depending on what you specify for the attributeName request parameter:

If you specify HealthCheckPath for the attributeName request parameter, then the attributeValue request parameter must be the path to ping on the target (for example, /weather/us/wa/seattle).
If you specify SessionStickinessEnabled for the attributeName request parameter, then the attributeValue request parameter must be true to activate session stickiness or false to deactivate session stickiness.
If you specify SessionStickiness_LB_CookieDurationSeconds for the attributeName request parameter, then the attributeValue request parameter must be an interger that represents the cookie duration in seconds.
If you specify HttpsRedirectionEnabled for the attributeName request parameter, then the attributeValue request parameter must be true to activate HTTP to HTTPS redirection or false to deactivate HTTP to HTTPS redirection.
If you specify TlsPolicyName for the attributeName request parameter, then the attributeValue request parameter must be the name of the TLS policy.
Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can specify.

Request Lenses

updateLoadBalancerAttribute_loadBalancerName :: Lens' UpdateLoadBalancerAttribute Text Source #

The name of the load balancer that you want to modify (e.g., my-load-balancer.

updateLoadBalancerAttribute_attributeName :: Lens' UpdateLoadBalancerAttribute LoadBalancerAttributeName Source #

The name of the attribute you want to update.

updateLoadBalancerAttribute_attributeValue :: Lens' UpdateLoadBalancerAttribute Text Source #

The value that you want to specify for the attribute name.

The following values are supported depending on what you specify for the attributeName request parameter:

If you specify HealthCheckPath for the attributeName request parameter, then the attributeValue request parameter must be the path to ping on the target (for example, /weather/us/wa/seattle).
If you specify SessionStickinessEnabled for the attributeName request parameter, then the attributeValue request parameter must be true to activate session stickiness or false to deactivate session stickiness.
If you specify SessionStickiness_LB_CookieDurationSeconds for the attributeName request parameter, then the attributeValue request parameter must be an interger that represents the cookie duration in seconds.
If you specify HttpsRedirectionEnabled for the attributeName request parameter, then the attributeValue request parameter must be true to activate HTTP to HTTPS redirection or false to deactivate HTTP to HTTPS redirection.
If you specify TlsPolicyName for the attributeName request parameter, then the attributeValue request parameter must be the name of the TLS policy.
Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can specify.

Destructuring the Response

data UpdateLoadBalancerAttributeResponse Source #

See: newUpdateLoadBalancerAttributeResponse smart constructor.

Constructors

UpdateLoadBalancerAttributeResponse'
Fields operations :: Maybe [Operation] An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateLoadBalancerAttributeResponse Source #
Instance details Defined in Amazonka.Lightsail.UpdateLoadBalancerAttribute Associated Types type Rep UpdateLoadBalancerAttributeResponse :: Type -> Type # Methods from :: UpdateLoadBalancerAttributeResponse -> Rep UpdateLoadBalancerAttributeResponse x # to :: Rep UpdateLoadBalancerAttributeResponse x -> UpdateLoadBalancerAttributeResponse #
Read UpdateLoadBalancerAttributeResponse Source #
Instance details Defined in Amazonka.Lightsail.UpdateLoadBalancerAttribute Methods readsPrec :: Int -> ReadS UpdateLoadBalancerAttributeResponse # readList :: ReadS [UpdateLoadBalancerAttributeResponse] # readPrec :: ReadPrec UpdateLoadBalancerAttributeResponse # readListPrec :: ReadPrec [UpdateLoadBalancerAttributeResponse] #
Show UpdateLoadBalancerAttributeResponse Source #
Instance details Defined in Amazonka.Lightsail.UpdateLoadBalancerAttribute Methods showsPrec :: Int -> UpdateLoadBalancerAttributeResponse -> ShowS # show :: UpdateLoadBalancerAttributeResponse -> String # showList :: [UpdateLoadBalancerAttributeResponse] -> ShowS #
NFData UpdateLoadBalancerAttributeResponse Source #
Instance details Defined in Amazonka.Lightsail.UpdateLoadBalancerAttribute Methods rnf :: UpdateLoadBalancerAttributeResponse -> () #
Eq UpdateLoadBalancerAttributeResponse Source #
Instance details Defined in Amazonka.Lightsail.UpdateLoadBalancerAttribute Methods (==) :: UpdateLoadBalancerAttributeResponse -> UpdateLoadBalancerAttributeResponse -> Bool # (/=) :: UpdateLoadBalancerAttributeResponse -> UpdateLoadBalancerAttributeResponse -> Bool #
type Rep UpdateLoadBalancerAttributeResponse Source #
Instance details Defined in Amazonka.Lightsail.UpdateLoadBalancerAttribute type Rep UpdateLoadBalancerAttributeResponse = D1 ('MetaData "UpdateLoadBalancerAttributeResponse" "Amazonka.Lightsail.UpdateLoadBalancerAttribute" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "UpdateLoadBalancerAttributeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "operations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Operation])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateLoadBalancerAttributeResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateLoadBalancerAttributeResponse'`
-> UpdateLoadBalancerAttributeResponse

Create a value of UpdateLoadBalancerAttributeResponse 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:operations:UpdateLoadBalancerAttributeResponse', updateLoadBalancerAttributeResponse_operations - An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

$sel:httpStatus:UpdateLoadBalancerAttributeResponse', updateLoadBalancerAttributeResponse_httpStatus - The response's http status code.

Response Lenses

updateLoadBalancerAttributeResponse_operations :: Lens' UpdateLoadBalancerAttributeResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

updateLoadBalancerAttributeResponse_httpStatus :: Lens' UpdateLoadBalancerAttributeResponse Int Source #

The response's http status code.