The highest tagged major version is
README
¶
Endpoints for AWS Global Accelerator
This library contains integration classes to reference endpoints in AWS
Global Accelerator. Instances of these classes should be passed to the
endpointGroup.addEndpoint() method.
See the README of the @aws-cdk/aws-globalaccelerator library for more information on
AWS Global Accelerator, and examples of all the integration classes available in
this module.
Documentation
¶
Index ¶
- func NewApplicationLoadBalancerEndpoint_Override(a ApplicationLoadBalancerEndpoint, ...)
- func NewCfnEipEndpoint_Override(c CfnEipEndpoint, eip awsec2.CfnEIP, options *CfnEipEndpointProps)
- func NewInstanceEndpoint_Override(i InstanceEndpoint, instance awsec2.IInstance, options *InstanceEndpointProps)
- func NewNetworkLoadBalancerEndpoint_Override(n NetworkLoadBalancerEndpoint, ...)
- type ApplicationLoadBalancerEndpoint
- type ApplicationLoadBalancerEndpointOptions
- type CfnEipEndpoint
- type CfnEipEndpointProps
- type InstanceEndpoint
- type InstanceEndpointProps
- type NetworkLoadBalancerEndpoint
- type NetworkLoadBalancerEndpointProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewApplicationLoadBalancerEndpoint_Override ¶
func NewApplicationLoadBalancerEndpoint_Override(a ApplicationLoadBalancerEndpoint, loadBalancer awselasticloadbalancingv2.IApplicationLoadBalancer, options *ApplicationLoadBalancerEndpointOptions)
Experimental.
func NewCfnEipEndpoint_Override ¶
func NewCfnEipEndpoint_Override(c CfnEipEndpoint, eip awsec2.CfnEIP, options *CfnEipEndpointProps)
Experimental.
func NewInstanceEndpoint_Override ¶
func NewInstanceEndpoint_Override(i InstanceEndpoint, instance awsec2.IInstance, options *InstanceEndpointProps)
Experimental.
func NewNetworkLoadBalancerEndpoint_Override ¶
func NewNetworkLoadBalancerEndpoint_Override(n NetworkLoadBalancerEndpoint, loadBalancer awselasticloadbalancingv2.INetworkLoadBalancer, options *NetworkLoadBalancerEndpointProps)
Experimental.
Types ¶
type ApplicationLoadBalancerEndpoint ¶
type ApplicationLoadBalancerEndpoint interface {
awsglobalaccelerator.IEndpoint
// The region where the endpoint is located.
//
// If the region cannot be determined, `undefined` is returned.
// Experimental.
Region() *string
// Render the endpoint to an endpoint configuration.
// Experimental.
RenderEndpointConfiguration() interface{}
}
Use an Application Load Balancer as a Global Accelerator Endpoint.
Example:
var alb applicationLoadBalancer
var listener listener
listener.addEndpointGroup(jsii.String("Group"), &endpointGroupOptions{
endpoints: []iEndpoint{
ga_endpoints.NewApplicationLoadBalancerEndpoint(alb, &applicationLoadBalancerEndpointOptions{
weight: jsii.Number(128),
preserveClientIp: jsii.Boolean(true),
}),
},
})
Experimental.
func NewApplicationLoadBalancerEndpoint ¶
func NewApplicationLoadBalancerEndpoint(loadBalancer awselasticloadbalancingv2.IApplicationLoadBalancer, options *ApplicationLoadBalancerEndpointOptions) ApplicationLoadBalancerEndpoint
Experimental.
type ApplicationLoadBalancerEndpointOptions ¶
type ApplicationLoadBalancerEndpointOptions struct {
// Forward the client IP address in an `X-Forwarded-For` header.
//
// GlobalAccelerator will create Network Interfaces in your VPC in order
// to preserve the client IP address.
//
// Client IP address preservation is supported only in specific AWS Regions.
// See the GlobalAccelerator Developer Guide for a list.
// Experimental.
PreserveClientIp *bool `field:"optional" json:"preserveClientIp" yaml:"preserveClientIp"`
// Endpoint weight across all endpoints in the group.
//
// Must be a value between 0 and 255.
// Experimental.
Weight *float64 `field:"optional" json:"weight" yaml:"weight"`
}
Properties for a ApplicationLoadBalancerEndpoint.
Example:
var alb applicationLoadBalancer
var listener listener
listener.addEndpointGroup(jsii.String("Group"), &endpointGroupOptions{
endpoints: []iEndpoint{
ga_endpoints.NewApplicationLoadBalancerEndpoint(alb, &applicationLoadBalancerEndpointOptions{
weight: jsii.Number(128),
preserveClientIp: jsii.Boolean(true),
}),
},
})
Experimental.
type CfnEipEndpoint ¶
type CfnEipEndpoint interface {
awsglobalaccelerator.IEndpoint
// The region where the endpoint is located.
//
// If the region cannot be determined, `undefined` is returned.
// Experimental.
Region() *string
// Render the endpoint to an endpoint configuration.
// Experimental.
RenderEndpointConfiguration() interface{}
}
Use an EC2 Instance as a Global Accelerator Endpoint.
Example:
var listener listener
var eip cfnEIP
listener.addEndpointGroup(jsii.String("Group"), &endpointGroupOptions{
endpoints: []iEndpoint{
ga_endpoints.NewCfnEipEndpoint(eip, &cfnEipEndpointProps{
weight: jsii.Number(128),
}),
},
})
Experimental.
func NewCfnEipEndpoint ¶
func NewCfnEipEndpoint(eip awsec2.CfnEIP, options *CfnEipEndpointProps) CfnEipEndpoint
Experimental.
type CfnEipEndpointProps ¶
type CfnEipEndpointProps struct {
// Endpoint weight across all endpoints in the group.
//
// Must be a value between 0 and 255.
// Experimental.
Weight *float64 `field:"optional" json:"weight" yaml:"weight"`
}
Properties for a NetworkLoadBalancerEndpoint.
Example:
var listener listener
var eip cfnEIP
listener.addEndpointGroup(jsii.String("Group"), &endpointGroupOptions{
endpoints: []iEndpoint{
ga_endpoints.NewCfnEipEndpoint(eip, &cfnEipEndpointProps{
weight: jsii.Number(128),
}),
},
})
Experimental.
type InstanceEndpoint ¶
type InstanceEndpoint interface {
awsglobalaccelerator.IEndpoint
// The region where the endpoint is located.
//
// If the region cannot be determined, `undefined` is returned.
// Experimental.
Region() *string
// Render the endpoint to an endpoint configuration.
// Experimental.
RenderEndpointConfiguration() interface{}
}
Use an EC2 Instance as a Global Accelerator Endpoint.
Example:
var listener listener
var instance instance
listener.addEndpointGroup(jsii.String("Group"), &endpointGroupOptions{
endpoints: []iEndpoint{
ga_endpoints.NewInstanceEndpoint(instance, &instanceEndpointProps{
weight: jsii.Number(128),
preserveClientIp: jsii.Boolean(true),
}),
},
})
Experimental.
func NewInstanceEndpoint ¶
func NewInstanceEndpoint(instance awsec2.IInstance, options *InstanceEndpointProps) InstanceEndpoint
Experimental.
type InstanceEndpointProps ¶
type InstanceEndpointProps struct {
// Forward the client IP address.
//
// GlobalAccelerator will create Network Interfaces in your VPC in order
// to preserve the client IP address.
//
// Client IP address preservation is supported only in specific AWS Regions.
// See the GlobalAccelerator Developer Guide for a list.
// Experimental.
PreserveClientIp *bool `field:"optional" json:"preserveClientIp" yaml:"preserveClientIp"`
// Endpoint weight across all endpoints in the group.
//
// Must be a value between 0 and 255.
// Experimental.
Weight *float64 `field:"optional" json:"weight" yaml:"weight"`
}
Properties for a NetworkLoadBalancerEndpoint.
Example:
var listener listener
var instance instance
listener.addEndpointGroup(jsii.String("Group"), &endpointGroupOptions{
endpoints: []iEndpoint{
ga_endpoints.NewInstanceEndpoint(instance, &instanceEndpointProps{
weight: jsii.Number(128),
preserveClientIp: jsii.Boolean(true),
}),
},
})
Experimental.
type NetworkLoadBalancerEndpoint ¶
type NetworkLoadBalancerEndpoint interface {
awsglobalaccelerator.IEndpoint
// The region where the endpoint is located.
//
// If the region cannot be determined, `undefined` is returned.
// Experimental.
Region() *string
// Render the endpoint to an endpoint configuration.
// Experimental.
RenderEndpointConfiguration() interface{}
}
Use a Network Load Balancer as a Global Accelerator Endpoint.
Example:
// Create an Accelerator
accelerator := globalaccelerator.NewAccelerator(this, jsii.String("Accelerator"))
// Create a Listener
listener := accelerator.addListener(jsii.String("Listener"), &listenerOptions{
portRanges: []portRange{
&portRange{
fromPort: jsii.Number(80),
},
&portRange{
fromPort: jsii.Number(443),
},
},
})
// Import the Load Balancers
nlb1 := elbv2.networkLoadBalancer.fromNetworkLoadBalancerAttributes(this, jsii.String("NLB1"), &networkLoadBalancerAttributes{
loadBalancerArn: jsii.String("arn:aws:elasticloadbalancing:us-west-2:111111111111:loadbalancer/app/my-load-balancer1/e16bef66805b"),
})
nlb2 := elbv2.networkLoadBalancer.fromNetworkLoadBalancerAttributes(this, jsii.String("NLB2"), &networkLoadBalancerAttributes{
loadBalancerArn: jsii.String("arn:aws:elasticloadbalancing:ap-south-1:111111111111:loadbalancer/app/my-load-balancer2/5513dc2ea8a1"),
})
// Add one EndpointGroup for each Region we are targeting
listener.addEndpointGroup(jsii.String("Group1"), &endpointGroupOptions{
endpoints: []iEndpoint{
ga_endpoints.NewNetworkLoadBalancerEndpoint(nlb1),
},
})
listener.addEndpointGroup(jsii.String("Group2"), &endpointGroupOptions{
// Imported load balancers automatically calculate their Region from the ARN.
// If you are load balancing to other resources, you must also pass a `region`
// parameter here.
endpoints: []*iEndpoint{
ga_endpoints.NewNetworkLoadBalancerEndpoint(nlb2),
},
})
Experimental.
func NewNetworkLoadBalancerEndpoint ¶
func NewNetworkLoadBalancerEndpoint(loadBalancer awselasticloadbalancingv2.INetworkLoadBalancer, options *NetworkLoadBalancerEndpointProps) NetworkLoadBalancerEndpoint
Experimental.
type NetworkLoadBalancerEndpointProps ¶
type NetworkLoadBalancerEndpointProps struct {
// Endpoint weight across all endpoints in the group.
//
// Must be a value between 0 and 255.
// Experimental.
Weight *float64 `field:"optional" json:"weight" yaml:"weight"`
}
Properties for a NetworkLoadBalancerEndpoint.
Example:
var nlb networkLoadBalancer
var listener listener
listener.addEndpointGroup(jsii.String("Group"), &endpointGroupOptions{
endpoints: []iEndpoint{
ga_endpoints.NewNetworkLoadBalancerEndpoint(nlb, &networkLoadBalancerEndpointProps{
weight: jsii.Number(128),
}),
},
})
Experimental.
Source Files
¶
Directories
Click to show internal directories.
Click to hide internal directories.