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

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.LoadBalancer

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

    Create LoadBalancer Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new LoadBalancer(name: string, args: LoadBalancerArgs, opts?: CustomResourceOptions);
    @overload
def LoadBalancer(resource_name: str,
                 args: LoadBalancerArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def LoadBalancer(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 instance_port: Optional[int] = None,
                 attached_instances: Optional[Sequence[str]] = None,
                 health_check_path: Optional[str] = None,
                 ip_address_type: Optional[str] = None,
                 load_balancer_name: Optional[str] = None,
                 session_stickiness_enabled: Optional[bool] = None,
                 session_stickiness_lb_cookie_duration_seconds: Optional[str] = None,
                 tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                 tls_policy_name: Optional[str] = None)
    func NewLoadBalancer(ctx *Context, name string, args LoadBalancerArgs, opts ...ResourceOption) (*LoadBalancer, error)
    public LoadBalancer(string name, LoadBalancerArgs args, CustomResourceOptions? opts = null)
    public LoadBalancer(String name, LoadBalancerArgs args)
public LoadBalancer(String name, LoadBalancerArgs args, CustomResourceOptions options)

    type: aws-native:lightsail:LoadBalancer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args LoadBalancerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args LoadBalancerArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args LoadBalancerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LoadBalancerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LoadBalancerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    LoadBalancer Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The LoadBalancer resource accepts the following input properties:

    InstancePort int
    The instance port where you're creating your 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., "/").
    IpAddressType string
    The IP address type for the load balancer. The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6. The default value is dualstack.
    LoadBalancerName string
    The name of your 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.Inputs.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.
    InstancePort int
    The instance port where you're creating your 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., "/").
    IpAddressType string
    The IP address type for the load balancer. The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6. The default value is dualstack.
    LoadBalancerName string
    The name of your load balancer.
    SessionStickinessEnabled bool
    Configuration option to enable session stickiness.
    SessionStickinessLbCookieDurationSeconds string
    Configuration option to adjust session stickiness cookie duration parameter.
    Tags TagArgs
    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.
    instancePort Integer
    The instance port where you're creating your 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., "/").
    ipAddressType String
    The IP address type for the load balancer. The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6. The default value is dualstack.
    loadBalancerName String
    The name of your 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.
    instancePort number
    The instance port where you're creating your 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., "/").
    ipAddressType string
    The IP address type for the load balancer. The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6. The default value is dualstack.
    loadBalancerName string
    The name of your 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.
    instance_port int
    The instance port where you're creating your 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., "/").
    ip_address_type str
    The IP address type for the load balancer. The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6. The default value is dualstack.
    load_balancer_name str
    The name of your 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[TagArgs]
    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.
    instancePort Number
    The instance port where you're creating your 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., "/").
    ipAddressType String
    The IP address type for the load balancer. The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6. The default value is dualstack.
    loadBalancerName String
    The name of your 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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LoadBalancer resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    LoadBalancerArn string
    The Amazon Resource Name (ARN) of the load balancer.
    Id string
    The provider-assigned unique ID for this managed resource.
    LoadBalancerArn string
    The Amazon Resource Name (ARN) of the load balancer.
    id String
    The provider-assigned unique ID for this managed resource.
    loadBalancerArn String
    The Amazon Resource Name (ARN) of the load balancer.
    id string
    The provider-assigned unique ID for this managed resource.
    loadBalancerArn string
    The Amazon Resource Name (ARN) of the load balancer.
    id str
    The provider-assigned unique ID for this managed resource.
    load_balancer_arn str
    The Amazon Resource Name (ARN) of the load balancer.
    id String
    The provider-assigned unique ID for this managed resource.
    loadBalancerArn String
    The Amazon Resource Name (ARN) of the load balancer.

    Supporting Types

    Tag, TagArgs

    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