Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. lightsail
  5. getLoadBalancer

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.lightsail.getLoadBalancer

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Lightsail::LoadBalancer

    Using getLoadBalancer

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getLoadBalancer(args: GetLoadBalancerArgs, opts?: InvokeOptions): Promise<GetLoadBalancerResult>
function getLoadBalancerOutput(args: GetLoadBalancerOutputArgs, opts?: InvokeOptions): Output<GetLoadBalancerResult>
    def get_load_balancer(load_balancer_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetLoadBalancerResult
def get_load_balancer_output(load_balancer_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetLoadBalancerResult]
    func LookupLoadBalancer(ctx *Context, args *LookupLoadBalancerArgs, opts ...InvokeOption) (*LookupLoadBalancerResult, error)
func LookupLoadBalancerOutput(ctx *Context, args *LookupLoadBalancerOutputArgs, opts ...InvokeOption) LookupLoadBalancerResultOutput

    > Note: This function is named LookupLoadBalancer in the Go SDK.

    public static class GetLoadBalancer 
{
    public static Task<GetLoadBalancerResult> InvokeAsync(GetLoadBalancerArgs args, InvokeOptions? opts = null)
    public static Output<GetLoadBalancerResult> Invoke(GetLoadBalancerInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetLoadBalancerResult> getLoadBalancer(GetLoadBalancerArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:lightsail:getLoadBalancer
  arguments:
    # arguments dictionary

    The following arguments are supported:

    LoadBalancerName string
    The name of your load balancer.
    LoadBalancerName string
    The name of your load balancer.
    loadBalancerName String
    The name of your load balancer.
    loadBalancerName string
    The name of your load balancer.
    load_balancer_name str
    The name of your load balancer.
    loadBalancerName String
    The name of your load balancer.

    getLoadBalancer Result

    The following output properties are available:

    AttachedInstances List<string>
    The names of the instances attached to the load balancer.
    HealthCheckPath string
    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., "/").
    LoadBalancerArn string
    The Amazon Resource Name (ARN) of the load balancer.
    SessionStickinessEnabled bool
    Configuration option to enable session stickiness.
    SessionStickinessLbCookieDurationSeconds string
    Configuration option to adjust session stickiness cookie duration parameter.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    TlsPolicyName string
    The name of the TLS policy to apply to the load balancer.
    AttachedInstances []string
    The names of the instances attached to the load balancer.
    HealthCheckPath string
    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., "/").
    LoadBalancerArn string
    The Amazon Resource Name (ARN) of the load balancer.
    SessionStickinessEnabled bool
    Configuration option to enable session stickiness.
    SessionStickinessLbCookieDurationSeconds string
    Configuration option to adjust session stickiness cookie duration parameter.
    Tags Tag
    An array of key-value pairs to apply to this resource.
    TlsPolicyName string
    The name of the TLS policy to apply to the load balancer.
    attachedInstances List<String>
    The names of the instances attached to the load balancer.
    healthCheckPath String
    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., "/").
    loadBalancerArn String
    The Amazon Resource Name (ARN) of the load balancer.
    sessionStickinessEnabled Boolean
    Configuration option to enable session stickiness.
    sessionStickinessLbCookieDurationSeconds String
    Configuration option to adjust session stickiness cookie duration parameter.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    tlsPolicyName String
    The name of the TLS policy to apply to the load balancer.
    attachedInstances string[]
    The names of the instances attached to the load balancer.
    healthCheckPath string
    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., "/").
    loadBalancerArn string
    The Amazon Resource Name (ARN) of the load balancer.
    sessionStickinessEnabled boolean
    Configuration option to enable session stickiness.
    sessionStickinessLbCookieDurationSeconds string
    Configuration option to adjust session stickiness cookie duration parameter.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    tlsPolicyName string
    The name of the TLS policy to apply to the load balancer.
    attached_instances Sequence[str]
    The names of the instances attached to the load balancer.
    health_check_path str
    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., "/").
    load_balancer_arn str
    The Amazon Resource Name (ARN) of the load balancer.
    session_stickiness_enabled bool
    Configuration option to enable session stickiness.
    session_stickiness_lb_cookie_duration_seconds str
    Configuration option to adjust session stickiness cookie duration parameter.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    tls_policy_name str
    The name of the TLS policy to apply to the load balancer.
    attachedInstances List<String>
    The names of the instances attached to the load balancer.
    healthCheckPath String
    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., "/").
    loadBalancerArn String
    The Amazon Resource Name (ARN) of the load balancer.
    sessionStickinessEnabled Boolean
    Configuration option to enable session stickiness.
    sessionStickinessLbCookieDurationSeconds String
    Configuration option to adjust session stickiness cookie duration parameter.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    tlsPolicyName String
    The name of the TLS policy to apply to the load balancer.

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native