Class CfnEndpointGroup
A CloudFormation AWS::GlobalAccelerator::EndpointGroup
.
Inherited Members
Namespace: Amazon.CDK.AWS.GlobalAccelerator
Assembly: Amazon.CDK.AWS.GlobalAccelerator.dll
Syntax (csharp)
public class CfnEndpointGroup : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnEndpointGroup
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::GlobalAccelerator::EndpointGroup
resource is a Global Accelerator resource type that contains information about how you create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one AWS Region .
CloudformationResource: AWS::GlobalAccelerator::EndpointGroup
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.GlobalAccelerator;
var cfnEndpointGroup = new CfnEndpointGroup(this, "MyCfnEndpointGroup", new CfnEndpointGroupProps {
EndpointGroupRegion = "endpointGroupRegion",
ListenerArn = "listenerArn",
// the properties below are optional
EndpointConfigurations = new [] { new EndpointConfigurationProperty {
EndpointId = "endpointId",
// the properties below are optional
ClientIpPreservationEnabled = false,
Weight = 123
} },
HealthCheckIntervalSeconds = 123,
HealthCheckPath = "healthCheckPath",
HealthCheckPort = 123,
HealthCheckProtocol = "healthCheckProtocol",
PortOverrides = new [] { new PortOverrideProperty {
EndpointPort = 123,
ListenerPort = 123
} },
ThresholdCount = 123,
TrafficDialPercentage = 123
});
Synopsis
Constructors
CfnEndpointGroup(Construct, String, ICfnEndpointGroupProps) | Create a new |
CfnEndpointGroup(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnEndpointGroup(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrEndpointGroupArn | The ARN of the endpoint group, such as |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
EndpointConfigurations | The list of endpoint objects. |
EndpointGroupRegion | The AWS Regions where the endpoint group is located. |
HealthCheckIntervalSeconds | The time—10 seconds or 30 seconds—between health checks for each endpoint. |
HealthCheckPath | If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. |
HealthCheckPort | The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. |
HealthCheckProtocol | The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. |
ListenerArn | The Amazon Resource Name (ARN) of the listener. |
PortOverrides | Allows you to override the destination ports used to route traffic to an endpoint. |
ThresholdCount | The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. |
TrafficDialPercentage | The percentage of traffic to send to an AWS Regions . |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnEndpointGroup(Construct, String, ICfnEndpointGroupProps)
Create a new AWS::GlobalAccelerator::EndpointGroup
.
public CfnEndpointGroup(Construct scope, string id, ICfnEndpointGroupProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnEndpointGroupProps
- resource properties.
CfnEndpointGroup(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnEndpointGroup(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnEndpointGroup(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnEndpointGroup(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrEndpointGroupArn
The ARN of the endpoint group, such as arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz/endpoint-group/098765zyxwvu
.
public virtual string AttrEndpointGroupArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: EndpointGroupArn
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
EndpointConfigurations
The list of endpoint objects.
public virtual object EndpointConfigurations { get; set; }
Property Value
System.Object
Remarks
EndpointGroupRegion
The AWS Regions where the endpoint group is located.
public virtual string EndpointGroupRegion { get; set; }
Property Value
System.String
Remarks
HealthCheckIntervalSeconds
The time—10 seconds or 30 seconds—between health checks for each endpoint.
public virtual Nullable<double> HealthCheckIntervalSeconds { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
HealthCheckPath
If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks.
public virtual string HealthCheckPath { get; set; }
Property Value
System.String
Remarks
HealthCheckPort
The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
public virtual Nullable<double> HealthCheckPort { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.
HealthCheckProtocol
The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
public virtual string HealthCheckProtocol { get; set; }
Property Value
System.String
Remarks
ListenerArn
The Amazon Resource Name (ARN) of the listener.
public virtual string ListenerArn { get; set; }
Property Value
System.String
Remarks
PortOverrides
Allows you to override the destination ports used to route traffic to an endpoint.
public virtual object PortOverrides { get; set; }
Property Value
System.Object
Remarks
Using a port override lets you map a list of external destination ports (that your users send traffic to) to a list of internal destination ports that you want an application endpoint to receive traffic on.
ThresholdCount
The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy.
public virtual Nullable<double> ThresholdCount { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
TrafficDialPercentage
The percentage of traffic to send to an AWS Regions .
public virtual Nullable<double> TrafficDialPercentage { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Additional traffic is distributed to other endpoint groups for this listener.
Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.
The default value is 100.
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>