Package com.pulumi.aws.globalaccelerator

Class EndpointGroup

  • public class EndpointGroup
extends com.pulumi.resources.CustomResource
    Provides a Global Accelerator endpoint group. ## Example Usage <!--Start PulumiCodeChooser --> 
     
 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.List;
 import java.util.ArrayList;
 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()        
             .listenerArn(exampleAwsGlobalacceleratorListener.id())
             .endpointConfigurations(EndpointGroupEndpointConfigurationArgs.builder()
                 .endpointId(exampleAwsLb.arn())
                 .weight(100)
                 .build())
             .build());
 
     }
 }
    <!--End PulumiCodeChooser --> ## Import Using `pulumi import`, import Global Accelerator endpoint groups using the `id`. For example: ```sh $ pulumi import aws:globalaccelerator/endpointGroup:EndpointGroup example arn:aws:globalaccelerator::111111111111:accelerator/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/listener/xxxxxxx/endpoint-group/xxxxxxxx ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<EndpointGroupEndpointConfiguration>>> endpointConfigurations()  
      com.pulumi.core.Output<java.lang.String> endpointGroupRegion()  
      static EndpointGroup get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, EndpointGroupState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> healthCheckIntervalSeconds()  
      com.pulumi.core.Output<java.lang.String> healthCheckPath()  
      com.pulumi.core.Output<java.lang.Integer> healthCheckPort()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> healthCheckProtocol()  
      com.pulumi.core.Output<java.lang.String> listenerArn()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<EndpointGroupPortOverride>>> portOverrides()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> thresholdCount()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Double>> trafficDialPercentage()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • EndpointGroup

        public EndpointGroup​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • EndpointGroup

        public EndpointGroup​(java.lang.String name,
                     EndpointGroupArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • EndpointGroup

        public EndpointGroup​(java.lang.String name,
                     EndpointGroupArgs args,
                     @Nullable
                     com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        The Amazon Resource Name (ARN) of the endpoint group.

      • endpointConfigurations

        public com.pulumi.core.Output<java.util.Optional<java.util.List<EndpointGroupEndpointConfiguration>>> endpointConfigurations()
        Returns:
        The list of endpoint objects. Fields documented below.

      • endpointGroupRegion

        public com.pulumi.core.Output<java.lang.String> endpointGroupRegion()
        Returns:
        The name of the AWS Region where the endpoint group is located.

      • healthCheckIntervalSeconds

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> healthCheckIntervalSeconds()
        Returns:
        The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.

      • healthCheckPath

        public com.pulumi.core.Output<java.lang.String> healthCheckPath()
        Returns:
        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.

      • healthCheckPort

        public com.pulumi.core.Output<java.lang.Integer> healthCheckPort()
        Returns:
        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.

      • healthCheckProtocol

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> healthCheckProtocol()
        Returns:
        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.

      • listenerArn

        public com.pulumi.core.Output<java.lang.String> listenerArn()
        Returns:
        The Amazon Resource Name (ARN) of the listener.

      • portOverrides

        public com.pulumi.core.Output<java.util.Optional<java.util.List<EndpointGroupPortOverride>>> portOverrides()
        Returns:
        Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. Fields documented below.

      • thresholdCount

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> thresholdCount()
        Returns:
        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.

      • trafficDialPercentage

        public com.pulumi.core.Output<java.util.Optional<java.lang.Double>> trafficDialPercentage()
        Returns:
        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.

      • get

        public static EndpointGroup get​(java.lang.String name,
                                com.pulumi.core.Output<java.lang.String> id,
                                @Nullable
                                EndpointGroupState state,
                                @Nullable
                                com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.