Class CfnLoadBalancer
Specifies an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.
Inherited Members
Namespace: Amazon.CDK.AWS.ElasticLoadBalancingV2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnLoadBalancer : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnLoadBalancer
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
CloudformationResource: AWS::ElasticLoadBalancingV2::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.ElasticLoadBalancingV2;
var cfnLoadBalancer = new CfnLoadBalancer(this, "MyCfnLoadBalancer", new CfnLoadBalancerProps {
EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic = "enforceSecurityGroupInboundRulesOnPrivateLinkTraffic",
IpAddressType = "ipAddressType",
LoadBalancerAttributes = new [] { new LoadBalancerAttributeProperty {
Key = "key",
Value = "value"
} },
Name = "name",
Scheme = "scheme",
SecurityGroups = new [] { "securityGroups" },
SubnetMappings = new [] { new SubnetMappingProperty {
SubnetId = "subnetId",
// the properties below are optional
AllocationId = "allocationId",
IPv6Address = "iPv6Address",
PrivateIPv4Address = "privateIPv4Address"
} },
Subnets = new [] { "subnets" },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Type = "type"
});
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
AttrCanonicalHostedZoneId | The ID of the Amazon Route 53 hosted zone associated with the load balancer. |
AttrDnsName | The DNS name for the load balancer. |
AttrLoadBalancerArn | The Amazon Resource Name (ARN) of the load balancer. |
AttrLoadBalancerFullName | The full name of the load balancer. |
AttrLoadBalancerName | The name of the load balancer. |
AttrSecurityGroups | The IDs of the security groups for the load balancer. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic | Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through AWS PrivateLink . |
IpAddressType | Note: Internal load balancers must use the |
LoadBalancerAttributes | The load balancer attributes. |
Name | The name of the load balancer. |
Scheme | The nodes of an Internet-facing load balancer have public IP addresses. |
SecurityGroups | [Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer. |
SubnetMappings | The IDs of the subnets. |
Subnets | The IDs of the subnets. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | The tags to assign to the load balancer. |
Type | The type of 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 = null)
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
AttrCanonicalHostedZoneId
The ID of the Amazon Route 53 hosted zone associated with the load balancer.
public virtual string AttrCanonicalHostedZoneId { get; }
Property Value
System.String
Remarks
For example, Z2P70J7EXAMPLE
.
CloudformationAttribute: CanonicalHostedZoneID
AttrDnsName
The DNS name for the load balancer.
public virtual string AttrDnsName { get; }
Property Value
System.String
Remarks
For example, my-load-balancer-424835706.us-west-2.elb.amazonaws.com
.
CloudformationAttribute: DNSName
AttrLoadBalancerArn
The Amazon Resource Name (ARN) of the load balancer.
public virtual string AttrLoadBalancerArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LoadBalancerArn
AttrLoadBalancerFullName
The full name of the load balancer.
public virtual string AttrLoadBalancerFullName { get; }
Property Value
System.String
Remarks
For example, app/my-load-balancer/50dc6c495c0c9188
.
CloudformationAttribute: LoadBalancerFullName
AttrLoadBalancerName
The name of the load balancer.
public virtual string AttrLoadBalancerName { get; }
Property Value
System.String
Remarks
For example, my-load-balancer
.
CloudformationAttribute: LoadBalancerName
AttrSecurityGroups
The IDs of the security groups for the load balancer.
public virtual string[] AttrSecurityGroups { get; }
Property Value
System.String[]
Remarks
CloudformationAttribute: SecurityGroups
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
EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic
Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through AWS PrivateLink .
public virtual string EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic { get; set; }
Property Value
System.String
IpAddressType
Note: Internal load balancers must use the ipv4
IP address type.
public virtual string IpAddressType { get; set; }
Property Value
System.String
LoadBalancerAttributes
The load balancer attributes.
public virtual object LoadBalancerAttributes { get; set; }
Property Value
System.Object
Name
The name of the load balancer.
public virtual string Name { get; set; }
Property Value
System.String
Scheme
The nodes of an Internet-facing load balancer have public IP addresses.
public virtual string Scheme { get; set; }
Property Value
System.String
SecurityGroups
[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.
public virtual string[] SecurityGroups { get; set; }
Property Value
System.String[]
SubnetMappings
The IDs of the subnets.
public virtual object SubnetMappings { get; set; }
Property Value
System.Object
Subnets
The IDs of the subnets.
public virtual string[] Subnets { get; set; }
Property Value
System.String[]
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The tags to assign to the load balancer.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Type
The type of load balancer.
public virtual string Type { get; set; }
Property Value
System.String
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>