Class CfnLoadBalancer
Specifies a Classic Load Balancer.
Inherited Members
Namespace: Amazon.CDK.AWS.ElasticLoadBalancing
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnLoadBalancer : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnLoadBalancer
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
If this resource has a public IP address and is also in a VPC that is defined in the same template, you must use the DependsOn attribute to declare a dependency on the VPC-gateway attachment.
CloudformationResource: AWS::ElasticLoadBalancing::LoadBalancer
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.ElasticLoadBalancing;
var attributes;
var cfnLoadBalancer = new CfnLoadBalancer(this, "MyCfnLoadBalancer", 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"
} }
});
Synopsis
Constructors
CfnLoadBalancer(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnLoadBalancer(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnLoadBalancer(Construct, String, ICfnLoadBalancerProps) |
Properties
AccessLoggingPolicy | Information about where and how access logs are stored for the load balancer. |
AppCookieStickinessPolicy | Information about a policy for application-controlled session stickiness. |
AttrCanonicalHostedZoneName | The name of the Route 53 hosted zone that is associated with the load balancer. |
AttrCanonicalHostedZoneNameId | The ID of the Route 53 hosted zone name that is associated with the load balancer. |
AttrDnsName | The DNS name for the load balancer. |
AttrId | |
AttrSourceSecurityGroupGroupName | The name of the security group that you can use as part of your inbound rules for your load balancer's back-end instances. |
AttrSourceSecurityGroupOwnerAlias | The owner of the source security group. |
AvailabilityZones | The Availability Zones for a load balancer in a default VPC. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ConnectionDrainingPolicy | If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance. |
ConnectionSettings | If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration. |
CrossZone | If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones. |
HealthCheck | The health check settings to use when evaluating the health of your EC2 instances. |
Instances | The IDs of the instances for the load balancer. |
LbCookieStickinessPolicy | Information about a policy for duration-based session stickiness. |
Listeners | The listeners for the load balancer. |
LoadBalancerName | The name of the load balancer. |
Policies | The policies defined for your Classic Load Balancer. |
Scheme | The type of load balancer. |
SecurityGroups | The security groups for the load balancer. |
Subnets | The IDs of the subnets for the load balancer. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | The tags associated with a load balancer. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnLoadBalancer(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnLoadBalancer(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnLoadBalancer(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnLoadBalancer(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnLoadBalancer(Construct, String, ICfnLoadBalancerProps)
public CfnLoadBalancer(Construct scope, string id, ICfnLoadBalancerProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnLoadBalancerProps
Resource properties.
Properties
AccessLoggingPolicy
Information about where and how access logs are stored for the load balancer.
public virtual object AccessLoggingPolicy { get; set; }
Property Value
System.Object
AppCookieStickinessPolicy
Information about a policy for application-controlled session stickiness.
public virtual object AppCookieStickinessPolicy { get; set; }
Property Value
System.Object
AttrCanonicalHostedZoneName
The name of the Route 53 hosted zone that is associated with the load balancer.
public virtual string AttrCanonicalHostedZoneName { get; }
Property Value
System.String
Remarks
Internal-facing load balancers don't use this value, use DNSName
instead.
CloudformationAttribute: CanonicalHostedZoneName
AttrCanonicalHostedZoneNameId
The ID of the Route 53 hosted zone name that is associated with the load balancer.
public virtual string AttrCanonicalHostedZoneNameId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CanonicalHostedZoneNameID
AttrDnsName
The DNS name for the load balancer.
public virtual string AttrDnsName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DNSName
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AttrSourceSecurityGroupGroupName
The name of the security group that you can use as part of your inbound rules for your load balancer's back-end instances.
public virtual string AttrSourceSecurityGroupGroupName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SourceSecurityGroup.GroupName
AttrSourceSecurityGroupOwnerAlias
The owner of the source security group.
public virtual string AttrSourceSecurityGroupOwnerAlias { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SourceSecurityGroup.OwnerAlias
AvailabilityZones
The Availability Zones for a load balancer in a default VPC.
public virtual string[] AvailabilityZones { get; set; }
Property Value
System.String[]
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ConnectionDrainingPolicy
If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance.
public virtual object ConnectionDrainingPolicy { get; set; }
Property Value
System.Object
ConnectionSettings
If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.
public virtual object ConnectionSettings { get; set; }
Property Value
System.Object
CrossZone
If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.
public virtual object CrossZone { get; set; }
Property Value
System.Object
HealthCheck
The health check settings to use when evaluating the health of your EC2 instances.
public virtual object HealthCheck { get; set; }
Property Value
System.Object
Instances
The IDs of the instances for the load balancer.
public virtual string[] Instances { get; set; }
Property Value
System.String[]
LbCookieStickinessPolicy
Information about a policy for duration-based session stickiness.
public virtual object LbCookieStickinessPolicy { get; set; }
Property Value
System.Object
Listeners
The listeners for the load balancer.
public virtual object Listeners { get; set; }
Property Value
System.Object
Remarks
You can specify at most one listener per port.
LoadBalancerName
The name of the load balancer.
public virtual string LoadBalancerName { get; set; }
Property Value
System.String
Policies
The policies defined for your Classic Load Balancer.
public virtual object Policies { get; set; }
Property Value
System.Object
Scheme
The type of load balancer.
public virtual string Scheme { get; set; }
Property Value
System.String
Remarks
Valid only for load balancers in a VPC.
SecurityGroups
The security groups for the load balancer.
public virtual string[] SecurityGroups { get; set; }
Property Value
System.String[]
Subnets
The IDs of the subnets for the load balancer.
public virtual string[] Subnets { get; set; }
Property Value
System.String[]
Remarks
You can specify at most one subnet per Availability Zone.
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The tags associated with a load balancer.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>