Class TargetGroupBase
Define the target of a load balancer.
Inherited Members
Namespace: Amazon.CDK.AWS.ElasticLoadBalancingV2
Assembly: Amazon.CDK.AWS.ElasticLoadBalancingV2.dll
Syntax (csharp)
public abstract class TargetGroupBase : Construct, ITargetGroup, IConstruct, IDependable
Syntax (vb)
Public MustInherit Class TargetGroupBase
Inherits Construct
Implements ITargetGroup, IConstruct, IDependable
Synopsis
Constructors
TargetGroupBase(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
TargetGroupBase(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
TargetGroupBase(Construct, String, IBaseTargetGroupProps, Object) |
Properties
DefaultPort | Default port configured for members of this target group. |
FirstLoadBalancerFullName | Full name of first load balancer. |
HealthCheck | |
LoadBalancerArns | A token representing a list of ARNs of the load balancers that route traffic to this target group. |
LoadBalancerAttached | List of constructs that need to be depended on to ensure the TargetGroup is associated to a load balancer. |
LoadBalancerAttachedDependencies | Configurable dependable with all resources that lead to load balancer attachment. |
TargetGroupArn | The ARN of the target group. |
TargetGroupFullName | The full name of the target group. |
TargetGroupLoadBalancerArns | ARNs of load balancers load balancing to this TargetGroup. |
TargetGroupName | The name of the target group. |
TargetType | The types of the directly registered members of this target group. |
Methods
AddLoadBalancerTarget(ILoadBalancerTargetProps) | Register the given load balancing target as part of this group. |
ConfigureHealthCheck(IHealthCheck) | Set/replace the target group's health check. |
SetAttribute(String, String) | Set a non-standard attribute on the target group. |
Validate() | Validate the current construct. |
Constructors
TargetGroupBase(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected TargetGroupBase(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
TargetGroupBase(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected TargetGroupBase(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
TargetGroupBase(Construct, String, IBaseTargetGroupProps, Object)
protected TargetGroupBase(Construct scope, string id, IBaseTargetGroupProps baseProps, object additionalProps)
Parameters
- scope Constructs.Construct
- id System.String
- baseProps IBaseTargetGroupProps
- additionalProps System.Object
Properties
DefaultPort
Default port configured for members of this target group.
protected virtual double DefaultPort { get; }
Property Value
System.Double
FirstLoadBalancerFullName
Full name of first load balancer.
public abstract string FirstLoadBalancerFullName { get; }
Property Value
System.String
Remarks
This identifier is emitted as a dimensions of the metrics of this target group.
Example value: app/my-load-balancer/123456789
HealthCheck
LoadBalancerArns
A token representing a list of ARNs of the load balancers that route traffic to this target group.
public virtual string LoadBalancerArns { get; }
Property Value
System.String
LoadBalancerAttached
List of constructs that need to be depended on to ensure the TargetGroup is associated to a load balancer.
public virtual IDependable LoadBalancerAttached { get; }
Property Value
LoadBalancerAttachedDependencies
Configurable dependable with all resources that lead to load balancer attachment.
protected virtual ConcreteDependable LoadBalancerAttachedDependencies { get; }
Property Value
TargetGroupArn
The ARN of the target group.
public virtual string TargetGroupArn { get; }
Property Value
System.String
TargetGroupFullName
The full name of the target group.
public virtual string TargetGroupFullName { get; }
Property Value
System.String
TargetGroupLoadBalancerArns
ARNs of load balancers load balancing to this TargetGroup.
public virtual string[] TargetGroupLoadBalancerArns { get; }
Property Value
System.String[]
TargetGroupName
The name of the target group.
public virtual string TargetGroupName { get; }
Property Value
System.String
TargetType
The types of the directly registered members of this target group.
protected virtual Nullable<TargetType> TargetType { get; set; }
Property Value
System.Nullable<TargetType>
Methods
AddLoadBalancerTarget(ILoadBalancerTargetProps)
Register the given load balancing target as part of this group.
protected virtual void AddLoadBalancerTarget(ILoadBalancerTargetProps props)
Parameters
- props ILoadBalancerTargetProps
ConfigureHealthCheck(IHealthCheck)
Set/replace the target group's health check.
public virtual void ConfigureHealthCheck(IHealthCheck healthCheck)
Parameters
- healthCheck IHealthCheck
SetAttribute(String, String)
Set a non-standard attribute on the target group.
public virtual void SetAttribute(string key, string value = null)
Parameters
- key System.String
- value System.String
Remarks
Validate()
Validate the current construct.
protected override string[] Validate()
Returns
System.String[]
Overrides
Remarks
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.