EndpointGroup class
Provides a Global Accelerator endpoint group.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.globalaccelerator.EndpointGroup("example", {
endpointConfigurations: [{
endpointId: exampleAwsLb.arn,
weight: 100,
}],
listenerArn: exampleAwsGlobalacceleratorListener.arn,
});
import pulumi
import pulumi_aws as aws
example = aws.globalaccelerator.EndpointGroup("example",
endpoint_configurations=[{
"endpoint_id": example_aws_lb["arn"],
"weight": 100,
}],
listener_arn=example_aws_globalaccelerator_listener["arn"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.GlobalAccelerator.EndpointGroup("example", new()
{
EndpointConfigurations = new[]
{
new Aws.GlobalAccelerator.Inputs.EndpointGroupEndpointConfigurationArgs
{
EndpointId = exampleAwsLb.Arn,
Weight = 100,
},
},
ListenerArn = exampleAwsGlobalacceleratorListener.Arn,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/globalaccelerator"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := globalaccelerator.NewEndpointGroup(ctx, "example", &globalaccelerator.EndpointGroupArgs{
EndpointConfigurations: globalaccelerator.EndpointGroupEndpointConfigurationArray{
&globalaccelerator.EndpointGroupEndpointConfigurationArgs{
EndpointId: pulumi.Any(exampleAwsLb.Arn),
Weight: pulumi.Int(100),
},
},
ListenerArn: pulumi.Any(exampleAwsGlobalacceleratorListener.Arn),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_globalaccelerator_endpointgroup" "example" {
endpoint_configurations {
endpoint_id = exampleAwsLb.arn
weight = 100
}
listener_arn = exampleAwsGlobalacceleratorListener.arn
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.globalaccelerator.EndpointGroup;
import com.pulumi.aws.globalaccelerator.EndpointGroupArgs;
import com.pulumi.aws.globalaccelerator.inputs.EndpointGroupEndpointConfigurationArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new EndpointGroup("example", EndpointGroupArgs.builder()
.endpointConfigurations(EndpointGroupEndpointConfigurationArgs.builder()
.endpointId(exampleAwsLb.arn())
.weight(100)
.build())
.listenerArn(exampleAwsGlobalacceleratorListener.arn())
.build());
}
}
resources:
example:
type: aws:globalaccelerator:EndpointGroup
properties:
endpointConfigurations:
- endpointId: ${exampleAwsLb.arn}
weight: 100
listenerArn: ${exampleAwsGlobalacceleratorListener.arn}
Import
Identity Schema
Required
arn(String) ARN of the Global Accelerator endpoint group.
Using pulumi import, import Global Accelerator endpoint groups using the id. For example:
$ pulumi import aws:globalaccelerator/endpointGroup:EndpointGroup example arn:aws:globalaccelerator::111111111111:accelerator/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/listener/xxxxxxx/endpoint-group/xxxxxxxx
Constructors
- EndpointGroup(String name, {EndpointGroupArgs? args, CustomResourceOptions? options})
-
Creates a new EndpointGroup.
nameThe Pulumi resource name.argsArguments used to configure this EndpointGroup. The set of arguments for EndpointGroup.optionsResource options controlling this resource's behavior. - EndpointGroup.reference(String urn)
- Creates a typed reference to an existing EndpointGroup resource.
Properties
-
arn
↔ Output<
String> -
ARN of the endpoint group.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
endpointConfigurations
↔ Output<
List< EndpointGroupEndpointConfiguration> ?> -
The list of endpoint objects. Fields documented below.
latefinal
-
endpointGroupRegion
↔ Output<
String> -
The name of the AWS Region where the endpoint group is located.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
healthCheckIntervalSeconds
↔ Output<
int?> -
The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
latefinal
-
healthCheckPath
↔ Output<
String> -
If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (
/). the provider will only perform drift detection of its value when present in a configuration.latefinal -
healthCheckPort
↔ Output<
int> -
The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list.
the provider will only perform drift detection of its value when present in a configuration.
latefinal
-
healthCheckProtocol
↔ Output<
String?> -
The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
latefinal
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
listenerArn
↔ Output<
String> -
ARN of the listener.
latefinal
-
portOverrides
↔ Output<
List< EndpointGroupPortOverride> ?> -
Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. Fields documented below.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
thresholdCount
↔ Output<
int?> -
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. The default value is 3.
latefinal
-
trafficDialPercentage
↔ Output<
double?> -
The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener. The default value is 100.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {EndpointGroupState? state, CustomResourceOptions? options}) → EndpointGroup -
Gets an existing EndpointGroup resource's state with the given
nameandid.