Interface ICfnLoadBalancerProps

Properties for defining a CfnLoadBalancer.

Namespace: Amazon.CDK.AWS.Lightsail

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnLoadBalancerProps

Syntax (vb)

Public Interface ICfnLoadBalancerProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Lightsail;

             var cfnLoadBalancerProps = new CfnLoadBalancerProps {
                 InstancePort = 123,
                 LoadBalancerName = "loadBalancerName",

                 // the properties below are optional
                 AttachedInstances = new [] { "attachedInstances" },
                 HealthCheckPath = "healthCheckPath",
                 IpAddressType = "ipAddressType",
                 SessionStickinessEnabled = false,
                 SessionStickinessLbCookieDurationSeconds = "sessionStickinessLbCookieDurationSeconds",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TlsPolicyName = "tlsPolicyName"
             };

Synopsis

Properties

AttachedInstances	The Lightsail instances to attach to the load balancer.
HealthCheckPath	The path on the attached instance where the health check will be performed.
InstancePort	The port that the load balancer uses to direct traffic to your Lightsail instances.
IpAddressType	The IP address type of the load balancer.
LoadBalancerName	The name of the load balancer.
SessionStickinessEnabled	A Boolean value indicating whether session stickiness is enabled.
SessionStickinessLbCookieDurationSeconds	The time period, in seconds, after which the load balancer session stickiness cookie should be considered stale.
Tags	An array of key-value pairs to apply to this resource.
TlsPolicyName	The name of the TLS security policy for the load balancer.

Properties

AttachedInstances

The Lightsail instances to attach to the load balancer.

string[]? AttachedInstances { get; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#cfn-lightsail-loadbalancer-attachedinstances

HealthCheckPath

The path on the attached instance where the health check will be performed.

string? HealthCheckPath { get; }

Property Value

string

Remarks

If no path is specified, the load balancer tries to make a request to the default (root) page ( /index.html ).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#cfn-lightsail-loadbalancer-healthcheckpath

InstancePort

The port that the load balancer uses to direct traffic to your Lightsail instances.

double InstancePort { get; }

Property Value

double

Remarks

For HTTP traffic, specify port 80 . For HTTPS traffic, specify port 443 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#cfn-lightsail-loadbalancer-instanceport

IpAddressType

The IP address type of the load balancer.

string? IpAddressType { get; }

Property Value

string

Remarks

The possible values are ipv4 for IPv4 only, and dualstack for both IPv4 and IPv6.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#cfn-lightsail-loadbalancer-ipaddresstype

LoadBalancerName

The name of the load balancer.

string LoadBalancerName { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#cfn-lightsail-loadbalancer-loadbalancername

SessionStickinessEnabled

A Boolean value indicating whether session stickiness is enabled.

object? SessionStickinessEnabled { get; }

Property Value

object

Remarks

Enable session stickiness (also known as session affinity ) to bind a user's session to a specific instance. This ensures that all requests from the user during the session are sent to the same instance.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#cfn-lightsail-loadbalancer-sessionstickinessenabled

SessionStickinessLbCookieDurationSeconds

The time period, in seconds, after which the load balancer session stickiness cookie should be considered stale.

string? SessionStickinessLbCookieDurationSeconds { get; }

Property Value

string

Remarks

If you do not specify this parameter, the default value is 0, which indicates that the sticky session should last for the duration of the browser session.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#cfn-lightsail-loadbalancer-sessionstickinesslbcookiedurationseconds

Tags

An array of key-value pairs to apply to this resource.

ICfnTag[]? Tags { get; }

Property Value

ICfnTag[]

Remarks

For more information, see Tag in the AWS CloudFormation User Guide .

The <code>Value</code> of <code>Tags</code> is optional for Lightsail resources.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#cfn-lightsail-loadbalancer-tags

TlsPolicyName

The name of the TLS security policy for the load balancer.

string? TlsPolicyName { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#cfn-lightsail-loadbalancer-tlspolicyname