Network.AWS.Lightsail.CreateLoadBalancer

Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing . You can create up to 5 load balancers per AWS Region in your account.

When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the UpdateLoadBalancerAttribute operation.

Creating a Request

createLoadBalancer

Arguments

:: Text

clbLoadBalancerName

-> Natural

clbInstancePort

-> CreateLoadBalancer

Creates a value of CreateLoadBalancer with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• clbHealthCheckPath - The path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (e.g., "/" ). You may want to specify a custom health check path other than the root of your application if your home page loads slowly or has a lot of media or scripting on it.
• clbCertificateName - The name of the SSL/TLS certificate. If you specify certificateName , then certificateDomainName is required (and vice-versa).
• clbCertificateDomainName - The domain name with which your certificate is associated (e.g., example.com ). If you specify certificateDomainName , then certificateName is required (and vice-versa).
• clbCertificateAlternativeNames - The optional alternative domains and subdomains to use with your SSL/TLS certificate (e.g., www.example.com , example.com , m.example.com , blog.example.com ).
• clbLoadBalancerName - The name of your load balancer.
• clbInstancePort - The instance port where you're creating your load balancer.

data CreateLoadBalancer

See: createLoadBalancer smart constructor.

Instances

Eq CreateLoadBalancer

Methods

(==) :: CreateLoadBalancer -> CreateLoadBalancer -> Bool

(/=) :: CreateLoadBalancer -> CreateLoadBalancer -> Bool

Data CreateLoadBalancer

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateLoadBalancer -> c CreateLoadBalancer

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateLoadBalancer

toConstr :: CreateLoadBalancer -> Constr

dataTypeOf :: CreateLoadBalancer -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateLoadBalancer)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateLoadBalancer)

gmapT :: (forall b. Data b => b -> b) -> CreateLoadBalancer -> CreateLoadBalancer

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateLoadBalancer -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateLoadBalancer -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateLoadBalancer -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateLoadBalancer -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateLoadBalancer -> m CreateLoadBalancer

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateLoadBalancer -> m CreateLoadBalancer

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateLoadBalancer -> m CreateLoadBalancer

Read CreateLoadBalancer

Methods

readsPrec :: Int -> ReadS CreateLoadBalancer

readList :: ReadS [CreateLoadBalancer]

readPrec :: ReadPrec CreateLoadBalancer

readListPrec :: ReadPrec [CreateLoadBalancer]

Show CreateLoadBalancer

Methods

showsPrec :: Int -> CreateLoadBalancer -> ShowS

show :: CreateLoadBalancer -> String

showList :: [CreateLoadBalancer] -> ShowS

Generic CreateLoadBalancer

Associated Types

type Rep CreateLoadBalancer :: * -> *

Methods

from :: CreateLoadBalancer -> Rep CreateLoadBalancer x

to :: Rep CreateLoadBalancer x -> CreateLoadBalancer

Hashable CreateLoadBalancer

Methods

hashWithSalt :: Int -> CreateLoadBalancer -> Int

hash :: CreateLoadBalancer -> Int

ToJSON CreateLoadBalancer

Methods

toJSON :: CreateLoadBalancer -> Value

toEncoding :: CreateLoadBalancer -> Encoding

toJSONList :: [CreateLoadBalancer] -> Value

toEncodingList :: [CreateLoadBalancer] -> Encoding

NFData CreateLoadBalancer

Methods

rnf :: CreateLoadBalancer -> ()

AWSRequest CreateLoadBalancer

Associated Types

type Rs CreateLoadBalancer :: *

Methods

request :: CreateLoadBalancer -> Request CreateLoadBalancer

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * CreateLoadBalancer -> ClientResponse -> m (Response CreateLoadBalancer)

ToHeaders CreateLoadBalancer

Methods

toHeaders :: CreateLoadBalancer -> [Header]

ToPath CreateLoadBalancer

Methods

toPath :: CreateLoadBalancer -> ByteString

ToQuery CreateLoadBalancer

Methods

toQuery :: CreateLoadBalancer -> QueryString

type Rep CreateLoadBalancer

type Rep CreateLoadBalancer = D1 * (MetaData "CreateLoadBalancer" "Network.AWS.Lightsail.CreateLoadBalancer" "amazonka-lightsail-1.6.0-ARMP2uYvcAnENqDU8iFIes" False) (C1 * (MetaCons "CreateLoadBalancer'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_clbHealthCheckPath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_clbCertificateName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_clbCertificateDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_clbCertificateAlternativeNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_clbLoadBalancerName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_clbInstancePort") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Nat))))))

