Package com.pulumi.aws.globalaccelerator

Class Listener

  • public class Listener
extends com.pulumi.resources.CustomResource
    Provides a Global Accelerator listener. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.globalaccelerator.Accelerator;
 import com.pulumi.aws.globalaccelerator.AcceleratorArgs;
 import com.pulumi.aws.globalaccelerator.inputs.AcceleratorAttributesArgs;
 import com.pulumi.aws.globalaccelerator.Listener;
 import com.pulumi.aws.globalaccelerator.ListenerArgs;
 import com.pulumi.aws.globalaccelerator.inputs.ListenerPortRangeArgs;
 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 Accelerator("example", AcceleratorArgs.builder()
             .attributes(AcceleratorAttributesArgs.builder()
                 .flowLogsEnabled(true)
                 .flowLogsS3Bucket("example-bucket")
                 .flowLogsS3Prefix("flow-logs/")
                 .build())
             .name("Example")
             .ipAddressType("IPV4")
             .enabled(true)
             .build());
 
         var exampleListener = new Listener("exampleListener", ListenerArgs.builder()
             .portRanges(ListenerPortRangeArgs.builder()
                 .fromPort(80)
                 .toPort(80)
                 .build())
             .acceleratorArn(example.arn())
             .clientAffinity("SOURCE_IP")
             .protocol("TCP")
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required - `arn` (String) ARN of the Global Accelerator listener. Using `pulumi import`, import Global Accelerator listeners using the `id`. For example: ```sh $ pulumi import aws:globalaccelerator/listener:Listener example arn:aws:globalaccelerator::111111111111:accelerator/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/listener/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

    • Constructor Summary

      Constructors 
      Constructor Description
      Listener​(java.lang.String name)  
      Listener​(java.lang.String name, ListenerArgs args)  
      Listener​(java.lang.String name, ListenerArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> acceleratorArn()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> clientAffinity()  
      static Listener get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ListenerState 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.List<ListenerPortRange>> portRanges()  
      com.pulumi.core.Output<java.lang.String> protocol()  

      • 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

      • Listener

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

      • Listener

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

      • Listener

        public Listener​(java.lang.String name,
                ListenerArgs 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

      • acceleratorArn

        public com.pulumi.core.Output<java.lang.String> acceleratorArn()
        Returns:
        ARN of your accelerator.

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the listener.

      • clientAffinity

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> clientAffinity()
        Returns:
        Direct all requests from a user to the same endpoint. Valid values are `NONE`, `SOURCE_IP`. Default: `NONE`. If `NONE`, Global Accelerator uses the "five-tuple" properties of source IP address, source port, destination IP address, destination port, and protocol to select the hash value. If `SOURCE_IP`, Global Accelerator uses the "two-tuple" properties of source (client) IP address and destination IP address to select the hash value.

      • portRanges

        public com.pulumi.core.Output<java.util.List<ListenerPortRange>> portRanges()
        Returns:
        Port ranges for the connections from clients to the accelerator. See `portRange` below.

      • protocol

        public com.pulumi.core.Output<java.lang.String> protocol()
        Returns:
        Protocol for the connections from clients to the accelerator. Valid values are `TCP`, `UDP`.

      • get

        public static Listener get​(java.lang.String name,
                           com.pulumi.core.Output<java.lang.String> id,
                           @Nullable
                           ListenerState 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.