Interface ICfnLoadBalancerProps
- Namespace
- Amazon.CDK.AWS.ElasticLoadBalancing
- Assembly
- Amazon.CDK.AWS.ElasticLoadBalancing.dll
Properties for defining a CfnLoadBalancer.
public interface ICfnLoadBalancerPropsExamples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ElasticLoadBalancing;
var attributes;
var cfnLoadBalancerProps = new CfnLoadBalancerProps {
Listeners = new [] { new ListenersProperty {
InstancePort = "instancePort",
LoadBalancerPort = "loadBalancerPort",
Protocol = "protocol",
// the properties below are optional
InstanceProtocol = "instanceProtocol",
PolicyNames = new [] { "policyNames" },
SslCertificateId = "sslCertificateId"
} },
// the properties below are optional
AccessLoggingPolicy = new AccessLoggingPolicyProperty {
Enabled = false,
S3BucketName = "s3BucketName",
// the properties below are optional
EmitInterval = 123,
S3BucketPrefix = "s3BucketPrefix"
},
AppCookieStickinessPolicy = new [] { new AppCookieStickinessPolicyProperty {
CookieName = "cookieName",
PolicyName = "policyName"
} },
AvailabilityZones = new [] { "availabilityZones" },
ConnectionDrainingPolicy = new ConnectionDrainingPolicyProperty {
Enabled = false,
// the properties below are optional
Timeout = 123
},
ConnectionSettings = new ConnectionSettingsProperty {
IdleTimeout = 123
},
CrossZone = false,
HealthCheck = new HealthCheckProperty {
HealthyThreshold = "healthyThreshold",
Interval = "interval",
Target = "target",
Timeout = "timeout",
UnhealthyThreshold = "unhealthyThreshold"
},
Instances = new [] { "instances" },
LbCookieStickinessPolicy = new [] { new LBCookieStickinessPolicyProperty {
CookieExpirationPeriod = "cookieExpirationPeriod",
PolicyName = "policyName"
} },
LoadBalancerName = "loadBalancerName",
Policies = new [] { new PoliciesProperty {
Attributes = new [] { attributes },
PolicyName = "policyName",
PolicyType = "policyType",
// the properties below are optional
InstancePorts = new [] { "instancePorts" },
LoadBalancerPorts = new [] { "loadBalancerPorts" }
} },
Scheme = "scheme",
SecurityGroups = new [] { "securityGroups" },
Subnets = new [] { "subnets" },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};Remarks
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html
ExampleMetadata: fixture=_generated
Properties
AccessLoggingPolicy
Information about where and how access logs are stored for the load balancer.
object? AccessLoggingPolicy { get; }Property Value
Remarks
AppCookieStickinessPolicy
Information about a policy for application-controlled session stickiness.
object? AppCookieStickinessPolicy { get; }Property Value
Remarks
AvailabilityZones
The Availability Zones for the load balancer. For load balancers in a VPC, specify Subnets instead.
string[]? AvailabilityZones { get; }Property Value
- string[]
Remarks
Update requires replacement if you did not previously specify an Availability Zone or if you are removing all Availability Zones. Otherwise, update requires no interruption.
ConnectionDrainingPolicy
If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance.
object? ConnectionDrainingPolicy { get; }Property Value
Remarks
For more information, see Configure Connection Draining in the Classic Load Balancers Guide .
ConnectionSettings
If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.
object? ConnectionSettings { get; }Property Value
Remarks
By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. For more information, see Configure Idle Connection Timeout in the Classic Load Balancers Guide .
CrossZone
If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.
object? CrossZone { get; }Property Value
Remarks
For more information, see Configure Cross-Zone Load Balancing in the Classic Load Balancers Guide .
HealthCheck
The health check settings to use when evaluating the health of your EC2 instances.
object? HealthCheck { get; }Property Value
Remarks
Update requires replacement if you did not previously specify health check settings or if you are removing the health check settings. Otherwise, update requires no interruption.
Instances
The IDs of the instances for the load balancer.
string[]? Instances { get; }Property Value
- string[]
Remarks
LbCookieStickinessPolicy
Information about a policy for duration-based session stickiness.
object? LbCookieStickinessPolicy { get; }Property Value
Remarks
Listeners
The listeners for the load balancer. You can specify at most one listener per port.
object Listeners { get; }Property Value
Remarks
If you update the properties for a listener, AWS CloudFormation deletes the existing listener and creates a new one with the specified properties. While the new listener is being created, clients cannot connect to the load balancer.
LoadBalancerName
The name of the load balancer.
string? LoadBalancerName { get; }Property Value
Remarks
This name must be unique within your set of load balancers for the region.
If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. For more information, see Name Type . If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name.
Policies
The policies defined for your Classic Load Balancer.
object? Policies { get; }Property Value
Remarks
Specify only back-end server policies.
Scheme
The type of load balancer. Valid only for load balancers in a VPC.
string? Scheme { get; }Property Value
Remarks
If Scheme is internet-facing , the load balancer has a public DNS name that resolves to a public IP address.
If Scheme is internal , the load balancer has a public DNS name that resolves to a private IP address.
SecurityGroups
The security groups for the load balancer.
string[]? SecurityGroups { get; }Property Value
- string[]
Remarks
Valid only for load balancers in a VPC.
Subnets
The IDs of the subnets for the load balancer. You can specify at most one subnet per Availability Zone.
string[]? Subnets { get; }Property Value
- string[]
Remarks
Update requires replacement if you did not previously specify a subnet or if you are removing all subnets. Otherwise, update requires no interruption. To update to a different subnet in the current Availability Zone, you must first update to a subnet in a different Availability Zone, then update to the new subnet in the original Availability Zone.
Tags
The tags associated with a load balancer.
ICfnTag[]? Tags { get; }Property Value
- ICfnTag[]