awsglobalaccelerator

package
v2.0.0-rc.31 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 23, 2021 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Accelerator_IsConstruct 

func Accelerator_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func Accelerator_IsResource 

func Accelerator_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func CfnAccelerator_CFN_RESOURCE_TYPE_NAME 

func CfnAccelerator_CFN_RESOURCE_TYPE_NAME() *string

func CfnAccelerator_IsCfnElement 

func CfnAccelerator_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnAccelerator_IsCfnResource 

func CfnAccelerator_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnAccelerator_IsConstruct 

func CfnAccelerator_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnEndpointGroup_CFN_RESOURCE_TYPE_NAME 

func CfnEndpointGroup_CFN_RESOURCE_TYPE_NAME() *string

func CfnEndpointGroup_IsCfnElement 

func CfnEndpointGroup_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnEndpointGroup_IsCfnResource 

func CfnEndpointGroup_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnEndpointGroup_IsConstruct 

func CfnEndpointGroup_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnListener_CFN_RESOURCE_TYPE_NAME 

func CfnListener_CFN_RESOURCE_TYPE_NAME() *string

func CfnListener_IsCfnElement 

func CfnListener_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnListener_IsCfnResource 

func CfnListener_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnListener_IsConstruct 

func CfnListener_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func EndpointGroup_IsConstruct 

func EndpointGroup_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func EndpointGroup_IsResource 

func EndpointGroup_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func Listener_IsConstruct 

func Listener_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func Listener_IsResource 

func Listener_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func NewAccelerator_Override 

func NewAccelerator_Override(a Accelerator, scope constructs.Construct, id *string, props *AcceleratorProps)

Experimental.

func NewCfnAccelerator_Override 

func NewCfnAccelerator_Override(c CfnAccelerator, scope constructs.Construct, id *string, props *CfnAcceleratorProps)

Create a new `AWS::GlobalAccelerator::Accelerator`.

func NewCfnEndpointGroup_Override 

func NewCfnEndpointGroup_Override(c CfnEndpointGroup, scope constructs.Construct, id *string, props *CfnEndpointGroupProps)

Create a new `AWS::GlobalAccelerator::EndpointGroup`.

func NewCfnListener_Override 

func NewCfnListener_Override(c CfnListener, scope constructs.Construct, id *string, props *CfnListenerProps)

Create a new `AWS::GlobalAccelerator::Listener`.

func NewEndpointGroup_Override 

func NewEndpointGroup_Override(e EndpointGroup, scope constructs.Construct, id *string, props *EndpointGroupProps)

Experimental.

func NewListener_Override 

func NewListener_Override(l Listener, scope constructs.Construct, id *string, props *ListenerProps)

Experimental.

func NewRawEndpoint_Override 

func NewRawEndpoint_Override(r RawEndpoint, props *RawEndpointProps)

Experimental.

Types

type Accelerator 

type Accelerator interface {
	awscdk.Resource
	IAccelerator
	AcceleratorArn() *string
	DnsName() *string
	Env() *awscdk.ResourceEnvironment
	Node() constructs.Node
	PhysicalName() *string
	Stack() awscdk.Stack
	AddListener(id *string, options *ListenerOptions) Listener
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	ToString() *string
}

The Accelerator construct.

TODO: EXAMPLE

Experimental.

func NewAccelerator 

func NewAccelerator(scope constructs.Construct, id *string, props *AcceleratorProps) Accelerator

Experimental.

type AcceleratorAttributes 

type AcceleratorAttributes struct {
	// The ARN of the accelerator.
	// Experimental.
	AcceleratorArn *string `json:"acceleratorArn"`
	// The DNS name of the accelerator.
	// Experimental.
	DnsName *string `json:"dnsName"`
}

Attributes required to import an existing accelerator to the stack.

TODO: EXAMPLE

Experimental.

type AcceleratorProps 

type AcceleratorProps struct {
	// The name of the accelerator.
	// Experimental.
	AcceleratorName *string `json:"acceleratorName"`
	// Indicates whether the accelerator is enabled.
	// Experimental.
	Enabled *bool `json:"enabled"`
}

