Class CfnEndpointGroup.EndpointConfigurationProperty
A complex type for endpoints.
Inheritance
Namespace: Amazon.CDK.AWS.GlobalAccelerator
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class EndpointConfigurationProperty : Object, CfnEndpointGroup.IEndpointConfigurationProperty
Syntax (vb)
Public Class EndpointConfigurationProperty
Inherits Object
Implements CfnEndpointGroup.IEndpointConfigurationProperty
Remarks
A resource must be valid and active when you add it as an endpoint.
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 endpointConfigurationProperty = new EndpointConfigurationProperty {
EndpointId = "endpointId",
// the properties below are optional
AttachmentArn = "attachmentArn",
ClientIpPreservationEnabled = false,
Weight = 123
};
Synopsis
Constructors
EndpointConfigurationProperty() |
Properties
AttachmentArn | The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints. |
ClientIpPreservationEnabled | Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. |
EndpointId | An ID for the endpoint. |
Weight | The weight associated with the endpoint. |
Constructors
EndpointConfigurationProperty()
public EndpointConfigurationProperty()
Properties
AttachmentArn
The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints.
public string AttachmentArn { get; set; }
Property Value
System.String
Remarks
ClientIpPreservationEnabled
Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint.
public object ClientIpPreservationEnabled { get; set; }
Property Value
System.Object
Remarks
The value is true or false. The default value is true for new accelerators.
If the value is set to true, the client's IP address is preserved in the X-Forwarded-For
request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.
For more information, see Preserve Client IP Addresses in the AWS Global Accelerator Developer Guide .
Default: - true
EndpointId
An ID for the endpoint.
public string EndpointId { get; set; }
Property Value
System.String
Remarks
If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. A resource must be valid and active when you add it as an endpoint.
For cross-account endpoints, this must be the ARN of the resource.
Weight
The weight associated with the endpoint.
public Nullable<double> Weight { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
When you add weights to endpoints, you configure Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide .
Default: - 100