aws_sdk_lightsail/client/create_load_balancer.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`CreateLoadBalancer`](crate::operation::create_load_balancer::builders::CreateLoadBalancerFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`load_balancer_name(impl Into<String>)`](crate::operation::create_load_balancer::builders::CreateLoadBalancerFluentBuilder::load_balancer_name) / [`set_load_balancer_name(Option<String>)`](crate::operation::create_load_balancer::builders::CreateLoadBalancerFluentBuilder::set_load_balancer_name):<br>required: **true**<br><p>The name of your load balancer.</p><br>
7 /// - [`instance_port(i32)`](crate::operation::create_load_balancer::builders::CreateLoadBalancerFluentBuilder::instance_port) / [`set_instance_port(Option<i32>)`](crate::operation::create_load_balancer::builders::CreateLoadBalancerFluentBuilder::set_instance_port):<br>required: **true**<br><p>The instance port where you're creating your load balancer.</p><br>
8 /// - [`health_check_path(impl Into<String>)`](crate::operation::create_load_balancer::builders::CreateLoadBalancerFluentBuilder::health_check_path) / [`set_health_check_path(Option<String>)`](crate::operation::create_load_balancer::builders::CreateLoadBalancerFluentBuilder::set_health_check_path):<br>required: **false**<br><p>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 (<code>"/"</code>).</p> <p>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.</p><br>
9 /// - [`certificate_name(impl Into<String>)`](crate::operation::create_load_balancer::builders::CreateLoadBalancerFluentBuilder::certificate_name) / [`set_certificate_name(Option<String>)`](crate::operation::create_load_balancer::builders::CreateLoadBalancerFluentBuilder::set_certificate_name):<br>required: **false**<br><p>The name of the SSL/TLS certificate.</p> <p>If you specify <code>certificateName</code>, then <code>certificateDomainName</code> is required (and vice-versa).</p><br>
10 /// - [`certificate_domain_name(impl Into<String>)`](crate::operation::create_load_balancer::builders::CreateLoadBalancerFluentBuilder::certificate_domain_name) / [`set_certificate_domain_name(Option<String>)`](crate::operation::create_load_balancer::builders::CreateLoadBalancerFluentBuilder::set_certificate_domain_name):<br>required: **false**<br><p>The domain name with which your certificate is associated (<code>example.com</code>).</p> <p>If you specify <code>certificateDomainName</code>, then <code>certificateName</code> is required (and vice-versa).</p><br>
11 /// - [`certificate_alternative_names(impl Into<String>)`](crate::operation::create_load_balancer::builders::CreateLoadBalancerFluentBuilder::certificate_alternative_names) / [`set_certificate_alternative_names(Option<Vec::<String>>)`](crate::operation::create_load_balancer::builders::CreateLoadBalancerFluentBuilder::set_certificate_alternative_names):<br>required: **false**<br><p>The optional alternative domains and subdomains to use with your SSL/TLS certificate (<code>www.example.com</code>, <code>example.com</code>, <code>m.example.com</code>, <code>blog.example.com</code>).</p><br>
12 /// - [`tags(Tag)`](crate::operation::create_load_balancer::builders::CreateLoadBalancerFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_load_balancer::builders::CreateLoadBalancerFluentBuilder::set_tags):<br>required: **false**<br><p>The tag keys and optional values to add to the resource during create.</p> <p>Use the <code>TagResource</code> action to tag a resource after it's created.</p><br>
13 /// - [`ip_address_type(IpAddressType)`](crate::operation::create_load_balancer::builders::CreateLoadBalancerFluentBuilder::ip_address_type) / [`set_ip_address_type(Option<IpAddressType>)`](crate::operation::create_load_balancer::builders::CreateLoadBalancerFluentBuilder::set_ip_address_type):<br>required: **false**<br><p>The IP address type for the load balancer.</p> <p>The possible values are <code>ipv4</code> for IPv4 only, <code>ipv6</code> for IPv6 only, and <code>dualstack</code> for IPv4 and IPv6.</p> <p>The default value is <code>dualstack</code>.</p><br>
14 /// - [`tls_policy_name(impl Into<String>)`](crate::operation::create_load_balancer::builders::CreateLoadBalancerFluentBuilder::tls_policy_name) / [`set_tls_policy_name(Option<String>)`](crate::operation::create_load_balancer::builders::CreateLoadBalancerFluentBuilder::set_tls_policy_name):<br>required: **false**<br><p>The name of the TLS policy to apply to the load balancer.</p> <p>Use the <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetLoadBalancerTlsPolicies.html">GetLoadBalancerTlsPolicies</a> action to get a list of TLS policy names that you can specify.</p> <p>For more information about load balancer TLS policies, see <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configure-load-balancer-tls-security-policy">Configuring TLS security policies on your Amazon Lightsail load balancers</a> in the <i>Amazon Lightsail Developer Guide</i>.</p><br>
15 /// - On success, responds with [`CreateLoadBalancerOutput`](crate::operation::create_load_balancer::CreateLoadBalancerOutput) with field(s):
16 /// - [`operations(Option<Vec::<Operation>>)`](crate::operation::create_load_balancer::CreateLoadBalancerOutput::operations): <p>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.</p>
17 /// - On failure, responds with [`SdkError<CreateLoadBalancerError>`](crate::operation::create_load_balancer::CreateLoadBalancerError)
18 pub fn create_load_balancer(&self) -> crate::operation::create_load_balancer::builders::CreateLoadBalancerFluentBuilder {
19 crate::operation::create_load_balancer::builders::CreateLoadBalancerFluentBuilder::new(self.handle.clone())
20 }
21}