Construct properties of the Accelerator.

TODO: EXAMPLE

Experimental.

type CfnAccelerator 

type CfnAccelerator interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrAcceleratorArn() *string
	AttrDnsName() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Enabled() interface{}
	SetEnabled(val interface{})
	IpAddresses() *[]*string
	SetIpAddresses(val *[]*string)
	IpAddressType() *string
	SetIpAddressType(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::GlobalAccelerator::Accelerator`.

TODO: EXAMPLE

func NewCfnAccelerator 

func NewCfnAccelerator(scope constructs.Construct, id *string, props *CfnAcceleratorProps) CfnAccelerator

Create a new `AWS::GlobalAccelerator::Accelerator`.

type CfnAcceleratorProps 

type CfnAcceleratorProps struct {
	// `AWS::GlobalAccelerator::Accelerator.Enabled`.
	Enabled interface{} `json:"enabled"`
	// `AWS::GlobalAccelerator::Accelerator.IpAddresses`.
	IpAddresses *[]*string `json:"ipAddresses"`
	// `AWS::GlobalAccelerator::Accelerator.IpAddressType`.
	IpAddressType *string `json:"ipAddressType"`
	// `AWS::GlobalAccelerator::Accelerator.Name`.
	Name *string `json:"name"`
	// `AWS::GlobalAccelerator::Accelerator.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `AWS::GlobalAccelerator::Accelerator`.

TODO: EXAMPLE

type CfnEndpointGroup 

type CfnEndpointGroup interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrEndpointGroupArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	EndpointConfigurations() interface{}
	SetEndpointConfigurations(val interface{})
	EndpointGroupRegion() *string
	SetEndpointGroupRegion(val *string)
	HealthCheckIntervalSeconds() *float64
	SetHealthCheckIntervalSeconds(val *float64)
	HealthCheckPath() *string
	SetHealthCheckPath(val *string)
	HealthCheckPort() *float64
	SetHealthCheckPort(val *float64)
	HealthCheckProtocol() *string
	SetHealthCheckProtocol(val *string)
	ListenerArn() *string
	SetListenerArn(val *string)
	LogicalId() *string
	Node() constructs.Node
	PortOverrides() interface{}
	SetPortOverrides(val interface{})
	Ref() *string
	Stack() awscdk.Stack
	ThresholdCount() *float64
	SetThresholdCount(val *float64)
	TrafficDialPercentage() *float64
	SetTrafficDialPercentage(val *float64)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::GlobalAccelerator::EndpointGroup`.

TODO: EXAMPLE

func NewCfnEndpointGroup 

func NewCfnEndpointGroup(scope constructs.Construct, id *string, props *CfnEndpointGroupProps) CfnEndpointGroup

Create a new `AWS::GlobalAccelerator::EndpointGroup`.

type CfnEndpointGroupProps 

type CfnEndpointGroupProps struct {
	// `AWS::GlobalAccelerator::EndpointGroup.EndpointConfigurations`.
	EndpointConfigurations interface{} `json:"endpointConfigurations"`
	// `AWS::GlobalAccelerator::EndpointGroup.EndpointGroupRegion`.
	EndpointGroupRegion *string `json:"endpointGroupRegion"`
	// `AWS::GlobalAccelerator::EndpointGroup.HealthCheckIntervalSeconds`.
	HealthCheckIntervalSeconds *float64 `json:"healthCheckIntervalSeconds"`
	// `AWS::GlobalAccelerator::EndpointGroup.HealthCheckPath`.
	HealthCheckPath *string `json:"healthCheckPath"`
	// `AWS::GlobalAccelerator::EndpointGroup.HealthCheckPort`.
	HealthCheckPort *float64 `json:"healthCheckPort"`
	// `AWS::GlobalAccelerator::EndpointGroup.HealthCheckProtocol`.
	HealthCheckProtocol *string `json:"healthCheckProtocol"`
	// `AWS::GlobalAccelerator::EndpointGroup.ListenerArn`.
	ListenerArn *string `json:"listenerArn"`
	// `AWS::GlobalAccelerator::EndpointGroup.PortOverrides`.
	PortOverrides interface{} `json:"portOverrides"`
	// `AWS::GlobalAccelerator::EndpointGroup.ThresholdCount`.
	ThresholdCount *float64 `json:"thresholdCount"`
	// `AWS::GlobalAccelerator::EndpointGroup.TrafficDialPercentage`.
	TrafficDialPercentage *float64 `json:"trafficDialPercentage"`
}

Properties for defining a `AWS::GlobalAccelerator::EndpointGroup`.

TODO: EXAMPLE

type CfnEndpointGroup_EndpointConfigurationProperty 

type CfnEndpointGroup_EndpointConfigurationProperty struct {
	// `CfnEndpointGroup.EndpointConfigurationProperty.ClientIPPreservationEnabled`.
	ClientIpPreservationEnabled interface{} `json:"clientIpPreservationEnabled"`
	// `CfnEndpointGroup.EndpointConfigurationProperty.EndpointId`.
	EndpointId *string `json:"endpointId"`
	// `CfnEndpointGroup.EndpointConfigurationProperty.Weight`.
	Weight *float64 `json:"weight"`
}

TODO: EXAMPLE

type CfnEndpointGroup_PortOverrideProperty 

type CfnEndpointGroup_PortOverrideProperty struct {
	// `CfnEndpointGroup.PortOverrideProperty.EndpointPort`.
	EndpointPort *float64 `json:"endpointPort"`
	// `CfnEndpointGroup.PortOverrideProperty.ListenerPort`.
	ListenerPort *float64 `json:"listenerPort"`
}

TODO: EXAMPLE

type CfnListener 

type CfnListener interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AcceleratorArn() *string
	SetAcceleratorArn(val *string)
	AttrListenerArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ClientAffinity() *string
	SetClientAffinity(val *string)
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	PortRanges() interface{}
	SetPortRanges(val interface{})
	Protocol() *string
	SetProtocol(val *string)
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::GlobalAccelerator::Listener`.

TODO: EXAMPLE

func NewCfnListener 

func NewCfnListener(scope constructs.Construct, id *string, props *CfnListenerProps) CfnListener

Create a new `AWS::GlobalAccelerator::Listener`.

type CfnListenerProps 

type CfnListenerProps struct {
	// `AWS::GlobalAccelerator::Listener.AcceleratorArn`.
	AcceleratorArn *string `json:"acceleratorArn"`
	// `AWS::GlobalAccelerator::Listener.ClientAffinity`.
	ClientAffinity *string `json:"clientAffinity"`
	// `AWS::GlobalAccelerator::Listener.PortRanges`.
	PortRanges interface{} `json:"portRanges"`
	// `AWS::GlobalAccelerator::Listener.Protocol`.
	Protocol *string `json:"protocol"`
}

Properties for defining a `AWS::GlobalAccelerator::Listener`.

TODO: EXAMPLE

type CfnListener_PortRangeProperty 

type CfnListener_PortRangeProperty struct {
	// `CfnListener.PortRangeProperty.FromPort`.
	FromPort *float64 `json:"fromPort"`
	// `CfnListener.PortRangeProperty.ToPort`.
	ToPort *float64 `json:"toPort"`
}

TODO: EXAMPLE

type ClientAffinity 

type ClientAffinity string

Client affinity gives you control over whether to always route each client to the same specific endpoint. See: https://docs.aws.amazon.com/global-accelerator/latest/dg/about-listeners.html#about-listeners-client-affinity

Experimental. 

const (
	ClientAffinity_NONE      ClientAffinity = "NONE"
	ClientAffinity_SOURCE_IP ClientAffinity = "SOURCE_IP"
)

type ConnectionProtocol 

type ConnectionProtocol string

The protocol for the connections from clients to the accelerator. Experimental. 

const (
	ConnectionProtocol_TCP ConnectionProtocol = "TCP"
	ConnectionProtocol_UDP ConnectionProtocol = "UDP"
)

type EndpointGroup 

type EndpointGroup interface {
	awscdk.Resource
	IEndpointGroup
	EndpointGroupArn() *string
	EndpointGroupName() *string
	Endpoints() *[]IEndpoint
	Env() *awscdk.ResourceEnvironment
	Node() constructs.Node
	PhysicalName() *string
	Stack() awscdk.Stack
	AddEndpoint(endpoint IEndpoint)
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	ConnectionsPeer(id *string, vpc awsec2.IVpc) awsec2.IPeer
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	ToString() *string
}

EndpointGroup construct.

TODO: EXAMPLE

Experimental.

func NewEndpointGroup 

func NewEndpointGroup(scope constructs.Construct, id *string, props *EndpointGroupProps) EndpointGroup

Experimental.

type EndpointGroupOptions 

type EndpointGroupOptions struct {
	// Name of the endpoint group.
	// Experimental.
	EndpointGroupName *string `json:"endpointGroupName"`
	// Initial list of endpoints for this group.
	// Experimental.
	Endpoints *[]IEndpoint `json:"endpoints"`
	// The time between health checks for each endpoint.
	//
	// Must be either 10 or 30 seconds.
	// Experimental.
	HealthCheckInterval awscdk.Duration `json:"healthCheckInterval"`
	// The ping path for health checks (if the protocol is HTTP(S)).
	// Experimental.
	HealthCheckPath *string `json:"healthCheckPath"`
	// The port used to perform health checks.
	// Experimental.
	HealthCheckPort *float64 `json:"healthCheckPort"`
	// The protocol used to perform health checks.
	// Experimental.
	HealthCheckProtocol HealthCheckProtocol `json:"healthCheckProtocol"`
	// 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.
	// Experimental.
	HealthCheckThreshold *float64 `json:"healthCheckThreshold"`
	// Override the destination ports used to route traffic to an endpoint.
	//
	// Unless overridden, the port used to hit the endpoint will be the same as the port
	// that traffic arrives on at the listener.
	// Experimental.
	PortOverrides *[]*PortOverride `json:"portOverrides"`
	// The AWS Region where the endpoint group is located.
	// Experimental.
	Region *string `json:"region"`
	// The percentage of traffic to send to this AWS Region.
	//
	// The percentage is applied to the traffic that would otherwise have been
	// routed to the Region based on optimal routing. Additional traffic is
	// distributed to other endpoint groups for this listener.
	// Experimental.
	TrafficDialPercentage *float64 `json:"trafficDialPercentage"`
}

Basic options for creating a new EndpointGroup.

TODO: EXAMPLE

Experimental.

type EndpointGroupProps 

type EndpointGroupProps struct {
	// Name of the endpoint group.
	// Experimental.
	EndpointGroupName *string `json:"endpointGroupName"`
	// Initial list of endpoints for this group.
	// Experimental.
	Endpoints *[]IEndpoint `json:"endpoints"`
	// The time between health checks for each endpoint.
	//
	// Must be either 10 or 30 seconds.
	// Experimental.
	HealthCheckInterval awscdk.Duration `json:"healthCheckInterval"`
	// The ping path for health checks (if the protocol is HTTP(S)).
	// Experimental.
	HealthCheckPath *string `json:"healthCheckPath"`
	// The port used to perform health checks.
	// Experimental.
	HealthCheckPort *float64 `json:"healthCheckPort"`
	// The protocol used to perform health checks.
	// Experimental.
	HealthCheckProtocol HealthCheckProtocol `json:"healthCheckProtocol"`
	// 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.
	// Experimental.
	HealthCheckThreshold *float64 `json:"healthCheckThreshold"`
	// Override the destination ports used to route traffic to an endpoint.
	//
	// Unless overridden, the port used to hit the endpoint will be the same as the port
	// that traffic arrives on at the listener.
	// Experimental.
	PortOverrides *[]*PortOverride `json:"portOverrides"`
	// The AWS Region where the endpoint group is located.
	// Experimental.
	Region *string `json:"region"`
	// The percentage of traffic to send to this AWS Region.
	//
	// The percentage is applied to the traffic that would otherwise have been
	// routed to the Region based on optimal routing. Additional traffic is
	// distributed to other endpoint groups for this listener.
	// Experimental.
	TrafficDialPercentage *float64 `json:"trafficDialPercentage"`
	// The Amazon Resource Name (ARN) of the listener.
	// Experimental.
	Listener IListener `json:"listener"`
}

Property of the EndpointGroup.

TODO: EXAMPLE

Experimental.

type HealthCheckProtocol 

type HealthCheckProtocol string

The protocol for the connections from clients to the accelerator. Experimental. 

const (
	HealthCheckProtocol_HTTP  HealthCheckProtocol = "HTTP"
	HealthCheckProtocol_HTTPS HealthCheckProtocol = "HTTPS"
	HealthCheckProtocol_TCP   HealthCheckProtocol = "TCP"
)

type IAccelerator 

type IAccelerator interface {
	awscdk.IResource
	// The ARN of the accelerator.
	// Experimental.
	AcceleratorArn() *string
	// The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses.
	// Experimental.
	DnsName() *string
}

The interface of the Accelerator. Experimental.

func Accelerator_FromAcceleratorAttributes 

func Accelerator_FromAcceleratorAttributes(scope constructs.Construct, id *string, attrs *AcceleratorAttributes) IAccelerator

import from attributes. Experimental.

type IEndpoint 

type IEndpoint interface {
	// Render the endpoint to an endpoint configuration.
	// Experimental.
	RenderEndpointConfiguration() interface{}
	// The region where the endpoint is located.
	//
	// If the region cannot be determined, `undefined` is returned
	// Experimental.
	Region() *string
}

An endpoint for the endpoint group.

Implementations of `IEndpoint` can be found in the `aws-globalaccelerator-endpoints` package. Experimental.

type IEndpointGroup 

type IEndpointGroup interface {
	awscdk.IResource
	// EndpointGroup ARN.
	// Experimental.
	EndpointGroupArn() *string
}

The interface of the EndpointGroup. Experimental.

func EndpointGroup_FromEndpointGroupArn 

func EndpointGroup_FromEndpointGroupArn(scope constructs.Construct, id *string, endpointGroupArn *string) IEndpointGroup

import from ARN. Experimental.

type IListener 

type IListener interface {
	awscdk.IResource
	// The ARN of the listener.
	// Experimental.
	ListenerArn() *string
}

Interface of the Listener. Experimental.

func Listener_FromListenerArn 

func Listener_FromListenerArn(scope constructs.Construct, id *string, listenerArn *string) IListener

import from ARN. Experimental.

type Listener 

type Listener interface {
	awscdk.Resource
	IListener
	Env() *awscdk.ResourceEnvironment
	ListenerArn() *string
	ListenerName() *string
	Node() constructs.Node
	PhysicalName() *string
	Stack() awscdk.Stack
	AddEndpointGroup(id *string, options *EndpointGroupOptions) EndpointGroup
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	ToString() *string
}

The construct for the Listener.

TODO: EXAMPLE

Experimental.

func NewListener 

func NewListener(scope constructs.Construct, id *string, props *ListenerProps) Listener

Experimental.

type ListenerOptions 

type ListenerOptions struct {
	// Client affinity to direct all requests from a user to the same endpoint.
	//
	// If you have stateful applications, client affinity lets you direct all
	// requests from a user to the same endpoint.
	//
	// By default, each connection from each client is routed to seperate
	// endpoints. Set client affinity to SOURCE_IP to route all connections from
	// a single client to the same endpoint.
	// Experimental.
	ClientAffinity ClientAffinity `json:"clientAffinity"`
	// Name of the listener.
	// Experimental.
	ListenerName *string `json:"listenerName"`
	// The list of port ranges for the connections from clients to the accelerator.
	// Experimental.
	PortRanges *[]*PortRange `json:"portRanges"`
	// The protocol for the connections from clients to the accelerator.
	// Experimental.
	Protocol ConnectionProtocol `json:"protocol"`
}

Construct options for Listener.

TODO: EXAMPLE

Experimental.

type ListenerProps 

type ListenerProps struct {
	// Client affinity to direct all requests from a user to the same endpoint.
	//
	// If you have stateful applications, client affinity lets you direct all
	// requests from a user to the same endpoint.
	//
	// By default, each connection from each client is routed to seperate
	// endpoints. Set client affinity to SOURCE_IP to route all connections from
	// a single client to the same endpoint.
	// Experimental.
	ClientAffinity ClientAffinity `json:"clientAffinity"`
	// Name of the listener.
	// Experimental.
	ListenerName *string `json:"listenerName"`
	// The list of port ranges for the connections from clients to the accelerator.
	// Experimental.
	PortRanges *[]*PortRange `json:"portRanges"`
	// The protocol for the connections from clients to the accelerator.
	// Experimental.
	Protocol ConnectionProtocol `json:"protocol"`
	// The accelerator for this listener.
	// Experimental.
	Accelerator IAccelerator `json:"accelerator"`
}

Construct properties for Listener.

TODO: EXAMPLE

Experimental.

type PortOverride 

type PortOverride struct {
	// The endpoint port that you want a listener port to be mapped to.
	//
	// This is the port on the endpoint, such as the Application Load Balancer or Amazon EC2 instance.
	// Experimental.
	EndpointPort *float64 `json:"endpointPort"`
	// The listener port that you want to map to a specific endpoint port.
	//
	// This is the port that user traffic arrives to the Global Accelerator on.
	// Experimental.
	ListenerPort *float64 `json:"listenerPort"`
}

Override specific listener ports used to route traffic to endpoints that are part of an endpoint group.

TODO: EXAMPLE

Experimental.

type PortRange 

type PortRange struct {
	// The first port in the range of ports, inclusive.
	// Experimental.
	FromPort *float64 `json:"fromPort"`
	// The last port in the range of ports, inclusive.
	// Experimental.
	ToPort *float64 `json:"toPort"`
}

The list of port ranges for the connections from clients to the accelerator.

TODO: EXAMPLE

Experimental.

type RawEndpoint 

type RawEndpoint interface {
	IEndpoint
	Region() *string
	RenderEndpointConfiguration() interface{}
}

Untyped endpoint implementation.

Prefer using the classes in the `aws-globalaccelerator-endpoints` package instead, as they accept typed constructs. You can use this class if you want to use an endpoint type that does not have an appropriate class in that package yet.

TODO: EXAMPLE

Experimental.

func NewRawEndpoint 

func NewRawEndpoint(props *RawEndpointProps) RawEndpoint

Experimental.

type RawEndpointProps 

type RawEndpointProps struct {
	// Identifier of the endpoint.
	//
	// Load balancer ARN, instance ID or EIP allocation ID.
	// Experimental.
	EndpointId *string `json:"endpointId"`
	// Forward the client IP address.
	//
	// GlobalAccelerator will create Network Interfaces in your VPC in order
	// to preserve the client IP address.
	//
	// Only applies to Application Load Balancers and EC2 instances.
	//
	// Client IP address preservation is supported only in specific AWS Regions.
	// See the GlobalAccelerator Developer Guide for a list.
	// Experimental.
	PreserveClientIp *bool `json:"preserveClientIp"`
	// The region where this endpoint is located.
	// Experimental.
	Region *string `json:"region"`
	// Endpoint weight across all endpoints in the group.
	//
	// Must be a value between 0 and 255.
	// Experimental.
	Weight *float64 `json:"weight"`
}

Properties for RawEndpoint.

TODO: EXAMPLE

Experimental.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.