type Rs CreateLoadBalancer

type Rs CreateLoadBalancer = CreateLoadBalancerResponse

Request Lenses

clbHealthCheckPath :: Lens' CreateLoadBalancer (Maybe Text)

The path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (e.g., "/" ). You may want to specify a custom health check path other than the root of your application if your home page loads slowly or has a lot of media or scripting on it.

clbCertificateName :: Lens' CreateLoadBalancer (Maybe Text)

The name of the SSL/TLS certificate. If you specify certificateName , then certificateDomainName is required (and vice-versa).

clbCertificateDomainName :: Lens' CreateLoadBalancer (Maybe Text)

The domain name with which your certificate is associated (e.g., example.com ). If you specify certificateDomainName , then certificateName is required (and vice-versa).

clbCertificateAlternativeNames :: Lens' CreateLoadBalancer [Text]

The optional alternative domains and subdomains to use with your SSL/TLS certificate (e.g., www.example.com , example.com , m.example.com , blog.example.com ).

clbLoadBalancerName :: Lens' CreateLoadBalancer Text

The name of your load balancer.

clbInstancePort :: Lens' CreateLoadBalancer Natural

The instance port where you're creating your load balancer.

Destructuring the Response

createLoadBalancerResponse

Arguments

:: Int

clbrsResponseStatus

-> CreateLoadBalancerResponse

Creates a value of CreateLoadBalancerResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• clbrsOperations - An object containing information about the API operations.
• clbrsResponseStatus - -- | The response status code.

data CreateLoadBalancerResponse

See: createLoadBalancerResponse smart constructor.

Instances

Eq CreateLoadBalancerResponse

Methods

(==) :: CreateLoadBalancerResponse -> CreateLoadBalancerResponse -> Bool

(/=) :: CreateLoadBalancerResponse -> CreateLoadBalancerResponse -> Bool

Data CreateLoadBalancerResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateLoadBalancerResponse -> c CreateLoadBalancerResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateLoadBalancerResponse

toConstr :: CreateLoadBalancerResponse -> Constr

dataTypeOf :: CreateLoadBalancerResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateLoadBalancerResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateLoadBalancerResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateLoadBalancerResponse -> CreateLoadBalancerResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateLoadBalancerResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateLoadBalancerResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateLoadBalancerResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateLoadBalancerResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateLoadBalancerResponse -> m CreateLoadBalancerResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateLoadBalancerResponse -> m CreateLoadBalancerResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateLoadBalancerResponse -> m CreateLoadBalancerResponse

Read CreateLoadBalancerResponse

Methods

readsPrec :: Int -> ReadS CreateLoadBalancerResponse

readList :: ReadS [CreateLoadBalancerResponse]

readPrec :: ReadPrec CreateLoadBalancerResponse

readListPrec :: ReadPrec [CreateLoadBalancerResponse]

Show CreateLoadBalancerResponse

Methods

showsPrec :: Int -> CreateLoadBalancerResponse -> ShowS

show :: CreateLoadBalancerResponse -> String

showList :: [CreateLoadBalancerResponse] -> ShowS

Generic CreateLoadBalancerResponse

Associated Types

type Rep CreateLoadBalancerResponse :: * -> *

Methods

from :: CreateLoadBalancerResponse -> Rep CreateLoadBalancerResponse x

to :: Rep CreateLoadBalancerResponse x -> CreateLoadBalancerResponse

NFData CreateLoadBalancerResponse

Methods

rnf :: CreateLoadBalancerResponse -> ()

type Rep CreateLoadBalancerResponse

type Rep CreateLoadBalancerResponse = D1 * (MetaData "CreateLoadBalancerResponse" "Network.AWS.Lightsail.CreateLoadBalancer" "amazonka-lightsail-1.6.0-ARMP2uYvcAnENqDU8iFIes" False) (C1 * (MetaCons "CreateLoadBalancerResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_clbrsOperations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Operation]))) (S1 * (MetaSel (Just Symbol "_clbrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

clbrsOperations :: Lens' CreateLoadBalancerResponse [Operation]

An object containing information about the API operations.

clbrsResponseStatus :: Lens' CreateLoadBalancerResponse Int

• - | The response status code.